|
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.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. 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 | |
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 String for the data field. The String is contained in the description property 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. |
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. |
java.lang.String |
toString()
Gets the name of the data field. |
void |
toXML(java.lang.StringBuffer theBuffer)
Appends an XML string that represents this VWFieldDefinition object to the buffer specified by the input parameter. |
void |
validate(VWSession theSession,
java.util.Vector EDefVector)
Updates the parameter EDefVector to contain any validation errors found in this session and VWFieldDefinition object. |
Methods inherited from class java.lang.Object |
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Method Detail |
public boolean getCanAssign()
public boolean isArray()
isArray
in interface IVWField
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()
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
VWFieldType
public java.lang.String toString()
toString
in class java.lang.Object
public java.lang.String getName()
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
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
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 toXML(java.lang.StringBuffer theBuffer) throws VWException
Warning: This XML string is non-extensible, and cannot be modified in any way.
theBuffer
- A string buffer that the method will append with
XML content.VWException
- VWXMLUtil
public void validate(VWSession theSession, java.util.Vector EDefVector) throws VWException
theSession
- This is the (logged on) session object.
If null, the system will not validate areas that require a logon.EDefVector
- A Vector that is updated with VWValidationErrors.
This method does not remove errors placed in this vector during previous
validation calls.VWException
- Thrown if this method is unable to validate this
VWFieldDefinition object.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |