filenet.vw.api

Class VWWorkBasket.Column

java.lang.Object

filenet.vw.api.VWWorkBasket.Column

All Implemented Interfaces:

java.io.Serializable

Enclosing class:

VWWorkBasket

public static final class VWWorkBasket.Column
extends java.lang.Object
implements java.io.Serializable

Represents a read-only, runtime column for the workbasket.

See Also:

Serialized Form

Method Summary

Modifier and Type	Method and Description
VWAttributeInfo	getAttributeInfo() Gets the workbasket column attributes as paired labels (hashtable keys) and values.
java.lang.String	getAuthoredName() Gets the original name of the workbasket column.
java.lang.String	getName() Gets the name of the workbasket column.
java.lang.String	getPrompt() Gets the entry prompt assigned to the workbasket column.
int	getType() Gets the field type assigned to the workbasket column.
boolean	isSortable() Indicates whether the workbasket column can be sorted.
java.lang.String	toString() Gets a String representation of the column information for the workbasket.

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 of the workbasket column.

Returns:

A String containing the name currently assigned to the column.

Throws:

VWException

getAuthoredName

public java.lang.String getAuthoredName()
                                 throws VWException

Gets the original name of the workbasket column.

Returns:

A String containing the name originally assigned to the column.

Throws:

VWException

getType

public int getType()
            throws VWException

Gets the field type assigned to the workbasket column.

Returns:

An integer representing the field type assigned to the column.

Throws:

VWException

See Also:

VWExposedFieldDefinition.getFieldType()

isSortable

public boolean isSortable()
                   throws VWException

Indicates whether the workbasket column can be sorted.

Returns:

A boolean value indicating whether the column can be sorted..

Throws:

VWException

getPrompt

public java.lang.String getPrompt()
                           throws VWException

Gets the entry prompt assigned to the workbasket column.

Returns:

A String containing the text currently assigned as the entry prompt for the column.

Throws:

VWException

toString

public java.lang.String toString()

Gets a String representation of the column information for the workbasket.

Overrides:

toString in class java.lang.Object

Returns:

A String containing the column information for the workbasket.

getAttributeInfo

public VWAttributeInfo getAttributeInfo()
                                 throws VWException

Gets the workbasket column 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 column.

Throws:

VWException