VWOperationDefinition (Process API Documentation)

java.lang.Object
- filenet.vw.api.VWOperationDefinition

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable
```
public final class VWOperationDefinition
extends java.lang.Object
implements java.io.Serializable, java.lang.Cloneable
```
A VWOperationDefinition object specifies an operation within a queue that performs a specific task. The definition includes the operation name, a set of parameters needed to perform the operation, and an optional description. The VWParameterDefinition objects can be created, deleted, and/or retrieved from this class.

Since:

IWWS1.10

See Also:

VWParameter, VWParameterDefinition, VWModeType, VWFieldType, Serialized Form

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`VWParameterDefinition`	`createParameter(java.lang.String theName, int theMode, int theType, boolean theIsArray)` Creates a parameter definition object.
`VWParameterDefinition`	`createParameter(VWParameterDefinition theParameter)` Creates a parameter definition object from another parameter definition object. The name of the parameter cannot match the name of any other parameter in this operation (VWOperationDefinition object).
`void`	`deleteParameter(java.lang.String theName)` Deletes a parameter.
`VWAttributeInfo`	`getAttributeInfo()` Gets a VWAttribute object containing attributes for this object, as paired labels (keywords) and values in String format.
`java.lang.String`	`getDescription()` Returns the description of this operation.
`java.lang.String`	`getName()` Returns the name of this operation.
`VWParameterDefinition`	`getParameterDefinition(java.lang.String theName)` Gets a parameter definition from the set of parameter definitions stored in this operation definition.
`VWParameterDefinition[]`	`getParameterDefinitions()` Gets the parameters of this operation.
`VWSession`	`getSession()` Get the session associated with this operation definition.
`void`	`setAttributeInfo(VWAttributeInfo theAttributeInfo)` Sets a VWAttribute object containing attributes for this object.
`void`	`setDescription(java.lang.String theDescription)` Sets the description of this operation.
`void`	`setName(java.lang.String theName)` Sets the name of this operation.
`void`	`toXML(java.lang.StringBuffer theBuffer)` Deprecated. Use `VWXMLConfiguration.makeXMLBlock(IVWtoXML[])`.

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

- Method Detail
  - createParameter
```
public VWParameterDefinition createParameter(java.lang.String theName,
                                             int theMode,
                                             int theType,
                                             boolean theIsArray)
                                      throws java.lang.Exception
```
    Creates a parameter definition object.
    
    Parameters:
    
    theName - The name of the parameter
    
    theMode - An integer containing the mode of the parameter: IN (1), OUT (2), or IN_OUT (3)
    
    theType - An integer indicating the type to which the value expression will evaluate. To see valid integer values and their meanings, refer to the VWFieldType class field summary.
    
    theIsArray - A boolean value: true indicates that the parameter is an array; false indicates that the parameter is not an array.
    
    Returns:
    
    A new VWParameterDefinition object, as specified.
    
    Throws:
    
    VWException - Thrown if any of the parameters passed to this function are invalid
    
    java.lang.Exception
    
    Since:
    
    IWWS1.10
    
    See Also:
    
    VWModeType, VWFieldType
  - getParameterDefinition
```
public VWParameterDefinition getParameterDefinition(java.lang.String theName)
                                             throws VWException
```
    Gets a parameter definition from the set of parameter definitions stored in this operation definition. 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).
    
    Parameters:
    
    theName - A String containing the name of the parameter for which you seek the definition. If a translation source exists, the authored name is translated, if specified.
    
    Returns:
    
    A VWParameterDefinition object representing the specified parameter. If a translation source exists, the translated parameter name is returned; otherwise, the authored parameter name is returned.
    
    Throws:
    
    VWException - Thrown if this method cannot get the named parameter definition from the set of parameter definitions stored in this operation definition.
    
    See Also:
    
    VWParameterDefinition
  - createParameter
```
public VWParameterDefinition createParameter(VWParameterDefinition theParameter)
                                      throws java.lang.Exception
```
    Creates a parameter definition object from another parameter definition object. The name of the parameter cannot match the name of any other parameter in this operation (VWOperationDefinition object).
    
    Parameters:
    
    theParameter - A VWParameterDefinition object to be created for this operation (VWOperationDefinition object).
    
    Returns:
    
    A new VWParameterDefinition object
    
    Throws:
    
    VWException - Thrown if this method cannot create a parameter definition object from another parameter definition object. In particular, a VWException will be thrown whenever the name of the passed-in VWParameterDefinition object is not unique among the VWParameterDefinitions for this VWOperation object.
    
    java.lang.Exception
    
    Since:
    
    IWWS1.10
    
    See Also:
    
    VWModeType, VWFieldType
  - deleteParameter
```
public void deleteParameter(java.lang.String theName)
                     throws java.lang.Exception
```
    Deletes a parameter.
    
    Parameters:
    
    theName - A String containing the name of the parameter.
    
    Throws:
    
    VWException - Thrown if this method cannot delete the parameter
    
    java.lang.Exception
    
    Since:
    
    IWWS1.10
  - getParameterDefinitions
```
public VWParameterDefinition[] getParameterDefinitions()
                                                throws VWException
```
    Gets the parameters of this operation. If a translation source exists, the authored names of the parameters are 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 VWParameterDefinition object array corresponding to the parameters of this operation. If a translation source exists, the translated parameter names are returned; otherwise, the authored parameter names are returned.
    
    Throws:
    
    VWException - Thrown if this method cannot get the parameters of this operation
    
    Since:
    
    IWWS1.10
  - getName
```
public java.lang.String getName()
```
    Returns the name of this operation. If a translation source exists, the authored name 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 of this operation, if a translation source exists; otherwise, the authored name is returned.
    
    Since:
    
    IWWS1.10
  - getDescription
```
public java.lang.String getDescription()
```
    Returns the description of this operation. If a translation source exists, the authored 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 of this operation, if a translation source exists; otherwise, the authored description is returned. If no description is found, null is returned.
    
    Since:
    
    IWWS1.10
  - setDescription
```
public void setDescription(java.lang.String theDescription)
                    throws VWException
```
    Sets the description of this operation.
    
    Parameters:
    
    theDescription - A String containing the new description of this operation. Valid return values include null.
    
    Throws:
    
    VWException - Thrown if this method cannot set the description of this operation
    
    Since:
    
    IWWS1.10
  - setName
```
public void setName(java.lang.String theName)
             throws VWException
```
    Sets the name of this operation.
    
    Parameters:
    
    theName - A String containing the new name of this operation
    
    Throws:
    
    VWException - Thrown if this method cannot set the name of this operation
    
    Since:
    
    IWWS1.10
  - getAttributeInfo
```
public VWAttributeInfo getAttributeInfo()
                                 throws VWException
```
    Gets a VWAttribute object containing attributes for this object, as paired labels (keywords) and values in String format.
    
    Returns:
    
    A VWAttribute object containing attributes for this object, as paired labels (keywords) and values in String format.
    
    Throws:
    
    VWException
    
    See Also:
    
    VWOperationDefinition.setAttributeInfo(filenet.vw.api.VWAttributeInfo)
  - setAttributeInfo
```
public void setAttributeInfo(VWAttributeInfo theAttributeInfo)
                      throws VWException
```
    Sets a VWAttribute object containing attributes for this object.
    
    Parameters:
    
    theAttributeInfo - A VWAttribute object containing attributes for this object, as paired labels (keywords) and values in String format.
    
    Throws:
    
    VWException
    
    See Also:
    
    VWOperationDefinition.getAttributeInfo()
  - toXML
```
public void toXML(java.lang.StringBuffer theBuffer)
           throws VWException
```
    Deprecated. Use VWXMLConfiguration.makeXMLBlock(IVWtoXML[]).
    
    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:
    
    VWXMLConfiguration
  - getSession
```
public VWSession getSession()
                     throws VWException
```
    Get the session associated with this operation definition. Interface method implemented from the IVWHasParameterDefs interface.
    
    Returns:
    
    The session associated with this operation definition, may return null.
    
    Throws:
    
    VWException

Methods inherited from class java.lang.Object

createParameter

getParameterDefinition

createParameter

deleteParameter

getParameterDefinitions

getName

getDescription

setDescription

setName

getAttributeInfo

setAttributeInfo

toXML

getSession