Class ecm.model.Worklist

Extends ecm.model._ModelObject.
Represents a list of work items. For routing IBM Content Manager documents, this class represents an IBM Content Manager work list.
Defined in: <ecm\model\Worklist.js>.

Constructor Summary

Constructor Attributes	Constructor Name and Description
	ecm.model.Worklist(properties) Constructor

Field Summary

Field Attributes	Field Name and Description
	description A description to use for the work list.
	repository An instance of ecm.model.Repository for the repository containing or owning this work list.

Fields borrowed from class ecm.model._ModelObject:: categorization, id, isRecurring, name, nameFilter, pane, status, type, userId

Method Summary

Method Attributes	Method Name and Description
	continueWorkflow(workItems, callback) Perform the Continue action on a CM work item.
	onRefreshWorklist(worklist) Event fired when the worklist has been updated.
	refresh() Refresh the worklist
	removeWorkflow(workItems, callback) Perform the Remove action on a CM work item.
	resumeWorkflow(workItems, callback) Perform the Resume action on a CM work item.
	retrieveWorkItems(callback, orderBy, descending) Retrieve the work items in this worklist.
	suspendWorkflow(workItems, callback) Perform the Suspend action on a CM work item.

Methods borrowed from class ecm.model._ModelObject:: destroy, onChange, own, toString

Constructor Detail

ecm.model.Worklist(properties)

Constructor

Parameters:
properties: The properties for the model object. The properties can be any of the public fields as defined below and on ecm.model._ModelObject.

Field Detail

description

A description to use for the work list.

repository

An instance of ecm.model.Repository for the repository containing or owning this work list.

Method Detail

continueWorkflow(workItems, callback)

Perform the Continue action on a CM work item.

Parameters:
workItems: An array of ecm.model.WorkItem objects to be continued.
callback: A function that is called when the all work items have been continued.

onRefreshWorklist(worklist)

Event fired when the worklist has been updated.

Parameters:
worklist: A pointer to this ecm.model.Worklist object.

refresh()

Refresh the worklist

Since:: 2.0.3.5 LA002

removeWorkflow(workItems, callback)

Perform the Remove action on a CM work item.

Parameters:
workItems: An array of ecm.model.WorkItem objects to be removed.
callback: A function that is called when the all work items have been removed.

resumeWorkflow(workItems, callback)

Perform the Resume action on a CM work item.

Parameters:
workItems: An array of ecm.model.WorkItem objects to be resumed.
callback: A function that is called when the all work items have been resumed.

retrieveWorkItems(callback, orderBy, descending)

Retrieve the work items in this worklist.

Parameters:
callback: A function that is called when the work items have been retrieved. When the function is called, an instance of ecm.model.ResultSet is passed as a single argument which provides access to the work items.
orderBy: A string value indicating the column property to order the result set by.
descending: A boolean value indicating the direction of the sort. True is descending.

suspendWorkflow(workItems, callback)

Perform the Suspend action on a CM work item.

Parameters:
workItems: An array of ecm.model.WorkItem objects to be suspended.
callback: A function that is called when the all work items have been suspended.