VWParameterDefinition (Process API Documentation)

java.lang.Object
- 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

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`java.lang.Object`	`clone()` Creates a clone of this `VWParameterDefinition` object.
`VWAttributeInfo`	`getAttributeInfo()` Gets a VWAttribute object containing attributes for this object, as paired labels (keywords) and values in String format.
`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`	`setAttributeInfo(VWAttributeInfo theAttributeInfo)` Sets a VWAttribute object containing attributes for this object.
`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)` Deprecated. Use `VWWorkflowDefinition.write(java.io.OutputStream)` or `VWWorkflowDefinition.writeToFile(String)`.
`void`	`toXPDL(java.lang.String indentA, java.lang.StringBuffer theBuffer)` Deprecated. Use `VWWorkflowCollectionDefinition.write(java.io.OutputStream)` or `VWWorkflowCollectionDefinition.writeToFile(String)`.
`void`	`validate(java.util.Vector EDefVector)` Deprecated. Use `VWWorkflowDefinition.validate(VWSession, VWSystemConfiguration, String)`

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Method Detail
  - 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 VWFieldType 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.
  - 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 run time, 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 run time, 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
```
    Deprecated. Use VWWorkflowDefinition.write(java.io.OutputStream) or VWWorkflowDefinition.writeToFile(String).
    
    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:
    
    VWWorkflowDefinition
  - toXPDL
```
public void toXPDL(java.lang.String indentA,
                   java.lang.StringBuffer theBuffer)
            throws VWException
```
    Deprecated. Use VWWorkflowCollectionDefinition.write(java.io.OutputStream) or VWWorkflowCollectionDefinition.writeToFile(String).
    
    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:
    
    VWWorkflowCollectionDefinition
  - validate
```
public void validate(java.util.Vector EDefVector)
              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.
    
    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.
  - clone
```
public java.lang.Object clone()
```
    Creates a clone of this VWParameterDefinition object.
    
    Overrides:
    
    clone in class java.lang.Object
    
    Returns:
    
    a clone of this instance.
    
    Since:
    
    PE 5.2.0.0
  - getAttributeInfo
```
public VWAttributeInfo getAttributeInfo()
                                 throws VWException
```
    Gets a VWAttribute object containing attributes for this object, as paired labels (keywords) and values in String format. Note: Attributes can not be retrieved from an operation's parameter.
    
    Returns:
    
    A VWAttribute object containing attributes for this object, as paired labels (keywords) and values in String format.
    
    Throws:
    
    VWException
    
    Since:
    
    CPE 5.2.0.3 IF003
    
    See Also:
    
    VWParameterDefinition.setAttributeInfo(filenet.vw.api.VWAttributeInfo)
  - setAttributeInfo
```
public void setAttributeInfo(VWAttributeInfo theAttributeInfo)
                      throws VWException
```
    Sets a VWAttribute object containing attributes for this object. Note: Attributes can not be set on an operation's parameter.
    
    Parameters:
    
    theAttributeInfo - A VWAttribute object containing attributes for this object, as paired labels (keywords) and values in String format.
    
    Throws:
    
    VWException
    
    Since:
    
    CPE 5.2.0.3 IF003
    
    See Also:
    
    VWParameterDefinition.getAttributeInfo()

Methods inherited from class java.lang.Object

setName

getMode

setMode

getDataType

setDataType

getIsArray

setIsArray

getName

getValue

setValue

getDescription

setDescription

toString

toXML

toXPDL

validate

clone

getAttributeInfo

setAttributeInfo