Class TrashAppHandler

    • Constructor Detail

      • TrashAppHandler

        public TrashAppHandler()
    • Method Detail

      • processAction

        public boolean processAction()
                              throws java.io.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:
        java.io.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
      • 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 java.util.SortedSet<Publication> getSortedResultSet()
      • printParams

        protected java.lang.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 java.lang.String getQueryString​(java.util.Map<java.lang.String,​java.lang.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 java.lang.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 java.lang.String getAppUrl​(java.util.Map<java.lang.String,​java.lang.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
      • setTypes

        public void setTypes​(java.lang.String... types)
        Overrides:
        setTypes in class QueryHandler
      • showViews

        public boolean showViews()
      • setView

        public void setView​(java.lang.String viewStr)
      • isAllView

        public boolean isAllView()
      • setTrashWrkspc

        public void setTrashWrkspc​(java.lang.String... wsIds)
      • getAvailableTrashWorkspaceSet

        public java.util.Set<Workspace> getAvailableTrashWorkspaceSet()
      • showWorkspaceColumn

        public boolean showWorkspaceColumn()
      • getWorkspacesSettings

        public ControlSettings<?> getWorkspacesSettings()