filenet.vw.api

Class VWSimpleInstruction

java.lang.Object

filenet.vw.api.VWInstructionDefinition

filenet.vw.api.VWSimpleInstruction

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public final class VWSimpleInstruction
extends VWInstructionDefinition
implements java.io.Serializable

The VWSimpleInstruction class encapsulates simple instructions in a compound step definition. In this implementation, every instruction except Rollback and WaitForEvent can be represented by a VWSimpleInstruction object. Simple instructions have fixed parameters or variable parameters which can be represented in a one-dimensional array of Strings.

Since:

VWWS4.20

See Also:

VWException, Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	TIMER_TYPE_DEADLINE_STR Used by the ExpirationTimeTimer instruction to retrieve the expiration time of the deadline that is defined on the activity step at the top of the execution stack.
static java.lang.String	TIMER_TYPE_NAMED_STR Used by the ExpirationTimeTimer instruction to retrieve the expiration time of the specified timer.
static java.lang.String	TIMER_TYPE_REMINDER_STR Used by the ExpirationTimeTimer instruction to retrieve the expiration time of the reminder that is defined on the activity step at the top of the execution stack.

Method Summary

Modifier and Type	Method and Description
java.lang.String[]	getParams() Gets the parameters of this instruction.
void	setParams(java.lang.String[] theParams) Changes the value of this instruction's params property.
java.lang.String	toString() Gets a String representing this Instruction.
void	toXML(java.lang.StringBuffer theBuffer) Deprecated. Use VWWorkflowCollectionDefinition.write(java.io.OutputStream) or VWWorkflowDefinition.write(java.io.OutputStream).
void	validate(VWSession theSession, java.util.Vector EDefVector, VWCompoundStepDefinition myStep) Deprecated. Use VWWorkflowDefinition.validate(VWSession, VWSystemConfiguration, String)

Methods inherited from class filenet.vw.api.VWInstructionDefinition

getAction, getInstructionId, getStep

Methods inherited from class java.lang.Object

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

Field Detail

TIMER_TYPE_DEADLINE_STR

public static final java.lang.String TIMER_TYPE_DEADLINE_STR

Used by the ExpirationTimeTimer instruction to retrieve the expiration time of the deadline that is defined on the activity step at the top of the execution stack.

Since:

CPE 5.2.0.3

See Also:

VWActionType#ACTION_TYPE_EXPIRATION_TIME_TIMER}, Constant Field Values

TIMER_TYPE_NAMED_STR

public static final java.lang.String TIMER_TYPE_NAMED_STR

Used by the ExpirationTimeTimer instruction to retrieve the expiration time of the specified timer.

Since:

CPE 5.2.0.3

See Also:

VWActionType#ACTION_TYPE_EXPIRATION_TIME_TIMER}, Constant Field Values

TIMER_TYPE_REMINDER_STR

public static final java.lang.String TIMER_TYPE_REMINDER_STR

Used by the ExpirationTimeTimer instruction to retrieve the expiration time of the reminder that is defined on the activity step at the top of the execution stack.

Since:

CPE 5.2.0.3

See Also:

VWActionType#ACTION_TYPE_EXPIRATION_TIME_TIMER}, Constant Field Values

Method Detail

getParams

public java.lang.String[] getParams()

Gets the parameters of this instruction.

Returns:

An array of Strings that contains the list of parameters for this instruction

setParams

public void setParams(java.lang.String[] theParams)
               throws VWException

Changes the value of this instruction's params property.

Parameters:

theParams - The String array of parameters for this instruction

Throws:

VWException - Thrown if the length of the params array is not consistent with the number of parameters required by the action property of this instruction.

validate

public void validate(VWSession theSession,
                     java.util.Vector EDefVector,
                     VWCompoundStepDefinition myStep)
              throws VWException

Deprecated. Use VWWorkflowDefinition.validate(VWSession, VWSystemConfiguration, String)

Validates this instance, appending any validation errors found to the specified Vector object. Although this method does not return a value, EDefVector will be updated to contain any validation errors found.

Specified by:

validate in class VWInstructionDefinition

Parameters:

theSession - The current VWSession object if logged on. This is needed for various parts of the validation process. This can be null; however, areas of validation requiring a logon will not be validated.

EDefVector - A Vector to which will be added a VWValidationError object for each validation error found. This can be null; in this case, a new Vector is used.

Note: Because validate methods having EDefVector in the signature also occur on other classes, the existing Vector can contain validation errors from previous validation calls.

myStep - The VWCompoundStepDefinition object containing this event.

Throws:

VWException - Thrown if an error occurs during the validation.

toXML

public void toXML(java.lang.StringBuffer theBuffer)
           throws VWException

Deprecated. Use VWWorkflowCollectionDefinition.write(java.io.OutputStream) or VWWorkflowDefinition.write(java.io.OutputStream).

Appends an XML string representing this instance to the buffer specified.

Warning: This XML string is nonextensible, and cannot be modified in any way.

Specified by:

toXML in class VWInstructionDefinition

Parameters:

theBuffer - A StringBuffer that will be appended with the XML content.

Throws:

VWException - Thrown if the specified buffer is null.

See Also:

VWWorkflowCollectionDefinition, VWWorkflowDefinition

toString

public java.lang.String toString()

Gets a String representing this Instruction.

Specified by:

toString in class VWInstructionDefinition

Returns:

A String representing this Instruction.