complexType ColumnDefinition

diagram |
namespace | http://api.brm.n2.tibco.com
used by |
elements | getWorkItemOrderFilterResponse/columnData ColumnOrder/columnDef
attributes |
Name | Type | Use | Default | Fixed | Annotation
id | xs:short | required |  |  |
documentation
ID of the field.
name | xs:string | optional |  |  |
documentation
Name of the field.
description | xs:string | optional |  |  |
documentation
Textual description of the field.
type | ColumnType |  |  |  |
documentation
Type of the field (for example, string or numeric).
capability | ColumnCapability |  |  |  |
documentation
Enumerated value that defines whether the field can be used in expressions that define sort criteria and/or filter criteria.
displayName | xs:string |  |  |  |
documentation
If requested by setting API Version > 1, then this attribute will provide the Display Name if this column is a Work Item Attribute and has an display name defined.
isWorkListAttribute | xs:boolean |  |  |  |
documentation
If requested If requested by setting API Version > 1, this atrribute will be true if the specified field is a work list attribute.
annotation |
documentation
Details of a field defined by BRM that can be used in sort/filter criteria expressions for work item lists.
source | <xs:complexType name="ColumnDefinition"> <xs:annotation> <xs:documentation>Details of a field defined by BRM that can be used in sort/filter criteria expressions for work item lists.</xs:documentation> </xs:annotation> <xs:attribute name="id" type="xs:short" use="required"> <xs:annotation> <xs:documentation>ID of the field.</xs:documentation> </xs:annotation> </xs:attribute> <xs:attribute name="name" type="xs:string" use="optional"> <xs:annotation> <xs:documentation>Name of the field.</xs:documentation> </xs:annotation> </xs:attribute> <xs:attribute name="description" type="xs:string" use="optional"> <xs:annotation> <xs:documentation>Textual description of the field.</xs:documentation> </xs:annotation> </xs:attribute> <xs:attribute name="type" type="ColumnType"> <xs:annotation> <xs:documentation>Type of the field (for example, string or numeric).</xs:documentation> </xs:annotation> </xs:attribute> <xs:attribute name="capability" type="ColumnCapability"> <xs:annotation> <xs:documentation>Enumerated value that defines whether the field can be used in expressions that define sort criteria and/or filter criteria.</xs:documentation> </xs:annotation> </xs:attribute> <xs:attribute name="displayName" type="xs:string"> <xs:annotation> <xs:documentation>If requested by setting API Version > 1, then this attribute will provide the Display Name if this column is a Work Item Attribute and has an display name defined.</xs:documentation> </xs:annotation> </xs:attribute> <xs:attribute name="isWorkListAttribute" type="xs:boolean"> <xs:annotation> <xs:documentation>If requested If requested by setting API Version > 1, this atrribute will be true if the specified field is a work list attribute.</xs:documentation> </xs:annotation> </xs:attribute> </xs:complexType>

attribute ColumnDefinition/@id

type | xs:short
properties |
use | required
annotation |
documentation
ID of the field.
source | <xs:attribute name="id" type="xs:short" use="required"> <xs:annotation> <xs:documentation>ID of the field.</xs:documentation> </xs:annotation> </xs:attribute>

attribute ColumnDefinition/@name

type | xs:string
properties |
use | optional
annotation |
documentation
Name of the field.
source | <xs:attribute name="name" type="xs:string" use="optional"> <xs:annotation> <xs:documentation>Name of the field.</xs:documentation> </xs:annotation> </xs:attribute>

attribute ColumnDefinition/@description

type | xs:string
properties |
use | optional
annotation |
documentation
Textual description of the field.
source | <xs:attribute name="description" type="xs:string" use="optional"> <xs:annotation> <xs:documentation>Textual description of the field.</xs:documentation> </xs:annotation> </xs:attribute>

attribute ColumnDefinition/@type

type | ColumnType
facets |
Kind | Value | Annotation
enumeration | COL_UNSPECIFIED |
enumeration | COL_NUMERIC |
enumeration | COL_STRING |
enumeration | COL_DATETIME |
enumeration | COL_BOOLEAN |
enumeration | COL_STATE |
enumeration | COL_DISTSTRATEGY |
annotation |
documentation
Type of the field (for example, string or numeric).
source | <xs:attribute name="type" type="ColumnType"> <xs:annotation> <xs:documentation>Type of the field (for example, string or numeric).</xs:documentation> </xs:annotation> </xs:attribute>

attribute ColumnDefinition/@capability

type | ColumnCapability
facets |
Kind | Value | Annotation
enumeration | NONE |
enumeration | ORDER |
enumeration | FILTER |
enumeration | BOTH_ORDER_FILTER |
annotation |
documentation
Enumerated value that defines whether the field can be used in expressions that define sort criteria and/or filter criteria.
source | <xs:attribute name="capability" type="ColumnCapability"> <xs:annotation> <xs:documentation>Enumerated value that defines whether the field can be used in expressions that define sort criteria and/or filter criteria.</xs:documentation> </xs:annotation> </xs:attribute>

attribute ColumnDefinition/@displayName

type | xs:string
annotation |
documentation
If requested by setting API Version > 1, then this attribute will provide the Display Name if this column is a Work Item Attribute and has an display name defined.
source | <xs:attribute name="displayName" type="xs:string"> <xs:annotation> <xs:documentation>If requested by setting API Version > 1, then this attribute will provide the Display Name if this column is a Work Item Attribute and has an display name defined.</xs:documentation> </xs:annotation> </xs:attribute>

attribute ColumnDefinition/@isWorkListAttribute

type | xs:boolean
annotation |
documentation
If requested If requested by setting API Version > 1, this atrribute will be true if the specified field is a work list attribute.
source | <xs:attribute name="isWorkListAttribute" type="xs:boolean"> <xs:annotation> <xs:documentation>If requested If requested by setting API Version > 1, this atrribute will be true if the specified field is a work list attribute.</xs:documentation> </xs:annotation> </xs:attribute>

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