Class AllMemberQueryHandler
- All Implemented Interfaces:
JcmsConstants,JaliosConstants
- Since:
- jcms-6.1
-
Nested Class Summary
Nested classes/interfaces inherited from class com.jalios.jcms.handler.AbstractQueryHandler
AbstractQueryHandler.HiddenParamQhPrinter, AbstractQueryHandler.QueryHandlerPrinter, AbstractQueryHandler.QueryStringQhPrinter -
Field Summary
FieldsModifier and TypeFieldDescriptionprotected booleanprotected booleanstatic final intValue that can be specified toAbstractMemberQueryHandler.setUsage(int)to search for all members whatever their usage (both contact and account).static final Stringstatic final Stringprotected booleanprotected LuceneMemberSearchEngineprotected booleanFields inherited from class com.jalios.jcms.handler.AbstractMemberQueryHandler
CLEARANCE_LEVEL_FILTER_PARAM, groupOffSet, groupSet, GUEST_FILTER_PARAM, isMissingCriteria, LDAP_FILTER_PARAM, pagerAll, pageSize, pageStart, reverse, sortFields inherited from class com.jalios.jcms.handler.JcmsFormHandler
contextMap, csrfValidationEnabled, editFieldSet, formStep, noRedirect, noSendRedirect, op, openTabId, opFinish, opNext, opPrevious, popupEdition, redirect, redirectOnClosePopup, workspaceForcedFields inherited from class com.jalios.jcms.context.JcmsJspContext
AJAX_REQUEST_ATTRIBUTES, BODY_HEADER, CSS_FOOTER, CSS_HEADER, cssboMap, cssfoMap, CUSTOM_HEADER, editIcon, HTTPEQUIV_HEADER, httpequivMap, HTTPNAME_HEADER, httpnameMap, initEditIcon, JAVASCRIPT_CODE_SET_ATTRIBUTE, JAVASCRIPT_MODULE_SET_ATTRIBUTE, JAVASCRIPT_SET_ATTRIBUTE, jsboSet, jsfoSet, out, pageContext, SHOW_EDIT_ICON, STYLE_HEADERFields inherited from class com.jalios.jcms.context.JcmsContext
browser, caddy, channel, inFO, initDone, initWorkspace, isAdmin, isAjaxRequest, isDBMember, isDebug, isDebugTemplatePath, isLogged, loggedMember, request, response, userCountry, userLang, userLocale, userZoneId, workspaceFields inherited from interface com.jalios.util.JaliosConstants
CRLF, MILLIS_IN_ONE_DAY, MILLIS_IN_ONE_HOUR, MILLIS_IN_ONE_MINUTE, MILLIS_IN_ONE_MONTH, MILLIS_IN_ONE_SECOND, MILLIS_IN_ONE_WEEK, MILLIS_IN_ONE_YEARFields inherited from interface com.jalios.jcms.JcmsConstants
ADATE_SEARCH, ADVANCED_TAB, AJAX_MODE_ATTR, ARCHIVES_DIR, ASCII_WIDTH, CATEGORY_TAB, CDATE_SEARCH, CLASS_PROPERTY, COMMON_ALARM, CONTENT_TAB, COOKIE_MAX_AGE, COUNTRY_SPRITE, CS_TYPOLOGY_ROOT_CAT_VID, CTRL_TOPIC_INTERNAL, CTRL_TOPIC_REF, CTRL_TOPIC_VALUE, CTRL_TOPIC_WRITE, CUSTOM_PROP, DATA_DIRECTORY, DEFAULT_PHOTO_PROP, DOCCHOOSER_HEIGHT, DOCCHOOSER_WIDTH, DOCS_DIR, EDATE_SEARCH, EMAIL_REGEXP, ERROR_MSG, FORBIDDEN_FILE_ACCESS, FORBIDDEN_REDIRECT, FORCE_REDIRECT, GENERATIONAL_STORE_DIRECTORY, GLYPH_ICON_PREFIX, ICON_ARCHIVE, ICON_ICON_PREFIX, ICON_LOCK, ICON_LOCK_STRONG, ICON_PREFIX_PROP, ICON_WARN, ICON_WH_BOOK_CLOSED, ICON_WH_BOOK_OPEN, INFORMATION_MSG, IS_IN_FRONT_OFFICE, JALIOS_JUNIT_PROP, JCMS_CADDY, JCMS_MSG_LIST, JCMS_TOASTR_COLLECTION, JSYNC_DOWNLOAD_DIR, JSYNC_SYNC_ALARM, LANG_SPRITE, LOG_FILE, LOG_TOPIC_SECURITY, LOGGER_PROP, LOGGER_XMLPROP, MBR_PHOTO_DIR, MDATE_SEARCH, MONITOR_XML, OP_CREATE, OP_CREATE_STR, OP_DEEP_COPY, OP_DEEP_COPY_STR, OP_DEEP_DELETE, OP_DEEP_DELETE_STR, OP_DELETE, OP_DELETE_STR, OP_MERGE, OP_MERGE_STR, OP_UPDATE, OP_UPDATE_STR, ORGANIZATION_ROOT_GROUP_PROP, PDATE_SEARCH, PHOTO_DIR, PHOTO_ICON, PHOTO_ICON_HEIGHT, PHOTO_ICON_PROP_PREFIX, PHOTO_ICON_WIDTH, PHOTO_LARGE, PHOTO_LARGE_HEIGHT, PHOTO_LARGE_PROP_PREFIX, PHOTO_LARGE_WIDTH, PHOTO_MINI, PHOTO_MINI_HEIGHT, PHOTO_MINI_PROP_PREFIX, PHOTO_MINI_WIDTH, PHOTO_NORMAL, PHOTO_NORMAL_HEIGHT, PHOTO_NORMAL_PROP_PREFIX, PHOTO_NORMAL_WIDTH, PHOTO_SMALL, PHOTO_SMALL_HEIGHT, PHOTO_SMALL_PROP_PREFIX, PHOTO_SMALL_WIDTH, PHOTO_TINY, PHOTO_TINY_HEIGHT, PHOTO_TINY_PROP_PREFIX, PHOTO_TINY_WIDTH, PHOTO_XLARGE, PHOTO_XLARGE_HEIGHT, PHOTO_XLARGE_PROP_PREFIX, PHOTO_XLARGE_WIDTH, PREVIOUS_TAB, PRINT_VIEW, PRIVATE_FILE_ACCESS, PUBLIC_FILE_ACCESS, RAW_CONTENT_ICON_PREFIX, READ_RIGHT_TAB, SDATE_SEARCH, SEARCHENGINE_ALARM, SECURITY_LOG_FILE, SESSION_AUTHORIZED_FILENAMES_SET, SPRITE_ICON_PREFIX, STATS_REPORT_DIR, STATUS_PROP, STORE_XML, SUCCESS_MSG, SVG_ICON_PREFIX, SVGINLINE_ICON_PREFIX, SVGSPRITE_ICON_PREFIX, TEMPLATE_TAB, THEME_DIR, THUMBNAIL_LARGE_HEIGHT, THUMBNAIL_LARGE_WIDTH, THUMBNAIL_SMALL_HEIGHT, THUMBNAIL_SMALL_WIDTH, TTCARD_MEDIA_HEIGHT, TTCARD_MEDIA_WIDTH, TYPES_ICON_ALT_PROP, TYPES_ICON_SUFFIX_PROP, TYPES_ICON_TITLE_PROP, TYPES_PREFIX_PROP, TYPES_THUMB_SUFFIX_PROP, TYPES_UNKNOWN_CLASS_PROP, UDATE_SEARCH, UPDATE_RIGHT_TAB, UPLOAD_DIR, UPLOAD_PERMISSION_COUNT_PROP_PREFIX, UPLOAD_PERMISSION_SIZE_PROP_PREFIX, URL_REGEXP, VID_LOGGED_MEMBER, WARNING_MSG, WEBAPP_PROP, WFEXPRESS_ALARM, WFREMINDER_ALARM, WORKFLOW_TAB, WORKFLOW_XML -
Constructor Summary
ConstructorsConstructorDescriptionConstructs a new emptyAllMemberQueryHandlerwith default option.AllMemberQueryHandler(String queryString) Constructs a newAllMemberQueryHandlerby parsing the specified query string.AllMemberQueryHandler(String queryString, javax.servlet.http.HttpServletRequest request) Constructs a newAllMemberQueryHandlerby parsing the specified query string and using informations available from the specified request (logged member, user language, etc). -
Method Summary
Modifier and TypeMethodDescriptionbooleangetAdmin()Retrieve the value of the administrator filter.Returns a description of the query in the language defined by userLang of this handler.getEmail()Retrieves the email being search in this queryPerform the Query and return a list of Member/DBMember id.protected org.apache.log4j.LoggerReturns a new PageResult of Member/DBMember for the current settings of this handler.String[]Retrieves the lucene fields in which the text search is being performed for members.getSort()Retrieve current sorting criteriagetType()Retrieve the type of Member to look for.booleanRetrieve whether the admin filter is used or not for this querybooleanbooleanprotected voidparseQueryStringParam(String key, String[] values) Method to be implemented by subclass to decode parameter from queryString.protected StringPrint current QueryHandler params using specified QueryHandlerPrinter.voidsetAdmin(boolean admin) Set the administrator filter option.voidsetAdminFilterEnabled(boolean enabled) Set whether the admin filter is used or not for this queryvoidSet the email to search in MembervoidsetGroupMode(String groupMode) Defines if the group search is an OR-search or an AND-search.voidsetSearchedFields(String... searchedFields) Defines the (lucene) members fields in which to perform the text search.voidSet the sorting criteriavoidSet the type of Member to look for.toString()Methods inherited from class com.jalios.jcms.handler.AbstractMemberQueryHandler
getClearanceLevel, getClearanceLevelSet, getEnabled, getExactGroup, getExternalAuth, getGid, getGids, getGidsOff, getGroupOffSet, getGroupSet, getGuest, getLdap, getPageSize, getRefinedWorkspace, getStart, getText, getUsage, isGuestFilterAvailable, isMissingCriteria, isPagerAll, isReverse, searchInSubGroup, setClearanceLevel, setClearanceLevelSet, setEnabled, setExactGroup, setExternalAuth, setGid, setGids, setGidsOff, setGroupOffSet, setGroupSet, setGuest, setGuests, setLdap, setPagerAll, setPageSize, setReverse, setStart, setText, setUsage, setWorkspace, setWrkspcMethods inherited from class com.jalios.jcms.handler.AbstractQueryHandler
getAttribute, getAttributeMap, getDataSet, getHiddenParams, getQueryString, init, parseQueryString, removeAttribute, setAttribute, setDataSetMethods inherited from class com.jalios.jcms.handler.JcmsFormHandler
afterValidation, canStartProcess, checkMissingField, getAvailableMainLanguage, getBackgroundProcess, getClosePopupUrl, getControllerContext, getEditFieldSet, getFormStep, getFormStepCount, getFormStepFinishLabel, getFormStepHiddenFields, getFormStepLabels, getFormStepPrefixProp, getHiddenField, getHiddenField, getHiddenField, getHiddenField, getHiddenField, getHiddenField, getHiddenField, getHiddenField, getHiddenField, getHiddenField, getHiddenField, getHiddenField, getHiddenField, getHiddenField, getHiddenField, getHiddenField, getHiddenFieldML, getMainLangValue, getMainLangValueArray, getMLMap, getMLMapArray, getModalRedirect, getMonolingualValue, getMonolingualValueArray, getMultilingualMainValue, getMultilingualMainValueArray, getMultilingualMLMap, getMultilingualMLMapArray, getOpenTabId, getRedirect, getRedirectOnClosePopup, getWorkspace, init, isFieldEdition, isFieldMissing, isFormStepClickable, isPartialFieldEdition, isPopupEdition, isWorkspaceForced, mapStringArrayToMapStringList, mapStringListToMapStringArray, mustSendForbiddenOnCSRF, performFinish, performNext, performPrevious, processAction, processStatus, sanitize, sanitize, sendRedirect, sendRedirect, setEditField, setFormStep, setNoRedirect, setNoSendRedirect, setOpenTabId, setOpFinish, setOpNext, setOpPrevious, setPopupEdition, setRedirect, setRedirectOnClosePopup, setWs, showCancelButton, showFinishButton, showNextButton, showPreviousButton, startProcess, updateUploadedFields, validate, validateCSRF, validateFinish, validateNext, validatePreviousMethods inherited from class com.jalios.jcms.context.JcmsJspContext
addAvoidanceLink, addBodyAttributes, addCSSHeader, addCSSHeader, addCSSHeader, addCSSHeader, addCustomHeader, addHandlebarTemplate, addHttpEquivHeader, addHttpNameHeader, addJavaScript, addJavaScript, addJavaScript, addJavaScriptCode, addJavaScriptModule, addPrefetchHeader, addStyleHeader, addStyleHeader, addSvgSpriteIcon, addWebAssets, canAccessAdminArea, checkAccess, checkAccess, checkCSRF, debugDisplayContext, disablePacker, forceEditIcon, forceUpdate, getAjaxRequestAttribute, getAjaxRequestId, getAllHeadersDiffMap, getAllHeadersMap, getAvoidanceLinks, getBackOfficeCSSHeader, getBackOfficeJavaScriptSet, getBodyAttributes, getContentForm, getCSSHeaders, getCtxCategories, getCurrentCategory, getCustomHeaders, getDocType, getFinalCSSFooterMap, getFinalCSSMap, getFinalJavaScriptModuleSet, getFinalJavaScriptSet, getFrontOfficeCSSHeader, getFrontOfficeJavaScriptSet, getHandlebarTemplates, getHttpEquivHeaders, getHttpNameHeaders, getJavaScriptCodeSet, getJavaScriptModuleSet, getJavaScriptSet, getPageContext, getPageTitle, getPageZone, getPortal, getPortalCategory, getPortlet, getPublication, getStyleHeaders, getSvgSprites, getSvgSpritesHtml, getTemplateUsage, internalSetupEmptyHeader, isEditIcon, isEditIcon, isEditIconForPublish, isEditIconForPublish, isPrintView, registerDisplayContext, removeAjaxRequestAttribute, setAjaxRequestAttribute, setAjaxRequestId, setAllHeadersDiffMap, setDocType, setEditIcon, setPageContext, setPageTitle, setPageZone, setShowEditIcon, setTemplateUsage, showEditIcon, showEditIcon, showEditIconMethods inherited from class com.jalios.jcms.context.JcmsContext
addMsg, addMsg, addMsgSession, addMsgSession, addToastr, addToastr, addToastrSession, addToastrSession, applySelector, canAccessAdminArea, copyMsgListToMsgSessionList, forceWorkspaceUpdate, getBaseUrl, getBrowser, getCaddy, getContextPath, getErrorMsg, getErrorMsgList, getErrorMsgSession, getErrorMsgSessionList, getInfoMsg, getInfoMsgList, getInfoMsgSession, getInfoMsgSessionList, getLoggedMember, getMsgList, getMsgSessionList, getRequest, getResponse, getSession, getSuccessMsg, getSuccessMsgList, getSuccessMsgSession, getSuccessMsgSessionList, getToastrCollection, getToastrSessionCollection, getUploadedFiles, getUploadedFiles, getUrlWithCommonUpdatedParams, getUserCountry, getUserLang, getUserLocale, getUserZoneId, getWarningMsg, getWarningMsgList, getWarningMsgSession, getWarningMsgSessionList, glp, isAdmin, isAdminZone, isAjaxRequest, isDBMember, isDebug, isDebugTemplate, isInFrontOffice, isLogged, isWorkZone, removeMessage, removeMessage, removeMsg, select, sendError, sendError, sendForbidden, sendForbidden, sendRedirect, sendRedirect, sendRedirect, setErrorMsg, setErrorMsg, setErrorMsgSession, setErrorMsgSession, setInfoMsg, setInfoMsg, setInfoMsgSession, setInfoMsgSession, setLoggedMember, setRequest, setResponse, setSuccessMsg, setSuccessMsg, setSuccessMsgSession, setSuccessMsgSession, setWarningMsg, setWarningMsg, setWarningMsgSession, setWarningMsgSession, updateWorkspace, validateRegexp, validateSchedule
-
Field Details
-
GROUP_MODE_OR
- See Also:
-
GROUP_MODE_AND
- See Also:
-
ALL_USAGE
public static final int ALL_USAGEValue that can be specified toAbstractMemberQueryHandler.setUsage(int)to search for all members whatever their usage (both contact and account).- Since:
- jcms-9.0.2 - JCMS-4764
- See Also:
-
mbrSearchEngine
-
isGroupModeOr
protected boolean isGroupModeOr -
sortForced
protected boolean sortForced -
admin
protected boolean admin -
adminFilterEnabled
protected boolean adminFilterEnabled
-
-
Constructor Details
-
AllMemberQueryHandler
public AllMemberQueryHandler()Constructs a new emptyAllMemberQueryHandlerwith default option.- Since:
- jcms-6.1
-
AllMemberQueryHandler
Constructs a newAllMemberQueryHandlerby 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
-
AllMemberQueryHandler
Constructs a newAllMemberQueryHandlerby 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.
"text":AbstractMemberQueryHandler.setText(String)"gid":AbstractMemberQueryHandler.setGid(String)"gids":AbstractMemberQueryHandler.setGids(String[])"gidsOff":AbstractMemberQueryHandler.setGidsOff(String[])"usage":AbstractMemberQueryHandler.setUsage(int)"email":setEmail(String)"wrkspc":AbstractMemberQueryHandler.setWrkspc(String)"enabled":AbstractMemberQueryHandler.setEnabled(Boolean)"ldap":AbstractMemberQueryHandler.setLdap(Boolean)"type":setType(String)"clearanceLevel":AbstractMemberQueryHandler.setClearanceLevel(String...)"admin":setAdmin(boolean)"searchedFields":setSearchedFields(String...)
- 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 :
"gid=j_42"
request- theHttpServletRequestto use to retrieveloggedMember,userLang,userLocalethat will be used by this handler, ignored if null.- Since:
- jcms-6.1
-
-
Method Details
-
getLogger
protected org.apache.log4j.Logger getLogger()- Specified by:
getLoggerin classAbstractQueryHandler<DBMember>
-
parseQueryStringParam
Description copied from class:AbstractQueryHandlerMethod to be implemented by subclass to decode parameter from queryString.- Overrides:
parseQueryStringParamin classAbstractMemberQueryHandler<DBMember>- Parameters:
key- the parameter name, never null nor empty.values- the parameter values, NEVER NULL NOR EMPTY. You can safely invokeparamValues[0]
-
printParams
Print current QueryHandler params using specified QueryHandlerPrinter.- Overrides:
printParamsin classAbstractMemberQueryHandler<DBMember>- Parameters:
printer- a QueryHandlerPrinter to use- Returns:
- a string containing all parameters of this handler printed using specified QueryHandlerPrinter.
- Since:
- jcms-6.1
-
toString
- Overrides:
toStringin classAbstractMemberQueryHandler<DBMember>
-
getDescription
Returns a description of the query in the language defined by userLang of this handler.- Returns:
- the string of the description
-
getPageResult
Returns a new PageResult of Member/DBMember for the current settings of this handler.No more than
LuceneMemberSearchEngine.getMaximumResults()Members will be returned, if this limit is reached, attributeLuceneMemberSearchEngine.MAXIMUM_RESULTS_NUMBER_REACHEDis added to thisAllMemberQueryHandlerwith the total count of Member retrieved in the value.- Returns:
- a new PageResult, null may be returned in case of internal error
-
getIdResultList
Perform the Query and return a list of Member/DBMember id.Paging parameter will not be used, however no more than
LuceneMemberSearchEngine.getMaximumResults()Members will be returned, if this limit is reached, attributeLuceneMemberSearchEngine.MAXIMUM_RESULTS_NUMBER_REACHEDis added to thisAllMemberQueryHandlerwith the total count of Member retrieved in the value.- Returns:
- a List of String (DBMembers' id), null may be returned in case of internal error
-
setGroupMode
Defines if the group search is an OR-search or an AND-search. Default is AND-search.- Parameters:
groupMode- eitherGROUP_MODE_ORorGROUP_MODE_AND- Since:
- jcms-7.0.0
-
isGroupModeAnd
public boolean isGroupModeAnd() -
isGroupModeOr
public boolean isGroupModeOr() -
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
Set the email to search in Member- Parameters:
email- any exact email to look for in Members- Since:
- jcms-6.1
-
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
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 ofgetAdmin()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
-
getSearchedFields
Retrieves the lucene fields in which the text search is being performed for members.- Returns:
- an array of lucene field name in which to do the text search. (if null or empty default behavior is used)
- Since:
- 11.0.0 / JCMS-11874
-
setSearchedFields
Defines the (lucene) members fields in which to perform the text search.- Parameters:
searchedFields- an array of lucene field name in which to do the text search. if null or empty will use default behavior.- Since:
- 11.0.0 / JCMS-11874
-
setSort
Description copied from class:AbstractMemberQueryHandlerSet the sorting criteriaPossible 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:
setSortin classAbstractMemberQueryHandler<DBMember>- Parameters:
sort- a field name that should be used for sorting
-
getSort
Description copied from class:AbstractMemberQueryHandlerRetrieve current sorting criteria- Overrides:
getSortin classAbstractMemberQueryHandler<DBMember>- Returns:
- a lucene field name that should be used for sorting
-