complexType HiddenPeriod

diagram |
namespace | http://api.brm.n2.tibco.com
children | hiddenDuration visibleDate
used by |
elements | closeWorkItem/hiddenPeriod pendWorkItem/hiddenPeriod
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 state that was in before it was hidden. 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 Allocated state. - a hiddenPeriod of -5 minutes, the work item will immediately transition to the Allocated state.
source | <xs:complexType name="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 state that was in before it was hidden. 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 Allocated state. - a hiddenPeriod of -5 minutes, the work item will immediately transition to the Allocated state.</xs:documentation> </xs:annotation> <xs:choice minOccurs="0"> <xs:element name="hiddenDuration" type="ItemDuration"> <xs:annotation> <xs:documentation>Duration that the work item is hidden.</xs:documentation> </xs:annotation> </xs:element> <xs:element name="visibleDate" type="xs:dateTime"> <xs:annotation> <xs:documentation>Fixed date/time when the work item becomes visible.</xs:documentation> </xs:annotation> </xs:element> </xs:choice> </xs:complexType>

element HiddenPeriod/hiddenDuration

diagram |
type | ItemDuration
properties |
content | complex
attributes |
Name | Type | Use | Default | Fixed | Annotation
years | xs:int | optional | 0 |  |
documentation
Number of years in this duration period.
months | xs:int | optional | 0 |  |
documentation
Number of months in this duration period.
weeks | xs:int | optional | 0 |  |
documentation
Number of weeks in this duration period.
days | xs:int | optional | 0 |  |
documentation
Number of days in this duration period.
hours | xs:int | optional | 0 |  |
documentation
Number of hours in this duration period.
minutes | xs:int | optional | 0 |  |
documentation
Number of minutes in this duration period.
annotation |
documentation
Duration that the work item is hidden.
source | <xs:element name="hiddenDuration" type="ItemDuration"> <xs:annotation> <xs:documentation>Duration that the work item is hidden.</xs:documentation> </xs:annotation> </xs:element>

element HiddenPeriod/visibleDate

diagram |
type | xs:dateTime
properties |
content | simple
annotation |
documentation
Fixed date/time when the work item becomes visible.
source | <xs:element name="visibleDate" type="xs:dateTime"> <xs:annotation> <xs:documentation>Fixed date/time when the work item becomes visible.</xs:documentation> </xs:annotation> </xs:element>

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