|
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.VWDataField
Use this class to access a workflow object data field. Once you have
access to the field you can determine or set the field value, determine
the type, and determine if the field is an array. Use the Java type when
setting the value of a field.
Process Engine
and Visual Basic types map
to Java types in the following manner:
Java | * Process Engine | Visual Basic |
java.lang.Integer | VW_Integer | Long |
java.lang.Short | VW_Integer | Long |
java.lang.Float | VW_Float | Double |
java.lang.Float | VW_Double | Double |
java.lang.String | VW_String | String |
java.lang.Double | VW_Float | Double |
java.lang.Boolean | VW_Boolean | Integer |
java.util.Date | VW_Time | Long |
Java Object array (Object[]) | VW_Array | Variant |
The Java Object array (Object[]) can contain a heterogeneous collection of the basic types, mentioned above.
Call this class from the following:
VWFieldType
,
VWAttachment
Method Summary | |
int |
getFieldType()
Gets an integer value associated with a valid data field type. |
boolean |
getIsSystemField()
Determines if the field is a system field. |
boolean |
getIsWritable()
Determines if the field is editable (writable). |
int |
getMode()
Returns the integer value associated with the mode of the data field. |
java.lang.String |
getName()
Gets the long name of a field. |
java.lang.String |
getStringValue()
Gets the data field value as a String. |
java.lang.Object |
getValue()
Gets the value of a field as a valid field type object. |
boolean |
isArray()
Determines whether the data field is an array. |
void |
setValue(java.lang.Object newValue)
Sets the value of data contained in an editable field. Note If the field is an array, you can cast the array to an Object to pass it to this method. |
java.lang.String |
toString()
Gets the data field value as a String. |
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 boolean getIsSystemField()
public boolean getIsWritable()
public java.lang.String getName()
VWFieldType.isValidName( String )
for more information on field naming conventions.
public java.lang.Object getValue() throws VWException
isArray()
), cast
the returned value to the correct array type to access individual
elements.getValue
in interface IVWField
VWException
- VWFieldType
public boolean isArray()
isArray
in interface IVWField
public void setValue(java.lang.Object newValue) throws VWException
setValue
in interface IVWField
newValue
- An Object containing the new value for the field.VWException
- Causes include the following conditions:
public java.lang.String toString()
toString
in class java.lang.Object
public java.lang.String getStringValue()
getStringValue
in interface IVWField
public int getMode()
VWModeType
public void toXML(java.lang.StringBuffer theBuffer) throws VWException
This description includes Name, Type, IsSystemField Flag, Mode, IsArray Flag, and either field 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 |