Process API

filenet.vw.api
Interface IVWField

All Known Implementing Classes:
VWDataField, VWFieldDefinition, VWParameter

public interface IVWField

The IVWField class provides a definition for field values. Field values are used in VWDataField and VWFieldDefinition. The purpose of this interface is to provide a common set of methods for all VW objects which contain field values.

Since:
VWWS3.10
See Also:
VWFieldDefinition, VWDataField

Method Summary
 int getFieldType()
          Get the value of the field's fieldType property.
 java.lang.String getStringValue()
          Get the value from the field in String format.
 java.lang.Object getValue()
          Get the value from the field as a java Object.
 boolean isArray()
          Get the value of the isArray flag.
 void setValue(java.lang.Object theValue)
          Set the value of the field unless it is a read-only or system field.
 

Method Detail

getStringValue

java.lang.String getStringValue()
Get the value from the field in String format.

Returns:
a String representation of the value in the field
See Also:
VWFieldType

getValue

java.lang.Object getValue()
                          throws VWException
Get the value from the field as a java Object.

Returns:
the field value as a java Object. May return null if the internal string representation of the value cannot be converted into an object of the correct type. This may occur, for example, with a VWFieldDefinition object which has an expression like "AnotherFieldName + 2" as it's value. If this function returns null, the caller can still retrieve the internal string representation of the value using the getStringValue() method.
Throws:
VWException
See Also:
getStringValue(), VWFieldType

setValue

void setValue(java.lang.Object theValue)
              throws VWException
Set the value of the field unless it is a read-only or system field. If the field's type is array, cast the array to an Object when passing it to this method.

Parameters:
newValue - New value of the field
Throws:
VWException

isArray

boolean isArray()
Get the value of the isArray flag.

Returns:
'True' if the field is an array; 'false' otherwise.

getFieldType

int getFieldType()
Get the value of the field's fieldType property.

Returns:
The field's type.
See Also:
VWFieldType

Process API

© Copyright IBM Corporation 2002, 2008. All rights reserved.