Class ecm.widget.process.InbasketContainer

Extends dijit._Widget.
Provides a widget that is used to display the in-baskets that are associated with an IBM FileNet Process Engine role. Each in-basket is displayed in a ecm.widget.listView.ContentList widget that is contained in the InbasketTabContainer widget.
Defined in: <ecm\widget\process\InbasketContainer.js>.

Constructor Summary

Constructor Attributes	Constructor Name and Description
	ecm.widget.process.InbasketContainer()

Field Summary

Field Attributes	Field Name and Description
	contentLists An array of ecm.widget.listView.ContentList widgets for rendering the in-basket list.
	filterContainers An array of ecm.widget.process.InbasketFilterContainer widgets for rendering the filter criteria for each in-basket.
	repository A ecm.model.Repository object.
	selectedInbasket A ecm.model.ProcessInbasket object holding current selected in-basket information.

Method Summary

Method Attributes	Method Name and Description
	configureFilterArea(inbasket, index) Configures the filter criteria widget and creates a ecm.widget.process.InbasketFilterContainer widget.
	constructor()
	createInbasketTab(index) Creates a ecm.widget.listView.ContentList widget for the current in-basket tab.
	destroy()
	getInbasket(index) Returns an ecm.model.ProcessInbasket object from the specified index.
	getInbaskets() Returns an array of ecm.model.ProcessInbasket objects.
	getInbasketTabIndex(inbasket) Returns the `int` index value for the specified in-basket.
	getProcessRole() Returns an ecm.model.ProcessRole object that the in-baskets were retrieved from.
	getRepository() Returns a ecm.model.Repository object.
	getSelectedContentList() Returns a ecm.widget.listView.ContentList widget object that is currently selected.
	postCreate()
	refresh(filters) A function that refreshes the current in-basket work items list.
	resize() Function to resize the widget.
	retrieveResultSet(inbasket, index) Retrieves the in-basket result set list of work items.
	selectCurrentContentList() Selects the Tab in the tab container for the current selected content list.
	setInbaskets(inbaskets) Sets an array of ecm.model.ProcessInbasket objects.
	setMessage() Sets the status message on the desktop for the status widget (if displayed).
	setProcessRole(processRole) Sets the process role that the in-baskets will be retrieved from.
	setRepository(repository) Sets the repository.
	setSelectedContentList(selectedContentList) Sets the selected content list
	setSelectedIndex(index) Sets the selected in-basket index.
	setSelectedWorklist(worklist) Sets the selected work list.

Constructor Detail

ecm.widget.process.InbasketContainer()

Field Detail

contentLists

An array of ecm.widget.listView.ContentList widgets for rendering the in-basket list.

filterContainers

An array of ecm.widget.process.InbasketFilterContainer widgets for rendering the filter criteria for each in-basket.

repository

A ecm.model.Repository object.

selectedInbasket

A ecm.model.ProcessInbasket object holding current selected in-basket information.

Method Detail

configureFilterArea(inbasket, index)

Configures the filter criteria widget and creates a ecm.widget.process.InbasketFilterContainer widget.

Parameters:
inbasket: An ecm.model.ProcessInbasket object from which to get the filter criteria information.
index: An {Integer} value for the index of the content list. This value is used to connect the filter widget.

constructor()

createInbasketTab(index)

Creates a ecm.widget.listView.ContentList widget for the current in-basket tab.

Parameters:
index: An {Integer} value that specifies the index into the ContentList array at which to add a new list view (this is the same as the tab index).

destroy()

{ecm.model.ProcessInbasket} getInbasket(index)

Returns an ecm.model.ProcessInbasket object from the specified index.

Parameters:
index: An {Integer} value for the index of the in-basket to return.

Returns:: {ecm.model.ProcessInbasket}

{ecm.model.ProcessInbasket} getInbaskets()

Returns an array of ecm.model.ProcessInbasket objects.

Returns:: {ecm.model.ProcessInbasket} object array.

{Integer} getInbasketTabIndex(inbasket)

Returns the int index value for the specified in-basket. Returns -1 if not found.

Parameters:
inbasket: A ecm.model.ProcessInbasket object to look for in the list.

Returns:: {Integer} holding index value.

getProcessRole()

Returns an ecm.model.ProcessRole object that the in-baskets were retrieved from.

Returns:: An {ecm.model.ProcessRole} object.

{ecm.model.Repository} getRepository()

Returns a ecm.model.Repository object.

Returns:: {ecm.model.Repository}

{ecm.widget.listView.ContentList} getSelectedContentList()

Returns a ecm.widget.listView.ContentList widget object that is currently selected.

Returns:: {ecm.widget.listView.ContentList} widget

postCreate()

refresh(filters)

A function that refreshes the current in-basket work items list.

Parameters:
filters: An array of filter values to be used when retrieving the in-basket work items list.

resize()

Function to resize the widget.

retrieveResultSet(inbasket, index)

Retrieves the in-basket result set list of work items.

Parameters:
inbasket: A ecm.model.ProcessInbasket object to retrieve the work items result set from.
index: An {Integer} value for the index of the content list to add the result set items to.

selectCurrentContentList()

Selects the Tab in the tab container for the current selected content list.

setInbaskets(inbaskets)

Sets an array of ecm.model.ProcessInbasket objects.

Parameters:
inbaskets

setMessage()

Sets the status message on the desktop for the status widget (if displayed).

setProcessRole(processRole)

Sets the process role that the in-baskets will be retrieved from.

Parameters:
processRole: An ecm.model.ProcessRole object.

setRepository(repository)

Sets the repository.

Parameters:
repository: An ecm.model.Repository object.

setSelectedContentList(selectedContentList)

Sets the selected content list

Parameters:
selectedContentList: A ecm.widget.listView.ContentList widget

setSelectedIndex(index)

Sets the selected in-basket index.

Parameters:
index: An int value for the selected index.

setSelectedWorklist(worklist)

Sets the selected work list.

Parameters:
worklist: A ecm.model.Worklist object