# Class: XmlOrgModelNode

## tibco.objectapi.de.XmlOrgModelNode

#### new XmlOrgModelNode()

Details of the properties and children of an organization model entity. This information is used when browsing the organization model. Constructs a new XmlOrgModelNode.

The following features are supported:

- `Selection Mode`
- `Child`
- `Admin Restrictions`
- `Calendar Alias`
- `Has Children`
- `Ideal Number`
- `Location Guid`
- `Resource Count`

### Extends

- tibco.objectapi.de.XmlModelEntity

### Members

#### adminRestrictions :Array.<tibco.objectapi.de.AdminLDAPContainer>

Only used if the entity is of type organization. If any LDAP containers are listed then this is the complete set of containers that are allowed to perform administration on this organization. This property holds the value of the 'Admin Restrictions' containment reference list.

##### Type:

- Array.<tibco.objectapi.de.AdminLDAPContainer>

#### adminRestrictions :Array.<tibco.objectapi.de.AdminLDAPContainer>

Only used if the entity is of type organization. If any LDAP containers are listed then this is the complete set of containers that are allowed to perform administration on this organization. This property holds the value of the 'Admin Restrictions' containment reference list.

##### Type:

- Array.<tibco.objectapi.de.AdminLDAPContainer>

#### calendarAlias :string

The optional alias by which a Calendar is referenced by the org-model entity. This property holds the value of the 'Calendar Alias' attribute.

##### Type:

- string

#### calendarAlias :string

The optional alias by which a Calendar is referenced by the org-model entity. This property holds the value of the 'Calendar Alias' attribute.

##### Type:

- string

#### child :Array.<tibco.objectapi.de.XmlOrgModelNode>

Details of each child organization model entity belonging to the parent. If the child element array is: - part of a listOrgModelOverviewResponse element, it will be populated for every entity (node) in the tree. - part of another response element (e.g. openOrgModelResponse or browseModelNodeResponse), it will only be populated for the top-level node(s). This property holds the value of the 'Child' containment reference list.

##### Type:

- Array.<tibco.objectapi.de.XmlOrgModelNode>

#### child :Array.<tibco.objectapi.de.XmlOrgModelNode>

Details of each child organization model entity belonging to the parent. If the child element array is: - part of a listOrgModelOverviewResponse element, it will be populated for every entity (node) in the tree. - part of another response element (e.g. openOrgModelResponse or browseModelNodeResponse), it will only be populated for the top-level node(s). This property holds the value of the 'Child' containment reference list.

##### Type:

- Array.<tibco.objectapi.de.XmlOrgModelNode>

#### dynamicIdAttr :Array.<tibco.objectapi.common.organisation.XmlDynamicIdField>

Provides a collection of name/value pairs that identify a Dynamic Organisational Instance. This property holds the value of the 'Dynamic Id Attr' containment reference list.

##### Type:

- Array.<tibco.objectapi.common.organisation.XmlDynamicIdField>

Overrides:
  - tibco.objectapi.de.XmlModelEntity#dynamicIdAttr

#### entityType :tibco.objectapi.common.organisation.OrganisationalEntityType

Enumerated value defining the type of the organization model entity. This property holds the value of the 'Entity Type' attribute.

##### Type:

- tibco.objectapi.common.organisation.OrganisationalEntityType

Overrides:
  - tibco.objectapi.de.XmlModelEntity#entityType

#### guid :string

Globally unique ID of the organization model entity. (Although this value is unique across all entities, if the entity exists within more than one major version, it will share the same GUID.) This property holds the value of the 'Guid' attribute.

##### Type:

- string

Overrides:
  - tibco.objectapi.de.XmlModelEntity#guid

#### hasChildren :boolean

Whether the organization model entity (node) has any child nodes available. If these child nodes are not included within the current XmlOrgModelNode they can be retrieved with a subsequent call to Directory Engine, passing the current XmlOrgModelNode as a parameter. This provides a mechanism for drilling down into the organization model. This property holds the value of the 'Has Children' attribute.

##### Type:

- boolean

#### hasChildren :boolean

Whether the organization model entity (node) has any child nodes available. If these child nodes are not included within the current XmlOrgModelNode they can be retrieved with a subsequent call to Directory Engine, passing the current XmlOrgModelNode as a parameter. This provides a mechanism for drilling down into the organization model. This property holds the value of the 'Has Children' attribute.

##### Type:

- boolean

#### idealNumber :number

Number of resources that the organization model entity should hold, if its type is one that can hold resources. (This is just an indication, the value is not enforced.) This property holds the value of the 'Ideal Number' attribute.

##### Type:

- number

#### idealNumber :number

Number of resources that the organization model entity should hold, if its type is one that can hold resources. (This is just an indication, the value is not enforced.) This property holds the value of the 'Ideal Number' attribute.

##### Type:

- number

#### locationGuid :string

GUID of the location associated with the organization model entity (for those entities that have an association with a location: namely ORGANIZATION, ORGANIZATIONAL_UNIT and POSITION. This property holds the value of the 'Location Guid' attribute.

##### Type:

- string

#### locationGuid :string

GUID of the location associated with the organization model entity (for those entities that have an association with a location: namely ORGANIZATION, ORGANIZATIONAL_UNIT and POSITION. This property holds the value of the 'Location Guid' attribute.

##### Type:

- string

#### modelVersion :number

Major version number of the organization model in which an organization model entity resides. If not specified, the default value will be the latest version of the organization model. (Version numbers must be compatible with, and conform to, the OSGi version number schema. For Directory Engine, only the major part of the version number is significant.) This property holds the value of the 'Model Version' attribute.

##### Type:

- number

Overrides:
  - tibco.objectapi.de.XmlModelEntity#modelVersion

#### name :string

Name of the organization model entity. The name must be unique within entities of the same type and in the same majotr version of the organization model. This property holds the value of the 'Name' attribute.

##### Type:

- string

Overrides:
  - tibco.objectapi.de.XmlModelEntity#name

#### qualifier :string

Only applicable in certain circumstances, and only to organization model entities whose entity-type is PRIVILEGE or CAPABILITY. These entities can have an association with other entities - for example, a resource may hold many capabilities, or a position may have many privileges. These associations can have a qualifying value, according to their nature, to differentiate them. For example, the PRIVILEGE to sign off a purchase order may be qualified with the maximum amount that can be signed off. This property holds the value of the 'Qualifier' attribute.

##### Type:

- string

Overrides:
  - tibco.objectapi.de.XmlModelEntity#qualifier

#### qualifierSet :Array.<tibco.objectapi.common.organisation.QualifierSetType>

An optional collection of qualifying values. This overrides any qualifier attribute set on the parent element, allowing more than one value to be set. Multiple values will only be used for qualifiers of type "enumset". This property holds the value of the 'Qualifier Set' containment reference list.

##### Type:

- Array.<tibco.objectapi.common.organisation.QualifierSetType>

Overrides:
  - tibco.objectapi.de.XmlModelEntity#qualifierSet

#### resourceCount :number

Number of resources held by the organization model entity, if its type is one that can hold resources. This property holds the value of the 'Resource Count' attribute.

##### Type:

- number

#### resourceCount :number

Number of resources held by the organization model entity, if its type is one that can hold resources. This property holds the value of the 'Resource Count' attribute.

##### Type:

- number

#### selectionMode :tibco.objectapi.de.SelectionMode

Default algorithm used to select a resource from those associated with this organization model entity. Applies only to entities of type: GROUP, ORGANIZATION, ORGANIZATIONAL_UNIT, POSITION and LOCATION. This property holds the value of the 'Selection Mode' containment reference.

##### Type:

- tibco.objectapi.de.SelectionMode

#### selectionMode :tibco.objectapi.de.SelectionMode

Default algorithm used to select a resource from those associated with this organization model entity. Applies only to entities of type: GROUP, ORGANIZATION, ORGANIZATIONAL_UNIT, POSITION and LOCATION. This property holds the value of the 'Selection Mode' containment reference.

##### Type:

- tibco.objectapi.de.SelectionMode

## tibco.objectapi.de.XmlOrgModelNode

#### new XmlOrgModelNode()

Details of the properties and children of an organization model entity. This information is used when browsing the organization model. Constructs a new XmlOrgModelNode.

The following features are supported:

- `Selection Mode`
- `Child`
- `Admin Restrictions`
- `Calendar Alias`
- `Has Children`
- `Ideal Number`
- `Location Guid`
- `Resource Count`

### Extends

- tibco.objectapi.de.XmlModelEntity

### Members

#### adminRestrictions :Array.<tibco.objectapi.de.AdminLDAPContainer>

Only used if the entity is of type organization. If any LDAP containers are listed then this is the complete set of containers that are allowed to perform administration on this organization. This property holds the value of the 'Admin Restrictions' containment reference list.

##### Type:

- Array.<tibco.objectapi.de.AdminLDAPContainer>

#### adminRestrictions :Array.<tibco.objectapi.de.AdminLDAPContainer>

Only used if the entity is of type organization. If any LDAP containers are listed then this is the complete set of containers that are allowed to perform administration on this organization. This property holds the value of the 'Admin Restrictions' containment reference list.

##### Type:

- Array.<tibco.objectapi.de.AdminLDAPContainer>

#### calendarAlias :string

The optional alias by which a Calendar is referenced by the org-model entity. This property holds the value of the 'Calendar Alias' attribute.

##### Type:

- string

#### calendarAlias :string

The optional alias by which a Calendar is referenced by the org-model entity. This property holds the value of the 'Calendar Alias' attribute.

##### Type:

- string

#### child :Array.<tibco.objectapi.de.XmlOrgModelNode>

Details of each child organization model entity belonging to the parent. If the child element array is: - part of a listOrgModelOverviewResponse element, it will be populated for every entity (node) in the tree. - part of another response element (e.g. openOrgModelResponse or browseModelNodeResponse), it will only be populated for the top-level node(s). This property holds the value of the 'Child' containment reference list.

##### Type:

- Array.<tibco.objectapi.de.XmlOrgModelNode>

#### child :Array.<tibco.objectapi.de.XmlOrgModelNode>

Details of each child organization model entity belonging to the parent. If the child element array is: - part of a listOrgModelOverviewResponse element, it will be populated for every entity (node) in the tree. - part of another response element (e.g. openOrgModelResponse or browseModelNodeResponse), it will only be populated for the top-level node(s). This property holds the value of the 'Child' containment reference list.

##### Type:

- Array.<tibco.objectapi.de.XmlOrgModelNode>

#### dynamicIdAttr :Array.<tibco.objectapi.common.organisation.XmlDynamicIdField>

Provides a collection of name/value pairs that identify a Dynamic Organisational Instance. This property holds the value of the 'Dynamic Id Attr' containment reference list.

##### Type:

- Array.<tibco.objectapi.common.organisation.XmlDynamicIdField>

Overrides:
  - tibco.objectapi.de.XmlModelEntity#dynamicIdAttr

#### entityType :tibco.objectapi.common.organisation.OrganisationalEntityType

Enumerated value defining the type of the organization model entity. This property holds the value of the 'Entity Type' attribute.

##### Type:

- tibco.objectapi.common.organisation.OrganisationalEntityType

Overrides:
  - tibco.objectapi.de.XmlModelEntity#entityType

#### guid :string

Globally unique ID of the organization model entity. (Although this value is unique across all entities, if the entity exists within more than one major version, it will share the same GUID.) This property holds the value of the 'Guid' attribute.

##### Type:

- string

Overrides:
  - tibco.objectapi.de.XmlModelEntity#guid

#### hasChildren :boolean

Whether the organization model entity (node) has any child nodes available. If these child nodes are not included within the current XmlOrgModelNode they can be retrieved with a subsequent call to Directory Engine, passing the current XmlOrgModelNode as a parameter. This provides a mechanism for drilling down into the organization model. This property holds the value of the 'Has Children' attribute.

##### Type:

- boolean

#### hasChildren :boolean

Whether the organization model entity (node) has any child nodes available. If these child nodes are not included within the current XmlOrgModelNode they can be retrieved with a subsequent call to Directory Engine, passing the current XmlOrgModelNode as a parameter. This provides a mechanism for drilling down into the organization model. This property holds the value of the 'Has Children' attribute.

##### Type:

- boolean

#### idealNumber :number

Number of resources that the organization model entity should hold, if its type is one that can hold resources. (This is just an indication, the value is not enforced.) This property holds the value of the 'Ideal Number' attribute.

##### Type:

- number

#### idealNumber :number

Number of resources that the organization model entity should hold, if its type is one that can hold resources. (This is just an indication, the value is not enforced.) This property holds the value of the 'Ideal Number' attribute.

##### Type:

- number

#### locationGuid :string

GUID of the location associated with the organization model entity (for those entities that have an association with a location: namely ORGANIZATION, ORGANIZATIONAL_UNIT and POSITION. This property holds the value of the 'Location Guid' attribute.

##### Type:

- string

#### locationGuid :string

GUID of the location associated with the organization model entity (for those entities that have an association with a location: namely ORGANIZATION, ORGANIZATIONAL_UNIT and POSITION. This property holds the value of the 'Location Guid' attribute.

##### Type:

- string

#### modelVersion :number

Major version number of the organization model in which an organization model entity resides. If not specified, the default value will be the latest version of the organization model. (Version numbers must be compatible with, and conform to, the OSGi version number schema. For Directory Engine, only the major part of the version number is significant.) This property holds the value of the 'Model Version' attribute.

##### Type:

- number

Overrides:
  - tibco.objectapi.de.XmlModelEntity#modelVersion

#### name :string

Name of the organization model entity. The name must be unique within entities of the same type and in the same majotr version of the organization model. This property holds the value of the 'Name' attribute.

##### Type:

- string

Overrides:
  - tibco.objectapi.de.XmlModelEntity#name

#### qualifier :string

Only applicable in certain circumstances, and only to organization model entities whose entity-type is PRIVILEGE or CAPABILITY. These entities can have an association with other entities - for example, a resource may hold many capabilities, or a position may have many privileges. These associations can have a qualifying value, according to their nature, to differentiate them. For example, the PRIVILEGE to sign off a purchase order may be qualified with the maximum amount that can be signed off. This property holds the value of the 'Qualifier' attribute.

##### Type:

- string

Overrides:
  - tibco.objectapi.de.XmlModelEntity#qualifier

#### qualifierSet :Array.<tibco.objectapi.common.organisation.QualifierSetType>

An optional collection of qualifying values. This overrides any qualifier attribute set on the parent element, allowing more than one value to be set. Multiple values will only be used for qualifiers of type "enumset". This property holds the value of the 'Qualifier Set' containment reference list.

##### Type:

- Array.<tibco.objectapi.common.organisation.QualifierSetType>

Overrides:
  - tibco.objectapi.de.XmlModelEntity#qualifierSet

#### resourceCount :number

Number of resources held by the organization model entity, if its type is one that can hold resources. This property holds the value of the 'Resource Count' attribute.

##### Type:

- number

#### resourceCount :number

Number of resources held by the organization model entity, if its type is one that can hold resources. This property holds the value of the 'Resource Count' attribute.

##### Type:

- number

#### selectionMode :tibco.objectapi.de.SelectionMode

Default algorithm used to select a resource from those associated with this organization model entity. Applies only to entities of type: GROUP, ORGANIZATION, ORGANIZATIONAL_UNIT, POSITION and LOCATION. This property holds the value of the 'Selection Mode' containment reference.

##### Type:

- tibco.objectapi.de.SelectionMode

#### selectionMode :tibco.objectapi.de.SelectionMode

Default algorithm used to select a resource from those associated with this organization model entity. Applies only to entities of type: GROUP, ORGANIZATION, ORGANIZATIONAL_UNIT, POSITION and LOCATION. This property holds the value of the 'Selection Mode' containment reference.

##### Type:

- tibco.objectapi.de.SelectionMode