Class BaseAction

java.lang.Object
org.openxava.actions.BaseAction
All Implemented Interfaces:
IAction, IChangeModeAction, IModuleContextAction, IRequestAction
Direct Known Subclasses:
CancelInListAction, ChangeModuleAction, ChangeSectionAction, EmptyAction, GoDetailAction, GoListAction, NavigationAction, ResetPreviousControllersAction, ReturnPreviousModuleAction, SearchAction, SetCustomViewAction, SetDefaultSchemaAction, SetLocaleAction, SetPersistenceUnitAction, SubscribeToEmailNotificationsAction, ViewBaseAction
public abstract class BaseAction extends Object implements IAction, IRequestAction, IModuleContextAction, IChangeModeAction
Author:
Javier Paniza

  • Constructor Details

    • BaseAction

      public BaseAction()

  • Method Details

    • getErrors

      public Messages getErrors()
      Specified by:
      getErrors in interface IAction

    • setErrors

      public void setErrors(Messages errors)
      Specified by:
      setErrors in interface IAction

    • getMessages

      public Messages getMessages()
      Specified by:
      getMessages in interface IAction

    • setMessages

      public void setMessages(Messages messages)
      Specified by:
      setMessages in interface IAction

    • addErrors

      protected void addErrors(Messages errors)

    • addMessages

      protected void addMessages(Messages messages)

    • addError

      protected void addError(String messageId, Object... ids)
      If some id is a String between quotes (') it will be displayed literally, untranslated.

    • addMessage

      protected void addMessage(String messageId, Object... ids)
      If some id is a String between quotes (') it will be displayed literally, untranslated.

    • addInfo

      protected void addInfo(String messageId, Object... ids)
      If some id is a String between quotes (') it will be displayed literally, untranslated.
      Since:
      4.3

    • addWarning

      protected void addWarning(String messageId, Object... ids)
      If some id is a String between quotes (') it will be displayed literally, untranslated.
      Since:
      4.3

    • executeBefore

      public void executeBefore() throws Exception
      Throws:
      Exception

    • executeAfter

      public void executeAfter() throws Exception
      Throws:
      Exception

    • setEnvironment

      public void setEnvironment(Environment environment)
      Specified by:
      setEnvironment in interface IAction

    • getEnvironment

      public Environment getEnvironment()

    • resetDescriptionsCache

      protected void resetDescriptionsCache()
      Reset the cache of all descriptions-list and others uses of descriptionsEditors.

    • setRequest

      public void setRequest(javax.servlet.http.HttpServletRequest request)
      Specified by:
      setRequest in interface IRequestAction

    • getRequest

      protected javax.servlet.http.HttpServletRequest getRequest()
      With this method you can access directly to the web application resources, but it ties you to implementation technology (servlets), hence it's better to avoid it if you have alternative and are thinking in migrating to another tecnology.
      Since:
      4m1

    • getLocale

      protected Locale getLocale()
      The Locale of the current request.

    • getContext

      protected ModuleContext getContext()
      Since:
      4m1

    • setContext

      public void setContext(ModuleContext context)
      Specified by:
      setContext in interface IModuleContextAction

    • getNextMode

      public String getNextMode()
      Description copied from interface: IChangeModeAction
      LIST, DETAIL or PREVIOUS_MODE.
      Specified by:
      getNextMode in interface IChangeModeAction
      Since:
      4m1

    • setNextMode

      protected void setNextMode(String nextMode)
      Since:
      4m1

    • getManager

      protected ModuleManager getManager()
      Since:
      4m1

    • addActions

      protected void addActions(String... qualifiedActions)
      Actions add added even if they are hidden.

      Since:
      4m2

    • removeActions

      protected void removeActions(String... qualifiedActions)
      Since:
      4m2

    • clearActions

      protected void clearActions()
      Since:
      4m2

    • setControllers

      protected void setControllers(String... controllers)
      Since:
      4m2

    • returnToPreviousControllers

      protected void returnToPreviousControllers()
      Since:
      4m2

    • setDefaultControllers

      protected void setDefaultControllers()
      Set the default controllers of the current module.

      The defaults controllers are those declared in application.xml for the module, so the initial controllers when the module starts.
      Also, this method clear the stack of controllers navigation, that is, if after calling to this method you call to

      invalid reference 
      returnToPreviousController
      () it will not have effect.
      Since:
      4m2

    • commit

      protected void commit()
      Commit the current transaction.
      Since:
      5.0

    • rollback

      protected void rollback()
      Rollback the current transaction.
      Since:
      5.0

    • executeAction

      protected void executeAction(String qualifiedActionName)
      Execute an action, you can call it several times, for several actions. It does not throw exceptions but accumulate the errors in getErrors(). Also it can modify getMessages().
      Since:
      5.7

    • getQualifiedActionIfAvailable

      protected String getQualifiedActionIfAvailable(String simpleName)
      From an action simple name get the qualified name of the action.
      If the action is not available returns null.
      For example, from "new" gets "CRUD.new" if it exists, but if there is no an action called "new" in that moment it returns null.
      Since:
      5.8