Process API

filenet.vw.api
Class VWWorkBasket.Filter

java.lang.Object
  extended by filenet.vw.api.VWWorkBasket.Filter
All Implemented Interfaces:
java.io.Serializable
Enclosing class:
VWWorkBasket

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

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

See Also:
Serialized Form

Method Summary
 VWAttributeInfo getAttributeInfo()
          Gets the workbasket filter attributes as paired labels (hashtable keys) and values in String format.
 java.lang.String getAuthoredName()
          Gets the original name of the workbasket filter.
 java.lang.String getDescription()
           
 java.lang.String getName()
          Gets the name of the workbasket filter.
 int getOperator()
          Gets the search field operator used for filtering.
 java.lang.String getPrompt()
          Gets the entry prompt assigned to the workbasket filter.
 int getType()
          Gets the field type assigned to the workbasket filter.
 java.lang.String toString()
          Gets a String representation of the filter information for the workbasket.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Method Detail

getOperator

public int getOperator()
                throws VWException
Gets the search field operator used for filtering.

Returns:
An integer indicating the operator used for filtering. The operators are defined in VWWorkBasketFilterDefinition.
Throws:
VWException
See Also:
VWWorkBasketFilterDefinition

getName

public java.lang.String getName()
                         throws VWException
Gets the name of the workbasket filter.

Returns:
A String containing the name currently assigned to the filter.
Throws:
VWException

getAuthoredName

public java.lang.String getAuthoredName()
                                 throws VWException
Gets the original name of the workbasket filter.

Returns:
A String containing the name originally assigned to the filter.
Throws:
VWException

getPrompt

public java.lang.String getPrompt()
                           throws VWException
Gets the entry prompt assigned to the workbasket filter. The prompt will be translated per the session locale.

Returns:
A String containing the text currently assigned as the entry prompt for the filter.
Throws:
VWException

getDescription

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

getType

public int getType()
            throws VWException
Gets the field type assigned to the workbasket filter.

Returns:
An integer representing the field type of the filter.
Throws:
VWException
See Also:
VWExposedFieldDefinition.getFieldType()

getAttributeInfo

public VWAttributeInfo getAttributeInfo()
                                 throws VWException
Gets the workbasket filter 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 filter.
Throws:
VWException

toString

public java.lang.String toString()
Gets a String representation of the filter information for the workbasket.

Overrides:
toString in class java.lang.Object
Returns:
A String containing the filter information for the workbasket.

Process API

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