Process Class Relationships

filenet.vw.api
Class VWOperationDefinition

java.lang.Object
  |
  +--filenet.vw.api.VWOperationDefinition
All Implemented Interfaces:
java.lang.Cloneable, filenet.vw.api.IVWHasParameterDefs, java.io.Serializable

public final class VWOperationDefinition
extends java.lang.Object
implements java.io.Serializable, filenet.vw.api.IVWHasParameterDefs, java.lang.Cloneable

A VWOperationDefinition object specifies a function 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
 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.
 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.
 
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
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.
Specified by:
getParameterDefinition in interface filenet.vw.api.IVWHasParameterDefs
Parameters:
theName - A String containing the name of the parameter for which you seek the definition.
Returns:
A VWParameterDefinition object that represents the parameter named in the theName parameter.
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.
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
Since:
IWWS1.10

getParameterDefinitions

public VWParameterDefinition[] getParameterDefinitions()
                                                throws VWException
Gets the parameters of this operation.
Returns:
A VWParameterDefinition object array corresponding to the parameters of this operation
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.
Returns:
A String containing the name of this operation
Since:
IWWS1.10

getDescription

public java.lang.String getDescription()
Returns the description of this operation.
Returns:
A String containing the description of this operation. Valid return values include null.
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.
See Also:
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:
getAttributeInfo()

Process Class Relationships

Copyright © 2002 FileNET Corporation. All rights reserved.