com.filenet.wcm.toolkit.server.util.workflow
Class WcmWorkflowParameter

java.lang.Object
  extended bycom.filenet.wcm.toolkit.server.util.workflow.WcmWorkflowParameter

public class WcmWorkflowParameter
extends java.lang.Object

Definition class for describing workflow parameters, including fields for the parameter string name, input/output mode, data type, and a boolean array indicator.


Field Summary
static int MODE_IN
          Parameter is input mode only.
static int MODE_INOUT
          Parameter supports both input and output modes.
static int MODE_OUT
          Parameter is output mode only.
static int TYPE_ATTACHMENT
          The parameter data type is an attachment.
static int TYPE_BOOLEAN
          The parameter data type is a boolean.
static int TYPE_FLOAT
          The parameter data type is a floating point integer.
static int TYPE_INT
          The parameter data type is an integer.
static int TYPE_STRING
          The parameter data type is a string.
static int TYPE_TIME
          The parameter data type is a period of time
 
Constructor Summary
WcmWorkflowParameter()
          Default constructor.
WcmWorkflowParameter(java.lang.String name, int type, boolean isArray)
          Constructs an instance of WcmWorkflowParameter using specified values for the instance name, type, and indicates whether the instance is an array.
 
Method Summary
 boolean getIsArray()
          Get the workflow parameter cardinality
 int getMode()
          Get the workflow parameter mode string
 java.lang.String getName()
          Get the workflow parameter name string
 int getType()
          Get the workflow parameter type string
 void setIsArray(boolean isArray)
          Sets the workflow parameters cardinality
 void setMode(int mode)
          Sets the workflow parameter mode string
 void setName(java.lang.String name)
          Sets the workflow parameter name string
 void setType(int type)
          Sets the workflow parameter type
 void toXML(java.lang.StringBuffer buffer)
          Append an XML string, that represents this object, to the end of the buffer passed to this method.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

TYPE_ATTACHMENT

public static final int TYPE_ATTACHMENT
The parameter data type is an attachment.

See Also:
Constant Field Values

TYPE_BOOLEAN

public static final int TYPE_BOOLEAN
The parameter data type is a boolean.

See Also:
Constant Field Values

TYPE_FLOAT

public static final int TYPE_FLOAT
The parameter data type is a floating point integer.

See Also:
Constant Field Values

TYPE_INT

public static final int TYPE_INT
The parameter data type is an integer.

See Also:
Constant Field Values

TYPE_STRING

public static final int TYPE_STRING
The parameter data type is a string.

See Also:
Constant Field Values

TYPE_TIME

public static final int TYPE_TIME
The parameter data type is a period of time

See Also:
Constant Field Values

MODE_IN

public static final int MODE_IN
Parameter is input mode only.

See Also:
Constant Field Values

MODE_OUT

public static final int MODE_OUT
Parameter is output mode only.

See Also:
Constant Field Values

MODE_INOUT

public static final int MODE_INOUT
Parameter supports both input and output modes.

See Also:
Constant Field Values
Constructor Detail

WcmWorkflowParameter

public WcmWorkflowParameter()
Default constructor.


WcmWorkflowParameter

public WcmWorkflowParameter(java.lang.String name,
                            int type,
                            boolean isArray)
Constructs an instance of WcmWorkflowParameter using specified values for the instance name, type, and indicates whether the instance is an array.

Method Detail

getName

public java.lang.String getName()
Get the workflow parameter name string

Returns:
name string.

setName

public void setName(java.lang.String name)
Sets the workflow parameter name string

Parameters:
name - string.

getType

public int getType()
Get the workflow parameter type string

Returns:
type int.

setType

public void setType(int type)
Sets the workflow parameter type

Parameters:
type - int.

getMode

public int getMode()
Get the workflow parameter mode string

Returns:
mode int.

setMode

public void setMode(int mode)
Sets the workflow parameter mode string

Parameters:
mode - int.

getIsArray

public boolean getIsArray()
Get the workflow parameter cardinality

Returns:
isArray boolean.

setIsArray

public void setIsArray(boolean isArray)
Sets the workflow parameters cardinality

Parameters:
isArray - boolean.

toXML

public void toXML(java.lang.StringBuffer buffer)
           throws java.lang.Exception
Append an XML string, that represents this object, to the end of the buffer passed to this method.

Parameters:
buffer - StringBuffer to append XML data.
Throws:
java.lang.Exception


© Copyright IBM Corp. 2002, 2007. All Rights Reserved.