Class ecm.model.ProcessInbasket

Extends ecm.model.Worklist.
Represents an in-basket that contains a list of work items for a specific user or role. This class is used only for an IBM FileNet P8 repository.
Defined in: <ecm\model\ProcessInbasket.js>.

Constructor Summary

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

Field Summary

Field Attributes	Field Name and Description
	addStepFilterInformation A {Boolean} setting for specifying that the step element query filter information to be added to the work item json used for further resolution when opening step elements
	attributes The user and system attributes (also known as properties) associated with this item.
	connectionPoint A string value defining the Process Engine connection point to use for this repository.
	fetchCount The fetch count of the queue associated with the in-basket.
	filterClass An instance of a ecm.model.ContentClass for the in-baskets filter criteria.
	filterValues An array of current filter criteria values to be used for retrieving the work items list
	mergeBoundUser A {Boolean} setting for specifying that the Process Engine system field F_BoundUser should be merged into a pseudo field called F_BoundUserName when displayed in in-basket column properties or in-basket filter controls.
	pageSize An int value holding the paging size to be used, will override the default setting
	parent An instance of ecm.model.ProcessRole for the parent process role.
	queryFilter A SQL WHERE clause used as a filter, and having place holder variables that are replaced by values in the substitutionVars parameter.
	queueName The queue name for the queue associated with the in-basket.
	queueType The queue type for the queue associated with the in-basket.
	substitutionVars An {Object} containing the values to substitute for the place holder variables specified in the SQL WHERE clause for the queryFilter parameter.

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

Method Summary

Method Attributes	Method Name and Description
	containsValue(attribute, value) Returns true if the item contains an attribute with the specified value.
	getAttributeFormat(attribute) Returns the format of the attribute.
	getAttributeType(attribute) Returns the type of the attribute.
	getValue(attribute) Returns the value for an attribute.
	getValues(attribute) Returns an array containing all the values of an attribute.
	hasAttribute(attribute) Returns true if the process role has the specified attribute.
	onRetrieveQueueItemsCompleted(resultSet) Fired after the page of work items from a specific queue has been returned from the server.
	onRetrieveWorkItemsCompleted(resultSet) Fired after the page of work items has been returned from the server.
	retrieveFilterCriteria(callback) Retrieves the in-basket filter criteria.
	retrieveQueueItems(callback, refresh, filters) Retrieves the queue items from the specified queue.
	retrieveWorkItems(callback, orderBy, descending, refresh, filters, queryFilter, substitutionVars, queryFlags) Retrieves the work items in the in-basket.

Methods borrowed from class ecm.model.Worklist:: continueWorkflow, onRefreshWorklist, refresh, removeWorkflow, resumeWorkflow, suspendWorkflow
Methods borrowed from class ecm.model._ModelObject:: destroy, onChange, own, toString

Constructor Detail

ecm.model.ProcessInbasket(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.Worklist.

Field Detail

addStepFilterInformation

A {Boolean} setting for specifying that the step element query filter information to be added to the work item json used for further resolution when opening step elements

Since:: 2.0.3.5

attributes

The user and system attributes (also known as properties) associated with this item. This is an object with field names being the symbolic names of the attributes and values being arrays containing:

value
value type
value format

connectionPoint

A string value defining the Process Engine connection point to use for this repository. (Optional)

This connection point overrides the connection point that is configured on this repository in the IBM Content Navigator administration tool.

fetchCount

The fetch count of the queue associated with the in-basket. Returns the total count of items from the work items query results. Not the total returned to the client, that number is controlled by paging block size. This is the overall total that the user would see if they paged through all items.

filterClass

An instance of a ecm.model.ContentClass for the in-baskets filter criteria.

filterValues

An array of current filter criteria values to be used for retrieving the work items list

mergeBoundUser

A {Boolean} setting for specifying that the Process Engine system field F_BoundUser should be merged into a pseudo field called F_BoundUserName when displayed in in-basket column properties or in-basket filter controls.

pageSize

An int value holding the paging size to be used, will override the default setting

parent

An instance of ecm.model.ProcessRole for the parent process role.

queryFilter

A SQL WHERE clause used as a filter, and having place holder variables that are replaced by values in the substitutionVars parameter. Fields used in the query filter should be based on exposed fields of the queue associated with the in-basket. (since 2.0.2)

queueName

The queue name for the queue associated with the in-basket.

queueType

The queue type for the queue associated with the in-basket.

substitutionVars

An {Object} containing the values to substitute for the place holder variables specified in the SQL WHERE clause for the queryFilter parameter. (since 2.0.2)

Method Detail

{Boolean} containsValue(attribute, value)

Returns true if the item contains an attribute with the specified value. For multi-valued attributes, the specified value is compared with all values of the attribute and this function will return true if the value is equal to any value of the multi-valued attribute.

Parameters:
attribute: The attribute identifier.
value: The value to test.

Returns:: {Boolean} true if this item contains the specified attribute value, false otherwise.

{String} getAttributeFormat(attribute)

Returns the format of the attribute.

Parameters:
attribute: The attribute name

Returns:: {String} The format of the attribute

{String} getAttributeType(attribute)

Returns the type of the attribute.

Parameters:
attribute: The attribute name

Returns:: {String} The type of the attribute

{Object} getValue(attribute)

Returns the value for an attribute.

Parameters:
attribute: The identifier of the attribute.

Returns:: {Object} holding value of the attribute

{Array} getValues(attribute)

Returns an array containing all the values of an attribute.

Parameters:
attribute: The identifier of the attribute.

Returns:: {Array} holding the attribute values

{Boolean} hasAttribute(attribute)

Returns true if the process role has the specified attribute.

Parameters:
attribute: The attribute identifier for the attribute to test.

Returns:: {Boolean} true if the specified attribute exists, false otherwise.

onRetrieveQueueItemsCompleted(resultSet)

Fired after the page of work items from a specific queue has been returned from the server.

Parameters:
resultSet

Since:: 2.0.2

onRetrieveWorkItemsCompleted(resultSet)

Fired after the page of work items has been returned from the server.

Parameters:
resultSet

Since:: 2.0.2

retrieveFilterCriteria(callback)

Retrieves the in-basket filter criteria. Creates an pseudo instance of a ecm.model.ContentClass for the criteria.

Parameters:
callback: A function invoked after the work items have been retrieved. It is passed an instance of a ecm.model.ContentClass object.

retrieveQueueItems(callback, refresh, filters)

Retrieves the queue items from the specified queue.

Parameters:
callback: A function invoked after the work items have been retrieved. An instance of ecm.model.ResultSet is passed to this function providing access to the work items.
refresh: A {Boolean} true value indicating whether we should use the previous sort by property and the descending setting.
filters: An {Object} holding the in-basket filter criteria to use when querying for the work items.

retrieveWorkItems(callback, orderBy, descending, refresh, filters, queryFilter, substitutionVars, queryFlags)

Retrieves the work items in the in-basket.

Parameters:
callback: A function invoked after the work items have been retrieved. An instance of ecm.model.ResultSet is passed to this function providing access to the work items.
orderBy: The attribute identifier for the attribute to order the items.
descending: If true, the items are ordered in descending order.
refresh: A {Boolean} true value indicating whether we should use the previous sort by property and the descending setting.
filters: An {Object} holding the in-basket filter criteria to use when querying for the work items.
queryFilter: A SQL WHERE clause used as a filter, and having place holder variables that are replaced by values in the substitutionVars parameter. Fields used in the query filter should be based on exposed fields of the queue associated with the in-basket. (since 2.0.2)
substitutionVars: An {Object} containing the values to substitute for the place holder variables specified in the SQL WHERE clause for the queryFilter parameter. (since 2.0.2)
queryFlags: An integer value specifying the query flag setting to use when retrieving the in-basket work items. (since 2.0.2)