|
Process API | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectfilenet.vw.api.VWWorkBasketDefinition
public class VWWorkBasketDefinition
Use this class to create, read, delete, or modify work basket definition properties.
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. |
VWWorkBasketFilterDefinition |
createCopyOfWorkBasketFilterDefinition(java.lang.String workBasketFilterName,
VWWorkBasketFilterDefinition origWorkBasketFilterDef)
Creates a new work basket filter definition using the data from the specified work basket filter definition. |
VWWorkBasketColumnDefinition |
createWorkBasketColumnDefinition(java.lang.String prompt,
VWExposedFieldDefinition column)
Create a new work basket column definition. |
VWWorkBasketFilterDefinition |
createWorkBasketFilterDefinition(java.lang.String workBasketFilterName)
Creates a new work basket filter definition. |
VWWorkBasketColumnDefinition |
deleteWorkBasketColumnDefinition(java.lang.String workBasketColumnName)
Removes the specified work basket column from the work basket definition. |
VWWorkBasketFilterDefinition |
deleteWorkBasketFilterDefinition(java.lang.String workBasketFilterName)
Removes the specified work basket filter definition. |
VWAttributeInfo |
getAttributeInfo()
Gets the work basket definition attributes as paired labels (hashtable keys) and values in String format. |
java.lang.String |
getAuthoredName()
Gets the authored name assigned to the work basket definition. |
java.lang.String |
getDescription()
Gets the description of the work basket definition. |
java.lang.String |
getIndexName()
Gets the search index assigned. |
java.lang.String |
getName()
Gets the name assigned to the work basket definition. |
int |
getObjId()
Gets the object ID of the work basket definition. |
java.lang.String |
getQueryFilterString()
Gets the queue query filter string. |
java.lang.String |
getQueueName()
Gets the name of the queue associated with the work basket definition. |
int |
getRevision()
Gets the revision number of the work basket definition. |
VWWorkBasketColumnDefinition |
getWorkBasketColumnDefinition(java.lang.String workBasketColumnName)
Gets the work basket column definition for the specified column. |
VWWorkBasketColumnDefinition[] |
getWorkBasketColumnDefinitions()
Gets the work basket columns defined for the work basket definition. |
VWWorkBasketFilterDefinition |
getWorkBasketFilterDefinition(java.lang.String workBasketFilterName)
Gets the specified work basket filter definition. |
VWWorkBasketFilterDefinition[] |
getWorkBasketFilterDefinitions()
Gets the work basket filters defined for the work basket definition. |
void |
setAttributeInfo(VWAttributeInfo theAttributeInfo)
Sets the attributes property value for the work basket definition. |
void |
setDescription(java.lang.String description)
Sets the description of the work basket definition. |
void |
setIndexName(java.lang.String indexName)
Sets the search index to use. |
void |
setName(java.lang.String theName)
Sets the name of the work basket definition. |
void |
setQueryFilterString(java.lang.String queryFilter)
Sets the queue query filter string. |
void |
setWorkBasketColumnDefinitions(VWWorkBasketColumnDefinition[] workBasketColumnDefs)
Sets the work basket column definitions for the work basket definition. |
void |
setWorkBasketFilterDefinitions(VWWorkBasketFilterDefinition[] workBasketFilterDefs)
Sets the work basket filter definitions for this work basket definition. |
java.lang.String |
toString()
Gets the name of the work basket 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 |
---|
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 int getObjId() throws VWException
VWException
public int getRevision() throws VWException
VWException
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 of the work basket definition.
VWException
public java.lang.String getDescription() throws VWException
VWException
public void setDescription(java.lang.String description) throws VWException
description
- A String containing the description.
VWException
public java.lang.String getQueueName() throws VWException
VWException
public java.lang.String getQueryFilterString() throws VWException
VWException
public void setQueryFilterString(java.lang.String queryFilter) throws VWException
queryFilter
- A String containing the new query filter.
VWException
public java.lang.String getIndexName() throws VWException
VWException
public void setIndexName(java.lang.String indexName) throws VWException
indexName
- A String containing the name of the search index to use.
VWException
public VWWorkBasketColumnDefinition getWorkBasketColumnDefinition(java.lang.String workBasketColumnName) throws VWException
workBasketColumnName
- A String containing the name of the work basket column.
VWException
public VWWorkBasketColumnDefinition[] getWorkBasketColumnDefinitions() throws VWException
VWException
public VWWorkBasketColumnDefinition createWorkBasketColumnDefinition(java.lang.String prompt, VWExposedFieldDefinition column) throws VWException
prompt
- A String containing the entry prompt to assign to the column.column
- An VWExposedFieldDefinition object for the column to create.
VWException
- Thrown if a work basket column definition of the specified name already
exists.public VWWorkBasketColumnDefinition deleteWorkBasketColumnDefinition(java.lang.String workBasketColumnName) throws VWException
workBasketColumnName
- A String containing the name of the work basket column to
be deleted.
VWException
- Thrown if the specified work basket column name is null or invalid.VWWorkBasketColumnDefinition
public void setWorkBasketColumnDefinitions(VWWorkBasketColumnDefinition[] workBasketColumnDefs) throws VWException
workBasketColumnDefs
- An array of VWWorkBasketColumnDefinition objects identifying the
work basket columns that are to be defined for this work basket definition.
VWException
public VWWorkBasketFilterDefinition getWorkBasketFilterDefinition(java.lang.String workBasketFilterName) throws VWException
workBasketFilterName
- A String containing the name of the work basket filter definition.
VWException
public VWWorkBasketFilterDefinition[] getWorkBasketFilterDefinitions() throws VWException
VWException
public VWWorkBasketFilterDefinition createWorkBasketFilterDefinition(java.lang.String workBasketFilterName) throws VWException
workBasketFilterName
- A String containing the name to assign to the work basket filter
definition.
VWException
- if the work basket filter definition already existspublic VWWorkBasketFilterDefinition deleteWorkBasketFilterDefinition(java.lang.String workBasketFilterName) throws VWException
workBasketFilterName
- A String containing the name of the work basket filter definition
to be deleted.
VWException
- Thrown if the specified work basket filter name is null or invalid.VWWorkBasketFilterDefinition
public VWWorkBasketFilterDefinition createCopyOfWorkBasketFilterDefinition(java.lang.String workBasketFilterName, VWWorkBasketFilterDefinition origWorkBasketFilterDef) throws VWException
workBasketFilterName
- A String containing the name to use for the new work basket
definition.origWorkBasketFilterDef
- A VWWorkBasketFilterDefinition object representing the
work basket definition to copy.
VWException
- Thrown if a work basket definition having the specified name already
exists.public void setWorkBasketFilterDefinitions(VWWorkBasketFilterDefinition[] workBasketFilterDefs) throws VWException
workBasketFilterDefs
- An array of VWWorkBasketFilterDefinition objects identifying the
work basket filters that are to be defined for this work basket definition.
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 role 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 |