complexType pendWorkItem

diagram |
namespace | http://api.brm.n2.tibco.com
children | workItemID hiddenPeriod
used by |
element | pendWorkItem
source | <xs:complexType name="pendWorkItem"> <xs:sequence maxOccurs="unbounded"> <xs:element name="workItemID" type="ManagedObjectID"> <xs:annotation> <xs:documentation>ID of a work item that is to be pended.</xs:documentation> </xs:annotation> </xs:element> <xs:element name="hiddenPeriod" type="HiddenPeriod"> <xs:annotation> <xs:documentation>Information about how long the specified work item should remain hidden. If a hiddenPeriod is specified the work item will transition to the PendHidden state, rather than Pended. Operations that work on the Pended state (e.g. reallocateWorkItem) cannot then access the work item until either of the following occurs. - the hiddenPeriod expires. - a further pendWorkItem operation is specified with a hiddenPeriod of 0. This cancels the current hiddenPeriod. (A negative duration or date that is in the past will have the same effect.) The work item then transitions back to the Pended state. NOTE: The duration of a hiddenPeriod can also be extended or reduced by issuing a further pendWorkItem operation with a new hiddenPeriod. The new hiddenPeriod overrides the existing hiddenPeriod and is calculated from the current date/time. For example, suppose that a work item was pended at 2.30 with a hiddenPeriod of 30 minutes. If a further pendWorkItem is issued at 2.45 with: - a hiddenPeriod of 2 hours, the work item will remain hidden until 4.45. - a hiddenPeriod of 5 minutes, the work item will remain hidden until 2.50. - a hiddenPeriod of 0, the work item will immediately transition to the Pended state. - a hiddenPeriod of -5 minutes, the work item will immediately transition to the Pended state. </xs:documentation> </xs:annotation> </xs:element> </xs:sequence> </xs:complexType>

element pendWorkItem/workItemID

diagram |
type | ManagedObjectID
properties |
content | complex
attributes |
Name | Type | Use | Default | Fixed | Annotation
id | xs:long | required |  |  |
documentation
Unique ID of the work item.
version | xs:long |  |  |  |
documentation
Version of the work item. If not set, the latest version will be used.
annotation |
documentation
ID of a work item that is to be pended.
source | <xs:element name="workItemID" type="ManagedObjectID"> <xs:annotation> <xs:documentation>ID of a work item that is to be pended.</xs:documentation> </xs:annotation> </xs:element>

element pendWorkItem/hiddenPeriod

diagram |
type | HiddenPeriod
properties |
content | complex
children | hiddenDuration visibleDate
annotation |
documentation
Information about how long the specified work item should remain hidden. If a hiddenPeriod is specified the work item will transition to the PendHidden state, rather than Pended. Operations that work on the Pended state (e.g. reallocateWorkItem) cannot then access the work item until either of the following occurs. - the hiddenPeriod expires. - a further pendWorkItem operation is specified with a hiddenPeriod of 0. This cancels the current hiddenPeriod. (A negative duration or date that is in the past will have the same effect.) The work item then transitions back to the Pended state. NOTE: The duration of a hiddenPeriod can also be extended or reduced by issuing a further pendWorkItem operation with a new hiddenPeriod. The new hiddenPeriod overrides the existing hiddenPeriod and is calculated from the current date/time. For example, suppose that a work item was pended at 2.30 with a hiddenPeriod of 30 minutes. If a further pendWorkItem is issued at 2.45 with: - a hiddenPeriod of 2 hours, the work item will remain hidden until 4.45. - a hiddenPeriod of 5 minutes, the work item will remain hidden until 2.50. - a hiddenPeriod of 0, the work item will immediately transition to the Pended state. - a hiddenPeriod of -5 minutes, the work item will immediately transition to the Pended state.
source | <xs:element name="hiddenPeriod" type="HiddenPeriod"> <xs:annotation> <xs:documentation>Information about how long the specified work item should remain hidden. If a hiddenPeriod is specified the work item will transition to the PendHidden state, rather than Pended. Operations that work on the Pended state (e.g. reallocateWorkItem) cannot then access the work item until either of the following occurs. - the hiddenPeriod expires. - a further pendWorkItem operation is specified with a hiddenPeriod of 0. This cancels the current hiddenPeriod. (A negative duration or date that is in the past will have the same effect.) The work item then transitions back to the Pended state. NOTE: The duration of a hiddenPeriod can also be extended or reduced by issuing a further pendWorkItem operation with a new hiddenPeriod. The new hiddenPeriod overrides the existing hiddenPeriod and is calculated from the current date/time. For example, suppose that a work item was pended at 2.30 with a hiddenPeriod of 30 minutes. If a further pendWorkItem is issued at 2.45 with: - a hiddenPeriod of 2 hours, the work item will remain hidden until 4.45. - a hiddenPeriod of 5 minutes, the work item will remain hidden until 2.50. - a hiddenPeriod of 0, the work item will immediately transition to the Pended state. - a hiddenPeriod of -5 minutes, the work item will immediately transition to the Pended state. </xs:documentation> </xs:annotation> </xs:element>

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