Process API

filenet.vw.api
Class VWWorkBasketColumnDefinition

java.lang.Object
  extended by filenet.vw.api.VWWorkBasketColumnDefinition
All Implemented Interfaces:
IVWtoXML, java.io.Serializable, java.lang.Cloneable

public 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
static java.lang.String _get_FILE_AUTHOR()
          For FileNet internal use only, do not call.
static java.lang.String _get_FILE_DATE()
          For FileNet internal use only, do not call.
static java.lang.String _get_FILE_REVISION()
          For FileNet internal use only, do not call.
 VWAttributeInfo getAttributeInfo()
          Gets the workbasket column definition attributes as paired labels (hashtable keys) and values in String format.
 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)
          Gets 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)
          Appends an XML string representing this instance to the buffer specified.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Method Detail

_get_FILE_DATE

public static java.lang.String _get_FILE_DATE()
For FileNet internal use only, do not call.


_get_FILE_AUTHOR

public static java.lang.String _get_FILE_AUTHOR()
For FileNet internal use only, do not call.


_get_FILE_REVISION

public static java.lang.String _get_FILE_REVISION()
For FileNet internal use only, do not call.


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:
theName - 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)

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

Parameters:
A - VWExposedFieldDefinition object identifying the workbasket column definition.
Throws:
VWException
Since:
P8 4.5.0

getIndexName

public java.lang.String getIndexName()
                              throws VWException
Throws:
VWException

setIndexName

public void setIndexName(java.lang.String indexName)
                  throws VWException
Throws:
VWException

getAttributeInfo

public VWAttributeInfo getAttributeInfo()
                                 throws VWException
Gets the workbasket column definition attributes as paired labels (hashtable keys) and values in String format.

Returns:
A VWAttributeInfo object containing a hashtable of key (label) and value String pairs representing the attributes for the workbasket column definition.
Throws:
VWException
Since:
P8 4.5.0
See Also:
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:
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
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:
VWXMLUtil

Process API

© Copyright IBM Corporation 2002, 2008. All rights reserved.