complexType XmlOrgModelNode

diagram
namespace	http://api.de.n2.tibco.com
type	extension of XmlModelEntity
properties	base  XmlModelEntity
children	dynamic-id-attr qualifierSet selection-mode child admin-restrictions
used by	element  XmlOrgModelNode/child
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. location-guid   xs:string   optional         documentation 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. resource-count   xs:int   optional         documentation Number of resources held by the organization model entity, if its type is one that can hold resources. ideal-number   xs:int   optional         documentation 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.)   has-children   xs:boolean      false      documentation 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. calendar-alias   xs:string   optional         documentation The optional alias by which a Calendar is referenced by the org-model entity.
annotation	documentation Details of the properties and children of an organization model entity. This information is used when browsing the organization model.
source	<xs:complexType name="XmlOrgModelNode">   <xs:annotation>     <xs:documentation>Details of the properties and children of an organization model entity. This information is used when browsing the organization model.</xs:documentation>   </xs:annotation>   <xs:complexContent>     <xs:extension base="XmlModelEntity">       <xs:sequence>         <xs:element name="selection-mode" type="SelectionMode" minOccurs="0">           <xs:annotation>             <xs:documentation>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.</xs:documentation>           </xs:annotation>         </xs:element>         <xs:element name="child" type="XmlOrgModelNode" minOccurs="0" maxOccurs="unbounded">           <xs:annotation>             <xs:documentation>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).</xs:documentation>           </xs:annotation>         </xs:element>         <xs:element name="admin-restrictions" type="AdminLDAPContainer" minOccurs="0" maxOccurs="unbounded">           <xs:annotation>             <xs:documentation>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.</xs:documentation>           </xs:annotation>         </xs:element>       </xs:sequence>       <xs:attribute name="location-guid" type="xs:string" use="optional">         <xs:annotation>           <xs:documentation>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.</xs:documentation>         </xs:annotation>       </xs:attribute>       <xs:attribute name="resource-count" type="xs:int" use="optional">         <xs:annotation>           <xs:documentation>Number of resources held by the organization model entity, if its type is one that can hold resources.</xs:documentation>         </xs:annotation>       </xs:attribute>       <xs:attribute name="ideal-number" type="xs:int" use="optional">         <xs:annotation>           <xs:documentation>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.)   </xs:documentation>         </xs:annotation>       </xs:attribute>       <xs:attribute name="has-children" type="xs:boolean" default="false">         <xs:annotation>           <xs:documentation>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.</xs:documentation>         </xs:annotation>       </xs:attribute>       <xs:attribute name="calendar-alias" type="xs:string" use="optional">         <xs:annotation>           <xs:documentation>The optional alias by which a Calendar is referenced by the org-model entity.</xs:documentation>         </xs:annotation>       </xs:attribute>     </xs:extension>   </xs:complexContent> </xs:complexType>

attribute XmlOrgModelNode/@location-guid

type	xs:string
properties	use  optional
annotation	documentation 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.
source	<xs:attribute name="location-guid" type="xs:string" use="optional">   <xs:annotation>     <xs:documentation>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.</xs:documentation>   </xs:annotation> </xs:attribute>

attribute XmlOrgModelNode/@resource-count

type	xs:int
properties	use  optional
annotation	documentation Number of resources held by the organization model entity, if its type is one that can hold resources.
source	<xs:attribute name="resource-count" type="xs:int" use="optional">   <xs:annotation>     <xs:documentation>Number of resources held by the organization model entity, if its type is one that can hold resources.</xs:documentation>   </xs:annotation> </xs:attribute>

attribute XmlOrgModelNode/@ideal-number

type	xs:int
properties	use  optional
annotation	documentation 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.)
source	<xs:attribute name="ideal-number" type="xs:int" use="optional">   <xs:annotation>     <xs:documentation>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.)   </xs:documentation>   </xs:annotation> </xs:attribute>

attribute XmlOrgModelNode/@has-children

type	xs:boolean
properties	default  false
annotation	documentation 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.
source	<xs:attribute name="has-children" type="xs:boolean" default="false">   <xs:annotation>     <xs:documentation>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.</xs:documentation>   </xs:annotation> </xs:attribute>

attribute XmlOrgModelNode/@calendar-alias

type	xs:string
properties	use  optional
annotation	documentation The optional alias by which a Calendar is referenced by the org-model entity.
source	<xs:attribute name="calendar-alias" type="xs:string" use="optional">   <xs:annotation>     <xs:documentation>The optional alias by which a Calendar is referenced by the org-model entity.</xs:documentation>   </xs:annotation> </xs:attribute>

element XmlOrgModelNode/selection-mode

diagram
type	SelectionMode
properties	minOcc  0 maxOcc  1 content  complex
attributes	Name   Type   Use   Default   Fixed   Annotation method   AllocationMethod   required         documentation Algorithm used to select a resource. One of: - ANY: use random selection. - NEXT: use iterative selection. - THIS: use the specifically identified resource. - PLUGIN: use the named plugin code (where the name is given separately) to perform the selection. plugin   xs:string            documentation Name of plugin.
annotation	documentation 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.
source	<xs:element name="selection-mode" type="SelectionMode" minOccurs="0">   <xs:annotation>     <xs:documentation>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.</xs:documentation>   </xs:annotation> </xs:element>

element XmlOrgModelNode/child

diagram
type	XmlOrgModelNode
properties	minOcc  0 maxOcc  unbounded content  complex
children	dynamic-id-attr qualifierSet selection-mode child admin-restrictions
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. location-guid   xs:string   optional         documentation 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. resource-count   xs:int   optional         documentation Number of resources held by the organization model entity, if its type is one that can hold resources. ideal-number   xs:int   optional         documentation 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.)   has-children   xs:boolean      false      documentation 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. calendar-alias   xs:string   optional         documentation The optional alias by which a Calendar is referenced by the org-model entity.
annotation	documentation 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).
source	<xs:element name="child" type="XmlOrgModelNode" minOccurs="0" maxOccurs="unbounded">   <xs:annotation>     <xs:documentation>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).</xs:documentation>   </xs:annotation> </xs:element>

element XmlOrgModelNode/admin-restrictions

diagram
type	AdminLDAPContainer
properties	minOcc  0 maxOcc  unbounded content  complex
attributes	Name   Type   Use   Default   Fixed   Annotation id   xs:long   required         documentation Unique ID reference of the LDAP container. name   xs:string            documentation Unique name of the LDAP container.
annotation	documentation 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.
source	<xs:element name="admin-restrictions" type="AdminLDAPContainer" minOccurs="0" maxOccurs="unbounded">   <xs:annotation>     <xs:documentation>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.</xs:documentation>   </xs:annotation> </xs:element>

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