Process API

filenet.vw.api
Class VWWorkBasketFilterDefinition

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

public class VWWorkBasketFilterDefinition
extends java.lang.Object
implements java.io.Serializable, java.lang.Cloneable, IVWtoXML

Use this class to create, read, delete, or modify work basket filter definition properties.

Since:
P8 4.5.0
See Also:
Serialized Form

Field Summary
static int OPERATOR_EQUAL
          Value of 0 (zero).
static int OPERATOR_GREATER_THAN
          Value of 2.
static int OPERATOR_GREATER_THAN_OR_EQUAL
          Value of 3.
static int OPERATOR_LESS_THAN
          Value of 4.
static int OPERATOR_LESS_THAN_OR_EQUAL
          Value of 5.
static int OPERATOR_LIKE
          Value of 6.
static int OPERATOR_NOT_EQUAL
          Value of 1.
static int OPERATOR_NOT_LIKE
          Value of 7.
 
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 work basket filter definition attributes as paired labels (hash table keys) and values in String format.
 java.lang.String getAuthoredName()
          Gets the original name of the work basket filter definition.
 java.lang.String getDescription()
          Gets the description of the work basket filter definition.
 java.lang.String getName()
          Gets the current name of the work basket filter definition.
 int getOperator()
          Gets the operator applied to the search field used for filtering.
 java.lang.String getPrompt()
          Gets the prompt used for the work basket filter definition.
 VWExposedFieldDefinition getSearchField()
          Gets the search field used for filtering.
 int getType()
          Gets the field type used for the work basket filter field.
 void setAttributeInfo(VWAttributeInfo theAttributeInfo)
          Sets the attributes property value for the work basket filter definition.
 void setDescription(java.lang.String description)
          Sets the description to use for the work basket filter definition.
 void setName(java.lang.String theName)
          Sets the name for the work basket filter definition.
 void setOperator(int op)
          Sets the operator applied to the search field used for filtering.
 void setPrompt(java.lang.String label)
          Sets the prompt to use for the work basket filter definition.
 void setSearchField(VWExposedFieldDefinition field, int operator)
          Sets the search field used for filtering.
 java.lang.String toString()
          Gets the String version of this work basket filter 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
 

Field Detail

OPERATOR_EQUAL

public static final int OPERATOR_EQUAL
Value of 0 (zero). Applied to a search field used for filtering.

See Also:
setOperator(int), Constant Field Values

OPERATOR_NOT_EQUAL

public static final int OPERATOR_NOT_EQUAL
Value of 1. Applied to a search field used for filtering.

See Also:
setOperator(int), Constant Field Values

OPERATOR_GREATER_THAN

public static final int OPERATOR_GREATER_THAN
Value of 2. Applied to a search field used for filtering.

See Also:
setOperator(int), Constant Field Values

OPERATOR_GREATER_THAN_OR_EQUAL

public static final int OPERATOR_GREATER_THAN_OR_EQUAL
Value of 3. Applied to a search field used for filtering.

See Also:
setOperator(int), Constant Field Values

OPERATOR_LESS_THAN

public static final int OPERATOR_LESS_THAN
Value of 4. Applied to a search field used for filtering.

See Also:
setOperator(int), Constant Field Values

OPERATOR_LESS_THAN_OR_EQUAL

public static final int OPERATOR_LESS_THAN_OR_EQUAL
Value of 5. Applied to a search field used for filtering.

See Also:
setOperator(int), Constant Field Values

OPERATOR_LIKE

public static final int OPERATOR_LIKE
Value of 6. Applied to a search field used for filtering.

See Also:
setOperator(int), Constant Field Values

OPERATOR_NOT_LIKE

public static final int OPERATOR_NOT_LIKE
Value of 7. Applied to a search field used for filtering.

See Also:
setOperator(int), Constant Field Values
Method Detail

_get_FILE_DATE

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

Returns:
the file date

_get_FILE_AUTHOR

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

Returns:
the file author

_get_FILE_REVISION

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

Returns:
the file revision

getName

public java.lang.String getName()
                         throws VWException
Gets the current name of the work basket filter definition.

Returns:
A String containing the current name of the work basket filter.
Throws:
VWException
Since:
P8 4.5.0

getAuthoredName

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

Returns:
A String containing the original name of the work basket filter.
Throws:
VWException
Since:
P8 4.5.0

setName

public void setName(java.lang.String theName)
             throws VWException
Sets the name for the work basket filter definition.

Parameters:
theName - A String containing the name to assign to the work basket filter definition.
Throws:
VWException - Thrown if the name is null or invalid.
Since:
P8 4.5.0

getDescription

public java.lang.String getDescription()
                                throws VWException
Gets the description of the work basket filter definition.

Returns:
A String containing the description of the work basket filter definition.
Throws:
VWException
Since:
P8 4.5.0

setDescription

public void setDescription(java.lang.String description)
                    throws VWException
Sets the description to use for the work basket filter definition.

Parameters:
description - A String containing the description of the work basket filter definition.
Throws:
VWException
Since:
P8 4.5.0

getPrompt

public java.lang.String getPrompt()
                           throws VWException
Gets the prompt used for the work basket filter definition.

Returns:
A String containing the prompt for the work basket filter definition.
Throws:
VWException
Since:
P8 4.5.0

setPrompt

public void setPrompt(java.lang.String label)
               throws VWException
Sets the prompt to use for the work basket filter definition.

Parameters:
label - A String containing the prompt to use for the work basket filter definition.
Throws:
VWException
Since:
P8 4.5.0

getType

public int getType()
            throws VWException
Gets the field type used for the work basket filter field.

Returns:
An integer identifying the field type used.
Throws:
VWException
Since:
P8 4.5.0
See Also:
VWExposedFieldDefinition.getFieldType()

getSearchField

public VWExposedFieldDefinition getSearchField()
                                        throws VWException
Gets the search field used for filtering.

Returns:
A VWExposedFieldDefinition object identifying the search field used for filtering.
Throws:
VWException
Since:
P8 4.5.0

setSearchField

public void setSearchField(VWExposedFieldDefinition field,
                           int operator)
                    throws VWException
Sets the search field used for filtering.

Parameters:
field - A VWExposedFieldDefinition object representing the search field used for filtering. If this value is null, the search field is set to null and the operator defaults to OPERATOR_EQUAL.
operator - An integer indicating one of the following the search operators. Refer to the operators in Field Summary.
Throws:
VWException
Since:
P8 4.5.0

getOperator

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

Returns:
An integer indicating the operator used for filtering. Refer to the operators in Field Summary.
Throws:
VWException
Since:
P8 4.5.0

setOperator

public void setOperator(int op)
                 throws VWException
Sets the operator applied to the search field used for filtering.

Parameters:
op - An integer indicating the operator to use for filtering. Refer to the operators in Field Summary.
Throws:
VWException
Since:
P8 4.5.0

getAttributeInfo

public VWAttributeInfo getAttributeInfo()
                                 throws VWException
Gets the work basket filter definition attributes as paired labels (hash table keys) and values in String format.

Returns:
A VWAttributeInfo object containing a hash table of key (label) and value String pairs representing the attributes for the work basket filter 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 work basket filter definition.

Parameters:
theAttributeInfo - A VWAttributeInfo object containing the string and value pairs representing the attributes for the work basket filter definition.
Throws:
VWException
Since:
P8 4.5.0
See Also:
getAttributeInfo()

toString

public java.lang.String toString()
Gets the String version of this work basket filter definition.

Overrides:
toString in class java.lang.Object
Returns:
A String containing the name of this work basket filter definition.
Since:
P8 4.5.0

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.