org.alfresco.web.bean.actions

Interface IHandler

All Superinterfaces:

Serializable

All Known Implementing Classes:

AddFeaturesHandler, BaseActionHandler, BaseConditionHandler, CheckInHandler, CheckOutHandler, CompareMimeTypeHandler, CompositeConditionHandler, CopyHandler, DatePropertyValueConditionHandler, HasAspectHandler, HasTagHandler, ImportHandler, InCategoryHandler, IntegerPropertyValueConditionHandler, IsSubTypeHandler, LinkCategoryHandler, MailHandler, MoveHandler, PropertyValueHandler, RemoveFeaturesHandler, ScriptHandler, SimpleWorkflowHandler, SpecialiseTypeHandler, TextPropertyValueConditionHandler, TransformHandler, TransformImageHandler

public interface IHandler
extends Serializable

Interface definition for a handler, classes that are responsible for marshalling data between the repository and the action based wizards.

Author:

gavinc

Method Summary

Modifier and Type	Method and Description
String	generateSummary(FacesContext context, IWizardBean wizard, Map<String,Serializable> props) Generates a summary string for this handler.
String	getJSPPath() By default, a JSP with the same name as the handler will be loaded from a default location.
boolean	isAllowMultiple() Returns value of possibility of repeated performance of action
void	prepareForEdit(Map<String,Serializable> props, Map<String,Serializable> repoProps) Called at the start of the edit wizard.
void	prepareForSave(Map<String,Serializable> props, Map<String,Serializable> repoProps) Called at the end of the wizard.
void	setupUIDefaults(Map<String,Serializable> props) Adds any properties to the given map that need default values before the UI is displayed to the user.

Method Detail

setupUIDefaults

void setupUIDefaults(Map<String,Serializable> props)

Adds any properties to the given map that need default values before the UI is displayed to the user.

Parameters:

props - The current properties map

getJSPPath

String getJSPPath()

By default, a JSP with the same name as the handler will be loaded from a default location. If the handler has stored it's UI somewhere else the view id can be returned from this method.

Returns:

The path to the JSP for the handler

prepareForSave

void prepareForSave(Map<String,Serializable> props,
                    Map<String,Serializable> repoProps)

Called at the end of the wizard. The properties relevant to this handler have to be placed in the repository properties map in the correct form for sending to the node service.

Parameters:

props - The current properties map

repoProps - The repository properties map to prepare

prepareForEdit

void prepareForEdit(Map<String,Serializable> props,
                    Map<String,Serializable> repoProps)

Called at the start of the edit wizard. The repository properties map holds the current state of this rule. Any properties relevant to this handler should be retrieved and setup in the current properties map.

Parameters:

props - The current properties map

repoProps - The properties currently in the repository

generateSummary

String generateSummary(FacesContext context,
                       IWizardBean wizard,
                       Map<String,Serializable> props)

Generates a summary string for this handler. The current state of the wizard is passed as well as the current properties map.

Parameters:

context - Faces context

wizard - The current wizard

props - The properties map

Returns:

The summary string

isAllowMultiple

boolean isAllowMultiple()

Returns value of possibility of repeated performance of action

Returns:

true is allow multiple