com.oberon.ooql.sdk
Class Step

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

All Implemented Interfaces:

java.io.Serializable

public class Step
extends AdminComponent
implements java.io.Serializable

Represents a Workflow step.

Version:

5.0

See Also:

Serialized Form

Field Summary

static int	COMPLETE_ALL All actors in the access list must complete the step
static int	COMPLETE_ANY Any actor in the access list can complete the step
static int	COMPLETE_MIN A minimum number of actors in the access list must complete the step
static int	COMPLETION_OPTION The Completion flag index inside the Option Set
static int	DECISION_MULTI Each actor can select multiple transitions
static int	DECISION_OPTION The Completion flag index inside the Option Set
static int	DECISION_SINGLE Each actor can select only one transition
static int	EXPIREOTHERS_OPTION The 'Expire residual' flag index inside the Option Set
static int	HOLDER_OPTION The Holder Execute flag index inside the Option Set
static int	NOTIFY_OPTION The notify option flag index inside the Option Set
static int	OPERATE_IGNORE Perform Ignore operation
static int	OPERATE_length
static int	OPERATE_PROGRESS Perform Progress operation
static int	OPERATE_REFUSE Perform Refuse operation
static int	OPERATE_REGRESS Perform Regress operation
static int	OPERATE_SETSTAGE Perform Set Stage operation
static int	OPERATE_VALIDATE Perform Validate operation
static int	OPERATION_OPTION The operation option flag index inside the Option Set
static int	STEPTYPE_ACTION Action element
static int	STEPTYPE_AND_JOIN AND-Join element
static int	STEPTYPE_DECISION Decision element
static int	STEPTYPE_length
static int	STEPTYPE_LIFECYCLE_ACTION Licecycle Action element
static int	STEPTYPE_NOTIFICATION Notification element
static int	STEPTYPE_OR_JOIN OR-Join element
static int	STEPTYPE_SPLIT Split element
static int	STEPTYPE_START Start element
static int	STEPTYPE_STOP Stop element
static int	STEPTYPE_SYSTEM System Action element
static int	STOPOTHERS_OPTION The 'Stop residual' flag index inside the Option Set

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

bsOptions

Constructor Summary

Step()

Step(java.lang.String name)

Method Summary

void	addExecuteAccess(java.lang.String actorType, java.lang.String actorName) Add access right to execute this Step to an actor
void	addRecipient(java.lang.String type, java.lang.String actorType, java.lang.String actorName) Add a User/Team/Assignment to the recipient list
void	addTransition(Transition transition) Add a Transition to this Step
void	clearParameters() Remove all Step Parameters.
java.lang.String	compareUpdate(Step refStep, boolean checkImage, Framework framework) Return the OOQL command to update this Workflow-Step object and let it become equals to another reference object.
org.jdom.Element	destToXML(java.lang.String sToCc) Return the Notification object addresses as XML element tree
boolean	equals(Step step) Check if this Step is equal to another
void	fromXML(org.jdom.Element rootElement) Load the Step object from XML element tree
java.lang.String	getActionProgram() Get the method to run automatically by System
java.lang.String	getApplication() Get the application Menu name.
java.lang.String	getChangeCommand() Return the OOQL command to update this Workflow-Step with the settled properties
java.lang.String	getChangeStateTrigger() Get the Step change-state trigger
java.lang.String	getCompleteTrigger() Get the Step complete trigger
int	getCompletionType() Get the Step completion type option.
java.lang.String	getCompletionTypeAsString(int complete) Convert the completion type to OOQL string
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 Step with the settled properties to a Workflow
int	getDecisionType() Get the Step decision type option.
java.lang.String	getDecisionTypeAsString(int decision) Convert the decision type to OOQL string
long	getDurationTime() Get the Step Maximum Duration Time.
java.lang.String	getExecutable() Get the server-side executable to run in a System step
java.util.Vector<java.lang.String>	getExecuteAccess() Return the list of execute access rights for this Step.
double	getHPos() Get the Step Horizontal Position.
java.lang.String	getHRef() Get the web page link
java.util.Vector<Transition>	getInputTransitions() Return the input transitions
java.lang.String	getLabel() Get the Command label.
java.lang.String	getLifecycleOperationTypeAsString(int operation) Convert the operation type to OOQL string
java.lang.String	getMailBody() Get the mail body for notification / action / decision steps
java.lang.String	getMailBodyForm() Get the form used to compile the mail body in notification steps
java.lang.String	getMailLanguage() Get the mail language for notification steps
java.lang.String	getMailSubject() Get the mail subject for notification steps
int	getMaxInputTransitions() Returns the maximum input transitions on the base of the step type
int	getMaxOutputTransitions() Returns the maximum output transitions on the base of the step type
java.lang.String	getOperationOption() Get the operation option for lifecycle-operations
int	getOperationType() Get the Step operation type option.
java.util.Hashtable<java.lang.String,java.lang.String[]>	getParameters() Get the Step Parameters.
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 object by its OOQL identifier
java.util.Vector<java.lang.String>	getRecipients() Return the recipient list
java.lang.String	getRecipientToString(java.lang.String type, java.lang.String token) Return the recipient list as a string
java.lang.String	getSaveCommand(boolean force) [Inherited but not used]
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
int	getThreshold() Get the step Threshold
Transition	getTransition(java.lang.String transitionName) Get a Transition for this Step
java.util.Vector<java.lang.String>	getTransitionIDs() Get Transition internal ids for this Step
java.util.Vector<java.lang.String>	getTransitionNames() Get Transition names for this Step
int	getTransitionPos(Transition transition) Return the Transition position into the Step-Transition list
java.util.Vector<Transition>	getTransitions() Get Transitions for this Step
java.lang.String	getTransitionsAsString(java.lang.String delim) Get Transition names for this Step as String
int	getType() Get the Step type
java.lang.String	getTypeAsString() Get the Step type in OOQL format
static java.lang.String	getTypeAsString(int type) Convert the Step type in OOQL format
static int	getTypeFromString(java.lang.String stepType) Convert Step type from OOQL format
double	getVPos() Get the Step Vertical Position.
Workflow	getWorkflow() Get the related Workflow
boolean	hasExecuteAccess(User user, java.lang.String holderName, Framework framework) Check if a User has access to execute this Step.
boolean	isExpireOthers() Check if the expireOthers option is active for this Step
boolean	isHolderExecute() Check if the holderExecute option is active for this Step
boolean	isImageChanged() Check if Step image was updated
boolean	isNotify() Check if the notify option is active for this Step
boolean	isStopOthers() Check if the stopOthers option is active for this Step
void	removeExecuteAccess(java.lang.String actorType, java.lang.String actorName) Remove the actor access right to execute this Step
void	removeParameter(java.lang.String parameter) Remove a parameter from the Step Parameters.
void	removeRecipient(java.lang.String type, java.lang.String actorType, java.lang.String actorName) Remove a User/Team/Assignment from the recipient list
void	removeTransition(Transition transition) Remove a Transition from this Step
void	setActionProgram(java.lang.String programName) Set the method to run automatically by System
void	setChangeStateTrigger(java.lang.String programName) Set the Step change-state trigger It runs any time the step status changes
void	setCompleteTrigger(java.lang.String programName) Set the Step complete trigger It runs when each single actor complete the action task
void	setCompletionType(int complete) Set the Step completion type option.
void	setCompletionType(java.lang.String complete) Set the Step completion type option.
void	setDecisionType(int decision) Set the Step decision type option.
void	setDecisionType(java.lang.String decision) Set the Step decision type option.
void	setDurationTime(long seconds) Set the Step Maximum Duration Time.
void	setExecutable(java.lang.String executePath) Set the server-side executable to run in a System step
void	setExpireOthers(boolean expireOthers) Set the expire others flag for join elements When expireOthers is true the incomplete step at join inputs will be expired automatically
void	setHolderExecute(boolean holderExecute) Set the holder execute option.
void	setHPos(double hpos) Set the Step Horizontal Position.
void	setHRef(java.lang.String url) Set the web page link for this Command.
void	setLabel(java.lang.String label) Set the Command label.
void	setLifecycleOperationType(java.lang.String operation, java.lang.String option) Set the Step operation type option.
void	setMailBody(java.lang.String body) Set the mail body for notification / action / decision steps
void	setMailBodyForm(java.lang.String formName) Set the form used to compile the mail body in notification steps
void	setMailLanguage(java.lang.String language) Set the mail language for notification steps
void	setMailSubject(java.lang.String subject) Set the mail subject for notification steps
void	setNotify(boolean notify) Set the notify option for action / decision steps When this flag is true a notification is sent to action users as soon as the step becomes active
void	setOperationType(int operation, java.lang.String option) Set the Step operation type option.
void	setParameter(java.lang.String parameter, java.lang.String[] value) Set a Step Parameter.
void	setParameters(java.util.Hashtable<java.lang.String,java.lang.String[]> parameters) Set the Step Parameters.
void	setStopOthers(boolean stopOthers) Set the stop others flag for join elements When stopOthers is true the incomplete step at join inputs will be stopped automatically
void	setThreshold(int threshold) Set the step Threshold.
void	setTransitions(java.util.Vector<Transition> transitions) Set Transitions for this Step
void	setType(int type) Set the Step type
void	setVPos(double vpos) Set the Step Vertical Position.
void	setWorkflow(Workflow workflow) Link the Step with the related Workflow
java.lang.String	toString() Return the Step object basic properties as a single String
org.jdom.Element	toXML(boolean getImage, boolean fullDump, Framework framework) Return the Step properties as XML element tree
org.jdom.Element	toXML(Framework framework) Return the Step properties as XML element tree
void	updateExecuteAccess(java.util.Vector<java.lang.String> accesses) Update the execute access on the basis of a given list
void	updateParameters(java.util.Hashtable<java.lang.String,java.lang.String[]> parameters) Update the parameters on the basis of a given map
void	updateRecipients(java.util.Vector<java.lang.String> recipients) Update the recipients on the basis of a given list
void	updateTransitions(java.util.Vector<Transition> transitions) Update the transitions on the basis of a given list

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

HOLDER_OPTION

public static final int HOLDER_OPTION

The Holder Execute flag index inside the Option Set

See Also:

Constant Field Values

STOPOTHERS_OPTION

public static final int STOPOTHERS_OPTION

The 'Stop residual' flag index inside the Option Set

See Also:

Constant Field Values

COMPLETION_OPTION

public static final int COMPLETION_OPTION

The Completion flag index inside the Option Set

See Also:

Constant Field Values

DECISION_OPTION

public static final int DECISION_OPTION

The Completion flag index inside the Option Set

See Also:

Constant Field Values

EXPIREOTHERS_OPTION

public static final int EXPIREOTHERS_OPTION

The 'Expire residual' flag index inside the Option Set

See Also:

Constant Field Values

NOTIFY_OPTION

public static final int NOTIFY_OPTION

The notify option flag index inside the Option Set

See Also:

Constant Field Values

OPERATION_OPTION

public static final int OPERATION_OPTION

The operation option flag index inside the Option Set

See Also:

Constant Field Values

STEPTYPE_START

public static final int STEPTYPE_START

Start element

See Also:

Constant Field Values

STEPTYPE_STOP

public static final int STEPTYPE_STOP

Stop element

See Also:

Constant Field Values

STEPTYPE_ACTION

public static final int STEPTYPE_ACTION

Action element

See Also:

Constant Field Values

STEPTYPE_SPLIT

public static final int STEPTYPE_SPLIT

Split element

See Also:

Constant Field Values

STEPTYPE_OR_JOIN

public static final int STEPTYPE_OR_JOIN

OR-Join element

See Also:

Constant Field Values

STEPTYPE_AND_JOIN

public static final int STEPTYPE_AND_JOIN

AND-Join element

See Also:

Constant Field Values

STEPTYPE_SYSTEM

public static final int STEPTYPE_SYSTEM

System Action element

See Also:

Constant Field Values

STEPTYPE_DECISION

public static final int STEPTYPE_DECISION

Decision element

See Also:

Constant Field Values

STEPTYPE_NOTIFICATION

public static final int STEPTYPE_NOTIFICATION

Notification element

See Also:

Constant Field Values

STEPTYPE_LIFECYCLE_ACTION

public static final int STEPTYPE_LIFECYCLE_ACTION

Licecycle Action element

See Also:

Constant Field Values

STEPTYPE_length

public static final int STEPTYPE_length

See Also:

Constant Field Values

COMPLETE_ANY

public static final int COMPLETE_ANY

Any actor in the access list can complete the step

See Also:

Constant Field Values

COMPLETE_ALL

public static final int COMPLETE_ALL

All actors in the access list must complete the step

See Also:

Constant Field Values

COMPLETE_MIN

public static final int COMPLETE_MIN

A minimum number of actors in the access list must complete the step

See Also:

Constant Field Values

DECISION_SINGLE

public static final int DECISION_SINGLE

Each actor can select only one transition

See Also:

Constant Field Values

DECISION_MULTI

public static final int DECISION_MULTI

Each actor can select multiple transitions

See Also:

Constant Field Values

OPERATE_PROGRESS

public static final int OPERATE_PROGRESS

Perform Progress operation

See Also:

Constant Field Values

OPERATE_REGRESS

public static final int OPERATE_REGRESS

Perform Regress operation

See Also:

Constant Field Values

OPERATE_SETSTAGE

public static final int OPERATE_SETSTAGE

Perform Set Stage operation

See Also:

Constant Field Values

OPERATE_VALIDATE

public static final int OPERATE_VALIDATE

Perform Validate operation

See Also:

Constant Field Values

OPERATE_IGNORE

public static final int OPERATE_IGNORE

Perform Ignore operation

See Also:

Constant Field Values

OPERATE_REFUSE

public static final int OPERATE_REFUSE

Perform Refuse operation

See Also:

Constant Field Values

OPERATE_length

public static final int OPERATE_length

See Also:

Constant Field Values

Constructor Detail

Step

public Step()

Step

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

Parameters:

name - the name of the administrative object

Throws:

OberonException - if the name contains invalid characters

Method Detail

isImageChanged

public boolean isImageChanged()

Check if Step image was updated

setWorkflow

public void setWorkflow(Workflow workflow)

Link the Step with the related Workflow

getWorkflow

public Workflow getWorkflow()

Get the related Workflow

getApplication

public java.lang.String getApplication()

Get the application Menu name.

Since:

2.2_01

setType

public void setType(int type)

Set the Step type

Parameters:

type - the Step type

getType

public int getType()

Get the Step type

getTypeAsString

public static java.lang.String getTypeAsString(int type)

Convert the Step type in OOQL format

getTypeAsString

public java.lang.String getTypeAsString()

Get the Step type in OOQL format

getTypeFromString

public static int getTypeFromString(java.lang.String stepType)

Convert Step type from OOQL format

Returns:

the Step type

setHPos

public void setHPos(double hpos)

Set the Step Horizontal Position.

Parameters:

hpos - the horizontal position in the workflow graph

getHPos

public double getHPos()

Get the Step Horizontal Position.

Returns:

the horizontal position in the workflow graph

setVPos

public void setVPos(double vpos)

Set the Step Vertical Position.

Parameters:

vpos - the vertical position in the workflow graph

getVPos

public double getVPos()

Get the Step Vertical Position.

Returns:

the vertical position in the workflow graph

setDurationTime

public void setDurationTime(long seconds)

Set the Step Maximum Duration Time.

Parameters:

seconds - the duration time in seconds

getDurationTime

public long getDurationTime()

Get the Step Maximum Duration Time.

Returns:

the duration time in seconds

setHolderExecute

public void setHolderExecute(boolean holderExecute)

Set the holder execute option. When holderExecute is true the ObjectObj's holder is added to the user list for execution of this step

isHolderExecute

public boolean isHolderExecute()

Check if the holderExecute option is active for this Step

addExecuteAccess

public void addExecuteAccess(java.lang.String actorType,
                             java.lang.String actorName)

Add access right to execute this Step to an actor

Parameters:

actorType - the actor type: can be ActorAccess.USER , ActorAccess.TEAM , ActorAccess.ASSIGNMENT

actorName - the actor name

removeExecuteAccess

public void removeExecuteAccess(java.lang.String actorType,
                                java.lang.String actorName)

Remove the actor access right to execute this Step

Parameters:

actorType - the actor type: can be ActorAccess.USER , ActorAccess.TEAM , ActorAccess.ASSIGNMENT

actorName - the actor name

updateExecuteAccess

public void updateExecuteAccess(java.util.Vector<java.lang.String> accesses)

Update the execute access on the basis of a given list

Parameters:

accesses - list of accesses formatted as actorType|actorName

Since:

4.0

getExecuteAccess

public java.util.Vector<java.lang.String> getExecuteAccess()

Return the list of execute access rights for this Step.

Returns:

Vector of access rights formatted as actorType|actorName

See Also:

addExecuteAccess(String, String)

hasExecuteAccess

public boolean hasExecuteAccess(User user,
                                java.lang.String holderName,
                                Framework framework)

Check if a User has access to execute this Step.

addRecipient

public void addRecipient(java.lang.String type,
                         java.lang.String actorType,
                         java.lang.String actorName)

Add a User/Team/Assignment to the recipient list

Parameters:

type - the recipient type ( Mail.TO , Mail.CC , Mail.BCC )

actorType - the actor type: can be ActorAccess.USER , ActorAccess.TEAM , ActorAccess.ASSIGNMENT

actorName - the actor name

Since:

2.2_05

removeRecipient

public void removeRecipient(java.lang.String type,
                            java.lang.String actorType,
                            java.lang.String actorName)

Remove a User/Team/Assignment from the recipient list

Parameters:

type - the recipient type ( Mail.TO , Mail.CC , Mail.BCC )

actorType - the actor type: can be ActorAccess.USER , ActorAccess.TEAM , ActorAccess.ASSIGNMENT

actorName - the actor name

Since:

2.2_05

updateRecipients

public void updateRecipients(java.util.Vector<java.lang.String> recipients)

Update the recipients on the basis of a given list

Parameters:

recipients - list of recipients formatted as recipientType|actorType|actorName

Since:

4.0

getRecipients

public java.util.Vector<java.lang.String> getRecipients()

Return the recipient list

Returns:

Vector of recipients formatted as type|actorType|actorName

Since:

2.2_05

See Also:

addRecipient(String, String, String)

getRecipientToString

public java.lang.String getRecipientToString(java.lang.String type,
                                             java.lang.String token)

Return the recipient list as a string

Parameters:

type - the recipient type ( Mail.TO , Mail.CC , Mail.BCC )

token - the separator token

Since:

2.2_05

setCompletionType

public void setCompletionType(int complete)

Set the Step completion type option. Defines the number of actors required to complete the step task

Parameters:

complete - the completion type constant ( COMPLETE_ALL / COMPLETE_ANY / COMPLETE_MIN)

Since:

2.1_04

getCompletionType

public int getCompletionType()

Get the Step completion type option.

Since:

2.1_04

See Also:

setCompletionType(int)

getCompletionTypeAsString

public java.lang.String getCompletionTypeAsString(int complete)

Convert the completion type to OOQL string

Since:

2.1_04

setCompletionType

public void setCompletionType(java.lang.String complete)

Set the Step completion type option. Defines the number of actors required to complete the step task

Parameters:

complete - the OOQL completion type string ( all / any / min )

Since:

2.1_04

setDecisionType

public void setDecisionType(int decision)

Set the Step decision type option. Defines the number of transitions selectable for each users

Parameters:

decision - the decision type constant ( DECISION_SINGLE / DECISION_MULTI)

Since:

2.1_04

getDecisionType

public int getDecisionType()

Get the Step decision type option.

Since:

2.1_04

See Also:

setDecisionType(int)

getDecisionTypeAsString

public java.lang.String getDecisionTypeAsString(int decision)

Convert the decision type to OOQL string

Since:

2.1_04

setDecisionType

public void setDecisionType(java.lang.String decision)

Set the Step decision type option. Defines the number of transitions selectable for each users

Parameters:

decision - the OOQL decision type string ( single / multiple )

Since:

2.1_04

setOperationType

public void setOperationType(int operation,
                             java.lang.String option)

Set the Step operation type option. Defines the operation for lifecycle steps

Parameters:

operation - the operation type constant ( OPERATE_PROGRESS / OPERATE_REGRESS / OPERATE_SETSTAGE / OPERATE_VALIDATE / OPERATE_IGNORE / OPERATE_REFUSE)

option - the operation option ( Stage / Validation name )

Since:

4.2

getOperationType

public int getOperationType()

Get the Step operation type option.

Since:

4.2

See Also:

setOperationType(int,String)

getOperationOption

public java.lang.String getOperationOption()

Get the operation option for lifecycle-operations

Returns:

the Validation name or the Stage name

getLifecycleOperationTypeAsString

public java.lang.String getLifecycleOperationTypeAsString(int operation)

Convert the operation type to OOQL string

Since:

4.2

setLifecycleOperationType

public void setLifecycleOperationType(java.lang.String operation,
                                      java.lang.String option)

Set the Step operation type option. Defines the operation for lifecycle steps

Parameters:

operation - the OOQL operation type string ( progress / regress / setstage / validate / ignore / refuse )

option - the operation option ( Stage / Validation name )

Since:

4.2

setThreshold

public void setThreshold(int threshold)

Set the step Threshold. It represents the minimum number of actors to complete the Step or minimum completed inputs for And-Join elements

Since:

2.1_04

getThreshold

public int getThreshold()

Get the step Threshold

Since:

2.1_04

setStopOthers

public void setStopOthers(boolean stopOthers)

Set the stop others flag for join elements When stopOthers is true the incomplete step at join inputs will be stopped automatically

Since:

2.1_04

isStopOthers

public boolean isStopOthers()

Check if the stopOthers option is active for this Step

Since:

2.1_04

See Also:

setStopOthers(boolean)

setExpireOthers

public void setExpireOthers(boolean expireOthers)

Set the expire others flag for join elements When expireOthers is true the incomplete step at join inputs will be expired automatically

Since:

2.1_08

isExpireOthers

public boolean isExpireOthers()

Check if the expireOthers option is active for this Step

Since:

2.1_08

See Also:

setExpireOthers(boolean)

setNotify

public void setNotify(boolean notify)

Set the notify option for action / decision steps When this flag is true a notification is sent to action users as soon as the step becomes active

Since:

2.2_05

isNotify

public boolean isNotify()

Check if the notify option is active for this Step

Since:

2.1_08

See Also:

setNotify(boolean)

setLabel

public void setLabel(java.lang.String label)

Set the Command label.

Parameters:

label - the label value

getLabel

public java.lang.String getLabel()

Get the Command label.

Returns:

the label value

setHRef

public void setHRef(java.lang.String url)

Set the web page link for this Command. HTTP parameters can be added as Command Features

Parameters:

url - the http url (example: /myfolder/mypage.jsp)

getHRef

public java.lang.String getHRef()

Get the web page link

Returns:

the page link

setMailLanguage

public void setMailLanguage(java.lang.String language)

Set the mail language for notification steps

Parameters:

language - the language

Since:

2.2_04

getMailLanguage

public java.lang.String getMailLanguage()

Get the mail language for notification steps

Since:

2.2_04

setMailSubject

public void setMailSubject(java.lang.String subject)

Set the mail subject for notification steps

Parameters:

subject - the subject text (you can use here substitution or dictionary keywords )

Since:

2.2_04

getMailSubject

public java.lang.String getMailSubject()

Get the mail subject for notification steps

Since:

2.2_04

setMailBody

public void setMailBody(java.lang.String body)

Set the mail body for notification / action / decision steps

Parameters:

body - the body text (you can use here substitution or dictionary keywords )

Since:

2.2_05

getMailBody

public java.lang.String getMailBody()

Get the mail body for notification / action / decision steps

Since:

2.2_05

setMailBodyForm

public void setMailBodyForm(java.lang.String formName)

Set the form used to compile the mail body in notification steps

Parameters:

formName - the Form name

Since:

2.2_04

getMailBodyForm

public java.lang.String getMailBodyForm()

Get the form used to compile the mail body in notification steps

Returns:

the Form name

Since:

2.2_04

setActionProgram

public void setActionProgram(java.lang.String programName)

Set the method to run automatically by System

Parameters:

programName - the Program name

getActionProgram

public java.lang.String getActionProgram()

Get the method to run automatically by System

Returns:

the Program name

setExecutable

public void setExecutable(java.lang.String executePath)

Set the server-side executable to run in a System step

Parameters:

executePath - the path of executable file

Since:

2.2_03

getExecutable

public java.lang.String getExecutable()

Get the server-side executable to run in a System step

Returns:

the Program name

Since:

2.2_03

setCompleteTrigger

public void setCompleteTrigger(java.lang.String programName)

Set the Step complete trigger It runs when each single actor complete the action task

Parameters:

programName - the Program name

Since:

2.1_04

getCompleteTrigger

public java.lang.String getCompleteTrigger()

Get the Step complete trigger

Returns:

the Program name

Since:

2.1_04

setChangeStateTrigger

public void setChangeStateTrigger(java.lang.String programName)

Set the Step change-state trigger It runs any time the step status changes

Parameters:

programName - the Program name

Since:

4.2

getChangeStateTrigger

public java.lang.String getChangeStateTrigger()

Get the Step change-state trigger

Returns:

the Program name

Since:

4.2

setParameters

public void setParameters(java.util.Hashtable<java.lang.String,java.lang.String[]> parameters)

Set the Step Parameters.

Parameters:

parameters - set of parameters to put/change into the parameter table

Since:

2.2_01

setParameter

public void setParameter(java.lang.String parameter,
                         java.lang.String[] value)

Set a Step Parameter.

Parameters:

parameter - the parameter to set

value - array of 3 elements: the default value [0], the workflow source parameter [1],the workflow parameter to update [2]

Since:

2.2_01

removeParameter

public void removeParameter(java.lang.String parameter)

Remove a parameter from the Step Parameters.

Parameters:

parameter - the parameter to remove

Since:

2.2_01

updateParameters

public void updateParameters(java.util.Hashtable<java.lang.String,java.lang.String[]> parameters)

Update the parameters on the basis of a given map

Parameters:

parameters - map of parameter values

Since:

4.0

clearParameters

public void clearParameters()

Remove all Step Parameters.

Since:

2.2_01

getParameters

public java.util.Hashtable<java.lang.String,java.lang.String[]> getParameters()

Get the Step Parameters.

Returns:

Hashtable where the parameter names are the keys

addTransition

public void addTransition(Transition transition)

Add a Transition to this Step

removeTransition

public void removeTransition(Transition transition)

Remove a Transition from this Step

setTransitions

public void setTransitions(java.util.Vector<Transition> transitions)

Set Transitions for this Step

Parameters:

transitions - vector of Transitions

updateTransitions

public void updateTransitions(java.util.Vector<Transition> transitions)
                       throws OberonException

Update the transitions on the basis of a given list

Parameters:

transitions - list of Transitions

Throws:

OberonException

Since:

4.0

getTransitions

public java.util.Vector<Transition> getTransitions()

Get Transitions for this Step

Returns:

vector of Transitions

getTransition

public Transition getTransition(java.lang.String transitionName)

Get a Transition for this Step

Parameters:

transitionName - the Transition name

Returns:

null if the Transition is not defined

getTransitionNames

public java.util.Vector<java.lang.String> getTransitionNames()

Get Transition names for this Step

Returns:

vector of Transition names

getTransitionIDs

public java.util.Vector<java.lang.String> getTransitionIDs()

Get Transition internal ids for this Step

Returns:

vector of Transition ids

getTransitionsAsString

public java.lang.String getTransitionsAsString(java.lang.String delim)

Get Transition names for this Step as String

Parameters:

delim - the name separator

getTransitionPos

public int getTransitionPos(Transition transition)

Return the Transition position into the Step-Transition list

getInputTransitions

public java.util.Vector<Transition> getInputTransitions()

Return the input transitions

getMaxInputTransitions

public int getMaxInputTransitions()

Returns the maximum input transitions on the base of the step type

getMaxOutputTransitions

public int getMaxOutputTransitions()

Returns the maximum output transitions on the base of the step type

equals

public boolean equals(Step step)

Check if this Step is equal to another

Parameters:

step - the Step to compare with this Step

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 object by its OOQL identifier

Specified by:

getProperty in class OBBase

Parameters:

propertyName - OOQL property identifier/name (example: type , duration ...)

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 (example: transition, program

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 Step object basic properties as a single String

Overrides:

toString in class java.lang.Object

destToXML

public org.jdom.Element destToXML(java.lang.String sToCc)

Return the Notification object addresses as XML element tree

Parameters:

sToCc - can be TO, CC or BCC

toXML

public org.jdom.Element toXML(Framework framework)

Return the Step properties as XML element tree

Parameters:

framework - the current framework

toXML

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

Return the Step 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 Step 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 Step with the settled properties to a Workflow

Parameters:

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

getChangeCommand

public java.lang.String getChangeCommand()

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

compareUpdate

public java.lang.String compareUpdate(Step refStep,
                                      boolean checkImage,
                                      Framework framework)
                               throws OberonException

Return the OOQL command to update this Workflow-Step object and let it become equals to another reference object.
This method is useful to import objects from an XML file.

Parameters:

refStep - the reference Step object

framework - the current framework

Throws:

OberonException

See Also:

fromXML(Element)