Process Java API: VWWorkBasketColumnDefinition (Process API Documentation)

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

All Implemented Interfaces:

IVWtoXML, java.io.Serializable, java.lang.Cloneable
```
public final class VWWorkBasketColumnDefinition
extends java.lang.Object
implements java.io.Serializable, java.lang.Cloneable, IVWtoXML
```
Use this class to create, read, delete, or modify workbasket column definition properties.

Since:

P8 4.5.0

See Also:
Serialized Form

Method Summary

Methods
Modifier and Type	Method and Description
`VWAttributeInfo`	`getAttributeInfo()` Gets the workbasket column definition attributes as paired labels (hashtable keys) and values.
`java.lang.String`	`getAuthoredName()` Gets the name originally assigned to the workbasket column definition.
`VWExposedFieldDefinition`	`getColumn()` Gets the VWExposedFieldDefinition for the workbasket column definition.
`java.lang.String`	`getIndexName()`
`java.lang.String`	`getName()` Gets the current name for the workbasket column definition.
`java.lang.String`	`getPrompt()` Gets the prompt used for the workbasket column definition.
`int`	`getType()` Gets the field type used for the workbasket column field.
`boolean`	`isSortable()` Indicates whether or not the workbasket column can be sorted.
`void`	`setAttributeInfo(VWAttributeInfo theAttributeInfo)` Sets the attributes property value for the workbasket column definition.
`void`	`setColumn(VWExposedFieldDefinition column)` Sets the VWExposedFieldDefinition for the workbasket column definition.
`void`	`setIndexName(java.lang.String indexName)`
`void`	`setPrompt(java.lang.String thePrompt)` Sets the name for the workbasket column definition.
`void`	`setSortable(boolean bIsSortable)`
`java.lang.String`	`toString()` Gets the String version of this workbasket column definition.
`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
  - getName
```
public java.lang.String getName()
                         throws VWException
```
    Gets the current name for the workbasket column definition.
    
    Returns:
    A String containing the current name of the workbasket column definition.
    
    Throws:
    
    VWException
  - getAuthoredName
```
public java.lang.String getAuthoredName()
                                 throws VWException
```
    Gets the name originally assigned to the workbasket column definition.
    
    Returns:
    A String containing the original name of the workbasket column definition.
    
    Throws:
    
    VWException
  - getPrompt
```
public java.lang.String getPrompt()
                           throws VWException
```
    Gets the prompt used for the workbasket column definition.
    
    Returns:
    A String containing the prompt for the workbasket column definition.
    
    Throws:
    
    VWException
    Since:
    
    P8 4.5.0
  - setPrompt
```
public void setPrompt(java.lang.String thePrompt)
               throws VWException
```
    Sets the name for the workbasket column definition.
    
    Parameters:
    thePrompt - A String containing the name to assign to the workbasket column definition.
    
    Throws:
    
    VWException - Thrown if the name is null or invalid.
    Since:
    
    P8 4.5.0
  - isSortable
```
public boolean isSortable()
                   throws VWException
```
    Indicates whether or not the workbasket column can be sorted.
    
    Returns:
    A boolean value; where true indicates the workbasket column can be sorted, and false indicates it cannot be sorted.
    
    Throws:
    
    VWException
    Since:
    
    P8 4.5.0
  - setSortable
```
public void setSortable(boolean bIsSortable)
```
    Parameters:
    bIsSortable -
  - getType
```
public int getType()
            throws VWException
```
    Gets the field type used for the workbasket column field.
    
    Returns:
    An integer identifying the field type used.
    
    Throws:
    
    VWException
    Since:
    
    P8 4.5.0
    
    See Also:
    VWExposedFieldDefinition.getFieldType()
  - getColumn
```
public VWExposedFieldDefinition getColumn()
                                   throws VWException
```
    Gets the VWExposedFieldDefinition for the workbasket column definition.
    
    Returns:
    A VWExposedFieldDefinition object identifying the workbasket column definition.
    
    Throws:
    
    VWException
    Since:
    
    P8 4.5.0
  - setColumn
```
public void setColumn(VWExposedFieldDefinition column)
               throws VWException
```
    Sets the VWExposedFieldDefinition for the workbasket column definition.
    
    Parameters:
    column - A VWExposedFieldDefinition object identifying the workbasket column definition.
    
    Throws:
    
    VWException - Thrown for various causes.
    Since:
    
    P8 4.5.0
  - getIndexName
```
public java.lang.String getIndexName()
                              throws VWException
```
    Returns:
    The index name, if set. null otherwise.
    
    Throws:
    
    VWException - Thrown for various causes.
  - setIndexName
```
public void setIndexName(java.lang.String indexName)
                  throws VWException
```
    Parameters:
    indexName -
    
    Throws:
    
    VWException - Thrown for various causes.
  - getAttributeInfo
```
public VWAttributeInfo getAttributeInfo()
                                 throws VWException
```
    Gets the workbasket column definition attributes as paired labels (hashtable keys) and values.
    
    Returns:
    A VWAttributeInfo object containing a hashtable of key (label) and value pairs representing the attributes for the workbasket column definition.
    
    Throws:
    
    VWException
    Since:
    
    P8 4.5.0
    
    See Also:
    VWWorkBasketColumnDefinition.setAttributeInfo(filenet.vw.api.VWAttributeInfo)
  - setAttributeInfo
```
public void setAttributeInfo(VWAttributeInfo theAttributeInfo)
                      throws VWException
```
    Sets the attributes property value for the workbasket column definition.
    
    Parameters:
    theAttributeInfo - A VWAttributeInfo object containing the string and value pairs representing the attributes for the workbasket column definition.
    
    Throws:
    
    VWException
    Since:
    
    P8 4.5.0
    
    See Also:
    VWWorkBasketColumnDefinition.getAttributeInfo()
  - toString
```
public java.lang.String toString()
```
    Gets the String version of this workbasket column definition.
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    A String containing the name of this workbasket column definition.
  - 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.
    
    Specified by:
    
    toXML in interface IVWtoXML
    
    Parameters:
    theBuffer - A StringBuffer that will be appended with the XML content.
    
    Throws:
    
    VWException - Thrown if the specified buffer is null.
    Since:
    
    P8 4.5.0
    
    See Also:
    VWXMLConfiguration

Methods inherited from class java.lang.Object

getName

getAuthoredName

getPrompt

setPrompt

isSortable

setSortable

getType

getColumn

setColumn

getIndexName

setIndexName

getAttributeInfo

setAttributeInfo

toString

toXML