Namespace: |
|
Content: |
complex, 2 attributes, 16 elements |
Defined: |
globally in common-1.xsd; see XML source |
Includes: |
definitions of 13 elements |
Used: |
at 1 location |
XML Representation Summary |
|||||||||
<... | |||||||||
|
|||||||||
> | |||||||||
</...> |
Type Derivation Tree ![]() ![]() |
<xsd:complexType name="TaskType"> <xsd:annotation> <xsd:documentation> TODO </xsd:documentation> </xsd:annotation> <xsd:complexContent> <xsd:sequence> <xsd:annotation> <xsd:documentation> Execution status provides information about the task overall high-level execution state. It tells whether the task is running/runnable, waits for something or is done. </xsd:documentation> </xsd:annotation> </xsd:element> <xsd:annotation> <xsd:documentation> Exclusivity status tells about task "locking" to a particular node. </xsd:documentation> </xsd:annotation> </xsd:element> <xsd:annotation> <xsd:documentation> Identifier of the node that has claimed this task. Should be only present if excelusivity status is "claimed". </xsd:documentation> </xsd:annotation> </xsd:element> <xsd:annotation> <xsd:documentation> Expiration of the claim. If a "claimed" task is found after the moment specified in this attribute, the task is no longer considered claimed. Should be only present if excelusivity status is "claimed". </xsd:documentation> </xsd:annotation> </xsd:element> <xsd:annotation> <xsd:documentation> Handler URI indirectly specifies which class is responsible to handle the task. The handler will execute reaction to a task lifecycle events such as executing the task, task heartbeat, etc. </xsd:documentation> </xsd:annotation> </xsd:element> <xsd:annotation> <xsd:documentation> OperationResult that is used to compile task results (parent result). </xsd:documentation> </xsd:annotation> </xsd:element> <xsd:annotation> <xsd:documentation> Object that the task is associated with. Tasks may be associated with a particular objects. For example a "import from resource" task is associated with the resource definition object that it imports from. Similarly for synchronization and reconciliation tasks (cycles). </xsd:documentation> </xsd:annotation> </xsd:element> <xsd:annotation> <xsd:documentation> TODO </xsd:documentation> </xsd:annotation> </xsd:element> <xsd:annotation> <xsd:documentation> TODO </xsd:documentation> </xsd:annotation> </xsd:element> <xsd:annotation> <xsd:documentation> Relative metric of task progress. TODO </xsd:documentation> </xsd:annotation> </xsd:element> <xsd:annotation> <xsd:documentation> TODO </xsd:documentation> </xsd:annotation> </xsd:element> <xsd:annotation> <xsd:documentation> TODO loose - tight If not present the nodes may decide independently. </xsd:documentation> </xsd:annotation> </xsd:element> <xsd:annotation> <xsd:documentation> Task schedule. Specifies when and how often to execute the task. </xsd:documentation> </xsd:annotation> </xsd:element> </xsd:sequence> </xsd:extension> </xsd:complexContent> </xsd:complexType> |
Type: |
|
Use: |
optional |
Defined: |
<xsd:attribute name="oid" type="xsd:string" use="optional"> <xsd:annotation> <xsd:documentation> System-wide immutable identifier for the object. Will be probably quite long and not human-readable. It should not be displayed to user. It has no meaning outside of IDM system and should not be directly passed to any third-party systems. This identifier must be unique in the entire system. This attribute is immutable. It cannot be changed. Any operation attempting to change this identifier must fail. OID is not property and therefore cannot be "addressed" in usual operations. OID must be provided for all objects that are persistently stored. There may be detached objects without OID. Such objects have the same structure as normal objects, they are just not stored in the repository. E.g. object that are only stored on resource and are not replicated in the repository. Such objects do not have OID therefore their XML representation cannot contain oid attribute. The OID should be unique in both time and space. That means that OIDs must be unique in the whole system in any moment and should not be re-used. If an object is deleted, the OID of that object should not be used by a new object. The reason is to avoid problems with stale links pointing to a wrong object and appearing valid. However, this is not a strict requirement. Some marginal probability of OID reuse is tolerated. The recommended practice is to add some randomness to the process of OID generation. This attribute is NOT (necessarily) ASN.1 OID and should not be confused with it. The attribute is named "oid" meaning object identifier. It is not named "id" to avoid confusion with xml:id attribute as it is easy to confuse these two if namespace prefix is omitted. The confusion with ASN.1 OID id not likely. The oid is XML attribute of this object instead of element because it has special purpose of identifying the object. It is also immutable, therefore we do not need to handle changes to it. </xsd:documentation> </xsd:annotation> </xsd:attribute> |
Type: |
|
Use: |
optional |
Defined: |
<xsd:attribute name="version" type="xsd:string" use="optional"> <xsd:annotation> <xsd:documentation> Version for optimistic locking. Contains the version in which this object was read from the repository, fetched from the resource, etc. Type of the version attribute is string, not integer to provide flexibility for various versioning schemes in implementation (e.g. ETags). The type really does not matter, the only things that matters is if the version is the same or different. </xsd:documentation> </xsd:annotation> </xsd:attribute> |
Type: |
tns:TaskBindingType, simple content |
Defined: |
<xsd:element minOccurs="0" name="binding" type="tns:TaskBindingType"> <xsd:annotation> <xsd:documentation> TODO loose - tight If not present the nodes may decide independently. </xsd:documentation> </xsd:annotation> </xsd:element> |
Type: |
xsd:dateTime, simple content |
Defined: |
<xsd:element minOccurs="0" name="claimExpirationTimestamp" type="xsd:dateTime"> <xsd:annotation> <xsd:documentation> Expiration of the claim. If a "claimed" task is found after the moment specified in this attribute, the task is no longer considered claimed. Should be only present if excelusivity status is "claimed". </xsd:documentation> </xsd:annotation> </xsd:element> |
Type: |
xsd:string, simple content |
Defined: |
<xsd:element minOccurs="0" ref="tns:description"> <xsd:annotation> <xsd:documentation> Free-form textual description of the object. </xsd:documentation> </xsd:annotation> </xsd:element> |
Type: |
tns:TaskExclusivityStatusType, simple content |
Defined: |
<xsd:element name="exclusivityStatus" type="tns:TaskExclusivityStatusType"> <xsd:annotation> <xsd:documentation> Exclusivity status tells about task "locking" to a particular node. </xsd:documentation> </xsd:annotation> </xsd:element> |
Type: |
tns:TaskExecutionStatusType, simple content |
Defined: |
<xsd:element name="executionStatus" type="tns:TaskExecutionStatusType"> <xsd:annotation> <xsd:documentation> Execution status provides information about the task overall high-level execution state. It tells whether the task is running/runnable, waits for something or is done. </xsd:documentation> </xsd:annotation> </xsd:element> |
Type: |
anonymous complexType, complex content |
Defined: |
<xsd:element maxOccurs="1" minOccurs="0" ref="tns:extension"/> |
Type: |
xsd:anyURI, simple content |
Defined: |
<xsd:element name="handlerUri" type="xsd:anyURI"> <xsd:annotation> <xsd:documentation> Handler URI indirectly specifies which class is responsible to handle the task. The handler will execute reaction to a task lifecycle events such as executing the task, task heartbeat, etc. </xsd:documentation> </xsd:annotation> </xsd:element> |
Type: |
xsd:dateTime, simple content |
Defined: |
<xsd:element minOccurs="0" name="lastRunFinishTimestamp" type="xsd:dateTime"> <xsd:annotation> <xsd:documentation> TODO </xsd:documentation> </xsd:annotation> </xsd:element> |
Type: |
xsd:dateTime, simple content |
Defined: |
<xsd:element minOccurs="0" name="lastRunStartTimestamp" type="xsd:dateTime"> <xsd:annotation> <xsd:documentation> TODO </xsd:documentation> </xsd:annotation> </xsd:element> |
Type: |
xsd:string, simple content |
Defined: |
<xsd:element minOccurs="0" ref="tns:name"> <xsd:annotation> <xsd:documentation> Human-readable, mutable name of the object. It may also be an identifier (login name, group name). Should be unique in the respective context of interpretation. E.g. the name of the UserType subtype should be unique in the whole system. The name of the AccountType subtype should be unique in the scope of resource (target system) that it belongs to. This may not be human-readable in a sense to display to a common end-user. It is intended to be displayed to IDM system administrator. Therefore it may contain quite a "ugly" structures such as LDAP DN or URL. Name is considered to be ordinary property of the object. Therefore it can be changed by invoking usual modifyObject operations. However, change of the name may have side effects (rename process). Although name is specified as optional by this schema, it is in fact mandatory for most object types. The reason for specifying the name as optional is that the name may be generated by the system instead of supplied by the clients. However, all objects stored in the repository must have a name. </xsd:documentation> </xsd:annotation> </xsd:element> |
Type: |
xsd:string, simple content |
Defined: |
<xsd:element minOccurs="0" name="node" type="xsd:string"> <xsd:annotation> <xsd:documentation> Identifier of the node that has claimed this task. Should be only present if excelusivity status is "claimed". </xsd:documentation> </xsd:annotation> </xsd:element> |
Type: |
tns:ObjectReferenceType, complex content |
Defined: |
<xsd:element minOccurs="0" name="objectRef" type="tns:ObjectReferenceType"> <xsd:annotation> <xsd:documentation> Object that the task is associated with. Tasks may be associated with a particular objects. For example a "import from resource" task is associated with the resource definition object that it imports from. Similarly for synchronization and reconciliation tasks (cycles). </xsd:documentation> </xsd:annotation> </xsd:element> |
Type: |
xsd:integer, simple content |
Defined: |
<xsd:element minOccurs="0" name="progress" type="xsd:integer"> <xsd:annotation> <xsd:documentation> Relative metric of task progress. TODO </xsd:documentation> </xsd:annotation> </xsd:element> |
Type: |
tns:TaskRecurrenceType, simple content |
Defined: |
<xsd:element name="recurrence" type="tns:TaskRecurrenceType"> <xsd:annotation> <xsd:documentation> TODO </xsd:documentation> </xsd:annotation> </xsd:element> |
Type: |
tns:OperationResultType, complex content |
Defined: |
<xsd:element minOccurs="0" name="result" type="tns:OperationResultType"> <xsd:annotation> <xsd:documentation> OperationResult that is used to compile task results (parent result). </xsd:documentation> </xsd:annotation> </xsd:element> |
Type: |
tns:ScheduleType, complex content |
Defined: |
<xsd:element minOccurs="0" name="schedule" type="tns:ScheduleType"> <xsd:annotation> <xsd:documentation> Task schedule. Specifies when and how often to execute the task. </xsd:documentation> </xsd:annotation> </xsd:element> |
This XML schema documentation has been generated with DocFlex/XML RE 1.8.5 using DocFlex/XML XSDDoc 2.5.0 template set. DocFlex/XML RE is a reduced edition of DocFlex/XML, which is a tool for programming and running highly sophisticated documentation and reports generators by the data obtained from
any kind of XML files. The actual doc-generators are implemented in the form of special templates that are designed visually
using a high-quality Template Designer GUI basing on the XML schema (or DTD) files describing the data source XML. DocFlex/XML XSDDoc is a commercial template application of DocFlex/XML that implements a high-quality XML Schema documentation generator with simultaneous support of framed multi-file HTML,
single-file HTML and RTF output formats. (More formats are planned in the future). A commercial license for "DocFlex/XML XSDDoc" will allow you:
Once having only such a license, you will be able to run the fully-featured XML schema documentation generator both with DocFlex/XML (Full Edition) and with DocFlex/XML RE, which is a reduced free edition containing only the template interpretor / output generator. No other licenses will be required! But this is not all. In addition to it, a commercial license for "DocFlex/XML SDK" will allow you to modify the XSDDoc templates themselves as much as you want. You will be able to achieve whatever was impossible to do with the template parameters only.
And, of course, you could develop any template applications by your own! Please note that by purchasing a license for this software, you not only acquire a useful tool,
you will also make an important investment in its future development, the results of which you could enjoy later by yourself.
Every single your purchase matters and makes a difference for us! To purchase a license, please follow this link: http://www.filigris.com/shop/ |