Class QueueScreenAction

java.lang.Object
org.apache.struts.action.Action
org.apache.struts.actions.BaseAction
org.apache.struts.actions.DispatchAction
org.bgerp.action.base.BaseAction
org.bgerp.plugin.inventoru.action.QueueScreenAction
Direct Known Subclasses:
DeviceAction, ItemAction, ManufacturerQueueAction, ModelQueueAction, MovementAction, StoreAction

public abstract class QueueScreenAction extends BaseAction
The queue screen of an entity: a queue selector, the filter panel and the rows. Everything here is the same for warehouses, items and equipment — what differs is described by QueueEntity and by the few hooks below, so adding a queue screen to an entity is an action extending this class, not another copy of the machinery. The three screen methods are helpers rather than the action methods themselves: the dispatcher resolves an action method with getDeclaredMethod (see Invoker.find), which does not see inherited ones. So every subclass declares unspecified, queueFilter and queueShow of its own, each a single call into here.
  • Constructor Details

    • QueueScreenAction

      public QueueScreenAction()
  • Method Details

    • getEntity

      protected abstract QueueEntity getEntity()
      The entity the screen lists.
    • getScreenTitle

      protected abstract String getScreenTitle(DynActionForm form)
      Screen title, shown in the browser tab.
    • getShowAction

      protected abstract String getShowAction()
      Permission node of the card the rows link to, e.g. /user/plugin/inventoru/store:show; the row menu is hidden without it.
    • getToolbarJsp

      protected String getToolbarJsp()
      Entity specific buttons shown above the queue selector — creating a row, opening a related catalogue. The queue itself has no idea what can be done with what it lists.
      Returns:
      path of a JSP to include, or null when the entity has no such buttons.
    • queueScreen

      protected org.apache.struts.action.ActionForward queueScreen(DynActionForm form, ConnectionSet conSet) throws Exception
      Queue selector plus the containers the filter and the rows are loaded into.
      Throws:
      Exception
    • queueFilterScreen

      protected org.apache.struts.action.ActionForward queueFilterScreen(DynActionForm form, ConnectionSet conSet) throws Exception
      AJAX: the filter panel of a queue.
      Throws:
      Exception
    • queueShowScreen

      protected org.apache.struts.action.ActionForward queueShowScreen(DynActionForm form, ConnectionSet conSet) throws Exception
      AJAX: the rows of a queue, filtered and sorted as the panel says.
      Throws:
      Exception