com.oberon.ooql.sdk
Class Transition

java.lang.Object
  com.oberon.ooql.sdk.OBBase
      com.oberon.ooql.sdk.AdminComponent
          com.oberon.ooql.sdk.Transition

All Implemented Interfaces:

java.io.Serializable

public class Transition
extends AdminComponent
implements java.io.Serializable

Represents a Workflow Step transition.

Version:

5.0

See Also:

Serialized Form

Field Summary

static int

REQUIRED_OPTION The Required flag index inside the Option Set

Fields inherited from class com.oberon.ooql.sdk.AdminComponent

bsOptions

Constructor Summary

Transition()

Transition(java.lang.String name)

Method Summary

java.lang.String	compareUpdate(Transition refTransition, boolean checkImage, Framework framework) Return the OOQL command to update this Step-Transition object and let it become equals to another reference object.
boolean	equals(Transition transition) Check if this Transition is equal to another
void	fromXML(org.jdom.Element rootElement) Load the Transition object from XML element tree
java.lang.String	getActionTrigger() Get the Transition action trigger
java.lang.String	getChangeCommand() Return the OOQL command to update this Workflow-Step-Transition with the settled properties
java.lang.String	getCheckTrigger() Get the Transition check trigger
java.lang.String	getCreateCommand(boolean force) [Inherited but not used]
java.lang.String	getCreateCommand(java.lang.String operator) Return the OOQL command to add this Transition with the settled properties to a Workflow-Step
java.lang.String	getProperty(java.lang.String propertyName, java.util.Vector<java.lang.Object> filterArgs, java.lang.String token, Framework framework) Get a property for this Workflow-Step-Transition object by its OOQL identifier
java.lang.String	getSaveCommand(boolean force) [Inherited but not used]
Step	getStep() Get the from Workflow Step
java.lang.String	getStepFork() Get the final destination Step
java.util.Vector<?>	getTargetNames(java.lang.String composedName, java.util.Vector<java.lang.Object> filterArgs, Framework framework) Return a Vector of administrative object names extracted by using an OOQL selector
boolean	isRequired() Check if the transition is required for and-join minimal completion
void	setActionTrigger(java.lang.String programName) Set the Transition action trigger
void	setCheckTrigger(java.lang.String programName) Set the Transition check trigger
void	setRequired(boolean required) Set the transition as required for and-join minimal completion
void	setStep(Step step) Link the Transition with the from Workflow Step
void	setStepFork(java.lang.String stepName) Set the final destination Step assigned when the Transition is satisfied
java.lang.String	toString() Return the Transition object properties as a single String
java.lang.String	toString(java.lang.String indent) Return the Transition object properties as a single String
org.jdom.Element	toXML(boolean getImage, boolean fullDump, Framework framework) Return the Transition properties as XML element tree
org.jdom.Element	toXML(Framework framework) Return the Transition properties as XML element tree

Methods inherited from class com.oberon.ooql.sdk.AdminComponent

checkChangeName, getAdminType, getCommonProperty, getCommonTargetNames, getCrtDate, getDescription, getEditBasicCommand, getImage, getImageData, getImageFile, getModDate, getModUser, getName, getOldName, hasImage, setCrtDate, setDescription, setImage, setImageData, setImageFile, setModDate, setModUser, setName, toCommonXML, toXML

Methods inherited from class com.oberon.ooql.sdk.OBBase

addChange, addUniqueChange, ChangesFromXML, ChangesToXML, getChanges, getChangesAsString, getId, isLinked, removeChange, resetChanges, setId, setLinked

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

REQUIRED_OPTION

public static final int REQUIRED_OPTION

The Required flag index inside the Option Set

See Also:

Constant Field Values

Constructor Detail

Transition

public Transition()

Transition

public Transition(java.lang.String name)
           throws OberonException

Parameters:

name - the name of the administrative object

Throws:

OberonException - if the name contains invalid characters

Method Detail

