org.javlo.module.core

Class Module.EmptyAction

java.lang.Object

org.javlo.module.core.Module.EmptyAction

All Implemented Interfaces:

IAction, IModuleAction

Enclosing class:

Module

public static final class Module.EmptyAction
extends Object
implements IModuleAction

Constructor Summary

Constructors

Constructor and Description
EmptyAction()

Method Summary

Modifier and Type	Method and Description
String	getActionGroupName() the group name of the action
boolean	haveRight(ContentContext ctx, String action)
Boolean	haveRight(javax.servlet.http.HttpSession session, User user) check if a specific user can use the module.
String	performSearch(ContentContext ctx, ModulesContext moduleContext, String searchText) method called when a seach in lauched from search form.
String	prepare(ContentContext ctx, ModulesContext moduleContext) method called before module rendering

Methods inherited from class java.lang.Object

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

Constructor Detail

EmptyAction

public EmptyAction()

Method Detail

getActionGroupName

public String getActionGroupName()

Description copied from interface: IAction

the group name of the action

Specified by:

getActionGroupName in interface IAction

Returns:

a group name.

prepare

public String prepare(ContentContext ctx,
                      ModulesContext moduleContext)

Description copied from interface: IModuleAction

method called before module rendering

Specified by:

prepare in interface IModuleAction

Parameters:

ctx - the current context.

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

Returns:

eventually the error message

performSearch

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

Description copied from interface: IModuleAction

method called when a seach in lauched from search form.

Specified by:

performSearch in interface IModuleAction

searchText - the text entered in the search input field.

Returns:

eventually the error message

Throws:

Exception

haveRight

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

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.

haveRight

public boolean haveRight(ContentContext ctx,
                         String action)

Specified by:

haveRight in interface IAction