VWRegionFieldDefinition (Process API Documentation)

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

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable
```
public final class VWRegionFieldDefinition
extends java.lang.Object
implements java.io.Serializable, java.lang.Cloneable
```
Use this class to create, read, delete, or modify Region Field definition properties.

Since:

CPE 5.2.0.3

See Also:

Serialized Form

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.lang.String`	`getAuthoredName()` Gets the authored name assigned to the region field definition.
`java.lang.String`	`getDescription()` Gets the description of the region field definition.
`int`	`getFieldType()` Gets the integer value that represents the region field's field type.
`java.lang.String`	`getName()` Gets the name assigned to the region field definition.
`java.lang.Object`	`getValue()` Gets the value of a field as a valid field type object.
`boolean`	`isArray()` Determines whether the region field is an array.
`void`	`setDescription(java.lang.String description)` Sets the description of the region field definition.
`void`	`setValue(java.lang.Object theValue)` Sets or modifies the value of the field, ensuring that the field type of this field definition matches the field type of the input value.
`java.lang.String`	`toString()` Gets the name of the region field definition.

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

- Method Detail
  - getName
```
public java.lang.String getName()
                         throws VWException
```
    Gets the name assigned to the region field definition. If a translated version exists, that version is returned.
    
    Returns:
    
    A String containing the name of the region field definition.
    
    Throws:
    
    VWException - Thrown for various reasons.
    
    Since:
    
    CPE 5.2.0.3
  - getAuthoredName
```
public java.lang.String getAuthoredName()
                                 throws VWException
```
    Gets the authored name assigned to the region field definition.
    
    Returns:
    
    A String containing the authored name of the region field definition.
    
    Throws:
    
    VWException - Thrown for various reasons.
    
    Since:
    
    CPE 5.2.0.3
  - getDescription
```
public java.lang.String getDescription()
                                throws VWException
```
    Gets the description of the region field definition.
    
    Returns:
    
    A String containing the description.
    
    Throws:
    
    VWException - Thrown for various reasons.
    
    Since:
    
    CPE 5.2.0.3
  - setDescription
```
public void setDescription(java.lang.String description)
                    throws VWException
```
    Sets the description of the region field definition.
    
    Parameters:
    
    description - A String containing the description.
    
    Throws:
    
    VWException - Thrown for various reasons.
    
    Since:
    
    CPE 5.2.0.3
  - getFieldType
```
public int getFieldType()
```
    Gets the integer value that represents the region field's field type.
    
    Returns:
    
    An integer value indicating the region field type.
    
    Since:
    
    CPE 5.2.0.3
    
    See Also:
    
    VWFieldType.getVWFieldType(Object)
  - setValue
```
public void setValue(java.lang.Object theValue)
              throws VWException
```
    Sets or modifies the value of the field, ensuring that the field type of this field definition matches the field type of the input value. An array value must have at least 1 element, cannot be sparse, and all entries of the array must of the same type.
    
    Parameters:
    
    theValue - An object used to specify the value property. The five basic types are excepted: String, Boolean, Integer, Double(float), java.util.Date (time). Arrays of these five basic types are acceptable.
    
    Throws:
    
    VWException - Throws for various reasons, including situations in which the input is an invalid type or null.
    
    Since:
    
    CPE 5.2.0.3
    
    See Also:
    
    VWFieldType.getVWFieldType(Object)
  - getValue
```
public java.lang.Object getValue()
                          throws VWException
```
    Gets the value of a field as a valid field type object. If this value is an array (testable with VWRegionFieldDefinition.isArray()), cast the returned value to the correct array type to access individual elements.
    
    Returns:
    
    The value contained in the region field or null if the type is invalid.
    
    Throws:
    
    VWException - Thrown when an error occurs retrieving the field value.
    
    Since:
    
    CPE 5.2.0.3
    
    See Also:
    
    VWFieldType.getVWFieldType(Object)
  - isArray
```
public boolean isArray()
```
    Determines whether the region field is an array.
    
    Returns:
    
    true if the region field is an array; false otherwise.
    
    Since:
    
    CPE 5.2.0.3
  - toString
```
public java.lang.String toString()
```
    Gets the name of the region field definition.
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    
    A String containing the name of the region field definition.
    
    Since:
    
    CPE 5.2.0.3

Methods inherited from class java.lang.Object

getName

getAuthoredName

getDescription

setDescription

getFieldType

setValue

getValue

isArray

toString