setStep

public void setStep(Step step)

Link the Transition with the from Workflow Step

getStep

public Step getStep()

Get the from Workflow Step

setStepFork

public void setStepFork(java.lang.String stepName)

Set the final destination Step assigned when the Transition is satisfied

getStepFork

public java.lang.String getStepFork()

Get the final destination Step

setRequired

public void setRequired(boolean required)

Set the transition as required for and-join minimal completion

Since:

2.1_08

isRequired

public boolean isRequired()

Check if the transition is required for and-join minimal completion

Since:

2.1_08

See Also:

setRequired(boolean)

setCheckTrigger

public void setCheckTrigger(java.lang.String programName)

Set the Transition check trigger

Parameters:

programName - the Program name

getCheckTrigger

public java.lang.String getCheckTrigger()

Get the Transition check trigger

Returns:

the Program name

setActionTrigger

public void setActionTrigger(java.lang.String programName)

Set the Transition action trigger

Parameters:

programName - the Program name

getActionTrigger

public java.lang.String getActionTrigger()

Get the Transition action trigger

Returns:

the Program name

equals

public boolean equals(Transition transition)

Check if this Transition is equal to another

Parameters:

transition - the Transition to compare with this Transition

getProperty

public java.lang.String getProperty(java.lang.String propertyName,
                                    java.util.Vector<java.lang.Object> filterArgs,
                                    java.lang.String token,
                                    Framework framework)

Get a property for this Workflow-Step-Transition object by its OOQL identifier

Specified by:

getProperty in class OBBase

Parameters:

propertyName - OOQL property identifier/name (example: stepfork , validate ...)

filterArgs - extra arguments used to compute properties

token - separator token for complex properties

framework - the current framework

Returns:

the property value

getTargetNames

public java.util.Vector<?> getTargetNames(java.lang.String composedName,
                                          java.util.Vector<java.lang.Object> filterArgs,
                                          Framework framework)

Return a Vector of administrative object names extracted by using an OOQL selector

Specified by:

getTargetNames in class OBBase

Parameters:

composedName - OOQL property identifier/name

filterArgs - extra arguments used to compute properties

framework - the current framework

Returns:

a Vector of target names, used to extract their (sub)properties values

toString

public java.lang.String toString()

Return the Transition object properties as a single String

Overrides:

toString in class java.lang.Object

toString

public java.lang.String toString(java.lang.String indent)

Return the Transition object properties as a single String

Parameters:

indent - set the row indent chars

toXML

public org.jdom.Element toXML(Framework framework)

Return the Transition properties as XML element tree

Parameters:

framework - the current framework

toXML

public org.jdom.Element toXML(boolean getImage,
                              boolean fullDump,
                              Framework framework)

Return the Transition properties as XML element tree

Parameters:

fullDump - true to include detailed information

framework - the current framework

fromXML

public void fromXML(org.jdom.Element rootElement)

Load the Transition object from XML element tree

Overrides:

fromXML in class AdminComponent

getCreateCommand

public java.lang.String getCreateCommand(boolean force)

[Inherited but not used]

getSaveCommand

public java.lang.String getSaveCommand(boolean force)

[Inherited but not used]

getCreateCommand

public java.lang.String getCreateCommand(java.lang.String operator)

Return the OOQL command to add this Transition with the settled properties to a Workflow-Step

Parameters:

operator - OOQL operator (example: "add" (update Step) , or empty (add new Step) )

getChangeCommand

public java.lang.String getChangeCommand()

Return the OOQL command to update this Workflow-Step-Transition with the settled properties

compareUpdate

public java.lang.String compareUpdate(Transition refTransition,
                                      boolean checkImage,
                                      Framework framework)
                               throws OberonException

Return the OOQL command to update this Step-Transition object and let it become equals to another reference object.

Parameters:

refTransition - the reference Transition object

framework - the current framework

Throws:

OberonException

See Also:

fromXML(Element)