fr.paris.lutece.portal.web.pluginaction

Interface IPluginAction<FieldsDTO>

Type Parameters:

FieldsDTO - the dto used by the process method, might be session variables or any useful data for the action processing.

All Known Subinterfaces:

IExtendableResourcePluginAction

All Known Implementing Classes:

AbstractPluginAction

public interface IPluginAction<FieldsDTO>

A plugin Action.
The action should rely on a service instead of implementing the business rules itself if possible.

• fillModel(HttpServletRequest, AdminUser, Map) is called by the JspBean to add additionnal data in the main model
• getButtonTemplate() is used to display buttons.
• isInvoked(HttpServletRequest) is used by a JspBean to detect the invoked action.
• #process(HttpServletRequest, HttpServletResponse, AdminUser, IPluginActionFields) is called by the JspBean to process the invoked action. The IPluginActionResult may contain html content or a redirect url or a noop as a result of the action processing.
• getName() is mainly for debbuging purpose

Method Summary

Methods

Modifier and Type	Method and Description
void	fillModel(javax.servlet.http.HttpServletRequest request, AdminUser adminUser, Map<String,Object> model) Fills the model to provide necessary data to fill the button template
String	getButtonTemplate() Gets the template to display the action (typically a button - but also check box, select...)
String	getName() The action name
boolean	isInvoked(javax.servlet.http.HttpServletRequest request) Returns true if the action is invoked, false otherwise.
IPluginActionResult	process(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, AdminUser adminUser, FieldsDTO sessionFields) Processes the request

Method Detail

isInvoked

boolean isInvoked(javax.servlet.http.HttpServletRequest request)

Returns true if the action is invoked, false otherwise.
Uses one or several button names to detect if the action is called or note.

Parameters:

request - the request

Returns:

true if the action is invoked, false otherwise.

process

IPluginActionResult process(javax.servlet.http.HttpServletRequest request,
                          javax.servlet.http.HttpServletResponse response,
                          AdminUser adminUser,
                          FieldsDTO sessionFields)
                            throws AccessDeniedException

Processes the request

Parameters:

request - the request

response - the response

adminUser - the user

sessionFields - the session fields

Returns:

the action result

Throws:

AccessDeniedException - if the user can't access the feature

fillModel

void fillModel(javax.servlet.http.HttpServletRequest request,
             AdminUser adminUser,
             Map<String,Object> model)

Fills the model to provide necessary data to fill the button template

Parameters:

request - the request

adminUser - the admin user to filter features

model - the model

getButtonTemplate

String getButtonTemplate()

Gets the template to display the action (typically a button - but also check box, select...) Return an empty string if no display is needed (for default directory actions : create, search...)

Returns:

the template

getName

String getName()

The action name

Returns:

the name