IModuleAction (Javlo 2 2.1 API)

All Superinterfaces:

IAction

All Known Implementing Classes:

AbstractModuleAction, Action, AdminAction, CommentsAction, CommunicationAction, ComponentsAction, ContextAction, DashboardAction, DropboxAction, EcomAction, Edit, ErrorAction, EventAction, FileAction, MacroAction, MailingAction, Module.EmptyAction, MonitoringAction, Persistence, PortletAction, RemoteAction, RolesAction, SearchModuleAction, SharedContentAction, SiteMapAction, SocialAction, TaxonomyAction, TemplateAction, TemplateEditorAction, TicketAction, UserAction
```
public interface IModuleAction
extends IAction
```

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`Boolean`	`haveRight(javax.servlet.http.HttpSession session, User user)`	check if a specific user can use the module.
`String`	`performSearch(ContentContext ctx, ModulesContext modulesContext, String query)`	method called when a seach in lauched from search form.
`String`	`prepare(ContentContext ctx, ModulesContext moduleContext)`	method called before module rendering

Methods inherited from interface org.javlo.actions.IAction
getActionGroupName, haveRight

- Method Detail
  - prepare
```
String prepare(ContentContext ctx,
               ModulesContext moduleContext)
        throws Exception
```
    method called before module rendering
    
    Parameters:
    
    ctx - the current context.
    
    moduleContext - the context of the module. You can call getCurrentModule for recover the module.
    
    Returns:
    
    eventually the error message
    
    Throws:
    
    Exception
  - performSearch
```
String performSearch(ContentContext ctx,
                     ModulesContext modulesContext,
                     String query)
              throws Exception
```
    method called when a seach in lauched from search form.
    
    Parameters:
    
    ctx -
    
    moduleContext - the context of the module. You can call getCurrentModule for recover the module.
    
    query - the text entered in the search input field.
    
    Returns:
    
    eventually the error message
    
    Throws:
    
    Exception
  - haveRight
```
Boolean haveRight(javax.servlet.http.HttpSession session,
                  User user)
           throws ModuleException
```
    check if a specific user can use the module.
    
    Parameters:
    
    user -
    
    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