Class ecm.model.ProcessApplicationSpace

Extends ecm.model.WorklistFolder.
Represents a list of process roles that determine who can access a process application and who can use specific functionality within that application.
Defined in: <ecm\model\ProcessApplicationSpace.js>.

Constructor Summary

Constructor Attributes	Constructor Name and Description
	ecm.model.ProcessApplicationSpace()

Field Summary

Field Attributes	Field Name and Description
	auth_name A string value holding the original authored name of the application space (since 2.0.2.3).
	connectionPoint A string value defining the Process Engine connection point to use for this repository.

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

Method Summary

Method Attributes	Method Name and Description
	retrieveWorklists(callback, includeMembers, accessFlag, isBackgroundRequest, onError) Retrieves the process roles that are part of this application space.
	saveProcessRoles(roles, callback) Save the modification that have been made to the ProcessRole member ship from this application space.

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

Constructor Detail

ecm.model.ProcessApplicationSpace()

Field Detail

auth_name

A string value holding the original authored name of the application space (since 2.0.2.3). The displayed name can be altered with the Admin customized label settings.

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.

Method Detail

retrieveWorklists(callback, includeMembers, accessFlag, isBackgroundRequest, onError)

Retrieves the process roles that are part of this application space.

Parameters:

callback

A function that is invoked when the process roles have been retrieved. It is passed an array of ecm.model.ProcessRole objects.

includeMembers

A boolean flag indicating whether the role members should also be returned with each role. Default is false, no members will be returned.

accessFlag

A string value indicating what type of roles list to retrieve (optional). If not set (or null), will retrieve the roles the current user is a participant in. if set, values can be

"write" - Fetch only role names where the current user has Write permission to the application space
"read" - Fetch only role names where the current user has Write permission to the application space, or is a participant in any roles in the application space

isBackgroundRequest

A boolean flag indicating that this add request should be placed in a background process.

onError

A callback function called if there is an error returned when updating this item.

saveProcessRoles(roles, callback)

Save the modification that have been made to the ProcessRole member ship from this application space.

Parameters:
roles: An array of {Object} objects containing the role member values.
callback: A function that is called when the saving the application space roles has completed.