|
Process API | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectfilenet.vw.api.VWParameter
public final class 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 | |
---|---|
static java.lang.String |
_get_FILE_AUTHOR()
For FileNet internal use only, do not call. |
static java.lang.String |
_get_FILE_DATE()
For FileNet internal use only, do not call. |
static java.lang.String |
_get_FILE_REVISION()
For FileNet internal use only, do not call. |
java.lang.String |
getAuthoredName()
Gets the authored, untranslated name of the parameter. |
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 an XML string representing this instance to the buffer specified. |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Method Detail |
---|
public static java.lang.String _get_FILE_DATE()
public static java.lang.String _get_FILE_AUTHOR()
public static java.lang.String _get_FILE_REVISION()
public int getFieldType()
getFieldType
in interface IVWField
VWFieldType
public java.lang.String getName()
Note: The translation is done only at runtime, so will not appear in design-time applications (such as the Process Designer or Configuration Console).
public java.lang.String getAuthoredName() throws VWException
VWException
public int getMode()
VWModeType
public java.lang.String getDescription() throws VWException
Note: The translation is done only at runtime, so will not appear in design-time applications (such as the Process Designer or Configuration Console).
VWException
public java.lang.Object getValue() throws VWException
getValue
in interface IVWField
VWException
- Thrown when the parameter is not one of the specific field
types in VWFieldType.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
theValue
- 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
VWFieldType
public java.lang.String toString()
toString
in class java.lang.Object
public void toXML(java.lang.StringBuffer theBuffer) throws VWException
Warning: This XML string is nonextensible, and cannot be modified in any way.
theBuffer
- A StringBuffer that will be appended with the XML content.
VWException
- Thrown if the specified buffer is null.VWXMLUtil
|
Process API | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |