Class TrashAppHandler

All Implemented Interfaces:
JcmsConstants, JaliosConstants

public class TrashAppHandler extends QueryAppHandler
Handler used to access Trash application.
Since:
jcms-10.0.5 / JCMS-8353
  • Field Details

  • Constructor Details

    • TrashAppHandler

      public TrashAppHandler()
  • Method Details

    • processAction

      public boolean processAction() throws IOException
      Description copied from class: JcmsFormHandler
      Method to be implemented to check/validate action to be performed and process them.

      Default implementation is to return false. No need to call super method.

      This method may NOT be invoked at all if security validation are not met.

      You must ensure your handler and JSP can work properly without any code invoked in this method.

      Overrides:
      processAction in class JcmsFormHandler
      Returns:
      false if no redirection is needed, true otherwise
      Throws:
      IOException - IO Exception
    • addFrontEndDependencies

      public void addFrontEndDependencies()
    • init

      public void init()
      Description copied from class: JcmsFormHandler
      Method to implement if you need to initialize your handler from parameter received, prior to all security validation.

      You must absolutely not perform any action which modify data or site configuration.

      Therefore it is strongly recommend NOT TO implement this method, or use very wisely.

      Overrides:
      init in class QueryAppHandler
    • getConfirmDeletePublicationAttributes

      public ConfirmAttributes getConfirmDeletePublicationAttributes(Publication pub)
    • getDeletePublicationUrl

      public String getDeletePublicationUrl(Publication pub)
    • getResultSet

      public QueryResultSet getResultSet()
      Description copied from class: QueryHandler
      Return results of a query done using this QueryHandler.

      Warning: This method process the query each time it is invoked, therefore do not call it multiple times if you don't need it.

      Overrides:
      getResultSet in class QueryHandler
      Returns:
      a QueryResultSet containing all results of this query, it is a HashSet and therefore it is NOT sorted. use either getAsSortedSet() or getAsSortedSet(Comparator) to obtain a sorted Set.
    • getSortedResultSet

      public SortedSet<Publication> getSortedResultSet()
    • printParams

      protected String printParams(AbstractQueryHandler.QueryHandlerPrinter printer)
      Description copied from class: QueryHandler
      Print current QueryHandler params using specified QueryHandlerPrinter.
      Overrides:
      printParams in class QueryHandler
      Parameters:
      printer - a QueryHandlerPrinter to use
      Returns:
      a string containing all parameters of this handler printed using specified QueryHandlerPrinter.
    • getQueryString

      public String getQueryString(Map<String,String[]> parametersOverride)
      Returns all parameters of this handler as a queryString, overriding current settings with the specified params with the specified value(s).
      Parameters:
      parametersOverride - (optional, can be null)
      Returns:
      a query string, starting with a parameter name (no '?' or '&')
      Since:
      10.0.7 / JCMS-9688
    • getAppUrl

      public String getAppUrl()
      Returns the URL to the current state of this application
      Returns:
      a relative URL such as front/trash/trashApp.jsp?mids=j_2
      Since:
      10.0.7 / JCMS-9688
    • getAppUrl

      public String getAppUrl(Map<String,String[]> parametersOverride)
      Returns the URL to the current state of this application, overriding some parameter with the specified values
      Parameters:
      parametersOverride - (optional, can be null)
      Returns:
      a relative URL such as front/trash/trashApp.jsp?mids=j_2
      Since:
      10.0.7 / JCMS-9688
    • getMineViewUrl

      public String getMineViewUrl()
    • getAllViewUrl

      public String getAllViewUrl()
    • setTypes

      public void setTypes(String... v)
      Overrides:
      setTypes in class QueryHandler
    • showViews

      public boolean showViews()
    • setView

      public void setView(String viewStr)
    • isAllView

      public boolean isAllView()
    • isMineView

      public boolean isMineView()
    • getViewItems

      public List<AppSidebarSectionMenuItem> getViewItems()
    • getBreadcrumbItems

      public List<BreadcrumbItem> getBreadcrumbItems()
    • setTrashWrkspc

      public void setTrashWrkspc(String... wsIds)
    • getAvailableTrashWorkspaceSet

      public Set<Workspace> getAvailableTrashWorkspaceSet()
    • showWelcome

      public boolean showWelcome()
    • showNoResults

      public boolean showNoResults()
    • showWorkspaceColumn

      public boolean showWorkspaceColumn()
    • getWorkspacesSettings

      public ControlSettings<?> getWorkspacesSettings()
    • getBeginDateSettings

      public DateSettings getBeginDateSettings()
      Overrides:
      getBeginDateSettings in class QueryAppHandler
    • getEndDateSettings

      public DateSettings getEndDateSettings()
      Overrides:
      getEndDateSettings in class QueryAppHandler
    • getOpAuthorSettings

      public ControlSettings<?> getOpAuthorSettings()
    • validateBulkDelete

      protected boolean validateBulkDelete()
    • performBulkDelete

      protected boolean performBulkDelete() throws IOException
      Throws:
      IOException
    • setOpBulkDelete

      public void setOpBulkDelete(String v)
    • validateBulkRestore

      protected boolean validateBulkRestore()
    • performBulkRestore

      protected boolean performBulkRestore() throws IOException
      Throws:
      IOException
    • setOpBulkRestore

      public void setOpBulkRestore(String v)
    • isPublicationInBulk

      public boolean isPublicationInBulk(Publication pub)
    • showPublicationBulkSelect

      public boolean showPublicationBulkSelect()
    • getBulkPublicationSet

      public Set<Publication> getBulkPublicationSet()
      Returns:
      items in the trash selected by user for buld processing
    • setTrashId

      public void setTrashId(String[] v)