Class icm.model._DesktopMixin

This class is mixed in to the main navigator Desktop object contained in the ecm.model.desktop property. This class provides some ICM specific functionality on the desktop object.
Defined in: <icm/model/_DesktopMixin.js>.

Constructor Summary

Constructor Attributes	Constructor Name and Description
	icm.model._DesktopMixin() Constructs the desktop mixin object.

Field Summary

Field Attributes	Field Name and Description
	currentRole The currently selected role in the application.
	currentSolution The currently selected solution in the application.
	customContext An object that can provide certain application defined context entries to be passed to the server when making certain requests such as requests that integrate with an external data service.

Method Summary

Method Attributes	Method Name and Description
	getSolution(TOS) Returns a particular solution object.
	retrieveSolutions(callback, tosName, errCallback, backgroundRequest) Retrieves the list of solutions that are applicable to this desktop.
	setCurrentSolutionAndRole(solution, role) Specifies the currently selected solution and role in the application.

Constructor Detail

icm.model._DesktopMixin()

Constructs the desktop mixin object. A desktop mixin object is typically constructed internally by the ICM application.

Field Detail

currentRole

The currently selected role in the application. setCurrentSolutionAndRole() should be called to set this member whenever the user selects a different solution or role.

This information may be provided as context when requests to the server are made.

currentSolution

The currently selected solution in the application. setCurrentSolutionAndRole() should be called to set this member whenever the user selects a different solution or role.

This information may be provided as context when requests to the server are made.

customContext

An object that can provide certain application defined context entries to be passed to the server when making certain requests such as requests that integrate with an external data service. This property defaults to an object with no properties. The application can add any properties it chooses to but the values of each of the properties should only be simple types. There are also some reserved keys used by ICM base code. Refer to the IBM Case Management documentation for the keys used by the base ICM code.

Method Detail

getSolution(TOS)

Returns a particular solution object. The solutions should be retrieved first by calling retrieveSolutions().

Parameters:

TOS

An object with the following properties

tos = Required. The symbolic name of the target object store containing the solution.
solutionName = Optional. Either this property or solutionPrefix must be specified. Specify solutionName to look up the solution by its name.
solutionPrefix = Optional. Either this property or solutionName or caseTypeName must be specified. Specify solutionPrefix to look up the solution by its prefix.
caseTypeName = Optional. Either this property or solutionName or solutionPrefix name must be specified. Specify caseTypeName to look up the solution by one of its case type name.

retrieveSolutions(callback, tosName, errCallback, backgroundRequest)

Retrieves the list of solutions that are applicable to this desktop. The applicable solutions are those that are stored in any repository that representing a target object store. The list of solutions is cached after it is retrieved.

Parameters:
callback: a function that is called when the retrieval is complete. If the list is already cached, then the function is called immediately. The function is passed an array of icm.model.Solution objects.
tosName: The name of the object store where the solutions are deployed.
errCallback: Callback function called when the request fails.
backgroundRequest: An optional argument. If true, indicates the request is processed in the background.

setCurrentSolutionAndRole(solution, role)

Specifies the currently selected solution and role in the application. This should be called whenever the user selects a different solution or role.

This information may be provided as context when requests to the server are made.

Parameters:
solution: icm.model.Solution object that represents the currently selected solution.
role: ecm.model.ProcessRole object that represents the currently selected role.