Process Class Relationships

filenet.vw.api
Class VWFieldDefinition

filenet.vw.api.VWFieldDefinition
All Implemented Interfaces:
IVWField, java.io.Serializable

public final class VWFieldDefinition
implements java.io.Serializable, IVWField

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:

Since:
VWWS3.10
See Also:
VWException, VWMergeType, VWFieldType, VWWorkflowDefinition, VWParameterDefinition, VWParticipant, VWAttachment, IVWField, Serialized Form

Method 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 valid 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.
 

Method Detail

getCanAssign

public 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. The canAssign flag is used only in VWFieldDefinitions returned from the server in a VWWorkflowSignature instance at runtime. The canAssign flag has no meaning at design time, and its value is not peristed in the XML (.pep) file.
Returns:
A boolean value: TRUE if the field can be a left-hand value in an assignment statement; FALSE if the field cannot be a left-hand value in an assignment statement.

isArray

public boolean isArray()
Gets the value of the isArray flag. Determines whether or not the data field is an array.
Specified by:
isArray in interface IVWField
Returns:
A boolean value. The method returns true if the field is an array; otherwise the method returns false.

getMergeType

public int getMergeType()
Gets the merge type property for the data field.
Returns:
The integer value associated with the merge type.
See Also:
VWMergeType

setMergeType

public void setMergeType(int theMergeType)
                  throws VWException
Modifies the merge type property for the data field.
Parameters:
theMergeType - A valid integer value that specifies a new merge type for the data field.
Throws:
VWException - Thrown if the data field merge type specified in the theMergeType parameter is not valid.
See Also:
VWMergeType

getDescription

public java.lang.String getDescription()
Gets the description String for the data field. The String is contained in the description property of the data field.
Returns:
A String containing the description of the data field.

setDescription

public void setDescription(java.lang.String theDescription)
Modifies the String containing the description for the data field. The method modifies the description property on the data field.
Parameters:
theDescription - A String containing the new description for the data field.

getFieldType

public int getFieldType()
Gets the integer value that represents the field's field type.
Specified by:
getFieldType in interface IVWField
Returns:
An integer value indicating the data field type.
See Also:
VWFieldType

toString

public java.lang.String toString()
Gets the name of the data field.
Returns:
A String containing the localized name of the data field.

getName

public java.lang.String getName()
Gets the String from the name property on the data field.
Returns:
A String containing the value of the name property.

setName

public void setName(java.lang.String theName)
             throws VWException
Changes the data field name property.
Parameters:
theName - A String containing the new name for the data field.
Throws:
VWException - The method throws an exception if one of the following conditions exist:

  • The field name is null or has a length of zero (0).
  • The field name is a duplicate of an existing field.
  • The field name is invalid because it either contains more than 31 characters, begins with a character other than a letter, or contains an invalid character (not a number, letter or underscore) as part of the name.

getStringValue

public java.lang.String getStringValue()
Gets the initial value of the field type definition in String format, converted from any valid field type.
Specified by:
getStringValue in interface IVWField
Returns:
The value of the data field, represented in String format.
See Also:
VWFieldType

getValue

public java.lang.Object getValue()
Gets the value of the field in the format of any valid field type, as a Java Object.
Specified by:
getValue in interface IVWField
Returns:
A Java object; null if the internal String cannot be converted into an object--for example, if the field is an arithmetic expresson.

Note If the method returns null, the internal String representation may still be obtained from the getStringValue() method.

See Also:
VWFieldType

setValue

public void setValue(java.lang.Object theValue)
              throws VWException
Modifies the value of the field, ensuring that the field type of this field definition matches the field type of the input value.
Specified by:
setValue in interface IVWField
Parameters:
theValue - An object used to specify the value property.
Throws:
VWException - Causes include situations in which the input is an invalid type or null.
See Also:
VWFieldType

setValue

public void setValue(java.lang.String theValue,
                     int theType,
                     boolean theIsArray)
              throws VWException
Modifies the value of the data field with a String-formatted input to represent the value and an input valid field type. This method is especially useful for modifying a field value with an expression.
Parameters:
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.
Throws:
VWException - Causes include input that provides an invalid field type or a null value.
See Also:
VWFieldType

toXML

public void toXML(java.lang.StringBuffer theBuffer)
           throws VWException
Appends an XML string that represents this VWFieldDefinition object to the buffer specified by the input parameter.
Parameters:
theBuffer - A string buffer that the method will append with XML content.
Throws:
VWException -  
See Also:
VWXMLUtil

validate

public void validate(VWSession theSession,
                     java.util.Vector EDefVector)
              throws VWException
Updates the parameter EDefVector to contain any validation errors found in this session and VWFieldDefinition object.
Parameters:
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.
Throws:
VWException - Thrown if this method is unable to validate this VWFieldDefinition object.

Process Class Relationships

Copyright © 2002 FileNET Corporation. All rights reserved.