Class: DescribeEntityResponseType

tibco.objectapi.de.resolver.DescribeEntityResponseType

new DescribeEntityResponseType()

Describes the identified model entity. . Constructs a new DescribeEntityResponseType.

Extends

Members

alias :string

Alias name by which the LDAP connection (from which the resource originates) is registered with Directory Engine. This attribute is used with "dn" to locate the resource's entry in the LDAP directory. The attribute is only relevant for entities of type RESOURCE. This property holds the value of the 'Alias' attribute.
Type:
  • string
Overrides:

capabilities :Array.<string>

GUIDs of the capabilities currently associated with this resource. This attribute is only relevant for entities of type RESOURCE. This property holds the value of the 'Capabilities' attribute list.
Type:
  • Array.<string>
Overrides:

dn :string

DN of the LDAP entry for which the resource originates. This attribute is used with "alias" to locate the resource's entry in the LDAP directory. The attribute is only relevant for entities of type RESOURCE. This property holds the value of the 'Dn' attribute.
Type:
  • string
Overrides:

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:
Inherited From:

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:
Inherited From:

groups :Array.<string>

GUIDs of the groups to which this resource belongs. This attribute is only relevant for entities of type RESOURCE. This property holds the value of the 'Groups' attribute list.
Type:
  • Array.<string>
Overrides:

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
Inherited From:

ldapContainers :Array.<tibco.objectapi.de.AdminLDAPContainer>

(Optional) Lists the LDAP Containers that can map resources to this Organisation. This element is only relevant for ORGANIZATION entity types. This property holds the value of the 'Ldap Containers' containment reference list.
Type:
Overrides:

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
Inherited From:

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
Inherited From:

orgUnits :Array.<string>

GUIDs of the organization units to which this resource belongs, via the positions to which it belongs. This attribute is only relevant for entities of type RESOURCE. This property holds the value of the 'Org Units' attribute list.
Type:
  • Array.<string>
Overrides:

positions :Array.<string>

GUIDs of the positions to which this resource belongs. This attribute is only relevant for entities of type RESOURCE. This property holds the value of the 'Positions' attribute list.
Type:
  • Array.<string>
Overrides:

privileges :Array.<string>

GUIDs of the privileges currently held by this resource. This attribute is only relevant for entities of type RESOURCE. This property holds the value of the 'Privileges' attribute list.
Type:
  • Array.<string>
Overrides:

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
Inherited From:

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:
Inherited From:

queries :Array.<string>

GUIDs of the queries currently associated with this resource. This attribute is only relevant for entities of type RESOURCE. This property holds the value of the 'Queries' attribute list.
Type:
  • Array.<string>
Overrides:

resourceType :tibco.objectapi.de.ResourceType

Resouce type of this entity (for entities of type RESOURCE). This property holds the value of the 'Resource Type' attribute.
Type:
Overrides:

selectionMode :tibco.objectapi.de.SelectionMode

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