Package com.jalios.jcms.handler

Class AllMemberQueryHandler

    • Field Detail

      • isGroupModeOr

        protected boolean isGroupModeOr

      • sortForced

        protected boolean sortForced

      • admin

        protected boolean admin

      • adminFilterEnabled

        protected boolean adminFilterEnabled

    • 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

      • getType

        public java.lang.String getType()
        Retrieve the type of Member to look for.
        Returns:
        null to search all members, "Member" to search for JStore Member only, "DBMember" to search for jcmsdb members only.
        Since:
        10.0.8 / JCMS-10387

      • setType

        public void setType​(java.lang.String type)
        Set the type of Member to look for.
        Parameters:
        type - null to search all members, "Member" to search for JStore Member only, "DBMember" to search for jcmsdb members only.
        Since:
        10.0.8 / JCMS-10387

      • setAdmin

        public void setAdmin​(boolean admin)
        Set the administrator filter option.

        Automatically invoke setAdminFilterEnabled(boolean)) to enable filter.

        Parameters:
        admin - true to retrieve only administrators, false to retrieve all but administrators
        Since:
        jcms-10.0.8 / JCMS-10986

      • getAdmin

        public boolean getAdmin()
        Retrieve the value of the administrator filter.

        Important : this value is used only if isAdminFilterEnabled is true !

        Returns:
        true to retrieve only administrators, false to retrieve all but administrators
        Since:
        jcms-10.0.8 / JCMS-10986

      • setAdminFilterEnabled

        public void setAdminFilterEnabled​(boolean enabled)
        Set whether the admin filter is used or not for this query
        Parameters:
        enabled - true if the value of getAdmin() is used for this query, false otherwise.
        Since:
        jcms-10.0.8 / JCMS-10986

      • isAdminFilterEnabled

        public boolean isAdminFilterEnabled()
        Retrieve whether the admin filter is used or not for this query
        Returns:
        true if the value of getAdmin() is used for this query, false otherwise.
        Since:
        jcms-10.0.8 / JCMS-10986

      • 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