ChangeStateAction Element

System.Object
  ActionType
    ChangeStateAction

Client Declaration

  public class ChangeStateAction

Represents a pending action for changing the current lifecycle state of a document. Valid lifecycle states are defined by the collection of DocumentState objects that belong to the document's associated DocumentLifecyclePolicy object. For more information, see the Java™ API ChangeState class and changeState method topics.

Element Structure

Attributes

ChangeStateActionLifecycleAction lifecycleAction: [request] Required expression that specifies how to change the lifecycle policy state of a document.

Code Example

ChangeStateAction objChangeState = new ChangeStateAction();
objChangeState.lifecycleAction = ChangeStateActionLifecycleAction.Promote;

XML Schema

<xsd:complexType name="ChangeStateAction">
   <xsd:complexContent>
      <xsd:extension base="ActionType">
         <xsd:attribute name="lifecycleAction" use="required">
            <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>
         </xsd:attribute>
      </xsd:extension>
   </xsd:complexContent>
</xsd:complexType>