filenet.vw.api

Class VWWorkBasketDefinition

java.lang.Object

filenet.vw.api.VWWorkBasketDefinition

All Implemented Interfaces:

IVWtoXML, java.io.Serializable, java.lang.Cloneable

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

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

Since:

p8 4.5.0

See Also:

Serialized Form

Method Summary

Modifier and Type	Method and Description
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.
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.
boolean	isShowWorkForAllUsers() This returns TRUE only if flag for Show Work For All Users is set for the WorkBasket.
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	setShowWorkForAllUsers(boolean setting) Sets the flag, Show Work For All Users, on the WorkBasket.
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) Deprecated. Use VWXMLConfiguration.makeXMLBlock(IVWtoXML[]).

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

getObjId

public int getObjId()
             throws VWException

Gets the object ID of the work basket definition.

Returns:

An integer indicating the object ID.

Throws:

VWException

Since:

P8 4.5.0

getRevision

public int getRevision()
                throws VWException

Gets the revision number of the work basket definition.

Returns:

An integer indicating the revision.

Throws:

VWException

Since:

P8 4.5.0

getName

public java.lang.String getName()
                         throws VWException

Gets the name assigned to the work basket definition.

Returns:

A String containing the name of the work basket definition.

Throws:

VWException

Since:

P8 4.5.0

getAuthoredName

public java.lang.String getAuthoredName()
                                 throws VWException

Gets the authored name assigned to the work basket definition.

Returns:

A String containing the authored name of the work basket definition.

Throws:

VWException

Since:

P8 4.5.0

setName

public void setName(java.lang.String theName)
             throws VWException

Sets the name of the work basket definition.

Parameters:

theName - A String containing the name of the work basket definition.

Throws:

VWException

Since:

P8 4.5.0

getDescription

public java.lang.String getDescription()
                                throws VWException

Gets the description of the work basket definition.

Returns:

A String containing the description.

Throws:

VWException

Since:

P8 4.5.0

setDescription

public void setDescription(java.lang.String description)
                    throws VWException

Sets the description of the work basket definition.

Parameters:

description - A String containing the description.

Throws:

VWException

Since:

P8 4.5.0

getQueueName

public java.lang.String getQueueName()
                              throws VWException

Gets the name of the queue associated with the work basket definition.

Returns:

A String containing the name of the queue.

Throws:

VWException

Since:

P8 4.5.0

getQueryFilterString

public java.lang.String getQueryFilterString()
                                      throws VWException

Gets the queue query filter string.

Returns:

A String containing the query filter.

Throws:

VWException

Since:

P8 4.5.0

setQueryFilterString

public void setQueryFilterString(java.lang.String queryFilter)
                          throws VWException

Sets the queue query filter string.

Parameters:

queryFilter - A String containing the new query filter.

Throws:

VWException

Since:

P8 4.5.0

getIndexName

public java.lang.String getIndexName()
                              throws VWException

Gets the search index assigned.

Returns:

A String containing the search index.

Throws:

VWException

Since:

P8 4.5.0

setIndexName

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

Sets the search index to use.

Parameters:

indexName - A String containing the name of the search index to use.

Throws:

VWException

Since:

P8 4.5.0

getWorkBasketColumnDefinition

public VWWorkBasketColumnDefinition getWorkBasketColumnDefinition(java.lang.String workBasketColumnName)
                                                           throws VWException

Gets the work basket column definition for the specified column.

Parameters:

workBasketColumnName - A String containing the name of the work basket column.

Returns:

A VWWorkBasketColumnDefinition object representing the specified column, or null if the work basket column definition is not found.

Throws:

VWException

Since:

P8 4.5.0

getWorkBasketColumnDefinitions

public VWWorkBasketColumnDefinition[] getWorkBasketColumnDefinitions()
                                                              throws VWException

Gets the work basket columns defined for the work basket definition.

Returns:

An array of VWWorkBasketColumnDefinition objects representing the columns, or null if no work basket column definitions are found.

Throws:

VWException

Since:

P8 4.5.0

createWorkBasketColumnDefinition

public VWWorkBasketColumnDefinition createWorkBasketColumnDefinition(java.lang.String prompt,
                                                                     VWExposedFieldDefinition column)
                                                              throws VWException

Create a new work basket column definition.

Parameters:

prompt - A String containing the entry prompt to assign to the column.

column - An VWExposedFieldDefinition object for the column to create.

Returns:

A VWWorkBasketColumnDefinition object representing the new column.

Throws:

VWException - Thrown if a work basket column definition of the specified name already exists.

Since:

P8 4.5.0

deleteWorkBasketColumnDefinition

public VWWorkBasketColumnDefinition deleteWorkBasketColumnDefinition(java.lang.String workBasketColumnName)
                                                              throws VWException

Removes the specified work basket column from the work basket definition.

Parameters:

workBasketColumnName - A String containing the name of the work basket column to be deleted.

Returns:

The VWWorkBasketColumnDefinition object for the work basket column removed.

Throws:

VWException - Thrown if the specified work basket column name is null or invalid.

Since:

P8 4.5.0

See Also:

VWWorkBasketColumnDefinition

setWorkBasketColumnDefinitions

public void setWorkBasketColumnDefinitions(VWWorkBasketColumnDefinition[] workBasketColumnDefs)
                                    throws VWException

Sets the work basket column definitions for the work basket definition.

Parameters:

workBasketColumnDefs - An array of VWWorkBasketColumnDefinition objects identifying the work basket columns that are to be defined for this work basket definition.

Throws:

VWException

Since:

P8 4.5.0

getWorkBasketFilterDefinition

public VWWorkBasketFilterDefinition getWorkBasketFilterDefinition(java.lang.String workBasketFilterName)
                                                           throws VWException

Gets the specified work basket filter definition.

Parameters:

workBasketFilterName - A String containing the name of the work basket filter definition.

Returns:

A VWWorkBasketFilterDefinition object for the specified work basket filter definition, or null if the work basket filter definition is not found.

Throws:

VWException

Since:

P8 4.5.0

getWorkBasketFilterDefinitions

public VWWorkBasketFilterDefinition[] getWorkBasketFilterDefinitions()
                                                              throws VWException

Gets the work basket filters defined for the work basket definition.

Returns:

An array of VWWorkBasketFilterDefinition objects, or null if no work basket filters are found.

Throws:

VWException

Since:

P8 4.5.0

createWorkBasketFilterDefinition

public VWWorkBasketFilterDefinition createWorkBasketFilterDefinition(java.lang.String workBasketFilterName)
                                                              throws VWException

Creates a new work basket filter definition.

Parameters:

workBasketFilterName - A String containing the name to assign to the work basket filter definition.

Returns:

A VWWorkBasketFilterDefinition object for the new work basket filter definition.

Throws:

VWException - if the work basket filter definition already exists

Since:

P8 4.5.0

deleteWorkBasketFilterDefinition

public VWWorkBasketFilterDefinition deleteWorkBasketFilterDefinition(java.lang.String workBasketFilterName)
                                                              throws VWException

Removes the specified work basket filter definition.

Parameters:

workBasketFilterName - A String containing the name of the work basket filter definition to be deleted.

Returns:

A VWWorkBasketFilterDefinition object for the work basket filter definition to be removed.

Throws:

VWException - Thrown if the specified work basket filter name is null or invalid.

Since:

P8 4.5.0

See Also:

VWWorkBasketFilterDefinition

createCopyOfWorkBasketFilterDefinition

public VWWorkBasketFilterDefinition createCopyOfWorkBasketFilterDefinition(java.lang.String workBasketFilterName,
                                                                           VWWorkBasketFilterDefinition origWorkBasketFilterDef)
                                                                    throws VWException

Creates a new work basket filter definition using the data from the specified work basket filter definition.

Parameters:

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.

Returns:

The VWWorkBasketDefinition object for the new work basket definition.

Throws:

VWException - Thrown if a work basket definition having the specified name already exists.

Since:

P8 4.5.0

setWorkBasketFilterDefinitions

public void setWorkBasketFilterDefinitions(VWWorkBasketFilterDefinition[] workBasketFilterDefs)
                                    throws VWException

Sets the work basket filter definitions for this work basket definition.

Parameters:

workBasketFilterDefs - An array of VWWorkBasketFilterDefinition objects identifying the work basket filters that are to be defined for this work basket definition.

Throws:

VWException

Since:

P8 4.5.0

getAttributeInfo

public VWAttributeInfo getAttributeInfo()
                                 throws VWException

Gets the work basket definition attributes as paired labels (hashtable keys) and values.

Returns:

A VWAttributeInfo object containing a hashtable of key (label) and value pairs representing the attributes for the work basket definition.

Throws:

VWException

Since:

P8 4.5.0

See Also:

VWWorkBasketDefinition.setAttributeInfo(filenet.vw.api.VWAttributeInfo)

setAttributeInfo

public void setAttributeInfo(VWAttributeInfo theAttributeInfo)
                      throws VWException

Sets the attributes property value for the work basket definition.

Parameters:

theAttributeInfo - A VWAttributeInfo object containing the string and value pairs representing the attributes for the role definition.

Throws:

VWException

Since:

P8 4.5.0

See Also:

VWWorkBasketDefinition.getAttributeInfo()

toString

public java.lang.String toString()

Gets the name of the work basket definition.

Overrides:

toString in class java.lang.Object

Returns:

A String containing the name of the work basket definition.

Since:

P8 4.5.0

toXML

public void toXML(java.lang.StringBuffer theBuffer)
           throws VWException

Deprecated. Use VWXMLConfiguration.makeXMLBlock(IVWtoXML[]).

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:

VWXMLConfiguration

isShowWorkForAllUsers

public boolean isShowWorkForAllUsers()

This returns TRUE only if flag for Show Work For All Users is set for the WorkBasket. This flag would allow the user of the WorkBasket to query for all items, not just those the user is bound. This flag is only useful for WorkBasket that are associated to a QUEUE_TYPE_USER_CENTRIC type queue.

Returns:

TRUE if ShowWorkForAllUsers is set to true, else false.

Since:

5.0.0.4

setShowWorkForAllUsers

public void setShowWorkForAllUsers(boolean setting)
                            throws VWException

Sets the flag, Show Work For All Users, on the WorkBasket. This flag would allow the user of the WorkBasket to query for all items, not just those the user is bound. This flag is only useful for WorkBasket that are associated to a QUEUE_TYPE_USER_CENTRIC type queue.

Parameters:

setting - - A boolean to set the ShowWorkForAllUsers flag, TRUE to allow user when querying all items in the Workbaskets associated queue, FALSE to only get items intended for the user.

Throws:

VWException

Since:

5.0.0.4