com.exlibris.digitool.repository.api

Interface RepositoryTaskPlugin

public interface RepositoryTaskPlugin

Interface for a RepositoryTaskPlugin plug-in type. This plug-in type allows editing of IE's metadata . A plug-in implementing this interface can be associated to a repository task relevant for IEs, and can be run as part of the PA mechanism. When the plug-in is installed in the system, an associated task that runs the plug-in is created. The task name and task description can be controlled by adding a taskName or taskDescription field to the plugin xform. If the task name or the task description are not supplied, the system will create them based on the plugin instance name. Each plug-in should indicate if it makes changes in metadata so the PA mechanism will know whether or not to commit changes at the end of the task.

Author:

yaarac

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	PLUGIN_TASK_SUFFIX

Method Summary

Modifier and Type	Method and Description
TaskResults	execute(IEEditor ieEditor, java.util.Map<java.lang.String,java.lang.String> initParams, TaskResults taskResults) The main functionality of the plug-in.
boolean	isReadOnly() Returns a boolean indicating whether or not the plug-in commits changes in the metadata.

Field Detail

PLUGIN_TASK_SUFFIX

static final java.lang.String PLUGIN_TASK_SUFFIX

See Also:

Constant Field Values

Method Detail

execute

TaskResults execute(IEEditor ieEditor,
                    java.util.Map<java.lang.String,java.lang.String> initParams,
                    TaskResults taskResults)

The main functionality of the plug-in.

Parameters:

ieEditor - interface to edit and retrieve the control's metadata objects - DnxDocument and DublinCore.

initParams - the plugin's initial parameters taken from

taskResults - the current task results object. The plug-in can add a result to it

Throws:

java.lang.Exception - in case of fatal error

isReadOnly

boolean isReadOnly()

Returns a boolean indicating whether or not the plug-in commits changes in the metadata.

Returns:

True if the plug-in makes no changes in the IE's metadatas, and false otherwise