diagram | |||
namespace | http://base.api.ec.n2.tibco.com | ||
children | category componentId id isPrimary length name type isFilterable isSortable isArray displayName attributeGroup | ||
annotation |
|
||
source | <xs:complexType name="AttributeDefinition"> <xs:annotation> <xs:documentation>Definition of an attribute.</xs:documentation> </xs:annotation> <xs:sequence> <xs:element name="category" type="xs:string" minOccurs="0" maxOccurs="1"> <xs:annotation> <xs:documentation>Category of this AttributeDefinition.</xs:documentation> </xs:annotation> </xs:element> <xs:element name="componentId" type="xs:long" minOccurs="0" maxOccurs="1"> <xs:annotation> <xs:documentation>Component against which this AttributeDefinition is registered. This value is only populated when calling getAllAttributes. </xs:documentation> </xs:annotation> </xs:element> <xs:element name="id" type="xs:long" minOccurs="0" maxOccurs="1"> <xs:annotation> <xs:documentation>Identifier of this attribute. (When registering attributes this property should be left blank. The result of the registration operation is the same list of AttributeDefinitions passed in but with the id property filled out.)</xs:documentation> </xs:annotation> </xs:element> <xs:element name="isPrimary" type="xs:boolean" minOccurs="0" maxOccurs="1"> <xs:annotation> <xs:documentation>Boolean value defining whether this attribute can be used in a query string. Attributes that do not have this flag set can be returned as part of a query result, but cannot be used in a query filter.</xs:documentation> </xs:annotation> </xs:element> <xs:element name="length" type="xs:int" minOccurs="0" maxOccurs="1"> <xs:annotation> <xs:documentation>Length of this attribute (as defined by Hibernate mappings).</xs:documentation> </xs:annotation> </xs:element> <xs:element name="name" type="xs:string" minOccurs="0" maxOccurs="1"> <xs:annotation> <xs:documentation>Name of this AttributeDefinition. (The Name must be unique for a specific component and version.)</xs:documentation> </xs:annotation> </xs:element> <xs:element name="type" type="AttributeType" minOccurs="0" maxOccurs="1"> <xs:annotation> <xs:documentation>Type of this AttributeDefinition, for possible options see AttributeType</xs:documentation> </xs:annotation> </xs:element> <xs:element name="isFilterable" type="xs:boolean" minOccurs="0" maxOccurs="1"> <xs:annotation> <xs:documentation>Boolean value defining whether this attribute can be used for filtering.</xs:documentation> </xs:annotation> </xs:element> <xs:element name="isSortable" type="xs:boolean" minOccurs="0" maxOccurs="1"> <xs:annotation> <xs:documentation>Boolean value defining whether this attribute can be used for sorting.</xs:documentation> </xs:annotation> </xs:element> <xs:element name="isArray" type="xs:boolean" minOccurs="0" maxOccurs="1"> <xs:annotation> <xs:documentation>Whether or not this attribute is able to store arrays of values</xs:documentation> </xs:annotation> </xs:element> <xs:element name="displayName" type="xs:string" minOccurs="0" maxOccurs="1"/> <xs:element name="attributeGroup" type="AttributeGroup" minOccurs="0" maxOccurs="1"/> </xs:sequence> </xs:complexType> |
diagram | |||||||
type | xs:string | ||||||
properties |
|
||||||
annotation |
|
||||||
source | <xs:element name="category" type="xs:string" minOccurs="0" maxOccurs="1"> <xs:annotation> <xs:documentation>Category of this AttributeDefinition.</xs:documentation> </xs:annotation> </xs:element> |
diagram | |||||||
type | xs:long | ||||||
properties |
|
||||||
annotation |
|
||||||
source | <xs:element name="componentId" type="xs:long" minOccurs="0" maxOccurs="1"> <xs:annotation> <xs:documentation>Component against which this AttributeDefinition is registered. This value is only populated when calling getAllAttributes. </xs:documentation> </xs:annotation> </xs:element> |
diagram | |||||||
type | xs:long | ||||||
properties |
|
||||||
annotation |
|
||||||
source | <xs:element name="id" type="xs:long" minOccurs="0" maxOccurs="1"> <xs:annotation> <xs:documentation>Identifier of this attribute. (When registering attributes this property should be left blank. The result of the registration operation is the same list of AttributeDefinitions passed in but with the id property filled out.)</xs:documentation> </xs:annotation> </xs:element> |
diagram | |||||||
type | xs:boolean | ||||||
properties |
|
||||||
annotation |
|
||||||
source | <xs:element name="isPrimary" type="xs:boolean" minOccurs="0" maxOccurs="1"> <xs:annotation> <xs:documentation>Boolean value defining whether this attribute can be used in a query string. Attributes that do not have this flag set can be returned as part of a query result, but cannot be used in a query filter.</xs:documentation> </xs:annotation> </xs:element> |
diagram | |||||||
type | xs:int | ||||||
properties |
|
||||||
annotation |
|
||||||
source | <xs:element name="length" type="xs:int" minOccurs="0" maxOccurs="1"> <xs:annotation> <xs:documentation>Length of this attribute (as defined by Hibernate mappings).</xs:documentation> </xs:annotation> </xs:element> |
diagram | |||||||
type | xs:string | ||||||
properties |
|
||||||
annotation |
|
||||||
source | <xs:element name="name" type="xs:string" minOccurs="0" maxOccurs="1"> <xs:annotation> <xs:documentation>Name of this AttributeDefinition. (The Name must be unique for a specific component and version.)</xs:documentation> </xs:annotation> </xs:element> |
diagram | ||||||||||||||||||||||||||||
type | AttributeType | |||||||||||||||||||||||||||
properties |
|
|||||||||||||||||||||||||||
facets |
|
|||||||||||||||||||||||||||
annotation |
|
|||||||||||||||||||||||||||
source | <xs:element name="type" type="AttributeType" minOccurs="0" maxOccurs="1"> <xs:annotation> <xs:documentation>Type of this AttributeDefinition, for possible options see AttributeType</xs:documentation> </xs:annotation> </xs:element> |
diagram | |||||||
type | xs:boolean | ||||||
properties |
|
||||||
annotation |
|
||||||
source | <xs:element name="isFilterable" type="xs:boolean" minOccurs="0" maxOccurs="1"> <xs:annotation> <xs:documentation>Boolean value defining whether this attribute can be used for filtering.</xs:documentation> </xs:annotation> </xs:element> |
diagram | |||||||
type | xs:boolean | ||||||
properties |
|
||||||
annotation |
|
||||||
source | <xs:element name="isSortable" type="xs:boolean" minOccurs="0" maxOccurs="1"> <xs:annotation> <xs:documentation>Boolean value defining whether this attribute can be used for sorting.</xs:documentation> </xs:annotation> </xs:element> |
diagram | |||||||
type | xs:boolean | ||||||
properties |
|
||||||
annotation |
|
||||||
source | <xs:element name="isArray" type="xs:boolean" minOccurs="0" maxOccurs="1"> <xs:annotation> <xs:documentation>Whether or not this attribute is able to store arrays of values</xs:documentation> </xs:annotation> </xs:element> |
diagram | |||||||
type | xs:string | ||||||
properties |
|
||||||
source | <xs:element name="displayName" type="xs:string" minOccurs="0" maxOccurs="1"/> |
diagram | |||||||||||||
type | AttributeGroup | ||||||||||||
properties |
|
||||||||||||
facets |
|
||||||||||||
source | <xs:element name="attributeGroup" type="AttributeGroup" minOccurs="0" maxOccurs="1"/> |