Class ecm.model.ProcessRole

Extends ecm.model.WorklistFolder.
Represents a role that is defined on an IBM FileNet P8 process server to specify who has access to process applications and who can use specific functionality within certain process applications. A process role also determines who has access to in-baskets that are defined in an application space.
Defined in: <ecm\model\ProcessRole.js>.

Constructor Summary

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

Field Summary

Field Attributes	Field Name and Description
	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.
	parent An instance of ecm.model.ProcessApplicationSpace for the parent application space.
	participants Returns an array of ecm.model.User or ecm.model.UserGroup objects.
	worklists Returns an array of ecm.model.ProcessInbasket objects.

Fields borrowed from class ecm.model.WorklistFolder:: 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.
	retrieveWorklists(callback, includeFetchCount) Retrieves the in-baskets that are associated with this process role.

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

Constructor Detail

ecm.model.ProcessRole(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.WorklistFolder.

Field Detail

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.

parent

An instance of ecm.model.ProcessApplicationSpace for the parent application space.

participants

Returns an array of ecm.model.User or ecm.model.UserGroup objects.

worklists

Returns an array of ecm.model.ProcessInbasket objects.

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.

retrieveWorklists(callback, includeFetchCount)

Retrieves the in-baskets that are associated with this process role.

Parameters:
callback: A function, invoked when the in-baskets have been retrieved. An array of ecm.model.ProcessInbasket objects are passed to the function.
includeFetchCount: A {Boolean} setting to specify whether to return the total fetch count for each in-basket. Default is false, no counts will be returned.