ChangeSynergy::apiTransitions
The apiTransitions class will contain transition information for the current user.
The available transitions will be obtained when using the following api functions:
AttributeModifyCRData() ModifyCRData() GetCRData().
Show data format: from_state2to_state:label|from_state2to_state:label|ADMIN_ROLE...
Transition data format: from_state2to_state:label
The submit form data, i.e. " Submit to state," is available when using the following api functions: SubmitCRData().
Submit data format: START_HERE2to_state:label
The copy form data, i.e. " Submit to state" and " Submit relation name," is available when using the following api functions: CopyCRData(). Copy data format: COPY_relation_name2to_state:label
The following methods are available:
sub new(xmlData)
Initializes a newly created ChangeSynergy::apiTransitions class so that it represents the xml data passed in.
my $transitions = new ChangeSynergy::apiTransitions(xmlData); Parameters: xmlData - the XML data that needs to be parsed into a usable form.
Throws: die - if unable to parse the xml data
Gets the "from state" for this transition. Use this value to see the current "crstatus" attribute value.
my $fromState = $transitions->getFromState()
Returns: scalar the current "crstatus" attribute value
Gets the "descriptive label" for this transition.
my $name = $transitions->getName()
Returns: scalar the name for this transition.
Gets the "copy relation name" to be used for copy operations.
my $transition = $transitions->getTransition()
Returns: scalar the copy relation name.
Gets the "to state" for this transition. Use this value to set the "crstatus" attribute before calling the TransitionCR() function.
my $toState = $transitions->getToState()
Returns: scalar the to state for this transition
Gets the "transition template name" for this transition.
my $transition = $transitions->getTransition()
Returns: scalar the transition template name.
Gets the XML data used to constuct this apiQueryData class.
Note: This is intended for debugging only.
my $xmlData = $transitions->getXmlData()
Returns: scalar the XML data used to constuct this object, useful for debugging purposes.
Sets the "from state" property for the class instance.
$transitions->setFromState($value)
Parameters: value - the new value for the from state property
Sets the "name" property for the class instance.
$transitions->setName($value)
Parameters: value - the new value for the name property
Sets the "copy relation name" property for the class instance.
$transitions->setRelation($value)
Parameters: value - the new value for the transition copy relation name
Sets the "to state" property for the class instance.
$transitions->setToState($value)
Parameters: value - the new value for the to state property
Sets the "template name" property for the class instance.
$transitions->setTransition($value)
Parameters: value - the new value for the transition template name