|
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.VWParameterDefinition
Use this class to access the definition object for a parameter.
VWParameter
,
VWModeType
,
VWFieldType
,
VWFieldDefinition
, Serialized FormMethod 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 |
public int getMode()
VWModeType
public void setMode(int theMode) throws VWException
theMode
- An integer value used to set the mode
property of the parameter.VWException
- The method throws
an exception if the mode type specified in the theMode
parameter is invalid.VWModeType
,
VWException
public int getDataType()
VWFieldType
public void setDataType(int theDataType) throws VWException
theDataType
- An integer value used to set the
data type for the parameter.VWException
- The method throws an
exception if the type specified in the theDataType parameter
is not valid.VWFieldType
public boolean getIsArray()
public void setIsArray(boolean theIsArray)
theIsArray
- A Boolean value. Specify true to indicate
an array; otherwise, specify false.public java.lang.String getName()
public java.lang.String getValue()
public void setValue(java.lang.String theValue)
theValue
- The new value of the
parameter.public java.lang.String getDescription()
setDescription(String)
public void setDescription(java.lang.String theDescription)
theDescription
- The new
description for the parameter.public java.lang.String toString()
toString
in class java.lang.Object
public void toXML(java.lang.StringBuffer theBuffer) throws VWException
theBuffer
- A string buffer that this method will append with
XML content.VWException
- VWXMLUtil
public void validate(java.util.Vector EDefVector) throws VWException
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.VWException
- Thrown if this method cannot perform
its validation.
|
Process Class Relationships | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |