complexType AttributeDefinition

diagram |
namespace | http://base.api.ec.n2.tibco.com
children | category componentId id isPrimary length name type isFilterable isSortable isArray displayName attributeGroup
used by |
elements | AttributeDefinition AttributeDefinitions/definition
annotation |
documentation
Definition of an attribute.
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>

element AttributeDefinition/category

diagram |
type | xs:string
properties |
minOcc | 0
maxOcc | 1
content | simple
annotation |
documentation
Category of this AttributeDefinition.
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>

element AttributeDefinition/componentId

diagram |
type | xs:long
properties |
minOcc | 0
maxOcc | 1
content | simple
annotation |
documentation
Component against which this AttributeDefinition is registered. This value is only populated when calling getAllAttributes.
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>

element AttributeDefinition/id

diagram |
type | xs:long
properties |
minOcc | 0
maxOcc | 1
content | simple
annotation |
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.)
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>

element AttributeDefinition/isPrimary

diagram |
type | xs:boolean
properties |
minOcc | 0
maxOcc | 1
content | simple
annotation |
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.
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>

element AttributeDefinition/length

diagram |
type | xs:int
properties |
minOcc | 0
maxOcc | 1
content | simple
annotation |
documentation
Length of this attribute (as defined by Hibernate mappings).
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>

element AttributeDefinition/name

diagram |
type | xs:string
properties |
minOcc | 0
maxOcc | 1
content | simple
annotation |
documentation
Name of this AttributeDefinition. (The Name must be unique for a specific component and version.)
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>

element AttributeDefinition/type

diagram |
type | AttributeType
properties |
minOcc | 0
maxOcc | 1
content | simple
facets |
Kind | Value | Annotation
enumeration | DATE |
enumeration | INT |
enumeration | STRING |
enumeration | BOOLEAN |
enumeration | LONG |
enumeration | DOUBLE |
enumeration | BIGDECIMAL |
enumeration | BIGINTEGER |
annotation |
documentation
Type of this AttributeDefinition, for possible options see AttributeType
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>

element AttributeDefinition/isFilterable

diagram |
type | xs:boolean
properties |
minOcc | 0
maxOcc | 1
content | simple
annotation |
documentation
Boolean value defining whether this attribute can be used for filtering.
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>

element AttributeDefinition/isSortable

diagram |
type | xs:boolean
properties |
minOcc | 0
maxOcc | 1
content | simple
annotation |
documentation
Boolean value defining whether this attribute can be used for sorting.
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>

element AttributeDefinition/isArray

diagram |
type | xs:boolean
properties |
minOcc | 0
maxOcc | 1
content | simple
annotation |
documentation
Whether or not this attribute is able to store arrays of values
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>

element AttributeDefinition/displayName

diagram |
type | xs:string
properties |
minOcc | 0
maxOcc | 1
content | simple
source | <xs:element name="displayName" type="xs:string" minOccurs="0" maxOccurs="1"/>

element AttributeDefinition/attributeGroup

diagram |
type | AttributeGroup
properties |
minOcc | 0
maxOcc | 1
content | simple
facets |
Kind | Value | Annotation
enumeration | PRIMARY |
enumeration | GENERIC |
enumeration | EXTENDED |
source | <xs:element name="attributeGroup" type="AttributeGroup" minOccurs="0" maxOccurs="1"/>

XML Schema documentation generated by XMLSpy Schema Editor http://www.altova.com/xmlspy