ChangeStateActionLifecycleAction Enumeration

Client Declaration

  public enum ChangeStateActionLifecycleAction

Specifies how to change the lifecycle state of a document.

Constants

Name	Value	Description
`ClearException`	4	Removes the document from the exception state and sets its `IsInExceptionState` property to `false`.
`Demote`	2	Demotes the document's current lifecycle state to the previous state in its document lifecycle policy and sets the document's `CurrentState` property to the name of the previous state, unless the `CanBeDemoted` property of the document's current lifecycle state (`DocumentState` object) is set to `false`.
`Promote`	1	Promotes the document's current lifecycle state to the next state in its document lifecycle policy and sets the document's `CurrentState` property to the name of the next state.
`Reset`	0	Resets the document's current lifecycle state to the initial state in its document lifecycle policy and sets the document's `CurrentState` property to the name of the initial state.
`SetException`	3	Places the document into the exception state and sets its `IsInExceptionState` property to `true`. While a document is in an exception state, its lifecycle state cannot be promoted or demoted.

Applies To: ChangeStateAction

XML Schema

<xsd:simpleType>
   <xsd:restriction base="xsd:string">
      <xsd:enumeration value="Reset"/>
      <xsd:enumeration value="Promote"/>
      <xsd:enumeration value="Demote"/>
      <xsd:enumeration value="SetException"/>
      <xsd:enumeration value="ClearException"/>
   </xsd:restriction>
</xsd:simpleType>