org.javlo.actions

Class AbstractModuleAction

java.lang.Object

org.javlo.actions.AbstractModuleAction

All Implemented Interfaces:

IAction, IModuleAction

Direct Known Subclasses:

Action, AdminAction, CommentsAction, CommunicationAction, ContextAction, DashboardAction, EcomAction, Edit, ErrorAction, EventAction, FileAction, MacroAction, MailingAction, MonitoringAction, Persistence, PortletAction, RemoteAction, RolesAction, SearchModuleAction, SharedContentAction, SiteMapAction, SocialAction, TaxonomyAction, TemplateAction, TemplateEditorAction, TicketAction, UserAction

public abstract class AbstractModuleAction
extends Object
implements IModuleAction

Constructor Summary

Constructors

Constructor and Description
AbstractModuleAction()

Method Summary

Modifier and Type	Method and Description
AbstractModuleContext	getModuleContext(javax.servlet.http.HttpSession session, Module module)
boolean	haveRight(ContentContext ctx, String action)
Boolean	haveRight(javax.servlet.http.HttpSession session, User user) check if a specific user can use the module.
protected static boolean	isLightInterface(ContentContext ctx)
String	performChangeRenderer(RequestService rs, Module currentModule)
String	performSearch(ContentContext ctx, ModulesContext moduleContext, String query) method called when a seach in lauched from search form.
String	performWizard(ContentContext ctx, RequestService rs, Module currentModule, AbstractModuleContext moduleContext)
String	prepare(ContentContext ctx, ModulesContext modulesContext) method called before module rendering

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.javlo.actions.IAction

getActionGroupName

Constructor Detail

AbstractModuleAction

public AbstractModuleAction()

Method Detail

isLightInterface

protected static boolean isLightInterface(ContentContext ctx)

prepare

public String prepare(ContentContext ctx,
                      ModulesContext modulesContext)
               throws Exception

Description copied from interface: IModuleAction

method called before module rendering

Specified by:

prepare in interface IModuleAction

Parameters:

ctx - the current context.

modulesContext - the context of the module. You can call getCurrentModule for recover the module.

Returns:

eventually the error message

Throws:

Exception

performSearch

public String performSearch(ContentContext ctx,
                            ModulesContext moduleContext,
                            String query)
                     throws Exception

Description copied from interface: IModuleAction

method called when a seach in lauched from search form.

Specified by:

performSearch in interface IModuleAction

query - the text entered in the search input field.

Returns:

eventually the error message

Throws:

Exception

getModuleContext

public AbstractModuleContext getModuleContext(javax.servlet.http.HttpSession session,
                                              Module module)
                                       throws Exception

Throws:

Exception

performChangeRenderer

public String performChangeRenderer(RequestService rs,
                                    Module currentModule)
                             throws Exception

Throws:

Exception

performWizard

public String performWizard(ContentContext ctx,
                            RequestService rs,
                            Module currentModule,
                            AbstractModuleContext moduleContext)
                     throws Exception

Throws:

Exception

haveRight

public Boolean haveRight(javax.servlet.http.HttpSession session,
                         User user)
                  throws ModuleException

Description copied from interface: IModuleAction

check if a specific user can use the module.

Specified by:

haveRight in interface IModuleAction

Returns:

true if access, false if no access and null if this method can't determine access. If access is not determined by the action javlo will take the user group in config.properties.

Throws:

ModuleException

haveRight

public boolean haveRight(ContentContext ctx,
                         String action)

Specified by:

haveRight in interface IAction