Process Class Relationships

filenet.vw.api
Class VWExposedFieldDefinition

java.lang.Object
  |
  +--filenet.vw.api.VWExposedFieldDefinition
All Implemented Interfaces:
java.lang.Cloneable, java.io.Serializable

public final class VWExposedFieldDefinition
extends java.lang.Object
implements java.io.Serializable, java.lang.Cloneable

Use this class to designate specific search fields for roster, queue, and log classes. To initially use this class, you must call methods from any of the following VWSystemConfiguration-derived classes:

Since:
VWWS3.10
See Also:
VWLogDefinition, VWQueueDefinition, VWRosterDefinition, VWSystemConfiguration, Serialized Form

Method Summary
 int getFieldSourceType()
          Gets the search data source field type.
 int getFieldType()
          Gets the search data field type.
 int getLength()
          Gets the byte length of string data to be stored in the database search data field.
 java.lang.String getName()
          Gets the string containing the name of the exposed data field.
 java.lang.String getSourceName()
          Gets the string containing the source name of the exposed data field.
 boolean isMandatorySystemField()
          Indicates whether the system data field is a mandatory or not.
 boolean isSystemField()
          Determines whether the data field is a system field.
 void setLength(int theLength)
          Sets the byte length of string data to be stored in the search data field.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

getFieldType

public int getFieldType()
Gets the search data field type. Basic data field types are:

In addition, the following values are possible:


getLength

public int getLength()
Gets the byte length of string data to be stored in the database search data field. The default value is 20 bytes. The length is valid only for the String data type.

setLength

public void setLength(int theLength)
               throws VWException
Sets the byte length of string data to be stored in the search data field. The length is valid only for the String data type.
Parameters:
theLength - An integer value that specifies the number of bytes to store in the database field.
Throws:
VWException - Thrown if the data field is a system field or if the data field type is not String.

getName

public java.lang.String getName()
Gets the string containing the name of the exposed data field.
Returns:
The name of the exposed data field.

isSystemField

public boolean isSystemField()
Determines whether the data field is a system field.
Returns:
A Boolean value: returns TRUE if the data field is a system field; FALSE if the data field is not a system field.

isMandatorySystemField

public boolean isMandatorySystemField()
Indicates whether the system data field is a mandatory or not.
Returns:
A Boolean value: returns TRUE if the data field is a mandatory system field; FALSE if the data field is not a mandatory system field.

getFieldSourceType

public int getFieldSourceType()
Gets the search data source field type.
Returns:
Returns an integer that represents the search data source field type. The integer values represent types as follows:

  • 1: ROSTER
  • 2: QUEUE
  • 3: LOG


getSourceName

public java.lang.String getSourceName()
Gets the string containing the source name of the exposed data field.
Returns:
The source name of the exposed data field.


Copyright © 2002, 2003 FileNet Corporation. All rights reserved.