com.ibm.ecm.extension

Class PluginOpenAction

java.lang.Object

com.ibm.ecm.extension.PluginOpenAction

public abstract class PluginOpenAction
extends java.lang.Object

Defines an action, which will override default action for a MIME type or MIME class. By default, when a user double-clicks a document in the browse list view, or executes the Open action, a document viewer is launched. An implementation of this Plugin class will map an alternative action to perform instead.

Since:

2.0.2

Constructor Summary

Constructors

Constructor and Description
PluginOpenAction()

Method Summary

Modifier and Type	Method and Description
abstract java.lang.String[]	getContentTypes()
abstract java.lang.String	getId() Returns an identifier that is used to describe this open action.
abstract java.lang.String	getName(java.util.Locale locale) Returns a descriptive label for this open action that is displayed in the IBM Content Navigator administration tool.
abstract java.lang.String	getOpenActionFunction() Provides the name of the JavaScript function that is invoked for this open action.
abstract java.lang.String[]	getServerTypes() Returns the server types that this action is valid on.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PluginOpenAction

public PluginOpenAction()

Method Detail

getId

public abstract java.lang.String getId()

Returns an identifier that is used to describe this open action.

Important: This identifier is used in URLs so it must contain only alphanumeric characters.

Returns:

An alphanumeric String that is used to identify the viewer.

getName

public abstract java.lang.String getName(java.util.Locale locale)

Returns a descriptive label for this open action that is displayed in the IBM Content Navigator administration tool.

Returns:

A String that contains a short description of the open action.

getOpenActionFunction

public abstract java.lang.String getOpenActionFunction()

Provides the name of the JavaScript function that is invoked for this open action.

This parameters to this function include:

Parameter	Description
repository	An instance of ecm.model.Respository.
items	An array of ecm.model.Item objects.
callback	A function to be invoked by the action when the action completes.
teamspace	An instance of ecm.model.Teamspace if the action is related to a particular teamspace.
resultSet	An instance of ecm.model.ResultSet if the action is related to a particular result set.
parameterMap	Other parameters to the action.

Returns:

The name of a JavaScript function that is contained in one of the script files with the plug-in.

Since:

2.0.2

getContentTypes

public abstract java.lang.String[] getContentTypes()

Returns:

A String array of the MIME content types supported by the open action, or null for all types.

Since:

2.0.2

getServerTypes

public abstract java.lang.String[] getServerTypes()

Returns the server types that this action is valid on.

Returns:

A String array that contains one or more of the following values:

Server Type	Description
p8	IBM FileNet P8
cm	IBM Content Manager
od	IBM Content Manager OnDemand
null	For all server types

Since:

2.0.2