Process Class Relationships

filenet.vw.api
Class VWParameter

java.lang.Object
  |
  +--filenet.vw.api.VWParameter
All Implemented Interfaces:
IVWField

public final class VWParameter
extends java.lang.Object
implements IVWField

Use this class to access the parameter values for a step. Field types for these values are defined in the VWFieldType field summary.

Since:
VWWS3.10
See Also:
VWModeType, VWFieldType

Method Summary
 java.lang.String getDescription()
          Gets the description of the parameter.
 int getFieldType()
          Gets the field type for the parameter.
 int getMode()
          Gets the integer value for the mode property of the parameter.
 java.lang.String getName()
          Gets the name of the parameter.
 java.lang.String getStringValue()
          Converts the value of this parameter to a string.
 java.lang.Object getValue()
          Gets the value of the parameter.
 boolean isArray()
          Determines whether this parameter is of type array.
 boolean isSystemParameter()
          Indicates whether this parameter is of type "system parameter".
 void setValue(java.lang.Object theValue)
          Sets the value of this parameter, which is of one of the VWFieldType types.
 java.lang.String toString()
          Gets a string representation for the value of this parameter.
 void toXML(java.lang.StringBuffer theBuffer)
          Appends a description of this object's properties, formatted as an XML string, to the specified input buffer.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Method Detail

getFieldType

public int getFieldType()
Gets the field type for the parameter.
Specified by:
getFieldType in interface IVWField
Returns:
An integer value associated with the field type of the parameter.
See Also:
VWFieldType

getName

public java.lang.String getName()
Gets the name of the parameter.
Returns:
The parameter name.

getMode

public int getMode()
Gets the integer value for the mode property of the parameter.
Returns:
An integer value that indicates the mode of the step parameter. Valid modes are MODE_TYPE_IN (1), MODE_TYPE_OUT (2), or MODE_TYPE_IN_OUT (3).
See Also:
VWModeType

getDescription

public java.lang.String getDescription()
                                throws VWException
Gets the description of the parameter. The method makes a remote call (an RPC) to the server to retrieve the description.
Returns:
The description of this parameter.

getValue

public java.lang.Object getValue()
                          throws VWException
Gets the value of the parameter. The returned object is of one of the VWFieldType types. If its value is array then the returned object must be cast to the proper array type.
Specified by:
getValue in interface IVWField
Returns:
A VWFieldType object representing the value of the parameter.
See Also:
VWFieldType

isArray

public boolean isArray()
Determines whether this parameter is of type array.
Specified by:
isArray in interface IVWField
Returns:
A boolean value. The method returns true if the parameter is an array; otherwise, the method returns false.

isSystemParameter

public boolean isSystemParameter()
Indicates whether this parameter is of type "system parameter".
Returns:
A boolean value. The method returns true if the parameter is a system parameter; otherwise, the method returns false.

setValue

public void setValue(java.lang.Object theValue)
              throws VWException
Sets the value of this parameter, which is of one of the VWFieldType types. If the parameter type is array, you must cast the array to an object when passing it to the method.
Specified by:
setValue in interface IVWField
Parameters:
newValue - An object containing the new value of the parameter.
Throws:
VWException - The method throws an exception if the parameter specified has mode type MODE_TYPE_IN (1) or if the parameter is invalid.
See Also:
VWFieldType

getStringValue

public java.lang.String getStringValue()
Converts the value of this parameter to a string.
Specified by:
getStringValue in interface IVWField
Returns:
The value of this parameter.

toString

public java.lang.String toString()
Gets a string representation for the value of this parameter.
Overrides:
toString in class java.lang.Object
Returns:
The value of this parameter.

toXML

public void toXML(java.lang.StringBuffer theBuffer)
           throws VWException
Appends a description of this object's properties, formatted as an XML string, to the specified input buffer.

This description includes Name, Description, Type, IsSystemParameter Flag, Mode, IsArray Flag, and either parameter values or string representations of attachments.

Warning: This general list of properties currently contained in the appended string is subject to change without notice.

Parameters:
theBuffer - A string buffer that this method will append with XML content.
Throws:
VWException -  
See Also:
VWXMLUtil


Copyright © 2002, 2003 FileNet Corporation. All rights reserved.