Process Class Relationships

filenet.vw.api
Class VWParameterDefinition

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

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.

Since:
VWWS3.10
See Also:
VWParameter, VWModeType, VWFieldType, VWFieldDefinition, Serialized Form

Method Summary
 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 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 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)
          Appends an XML string that represents this VWParameterDefinition object to the buffer specified by the input parameter.
 void validate(java.util.Vector EDefVector)
          Validates this VWParameterDefinition object.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Method Detail

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. 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 the VWFieldType class for more information on data types.
Parameters:
theDataType - An integer value used to set the data type for the parameter.
Returns:
An integer value indicating the data type of the parameter.
Throws:
VWException - The method throws an exception if the type specified in the theDataType parameter is not valid.
See Also:
VWFieldType

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.
Returns:
The parameter name.

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)
Modifies the parameter value.
Parameters:
theValue - The new value of the parameter.

getDescription

public java.lang.String getDescription()
Gets the value of the description property.
Returns:
The description for the parameter.
See Also:
setDescription(String)

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
Appends an XML string that represents this VWParameterDefinition object to the buffer specified by the input parameter.
Parameters:
theBuffer - A string buffer that this method will append with XML content.
Throws:
VWException -  
See Also:
VWXMLUtil

validate

public void validate(java.util.Vector EDefVector)
              throws VWException
Validates this VWParameterDefinition object.
Parameters:
EDefVector - a Vector to which will be added any detected errors, represented as VWValidationError objects. The update does not remove VWValidationError objects from previous calls from the EDefVector.
Returns:
void: results are contained in the updated EDefVector parameter.
Throws:
VWException - Thrown if this method cannot perform its validation.

Process Class Relationships

Copyright © 2002 FileNET Corporation. All rights reserved.