Package com.jalios.jcms.handler

Class AllMemberQueryHandler

    • Constructor Detail

      • AllMemberQueryHandler

        public AllMemberQueryHandler()
        Constructs a new empty AllMemberQueryHandler with default option.
        Since:
        jcms-6.1

      • AllMemberQueryHandler

        public AllMemberQueryHandler​(java.lang.String queryString)
        Constructs a new AllMemberQueryHandler by parsing the specified query string.

        See AllMemberQueryHandler(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=john&gid=j_42"
        Since:
        jcms-6.1

    • Method Detail

      • parseQueryStringParam

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

      • getDescription

        public java.lang.String getDescription()
        Returns a description of the query in the language defined by userLang of this handler.
        Returns:
        the string of the description

      • setGroupMode

        public void setGroupMode​(java.lang.String groupMode)
        Defines if the group search is an OR-search or an AND-search. Default is AND-search.
        Parameters:
        groupMode - either GROUP_MODE_OR or GROUP_MODE_AND
        Since:
        jcms-7.0.0

      • isGroupModeAnd

        public boolean isGroupModeAnd()

      • isGroupModeOr

        public boolean isGroupModeOr()

      • getEmail

        public java.lang.String getEmail()
        Retrieves the email being search in this query
        Returns:
        a string or null if no email is being searched
        Since:
        jcms-6.1

      • setEmail

        public void setEmail​(java.lang.String email)
        Set the email to search in Member
        Parameters:
        email - any exact email to look for in Members
        Since:
        jcms-6.1

      • setSort

        public void setSort​(java.lang.String sort)
        Description copied from class: AbstractMemberQueryHandler
        Set the sorting criteria

        Possible sorting option :

        • "id" : Member id (quite useless when working with both Member and DBMember as they do not compare)
        • "cdate" : Member creation date
        • "login" : Member's login
        • "firstname" : Member's firstname
        • "name" or "lastname" : Member's lastname
        • "usage" : Member's usage (account / contact)
        Overrides:
        setSort in class AbstractMemberQueryHandler<DBMember>
        Parameters:
        sort - a field name that should be used for sorting