Class WorkspaceQueryHandler

All Implemented Interfaces:
JcmsConstants, JaliosConstants

public class WorkspaceQueryHandler extends AbstractQueryHandler<Workspace>
Deprecated.
since jcms-10.0.1 use WorkspaceQueryHandler instead
Holder class and form handler of all parameters to be used for a query of workspaces.

Since:
jcms-6.0
Author:
dissert
  • Constructor Details

    • WorkspaceQueryHandler

      public WorkspaceQueryHandler()
      Deprecated.
      Constructs a new empty WorkspaceQueryHandler with default option.
      Since:
      jcms-6.0
    • WorkspaceQueryHandler

      public WorkspaceQueryHandler(String queryString)
      Deprecated.
      Constructs a new WorkspaceQueryHandler by parsing the specified query string.

      See WorkspaceQueryHandler(String, HttpServletRequest) for a list of the decoded parameters.

      Parameters:
      queryString - a query String consisting of parameters (key=value) to be set in this handler.
      • Parameters must be separated with ampersand (&).
      • Values must be encoded in UTF-8.
      • Query must not starts with question mark (?) e.g : "text=welcome"
      Since:
      jcms-6.0
    • WorkspaceQueryHandler

      public WorkspaceQueryHandler(String queryString, javax.servlet.http.HttpServletRequest request)
      Deprecated.
      Constructs a new WorkspaceQueryHandler by parsing the specified query string and using informations available from the specified request (logged member, user language, etc).

      The following parameters (and only those listed here) will be automatically decoded from the specified query string. Other parameters should be set using apropriate setters.

      Parameters:
      queryString - a query String consisting of parameters (key=value) to be set in this handler.
      • Parameters must be separated with ampersand (&).
      • Values must be encoded in UTF-8.
      • Query must not starts with question mark (?) e.g : "text=welcome&gid=j_42"
      request - the HttpServletRequest to use to retrieve loggedMember, userLang, userLocale that will be used by this handler, ignored if null.
      Since:
      jcms-6.0
  • Method Details

    • getLogger

      protected org.apache.log4j.Logger getLogger()
      Deprecated.
      Specified by:
      getLogger in class AbstractQueryHandler<Workspace>
    • parseQueryStringParam

      protected void parseQueryStringParam(String key, String[] values)
      Deprecated.
      Description copied from class: AbstractQueryHandler
      Method to be implemented by subclass to decode parameter from queryString.
      Specified by:
      parseQueryStringParam in class AbstractQueryHandler<Workspace>
      Parameters:
      key - the parameter name, never null nor empty.
      values - the parameter values, NEVER NULL NOR EMPTY. You can safely invoke paramValues[0]
    • printParams

      protected String printParams(AbstractQueryHandler.QueryHandlerPrinter printer)
      Deprecated.
      Print current QueryHandler params using specified QueryHandlerPrinter.
      Specified by:
      printParams in class AbstractQueryHandler<Workspace>
      Parameters:
      printer - a QueryHandlerPrinter to use
      Returns:
      a string containing all parameters of this handler printed using specified QueryHandlerPrinter.
      Since:
      jcms-6.0
    • toString

      public String toString()
      Deprecated.
      Overrides:
      toString in class Object
    • getResultSet

      public Set<Workspace> getResultSet()
      Deprecated.
      Return results of a query done using this WorkspaceQueryHandler.

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

      Returns:
      a new Set containing all Workspace found by this query.
      Since:
      jcms-6.0
    • getResultSet

      public Set<Workspace> getResultSet(Comparator<Workspace> comparator)
      Deprecated.
      Return results of a query done using this WorkspaceQueryHandler.

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

      Parameters:
      comparator - the optional Comparator to sort the return collection
      Returns:
      a new Set containing all Workspace found by this query, sorted using specified comparator if any.
      Since:
      jcms-6.0
    • getText

      public String getText()
      Deprecated.
      Retrieves the text being search in this query
      Returns:
      a string or null if no text is being searched
      Since:
      jcms-6.0
    • setText

      public void setText(String text)
      Deprecated.
      Set the text to search in Workspace
      Parameters:
      text - any string to look for in Workspaces
      Since:
      jcms-6.0