|
Process Class Relationships | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--filenet.vw.api.VWOperationDefinition
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.
VWParameter
,
VWParameterDefinition
,
VWModeType
,
VWFieldType
, Serialized FormMethod 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 |
public VWParameterDefinition createParameter(java.lang.String theName, int theMode, int theType, boolean theIsArray) throws java.lang.Exception
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.VWException
- Thrown if any of the
parameters passed to this function are invalidVWModeType
,
VWFieldType
public VWParameterDefinition getParameterDefinition(java.lang.String theName) throws VWException
getParameterDefinition
in interface filenet.vw.api.IVWHasParameterDefs
theName
- A String containing the name of the parameter
for which you seek the definition.VWException
- Thrown if this method cannot get the named
parameter definition from the set of parameter definitions stored
in this operation definition.VWParameterDefinition
public VWParameterDefinition createParameter(VWParameterDefinition theParameter) throws java.lang.Exception
theParameter
- A VWParameterDefinition object to be created for this
operation (VWOperationDefinition object).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.VWModeType
,
VWFieldType
public void deleteParameter(java.lang.String theName) throws java.lang.Exception
theName
- A String containing the name of the parameter.VWException
- Thrown if this method
cannot delete the parameterpublic VWParameterDefinition[] getParameterDefinitions() throws VWException
VWException
- Thrown if this method
cannot get the parameters of this operationpublic java.lang.String getName()
public java.lang.String getDescription()
public void setDescription(java.lang.String theDescription) throws VWException
theDescription
- A String containing the new description of this
operation. Valid return values include null.VWException
- Thrown if this method cannot
set the description of this operationpublic void setName(java.lang.String theName) throws VWException
theName
- A String containing the new name of this operationVWException
- Thrown if this method cannot
set the name of this operationpublic VWAttributeInfo getAttributeInfo() throws VWException
setAttributeInfo(filenet.vw.api.VWAttributeInfo)
public void setAttributeInfo(VWAttributeInfo theAttributeInfo) throws VWException
theAttributeInfo
- A VWAttribute object containing
attributes for this object, as paired labels (keywords) and
values in String format.VWException
- getAttributeInfo()
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |