# Class: AttributeDefinition

## tibco.objectapi.ec.base.AttributeDefinition

#### new AttributeDefinition()

Definition of an attribute. Constructs a new AttributeDefinition.

The following features are supported:

- `Category`
- `Component Id`
- `Id`
- `Is Primary`
- `Length`
- `Name`
- `Type`
- `Is Filterable`
- `Is Sortable`
- `Is Array`
- `Display Name`
- `Attribute Group`

### Members

#### attributeGroup :tibco.objectapi.ec.base.AttributeGroup

This property holds the value of the 'Attribute Group' attribute.

##### Type:

- tibco.objectapi.ec.base.AttributeGroup

#### category :string

Category of this AttributeDefinition. This property holds the value of the 'Category' attribute.

##### Type:

- string

#### componentId :string

Component against which this AttributeDefinition is registered. This value is only populated when calling getAllAttributes. This property holds the value of the 'Component Id' attribute.

##### Type:

- string

#### displayName :string

This property holds the value of the 'Display Name' attribute.

##### Type:

- string

#### id :string

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.) This property holds the value of the 'Id' attribute.

##### Type:

- string

#### isArray :boolean

Whether or not this attribute is able to store arrays of values This property holds the value of the 'Is Array' attribute.

##### Type:

- boolean

#### isFilterable :boolean

Boolean value defining whether this attribute can be used for filtering. This property holds the value of the 'Is Filterable' attribute.

##### Type:

- boolean

#### isPrimary :boolean

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. This property holds the value of the 'Is Primary' attribute.

##### Type:

- boolean

#### isSortable :boolean

Boolean value defining whether this attribute can be used for sorting. This property holds the value of the 'Is Sortable' attribute.

##### Type:

- boolean

#### length :number

Length of this attribute (as defined by Hibernate mappings). This property holds the value of the 'Length' attribute.

##### Type:

- number

#### name :string

Name of this AttributeDefinition. (The Name must be unique for a specific component and version.) This property holds the value of the 'Name' attribute.

##### Type:

- string

#### type :tibco.objectapi.ec.base.AttributeType

Type of this AttributeDefinition, for possible options see AttributeType This property holds the value of the 'Type' attribute.

##### Type:

- tibco.objectapi.ec.base.AttributeType