Class ecm.model.Action

Extends ecm.model._ModelObject.
Represents a user-executable action. This action can be configured for a desktop in the IBM Content Navigator administration tool.
Defined in: <ecm\model\Action.js>.

Constructor Summary

Constructor Attributes	Constructor Name and Description
	ecm.model.Action(properties) Constructs an action.

Field Summary

Field Attributes	Field Name and Description
	action The name of the function within the action handler that handles this action.
	global Boolean value that is true if the action does not require an item.
	iconClass An icon cascading style sheet class to use for buttons or menu items representing this action.
	menuId The id of the menu that contains this action.
	menuType The type of the menu that contains this action.
	multiDoc Boolean value that is true if the action supports multiple items.
	pluginId If the action is provided by a plugin, this contains the id of the plugin.
	privileges An array of privileges that this action requires to be enabled.
	repositoryTypes A comma delimited string listing the repository types that this action supports.
	subActions If this action represents a submenu, this contains an array of action objects for the actions in the submenu.
	submenuId The id of the submenu if this action is contained by a submenu.

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

Method Summary

Method Attributes	Method Name and Description
	canPerformAction(repository, itemList, listType, teamspace, resultSet) Returns true if the action can be performed with the given repository and items.
	isEnabled(repository, listType, items, teamspace, resultSet) Returns true if this action is enabled for the given repository, list type, and items.
	isGlobalEnabled(resultSet, items, repository) Returns a boolean value indicating whether this action is enabled at the global scope
	isVisible(repository, items, repositoryTypes, teamspace) Returns true if this action should be visible for the given repository and items.
	performAction(repository, itemList, callback, teamspace, resultSet, parameterMap) Performs the action on the given repository and selected items.

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

Constructor Detail

ecm.model.Action(properties)

Constructs an action.

Parameters:
properties: The properties for the action. The properties can be any of the public fields defined below and on ecm.model._ModelObject.

Field Detail

action

The name of the function within the action handler that handles this action. See ecm.widget.layout.BaseActionHandler.

global

Boolean value that is true if the action does not require an item.

iconClass

An icon cascading style sheet class to use for buttons or menu items representing this action.

Since:: 2.0.3

menuId

The id of the menu that contains this action.

Since:: 2.0.3

menuType

The type of the menu that contains this action.

Since:: 2.0.3

multiDoc

Boolean value that is true if the action supports multiple items.

pluginId

If the action is provided by a plugin, this contains the id of the plugin.

privileges

An array of privileges that this action requires to be enabled.

repositoryTypes

A comma delimited string listing the repository types that this action supports. The complete list of repository types is: "cm,cmis,od,p8".

subActions

If this action represents a submenu, this contains an array of action objects for the actions in the submenu.

submenuId

The id of the submenu if this action is contained by a submenu.

Since:: 2.0.3

Method Detail

canPerformAction(repository, itemList, listType, teamspace, resultSet)

Returns true if the action can be performed with the given repository and items.

Parameters:
repository: A ecm.model.Repository object
itemList: An array of ecm.model.Item objects or derivations of Item object
listType: A string value indicating the type of object in the items list
teamspace: A ecm.model.Teamspace object (can be null).
resultSet: A ecm.model.ResultSet object (can be null)

isEnabled(repository, listType, items, teamspace, resultSet)

Returns true if this action is enabled for the given repository, list type, and items.

Parameters:
repository: A ecm.model.Repository object
listType: A string value indicating the type of object in the items list
items: An array of ecm.model.Item objects or derivations of Item object
teamspace: A ecm.model.Teamspace object (can be null).
resultSet: A ecm.model.ResultSet object (can be null)

isGlobalEnabled(resultSet, items, repository)

Returns a boolean value indicating whether this action is enabled at the global scope

Parameters:
resultSet: A ecm.model.ResultSet object
items: A array of ecm.model.Item objects or derivations if Item object
repository: A ecm.model.Repository object.

isVisible(repository, items, repositoryTypes, teamspace)

Returns true if this action should be visible for the given repository and items.

Parameters:
repository: A ecm.model.Repository object
items: An array of ecm.model.Item objects or derivations of Item object
repositoryTypes: An array of repository types.
teamspace

performAction(repository, itemList, callback, teamspace, resultSet, parameterMap)

Performs the action on the given repository and selected items.

Parameters:
repository: A ecm.model.Repository object
itemList: An array of ecm.model.Item objects or derivations of Item object
callback: A callback function to be called after the action has been performed
teamspace: A ecm.model.Teamspace object (can be null).
resultSet: A ecm.model.ResultSet object (can be null).
parameterMap: An array of extra parameters to be passed to the action (can be null).