element setCandidateQueries

diagram |
namespace | http://orgmodel.api.de.bpm.tibco.com
properties |
content | complex
children | assignment remove
annotation |
documentation
Sets, or updates, the Candidate Query assignments to identified org-model entities. Each org-model entity may only hold one Candidate Query. Any existing assignment will be ovewritten by a new assignment. Candidate Queries span all org-model versions in which the identified org-model entity exists. Therefore, the request does not include a model version.
source | <xs:element name="setCandidateQueries"> <xs:annotation> <xs:documentation>Sets, or updates, the Candidate Query assignments to identified org-model entities. Each org-model entity may only hold one Candidate Query. Any existing assignment will be ovewritten by a new assignment. Candidate Queries span all org-model versions in which the identified org-model entity exists. Therefore, the request does not include a model version.</xs:documentation> </xs:annotation> <xs:complexType> <xs:sequence> <xs:element name="assignment" type="de:XmlCandidateQueryAssignment" minOccurs="0" maxOccurs="unbounded"> <xs:annotation> <xs:documentation>Identifies an org-model entity and the LDAP query to be assigned to that entity.</xs:documentation> </xs:annotation> </xs:element> <xs:element name="remove" minOccurs="0" maxOccurs="1"> <xs:annotation> <xs:documentation>Identifies one or more org-model entitoes from which any existing Candidate Query is to be removed.</xs:documentation> </xs:annotation> <xs:complexType> <xs:choice> <xs:element name="position" type="xs:string" minOccurs="1" maxOccurs="unbounded"> <xs:annotation> <xs:documentation>Identifies the position, by its guid, to which the Candidate Query is assigned.</xs:documentation> </xs:annotation> </xs:element> <xs:element name="group" type="xs:string" minOccurs="1" maxOccurs="unbounded"> <xs:annotation> <xs:documentation>Identifies the group, by its guid, to which the Candidate Query is assigned.</xs:documentation> </xs:annotation> </xs:element> </xs:choice> <xs:attribute name="remove-resources" type="xs:boolean" default="false"> <xs:annotation> <xs:documentation>Indicates whether existing Resource assignments, to the identified positions or groups, should also be removed.</xs:documentation> </xs:annotation> </xs:attribute> </xs:complexType> </xs:element> </xs:sequence> </xs:complexType> </xs:element>

element setCandidateQueries/assignment

diagram |
type | XmlCandidateQueryAssignment
properties |
minOcc | 0
maxOcc | unbounded
content | complex
children | position group
attributes |
Name | Type | Use | Default | Fixed | Annotation
container-id | xs:long | required |  |  |
documentation
Identifies the LDAP Container whose the Primary LDAP Source will be used to evaluate the query.
query | xs:string | optional |  |  |
documentation
The LDAP Query that will be combined with the query of the Primary LDAP Source to identify candidate Resources.
base-dn | xs:string | optional |  |  |
documentation
(Optional) Provides an additional base DN that will be used to restrict the scope of the Candidate Query. This base DN is relative to, and in additon, to any base DN of the LDAP Container's primary LDAP Source.
search-scope | XmlLdapSearchScope | optional |  |  |
documentation
Enumerated value indicating the scope on which an LDAP search is to be performed.
annotation |
documentation
Identifies an org-model entity and the LDAP query to be assigned to that entity.
source | <xs:element name="assignment" type="de:XmlCandidateQueryAssignment" minOccurs="0" maxOccurs="unbounded"> <xs:annotation> <xs:documentation>Identifies an org-model entity and the LDAP query to be assigned to that entity.</xs:documentation> </xs:annotation> </xs:element>

element setCandidateQueries/remove

diagram |
properties |
minOcc | 0
maxOcc | 1
content | complex
children | position group
attributes |
Name | Type | Use | Default | Fixed | Annotation
remove-resources | xs:boolean |  | false |  |
documentation
Indicates whether existing Resource assignments, to the identified positions or groups, should also be removed.
annotation |
documentation
Identifies one or more org-model entitoes from which any existing Candidate Query is to be removed.
source | <xs:element name="remove" minOccurs="0" maxOccurs="1"> <xs:annotation> <xs:documentation>Identifies one or more org-model entitoes from which any existing Candidate Query is to be removed.</xs:documentation> </xs:annotation> <xs:complexType> <xs:choice> <xs:element name="position" type="xs:string" minOccurs="1" maxOccurs="unbounded"> <xs:annotation> <xs:documentation>Identifies the position, by its guid, to which the Candidate Query is assigned.</xs:documentation> </xs:annotation> </xs:element> <xs:element name="group" type="xs:string" minOccurs="1" maxOccurs="unbounded"> <xs:annotation> <xs:documentation>Identifies the group, by its guid, to which the Candidate Query is assigned.</xs:documentation> </xs:annotation> </xs:element> </xs:choice> <xs:attribute name="remove-resources" type="xs:boolean" default="false"> <xs:annotation> <xs:documentation>Indicates whether existing Resource assignments, to the identified positions or groups, should also be removed.</xs:documentation> </xs:annotation> </xs:attribute> </xs:complexType> </xs:element>

attribute setCandidateQueries/remove/@remove-resources

type | xs:boolean
properties |
default | false
annotation |
documentation
Indicates whether existing Resource assignments, to the identified positions or groups, should also be removed.
source | <xs:attribute name="remove-resources" type="xs:boolean" default="false"> <xs:annotation> <xs:documentation>Indicates whether existing Resource assignments, to the identified positions or groups, should also be removed.</xs:documentation> </xs:annotation> </xs:attribute>

element setCandidateQueries/remove/position

diagram |
type | xs:string
properties |
minOcc | 1
maxOcc | unbounded
content | simple
annotation |
documentation
Identifies the position, by its guid, to which the Candidate Query is assigned.
source | <xs:element name="position" type="xs:string" minOccurs="1" maxOccurs="unbounded"> <xs:annotation> <xs:documentation>Identifies the position, by its guid, to which the Candidate Query is assigned.</xs:documentation> </xs:annotation> </xs:element>

element setCandidateQueries/remove/group

diagram |
type | xs:string
properties |
minOcc | 1
maxOcc | unbounded
content | simple
annotation |
documentation
Identifies the group, by its guid, to which the Candidate Query is assigned.
source | <xs:element name="group" type="xs:string" minOccurs="1" maxOccurs="unbounded"> <xs:annotation> <xs:documentation>Identifies the group, by its guid, to which the Candidate Query is assigned.</xs:documentation> </xs:annotation> </xs:element>

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