|
Process API | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectfilenet.vw.api.VWWorkBasketFilterDefinition
public class VWWorkBasketFilterDefinition
Use this class to create, read, delete, or modify work basket filter definition properties.
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 |
---|
public static final int OPERATOR_EQUAL
setOperator(int)
,
Constant Field Valuespublic static final int OPERATOR_NOT_EQUAL
setOperator(int)
,
Constant Field Valuespublic static final int OPERATOR_GREATER_THAN
setOperator(int)
,
Constant Field Valuespublic static final int OPERATOR_GREATER_THAN_OR_EQUAL
setOperator(int)
,
Constant Field Valuespublic static final int OPERATOR_LESS_THAN
setOperator(int)
,
Constant Field Valuespublic static final int OPERATOR_LESS_THAN_OR_EQUAL
setOperator(int)
,
Constant Field Valuespublic static final int OPERATOR_LIKE
setOperator(int)
,
Constant Field Valuespublic static final int OPERATOR_NOT_LIKE
setOperator(int)
,
Constant Field ValuesMethod Detail |
---|
public static java.lang.String _get_FILE_DATE()
public static java.lang.String _get_FILE_AUTHOR()
public static java.lang.String _get_FILE_REVISION()
public java.lang.String getName() throws VWException
VWException
public java.lang.String getAuthoredName() throws VWException
VWException
public void setName(java.lang.String theName) throws VWException
theName
- A String containing the name to assign to the work basket filter definition.
VWException
- Thrown if the name is null or invalid.public java.lang.String getDescription() throws VWException
VWException
public void setDescription(java.lang.String description) throws VWException
description
- A String containing the description of the work basket filter definition.
VWException
public java.lang.String getPrompt() throws VWException
VWException
public void setPrompt(java.lang.String label) throws VWException
label
- A String containing the prompt to use for the work basket filter definition.
VWException
public int getType() throws VWException
VWException
VWExposedFieldDefinition.getFieldType()
public VWExposedFieldDefinition getSearchField() throws VWException
VWException
public void setSearchField(VWExposedFieldDefinition field, int operator) throws VWException
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.
VWException
public int getOperator() throws VWException
VWException
public void setOperator(int op) throws VWException
op
- An integer indicating the operator to use for filtering. Refer to the operators in
Field Summary.
VWException
public VWAttributeInfo getAttributeInfo() throws VWException
VWException
setAttributeInfo(filenet.vw.api.VWAttributeInfo)
public void setAttributeInfo(VWAttributeInfo theAttributeInfo) throws VWException
theAttributeInfo
- A VWAttributeInfo object containing the string and value pairs representing the
attributes for the work basket filter definition.
VWException
getAttributeInfo()
public java.lang.String toString()
toString
in class java.lang.Object
public void toXML(java.lang.StringBuffer theBuffer) throws VWException
Warning: This XML string is nonextensible, and cannot be modified in any way.
toXML
in interface IVWtoXML
theBuffer
- A StringBuffer that will be appended with the XML content.
VWException
- Thrown if the specified buffer is null.VWXMLUtil
|
Process API | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |