VWExposedFieldDefinition (Process API Documentation)

java.lang.Object
- filenet.vw.api.VWExposedFieldDefinition

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable
```
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:
- VWLogDefinition
- VWQueueDefinition
- VWRosterDefinition
Since:

VWWS3.10

See Also:

VWLogDefinition, VWQueueDefinition, VWRosterDefinition, VWSystemConfiguration, Serialized Form

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`java.lang.String`	`getAuthoredName()` Gets the authored, untranslated name of this exposed data field.
`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 the name of this instance.
`java.lang.String`	`getPrompt()` Gets the the prompt of this instance.
`java.lang.String`	`getSourceName()` Gets the source name of this instance.
`boolean`	`hasChanged()` Returns whether or not this exposed field has changed.
`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.
`void`	`setPrompt(java.lang.String thePrompt)` Sets the the prompt of this instance.
`java.lang.String`	`toString()` Gets the name of the data field.
`void`	`toXML(java.lang.StringBuffer theBuffer)` Deprecated. Use `VWXMLConfiguration.makeXMLBlock(IVWtoXML[])`.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Method Detail
  - getFieldType
```
public int getFieldType()
```
    Gets the search data field type.
    Basic data field types are:
    - 1: Integer (FIELD_TYPE_INT)
    - 2: String (FIELD_TYPE_STRING)
    - 4: Boolean (FIELD_TYPE_BOOLEAN)
    - 8: Float (FIELD_TYPE_FLOAT)
    - 16: Time (FIELD_TYPE_TIME)
    Returns:
    
    An integer referencing the field type.
  - 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.
    
    Returns:
    
    the length
  - 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 the name of this instance. If a translation source exists, the authored name of the field is translated.
    Note: The translation is done only at runtime, so will not appear in design-time applications (such as the Process Designer or Configuration Console).
    
    Returns:
    
    A String containing the translated name for this field, if a translation source exists; otherwise the authored name is returned.
  - toString
```
public java.lang.String toString()
```
    Gets the name of the data field.
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    
    A String containing the name of the data field.
  - getAuthoredName
```
public java.lang.String getAuthoredName()
                                 throws VWException
```
    Gets the authored, untranslated name of this exposed data field.
    
    Returns:
    
    A String containing the authored, untranslated name of this exposed data field.
    
    Throws:
    
    VWException
    
    Since:
    
    P8 4.0
  - 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.
  - hasChanged
```
public boolean hasChanged()
```
    Returns whether or not this exposed field has changed.
    
    Returns:
    
    'true' if this table has changed, 'false' otherwise
  - 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 source name of this instance. If a translation source exists, the authored source name of the field is translated.
    Note: The translation is done only at runtime, so will not appear in design-time applications (such as the Process Designer or Configuration Console).
    
    Returns:
    
    A String containing the translated source name for this field, if a translation source exists; otherwise the authored source name is returned.
  - toXML
```
public void toXML(java.lang.StringBuffer theBuffer)
           throws VWException
```
    Deprecated. Use VWXMLConfiguration.makeXMLBlock(IVWtoXML[]).
    
    Appends an XML string representing this instance to the buffer specified.
    Warning: This XML string is nonextensible, and cannot be modified in any way.
    
    Parameters:
    
    theBuffer - A StringBuffer that will be appended with the XML content.
    
    Throws:
    
    VWException - Thrown if the specified buffer is null.
    
    See Also:
    
    VWXMLConfiguration
  - getPrompt
```
public java.lang.String getPrompt()
```
    Gets the the prompt of this instance. If a translation source exists, the authored prompt of the field is translated.
    Note: The translation is done only at runtime, so will not appear in design-time applications (such as the Process Designer or Configuration Console).
    
    Returns:
    
    A String containing the translated prompt for this field, if a translation source exists; otherwise the authored prompt is returned.
  - setPrompt
```
public void setPrompt(java.lang.String thePrompt)
```
    Sets the the prompt of this instance.
    
    Parameters:
    
    thePrompt - prompt string for the exposed field.

Methods inherited from class java.lang.Object

getFieldType

getLength

setLength

getName

toString

getAuthoredName

isSystemField

isMandatorySystemField

hasChanged

getFieldSourceType

getSourceName

toXML

getPrompt

setPrompt