|
Process API | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectfilenet.vw.api.VWDataField
public final class 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 | |
---|---|
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 a field. |
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 this 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. |
java.lang.String |
toString()
Gets the data field value as a String. |
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 boolean getIsSystemField()
public boolean getIsWritable()
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).
VWFieldType.isValidName for more information on field
naming conventions.
public java.lang.String getAuthoredName() throws VWException
VWException
VWFieldType.isValidName
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
- Thrown when the parameter is not one of the specific field
types in VWFieldType.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()
Date/Time values returned are formatted using the format defined in VWFieldType.TIME_MASK
.
Prior releases used a long format (for example, "Sun Apr 17 04:00:00 PST 1977"). If you want
to continue to return date/time values in a long format, you can use code similar to the following:
if (vwDataField.getType == VWFieldType.FIELD_TYPEDEF_TIME32 || vwDataField.getType == VWFieldType.FIELD_TYPEDEF_TIME64) { Object fieldValue = vwDataField.getValue(); //java.util.Date if (fieldValue != null) { if (vwDataField.isArray()) stringValue = fieldValue.toString(); //long format else { stringValue = "{"; for (int nIndex = 0; nIndex < vwDataField.length; nIndex++) { stringValue += "\"" + fieldValue.toString() + "\""; } stringValue += "}"; } } }
getStringValue
in interface IVWField
VWFieldType
public int getMode()
VWModeType
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 |