Process API

filenet.vw.api
Class VWParameterDefinition

java.lang.Object
  extended by filenet.vw.api.VWParameterDefinition
All Implemented Interfaces:
java.io.Serializable, java.lang.Cloneable

public final class VWParameterDefinition
extends java.lang.Object
implements java.io.Serializable, java.lang.Cloneable

Use this class to access the definition object for a parameter.

Workflow property values that are set at design time and workflow launch step parameters are not encoded/encrypted.

Since:
VWWS3.10
See Also:
VWParameter, VWModeType, VWFieldType, VWFieldDefinition, Serialized Form

Method Summary
static java.lang.String _get_FILE_AUTHOR()
          For FileNet internal use only, do not call.
static java.lang.String _get_FILE_DATE()
          For FileNet internal use only, do not call.
static java.lang.String _get_FILE_REVISION()
          For FileNet internal use only, do not call.
 int getDataType()
          Gets the data type of the parameter.
 java.lang.String getDescription()
          Gets the value of the description property.
 boolean getIsArray()
          Gets the state of the isArray flag for the parameter.
 int getMode()
          Gets the value of the mode property for the parameter.
 java.lang.String getName()
          Gets the parameter name.
 java.lang.String getValue()
          Gets the value stored in the value property.
 void setDataType(int theDataType)
          Sets the data type for the parameter.
 void setDescription(java.lang.String theDescription)
          Modifies the description for the parameter.
 void setIsArray(boolean theIsArray)
          Sets the isArray flag on the parameter.
 void setMode(int theMode)
          Sets the mode for the parameter.
 void setName(java.lang.String theName)
          Renames this parameter.
 void setValue(java.lang.String theValue)
          Modifies the parameter value.
 java.lang.String toString()
          Returns a string version of the name of the definition object associated with the parameter.
 void toXML(java.lang.StringBuffer theBuffer)
          Appends an XML string representing this instance to the buffer specified.
 void toXPDL(java.lang.String indentA, java.lang.StringBuffer theBuffer)
          Appends an XPDL string representing this instance to the buffer specified.
 void validate(java.util.Vector EDefVector)
          Validates this instance, appending any validation errors found to the specified Vector object.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Method Detail

_get_FILE_DATE

public static java.lang.String _get_FILE_DATE()
For FileNet internal use only, do not call.


_get_FILE_AUTHOR

public static java.lang.String _get_FILE_AUTHOR()
For FileNet internal use only, do not call.


_get_FILE_REVISION

public static java.lang.String _get_FILE_REVISION()
For FileNet internal use only, do not call.


setName

public void setName(java.lang.String theName)
             throws VWException
Renames this parameter.

Parameters:
theName - The new name for this parameter.
Throws:
VWException - Causes include invalid name format or duplication of another parameter name.

getMode

public int getMode()
Gets the value of the mode property for the parameter. Valid mode types are MODE_TYPE_IN (1), MODE_TYPE_OUT (2), and MODE_TYPE_IN_OUT (3). Refer to the VWModeType class for more information on mode types.

Returns:
An integer value indicating the mode of the parameter.
See Also:
VWModeType

setMode

public void setMode(int theMode)
             throws VWException
Sets the mode for the parameter. Valid types are MODE_TYPE_IN (1), MODE_TYPE_OUT (2), and MODE_TYPE_IN_OUT (3). Refer to the VWModeType class for more information on mode types.

Parameters:
theMode - An integer value used to set the mode property of the parameter.
Throws:
VWException - The method throws an exception if the mode type specified in the theMode parameter is invalid.
See Also:
VWModeType, VWException

getDataType

public int getDataType()
Gets the data type of the parameter. Refer to the VWFieldType class for more information on data types.

Returns:
An integer value indicating the data type of the parameter.
See Also:
VWFieldType

setDataType

public void setDataType(int theDataType)
                 throws VWException
Sets the data type for the parameter. Refer to the VWFieldType class for more information on data types.

Parameters:
theDataType - An integer value used to set the data type for the parameter.
Throws:
VWException - The method throws an exception if the type specified in the theDataType parameter is not valid.
See Also:
VWFieldType

getIsArray

public boolean getIsArray()
Gets the state of the isArray flag for the parameter.

Returns:
A boolean value. The method returns true if the parameter is an array; otherwise, the method returns false.

setIsArray

public void setIsArray(boolean theIsArray)
Sets the isArray flag on the parameter.

Parameters:
theIsArray - A boolean value. Specify true to indicate an array; otherwise, specify false.

getName

public java.lang.String getName()
Gets the parameter name. If a translation source exists, the authored name of the parameter is translated.

Note: The translation is done only at runtime, so will not appear in design-time applications (such as the Process Designer or Configuration Console).

Returns:
A String containing the translated name for this parameter, if a translation source exists; otherwise, the authored name is returned.

getValue

public java.lang.String getValue()
Gets the value stored in the value property.

Returns:
The value of the value property.

setValue

public void setValue(java.lang.String theValue)
              throws VWException
Modifies the parameter value.

Parameters:
theValue - The new value of the parameter.
Throws:
VWException - Causes include setting a null value for a step definition parameter.

getDescription

public java.lang.String getDescription()
Gets the value of the description property. If a translation source exists, the description is translated.

Note: The translation is done only at runtime, so will not appear in design-time applications (such as the Process Designer or Configuration Console).

Returns:
A String containing the translated description, if a translation source exists; otherwise, the authored description is returned.
See Also:
setDescription

setDescription

public void setDescription(java.lang.String theDescription)
Modifies the description for the parameter.

Parameters:
theDescription - The new description for the parameter.

toString

public java.lang.String toString()
Returns a string version of the name of the definition object associated with the parameter.

Overrides:
toString in class java.lang.Object
Returns:
A string version of the parameter name.

toXML

public void toXML(java.lang.StringBuffer theBuffer)
           throws VWException
Appends an XML string representing this instance to the buffer specified.

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

Parameters:
theBuffer - A StringBuffer that will be appended with the XML content.
Throws:
VWException - Thrown if the specified buffer is null.
See Also:
VWXMLUtil

toXPDL

public void toXPDL(java.lang.String indentA,
                   java.lang.StringBuffer theBuffer)
            throws VWException
Appends an XPDL string representing this instance to the buffer specified.

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

Parameters:
indentA - A String specifying the initial indentation for this XPDL section.
theBuffer - A StringBuffer that will be appended with the XPDL content.
Throws:
VWException - Thrown if the specified buffer is null.
See Also:
VWXMLUtil

validate

public void validate(java.util.Vector EDefVector)
              throws VWException
Validates this instance, appending any validation errors found to the specified Vector object.

Parameters:
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.

Throws:
VWException - Thrown if an error occurs during the validation.

Process API

© Copyright IBM Corporation 2002, 2008. All rights reserved.