Class BaseViewAction

java.lang.Object
com.appiancorp.web.framework.kernel.main.Action
com.appiancorp.common.struts.BaseAction
com.appiancorp.common.struts.BaseViewAction
All Implemented Interfaces:
com.appiancorp.web.framework.kernel.main.IAction
Direct Known Subclasses:
BaseUpdateAction

@Deprecated public abstract class BaseViewAction extends BaseAction
Deprecated.
The Portal functionality will be removed in a future release. Use the Tempo Interface for similar functionality.
Super class for all actions in the product concerned only with viewing data (not saving to the database). This class provides useful features for all implemented struts actions, including simplified integration for customizers.

When extending this class, all Actions core to the AES should implement the main method. No core action should implement beforeMain or afterMain. Those methods should be implemented by customizers who wish to modify the action in some way. Customizers should not extend the main method.

When customizers extend a concrete BaseAction class they must use the same ActionForm class for the parent or a subclass of that ActionForm so that the main in the parent does not break.

  • Constructor Details

    • BaseViewAction

      public BaseViewAction()
      Deprecated.
  • Method Details

    • getServiceContext

      protected ServiceContext getServiceContext(javax.servlet.http.HttpServletRequest q_)
      Deprecated.
      Description copied from class: BaseAction
      Returns the ServiceContext for the user executing this request.
      Overrides:
      getServiceContext in class BaseAction
    • addOutput

      protected final void addOutput(javax.servlet.http.HttpServletRequest q_, String key_, Object value_)
      Deprecated.
      Add a value to a java.util.Map that is stored as a request attribute
      Parameters:
      q_ - the request
      key_ - the key under which the value will be stoed
      value_ - the value to be stored
    • getOutputValue

      protected final Object getOutputValue(javax.servlet.http.HttpServletRequest q_, String key_)
      Deprecated.
      Retrieve a value from the output map
      Parameters:
      q_ - the request
      key_ - the key
      Returns:
      the object stored in the output map at the given key
      See Also:
    • main

      public abstract com.appiancorp.web.framework.kernel.main.IActionForward main(com.appiancorp.web.framework.kernel.main.IActionMapping m_, com.appiancorp.web.framework.kernel.main.IActionForm f_, javax.servlet.http.HttpServletRequest q_, javax.servlet.http.HttpServletResponse r_)
      Deprecated.
      Should be implemented only by internal Appian development. No consultants should write code that extends this method directly.
      Parameters:
      m_ - The struts action mapping.
      f_ - The action form.
      q_ - The request.
      r_ - The response.
      Throws:
      com.appiancorp.common.struts.InvalidFormClassException - if the ActionForm cannot be cast to the required ActionForm implementation.
    • beforeMain

      public com.appiancorp.web.framework.kernel.main.IActionForward beforeMain(com.appiancorp.web.framework.kernel.main.IActionMapping m_, com.appiancorp.web.framework.kernel.main.IActionForm f_, javax.servlet.http.HttpServletRequest q_, javax.servlet.http.HttpServletResponse r_)
      Deprecated.
      Should never be implemented in-house. Should only be implemented by customizers of AES. This method will be called before main.
      Parameters:
      m_ - The struts action mapping.
      f_ - The action form.
      q_ - The request.
      r_ - The response.
      Throws:
      com.appiancorp.common.struts.InvalidFormClassException - if the ActionForm cannot be cast to the required ActionForm implementation.
    • afterMain

      public com.appiancorp.web.framework.kernel.main.IActionForward afterMain(com.appiancorp.web.framework.kernel.main.IActionMapping m_, com.appiancorp.web.framework.kernel.main.IActionForm f_, javax.servlet.http.HttpServletRequest q_, javax.servlet.http.HttpServletResponse r_, com.appiancorp.web.framework.kernel.main.IActionForward defaultForward_)
      Deprecated.
      Should never be implemented in-house. Should only be implemented by customizers of AES. This method will be called after main.
      Parameters:
      m_ - The struts action mapping.
      f_ - The action form.
      q_ - The request.
      r_ - The response.
      Throws:
      com.appiancorp.common.struts.InvalidFormClassException - if the ActionForm cannot be cast to required ActionForm implementation.