|
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.VWParameter
Use this class to access the parameter values for a step. Field types for these values are defined in the VWFieldType field summary.
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 |
public int getFieldType()
getFieldType
in interface IVWField
VWFieldType
public java.lang.String getName()
public int getMode()
VWModeType
public java.lang.String getDescription() throws VWException
public java.lang.Object getValue() throws VWException
getValue
in interface IVWField
VWFieldType
public boolean isArray()
isArray
in interface IVWField
true
if the
parameter is an array; otherwise, the method returns false
.public boolean isSystemParameter()
true
if the
parameter is a system parameter; otherwise, the method
returns false
.public void setValue(java.lang.Object theValue) throws VWException
setValue
in interface IVWField
newValue
- An object containing the new value of the
parameter.VWException
- The method throws an exception if the
parameter specified has mode type MODE_TYPE_IN (1) or if
the parameter is invalid.VWFieldType
public java.lang.String getStringValue()
getStringValue
in interface IVWField
public java.lang.String toString()
toString
in class java.lang.Object
public void toXML(java.lang.StringBuffer theBuffer) throws VWException
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.
theBuffer
- A string buffer that this method will append with
XML content.VWException
- VWXMLUtil
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |