complexType XmlResourceDetail

diagram |
namespace | http://api.de.n2.tibco.com
type | extension of XmlLdapEntity
properties |
base | XmlLdapEntity
children | LdapReference group position privilege capability attribute
used by |
element | getResourceDetailResponse/resource
attributes |
Name | Type | Use | Default | Fixed | Annotation
resource-type | ResourceType |  | HUMAN |  |
documentation
Specifies the type of an organization model resource entity. One of: - HUMAN - DURABLE - CONSUMABLE
guid | xs:string | optional |  |  |
documentation
Unique identifier of the resource.
name | xs:string | optional |  |  |
documentation
Descriptive name of the resource.
startDate | xs:dateTime | optional |  |  |
documentation
Date/time at which the entity becomes available.
endDate | xs:dateTime | optional |  |  |
documentation
Date/time at which the entity becomes unavailable.
invalid | xs:boolean |  |  |  |
documentation
Boolean value indicating whether the resource is valid (FALSE) or invalid (TRUE). A resource may be invalid if, for example, the resource has been removed from the LDAP source, or if all of the data cannot be returned from the LDAP source. Check the invalidReason attribute for more details.
invalidReason | xs:string |  |  |  |
documentation
Description of the reason why this resource is invalid.
annotation |
documentation
Extension of XmlLdapEntity, which gives more detail on an LDAP entry - namely its attributes, capabilities and organization model entity associations.
source | <xs:complexType name="XmlResourceDetail"> <xs:annotation> <xs:documentation>Extension of XmlLdapEntity, which gives more detail on an LDAP entry - namely its attributes, capabilities and organization model entity associations. </xs:documentation> </xs:annotation> <xs:complexContent> <xs:extension base="XmlLdapEntity"> <xs:choice minOccurs="0" maxOccurs="unbounded"> <xs:element name="group" type="XmlEntityAssociation" minOccurs="0" maxOccurs="unbounded"> <xs:annotation> <xs:documentation>Details of all organization model groups of which the resource is a member.</xs:documentation> </xs:annotation> </xs:element> <xs:element name="position" type="XmlEntityAssociation" minOccurs="0" maxOccurs="unbounded"> <xs:annotation> <xs:documentation>Details of all organization model positions held by the resource.</xs:documentation> </xs:annotation> </xs:element> <xs:element name="privilege" type="XmlInheritedAssociation" minOccurs="0" maxOccurs="unbounded"> <xs:annotation> <xs:documentation>Details of all organization model privileges held by the resource.</xs:documentation> </xs:annotation> </xs:element> <xs:element name="capability" type="XmlModelEntity" minOccurs="0" maxOccurs="unbounded"> <xs:annotation> <xs:documentation>Details of all organization model capabilities possessed by the resource.</xs:documentation> </xs:annotation> </xs:element> <xs:element name="attribute" type="XmlLdapAttribute" minOccurs="0" maxOccurs="unbounded"> <xs:annotation> <xs:documentation>Details of all organization model attributes held by the resource.</xs:documentation> </xs:annotation> </xs:element> </xs:choice> </xs:extension> </xs:complexContent> </xs:complexType>

element XmlResourceDetail/group

diagram |
type | XmlEntityAssociation
properties |
minOcc | 0
maxOcc | unbounded
content | complex
children | dynamic-id-attr qualifierSet
attributes |
Name | Type | Use | Default | Fixed | Annotation
model-version | xs:int | optional | -1 |  |
documentation
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.)
entity-type | OrganisationalEntityType | required |  |  |
documentation
Enumerated value defining the type of the organization model entity.
guid | xs:string | required |  |  |
documentation
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.)
qualifier | xs:string | optional |  |  |
documentation
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.
name | xs:string | required |  |  |
documentation
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.
startDate | xs:dateTime | optional |  |  |
documentation
Date/time at which the entity becomes available.
endDate | xs:dateTime | optional |  |  |
documentation
Date/time at which the entity becomes unavailable.
annotation |
documentation
Details of all organization model groups of which the resource is a member.
source | <xs:element name="group" type="XmlEntityAssociation" minOccurs="0" maxOccurs="unbounded"> <xs:annotation> <xs:documentation>Details of all organization model groups of which the resource is a member.</xs:documentation> </xs:annotation> </xs:element>

element XmlResourceDetail/position

diagram |
type | XmlEntityAssociation
properties |
minOcc | 0
maxOcc | unbounded
content | complex
children | dynamic-id-attr qualifierSet
attributes |
Name | Type | Use | Default | Fixed | Annotation
model-version | xs:int | optional | -1 |  |
documentation
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.)
entity-type | OrganisationalEntityType | required |  |  |
documentation
Enumerated value defining the type of the organization model entity.
guid | xs:string | required |  |  |
documentation
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.)
qualifier | xs:string | optional |  |  |
documentation
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.
name | xs:string | required |  |  |
documentation
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.
startDate | xs:dateTime | optional |  |  |
documentation
Date/time at which the entity becomes available.
endDate | xs:dateTime | optional |  |  |
documentation
Date/time at which the entity becomes unavailable.
annotation |
documentation
Details of all organization model positions held by the resource.
source | <xs:element name="position" type="XmlEntityAssociation" minOccurs="0" maxOccurs="unbounded"> <xs:annotation> <xs:documentation>Details of all organization model positions held by the resource.</xs:documentation> </xs:annotation> </xs:element>

element XmlResourceDetail/privilege

diagram |
type | XmlInheritedAssociation
properties |
minOcc | 0
maxOcc | unbounded
content | complex
children | dynamic-id-attr qualifierSet origin
attributes |
Name | Type | Use | Default | Fixed | Annotation
model-version | xs:int | optional | -1 |  |
documentation
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.)
entity-type | OrganisationalEntityType | required |  |  |
documentation
Enumerated value defining the type of the organization model entity.
guid | xs:string | required |  |  |
documentation
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.)
qualifier | xs:string | optional |  |  |
documentation
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.
name | xs:string | required |  |  |
documentation
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.
startDate | xs:dateTime | optional |  |  |
documentation
Date/time at which the entity becomes available.
endDate | xs:dateTime | optional |  |  |
documentation
Date/time at which the entity becomes unavailable.
annotation |
documentation
Details of all organization model privileges held by the resource.
source | <xs:element name="privilege" type="XmlInheritedAssociation" minOccurs="0" maxOccurs="unbounded"> <xs:annotation> <xs:documentation>Details of all organization model privileges held by the resource.</xs:documentation> </xs:annotation> </xs:element>

element XmlResourceDetail/capability

diagram |
type | XmlModelEntity
properties |
minOcc | 0
maxOcc | unbounded
content | complex
children | dynamic-id-attr qualifierSet
attributes |
Name | Type | Use | Default | Fixed | Annotation
model-version | xs:int | optional | -1 |  |
documentation
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.)
entity-type | OrganisationalEntityType | required |  |  |
documentation
Enumerated value defining the type of the organization model entity.
guid | xs:string | required |  |  |
documentation
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.)
qualifier | xs:string | optional |  |  |
documentation
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.
name | xs:string | required |  |  |
documentation
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.
annotation |
documentation
Details of all organization model capabilities possessed by the resource.
source | <xs:element name="capability" type="XmlModelEntity" minOccurs="0" maxOccurs="unbounded"> <xs:annotation> <xs:documentation>Details of all organization model capabilities possessed by the resource.</xs:documentation> </xs:annotation> </xs:element>

element XmlResourceDetail/attribute

diagram |
type | XmlLdapAttribute
properties |
minOcc | 0
maxOcc | unbounded
content | complex
children | value
attributes |
Name | Type | Use | Default | Fixed | Annotation
name | xs:string | required |  |  |
documentation
Name of the resource attribute within the organization model (NOT the name of any LDAP attribute from which it takes its value). Exception: When returned as part of a listLDAPAttributesResponse, name of the LDAP attribute.
desc-guid | xs:string | optional |  |  |
documentation
Unique identifier of the parameter descriptor that describes the resource attribute.
type | XmlParameterType |  | String |  |
documentation
Enumerated value defining the data type of this resource attribute's value.
local | xs:boolean |  | true |  |
documentation
Boolean value defining whether the resource attribute holds its value locally within Directory Engine (TRUE), or whether it reads the value from an identified LDAP attribute (FALSE).
ldap-alias | xs:string | optional |  |  |
documentation
For non-locally held resource attribute values, the alias by which the LDAP connection is registered within Directory Engine. Used to look up that connection so that the resource attribute's value can be read.
ldap-dn | xs:string | optional |  |  |
documentation
For non-locally held resource attribute values, the DN of the LDAP entry from which the attribute's value is read. Together with the ldap-alias, this will locate an entry within the LDAP directory.
ldap-attribute | xs:string | optional |  |  |
documentation
For non-locally held resource attribute values, the name of the LDAP attribute from which the attribute's value is read. Together with the ldap-alias and ldap-dn, this will uniquely identify an attribute of an entry within the LDAP directory.
annotation |
documentation
Details of all organization model attributes held by the resource.
source | <xs:element name="attribute" type="XmlLdapAttribute" minOccurs="0" maxOccurs="unbounded"> <xs:annotation> <xs:documentation>Details of all organization model attributes held by the resource.</xs:documentation> </xs:annotation> </xs:element>

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