Class icm.base.BaseActionContext

Represents the context that is used for exchanging context information between a widget and actions. Widgets that leverage the IBM Case Manager action framework to provide toolbars or menus should implement this interface.
Defined in: <icm/base/BaseActionContext.js>.

Constructor Summary

Constructor Attributes	Constructor Name and Description
	icm.base.BaseActionContext() Constructs an interface for exchanging context information between a widget and actions.

Method Summary

Method Attributes	Method Name and Description
	cleanActionContext(ctx) Removes the specified action context.
	constructor()
	getActionContext(ctx) Gets the specified context object.
	setActionContext(ctx, ctxObj, append) Sets the context object.

Constructor Detail

icm.base.BaseActionContext()

Constructs an interface for exchanging context information between a widget and actions.

Method Detail

cleanActionContext(ctx)

Removes the specified action context.

Parameters:
{string} ctx: The name of the context that is to be removed.

constructor()

{object} getActionContext(ctx)

Gets the specified context object.

Parameters:
{string} ctx: The name of the context that is to be retrieved. If this parameter is null, the method returns the whole context object.

Returns:: {object} The context object. If no object matches the ctx parameter, the method returns a null value.

setActionContext(ctx, ctxObj, append)

Sets the context object. This method can replace an existing context object or append the specified content object to an existing context object array.

Parameters:
{string} ctx: The name of the context to be set.
{object} ctxObj: The context object that is to be set
{boolean} append: Set to true to append the context object to the context object array. Otherwise, the specified context replaces the existing context.