|
Process API | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectfilenet.vw.api.VWFieldDefinition
public final class VWFieldDefinition
Use this class to access a field definition object, which is the authoring-time representation of a field in a workflow. VWFieldDefinition objects reside in VWWorkflowDefinition objects.
Workflow property values that are set at design time and workflow launch step parameters are not encoded/encrypted.
The name of a field definition must be unique within a workflow definition. The field can be one of the following:
VWException
,
VWMergeType
,
VWFieldType
,
VWWorkflowDefinition
,
VWParameterDefinition
,
VWParticipant
,
VWAttachment
,
IVWField
,
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. |
java.lang.Object |
clone()
Creates a clone of this VWFieldDefinition object. |
boolean |
getCanAssign()
Gets the value of the canAssign flag, which indicates whether or not this data field can be a left-hand value in an assignment statement. |
java.lang.String |
getDescription()
Gets the description of the data field. |
int |
getFieldType()
Gets the integer value that represents the field's field type. |
int |
getMergeType()
Gets the merge type property for the data field. |
java.lang.String |
getName()
Gets the String from the name property on the data field. |
java.lang.String |
getStringValue()
Gets the initial value of the field type definition in String format, converted from any valid field type. |
java.lang.Object |
getValue()
Gets the value of the field in the format of any valid field type, as a Java Object. |
java.lang.String |
getXMLSchemaElement()
Get the XML Schema Element. |
java.lang.String |
getXMLSchemaName()
Get the XML Schema Name. |
boolean |
isArray()
Gets the value of the isArray flag. |
void |
setDescription(java.lang.String theDescription)
Modifies the String containing the description for the data field. |
void |
setMergeType(int theMergeType)
Modifies the merge type property for the data field. |
void |
setName(java.lang.String theName)
Changes the data field name property. |
void |
setValue(java.lang.Object theValue)
Modifies the value of the field, ensuring that the field type of this field definition matches the field type of the input value. |
void |
setValue(java.lang.String theValue,
int theType,
boolean theIsArray)
Modifies the value of the data field with a String-formatted input to represent the value and an input field type. This method is especially useful for modifying a field value with an expression. |
void |
setXMLSchemaElement(java.lang.String theSchemaElement)
Set the XML Schema Element. |
void |
setXMLSchemaName(java.lang.String theSchemaName)
Set the XML Schema Name. |
java.lang.String |
toString()
Gets the name of the data field. |
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(VWSession theSession,
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 boolean getCanAssign()
public boolean isArray()
isArray
in interface IVWField
isArray
in interface filenet.vw.base.exprcomp.IField
public int getMergeType()
VWMergeType
public void setMergeType(int theMergeType) throws VWException
theMergeType
- A valid integer value that specifies a new
merge type for the data field.
VWException
- Thrown if the data field
merge type specified in the theMergeType parameter is not valid.VWMergeType
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).
public void setDescription(java.lang.String theDescription)
theDescription
- A String containing the new description
for the data field.public int getFieldType()
getFieldType
in interface IVWField
getFieldType
in interface filenet.vw.base.exprcomp.IField
VWFieldType
public java.lang.String toString()
toString
in class java.lang.Object
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).
getName
in interface filenet.vw.base.exprcomp.IField
public void setName(java.lang.String theName) throws VWException
theName
- A String containing the new name for the data
field.
VWException
- The method throws an
exception if one of the following conditions exist:
public java.lang.String getStringValue()
getStringValue
in interface IVWField
VWFieldType
public java.lang.Object getValue()
getValue
in interface IVWField
getValue
in interface filenet.vw.base.exprcomp.IField
Note If the method returns null, the internal String representation may still be obtained from the getStringValue() method.
VWFieldType
public void setValue(java.lang.Object theValue) throws VWException
setValue
in interface IVWField
setValue
in interface filenet.vw.base.exprcomp.IField
theValue
- An object used to specify the value property.
VWException
- Causes include situations in which
the input is an invalid type or null.VWFieldType
public void setValue(java.lang.String theValue, int theType, boolean theIsArray) throws VWException
theValue
- An expression providing a value for the
field, formatted as a String.theType
- The field data type of the String expression.theIsArray
- A boolean variable indicating whether or not
the String expression is an array.
VWException
- Causes include input that provides
an invalid field type or a null value.VWFieldType
public void setXMLSchemaName(java.lang.String theSchemaName) throws VWException
theSchemaName
- new schema name value for this XML field definition.
VWException
- if the field type of this field definition is not FIELD_TYPE_XMLpublic java.lang.String getXMLSchemaName() throws VWException
VWException
- if the field type of this field definition is not FIELD_TYPE_XMLpublic void setXMLSchemaElement(java.lang.String theSchemaElement) throws VWException
theSchemaElement
- A String containing the new schema element value for this XML field definition.
VWException
- if the field type of this field definition is not FIELD_TYPE_XML.public java.lang.String getXMLSchemaElement() throws VWException
VWException
- if the field type of this field definition is not FIELD_TYPE_XML.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(VWSession theSession, java.util.Vector EDefVector) throws VWException
theSession
- The current VWSession object if logged on. This is needed
for various parts of the validation process. This can be null; however, areas of validation requiring a
logon will not be validated.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.VWValidationError
public java.lang.Object clone()
VWFieldDefinition
object.
clone
in class java.lang.Object
|
Process API | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |