|
Process API | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectfilenet.vw.api.VWParameterDefinition
public final class VWParameterDefinition
Use this class to access the definition object for a parameter.
Workflow property values that are set at design time and workflow launch step parameters are not encoded/encrypted.
VWParameter
,
VWModeType
,
VWFieldType
,
VWFieldDefinition
,
Serialized FormMethod 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. |
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 |
setName(java.lang.String theName)
Renames this 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 representing this instance to the buffer specified. |
void |
toXPDL(java.lang.String indentA,
java.lang.StringBuffer theBuffer)
Appends an XPDL string representing this instance to the buffer specified. |
void |
validate(java.util.Vector EDefVector)
Validates this instance, appending any validation errors found to the specified Vector object. |
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 void setName(java.lang.String theName) throws VWException
theName
- The new name for this parameter.
VWException
- Causes include invalid name
format or duplication of another parameter name.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()
true
if the
parameter is an array; otherwise, the method returns false
.public void setIsArray(boolean theIsArray)
theIsArray
- A boolean value. Specify true
to indicate
an array; otherwise, specify false
.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 getValue()
public void setValue(java.lang.String theValue) throws VWException
theValue
- The new value of the parameter.
VWException
- Causes include setting a null value for
a step definition parameter.public java.lang.String getDescription()
Note: The translation is done only at runtime, so will not appear in design-time applications (such as the Process Designer or Configuration Console).
setDescription
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
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
public void toXPDL(java.lang.String indentA, java.lang.StringBuffer theBuffer) throws VWException
Warning: This XPDL string is nonextensible, and cannot be modified in any way.
indentA
- A String specifying the initial indentation for this XPDL section.theBuffer
- A StringBuffer that will be appended with the XPDL content.
VWException
- Thrown if the specified buffer is null.VWXMLUtil
public void validate(java.util.Vector EDefVector) throws VWException
EDefVector
- A Vector to which will be added a VWValidationError object for each validation
error found. This can be null; in this case, a new Vector is used.
Note: Because validate methods having EDefVector in the signature also occur on other classes, the existing Vector can contain validation errors from previous validation calls.
VWException
- Thrown if an error occurs during the validation.
|
Process API | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |