Package com.jalios.jcms.handler
Class GroupQueryHandler
java.lang.Object
- All Implemented Interfaces:
JcmsConstants,JaliosConstants
Holder class and form handler of all parameters to be used for a query of groups.
- Since:
- jcms-5.7.4
- Author:
- Olivier Jaquemet
-
Nested Class Summary
Nested classes/interfaces inherited from class com.jalios.jcms.handler.AbstractQueryHandler
AbstractQueryHandler.HiddenParamQhPrinter, AbstractQueryHandler.QueryHandlerPrinter, AbstractQueryHandler.QueryStringQhPrinter -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final Stringstatic final Stringstatic final Stringprotected booleanprotected intprotected intstatic final Stringprotected booleanprotected Stringstatic final StringFields 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 emptyGroupQueryHandlerwith default option.GroupQueryHandler(String queryString) Constructs a newGroupQueryHandlerby parsing the specified query string.GroupQueryHandler(String queryString, javax.servlet.http.HttpServletRequest request) Constructs a newGroupQueryHandlerby parsing the specified query string and using informations available from the specified request (logged member, user language, etc). -
Method Summary
Modifier and TypeMethodDescriptiongetGid()Retrieve the parent group id used by this QueryRetrieve the current group filter being used by this GroupQueryHandler.Retrieves the text being search in this querygetLdap()protected org.apache.log4j.LoggerintGet the page sizeRetrieves the parent group used by this query, as specified usingsetGid(String).Retrieves the Workspace being used to filter groups in this Query.Return results of a query done using thisGroupQueryHandler.getResultSet(Comparator<? super Group> comparator) Return results of a query done using thisGroupQueryHandler.getSort()Retrieve current sorting criteriaintgetStart()Get the start index to use for pagingbooleanGet the paging option of this handlerbooleanCheck the ordering of the sort criteriaprotected voidparseQueryStringParam(String key, String[] values) Method to be implemented by subclass to decode parameter from queryString.protected StringPrint current QueryHandler params using specified QueryHandlerPrinter.voidSets the parent group id to be used during queryvoidvoidsetGroupFilter(String groupFilter) Define the groupFilter to use in this GroupQueryHandler.voidsetGroupText(String groupText) Set the text to search in GroupvoidvoidvoidsetPagerAll(boolean pagerAll) Set the pagerAll option of this handlervoidsetPageSize(int pageSize) Set the page sizevoidvoidsetReverse(boolean reverse) Set the ordering of the sort criteriavoidSet the sorting criteriavoidsetStart(int start) Set the start index to use for pagingvoidvoidSets the Workspace that groups must belong to in order to be found.toString()Methods 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, setWorkspace, 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
-
LDAP_FILTER_PARAM
- See Also:
-
GLOBAL_FILTER_PARAM
- See Also:
-
ORGANIZATION_FILTER_PARAM
- See Also:
-
VISIBILITY_FILTER_PARAM
- See Also:
-
PROFILING_FILTER_PARAM
- See Also:
-
sort
-
reverse
protected boolean reverse -
pageStart
protected int pageStart -
pageSize
protected int pageSize -
pagerAll
protected boolean pagerAll
-
-
Constructor Details
-
GroupQueryHandler
public GroupQueryHandler()Constructs a new emptyGroupQueryHandlerwith default option.- Since:
- jcms-5.7.4
-
GroupQueryHandler
Constructs a newGroupQueryHandlerby parsing the specified query string.See
GroupQueryHandler(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 :
"groupText=welcome&gid=j_42"
- Since:
- jcms-5.7.4
-
GroupQueryHandler
Constructs a newGroupQueryHandlerby 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.
"groupFilter":setGroupFilter(String)"groupText":setGroupText(String)"gid":setGid(String)"wrkspc":setWrkspc(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 :
"groupText=welcome&gid=j_42"
request- theHttpServletRequestto use to retrieveloggedMember,userLang,userLocalethat will be used by this handler, ignored if null.- Since:
- jcms-5.7.4
-
-
Method Details
-
getLogger
protected org.apache.log4j.Logger getLogger()- Specified by:
getLoggerin classAbstractQueryHandler<Group>
-
parseQueryStringParam
Description copied from class:AbstractQueryHandlerMethod to be implemented by subclass to decode parameter from queryString.- Specified by:
parseQueryStringParamin classAbstractQueryHandler<Group>- 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.- Specified by:
printParamsin classAbstractQueryHandler<Group>- Parameters:
printer- a QueryHandlerPrinter to use- Returns:
- a string containing all parameters of this handler printed using specified QueryHandlerPrinter.
- Since:
- jcms-5.7.4
-
toString
-
getResultSet
Return results of a query done using thisGroupQueryHandler.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
Setcontaining allGroupfound by this query.
-
getResultSet
Return results of a query done using thisGroupQueryHandler.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
Setcontaining allGroupfound by this query, sorted using specified comparator if any.
-
getGroupFilter
Retrieve the current group filter being used by this GroupQueryHandler.- Returns:
- a string indicating the filter being applied
- Since:
- jcms-5.7.4
- See Also:
-
setGroupFilter
Define the groupFilter to use in this GroupQueryHandler.- Parameters:
groupFilter- a string indicating the filter being applied, see constructorGroup.WorkspaceSelectorfor more information on possible values
-
setWrkspc
Sets the Workspace that groups must belong to in order to be found.- Parameters:
wsId- an id of Workspace or null to disable filter on Group's Workspace- Since:
- jcms-7.0.2 jcms-7.1
-
getRefinedWorkspace
Retrieves the Workspace being used to filter groups in this Query.- Returns:
- a Workspace or null if no workspace is being used
- Since:
- jcms-5.7.4
-
getGroupText
Retrieves the text being search in this query- Returns:
- a string or null if no text is being searched
-
setGroupText
Set the text to search in Group- Parameters:
groupText- any string to look for in Group's name
-
getGid
Retrieve the parent group id used by this Query- Returns:
- an id of Group or null if there is no filter on parent Group
-
setGid
Sets the parent group id to be used during query- Parameters:
parentGid- an id of Group or null to disable filter on parent Group
-
getParentGroup
Retrieves the parent group used by this query, as specified usingsetGid(String).- Returns:
- a Group or null if there is no filter on parent Group
-
getLdap
- Returns:
- true to filter on LDAP groups only
- Since:
- jcms-10.0.8 / JCMS-10227
-
setLdap
- Parameters:
v- set filter on LDAP groups only- Since:
- jcms-10.0.8 / JCMS-10227
-
getGlobal
- Returns:
- true to filter on global groups only, false on workspace groups
- Since:
- jcms-10.0.8 / JCMS-10641
-
setGlobal
- Parameters:
v- set filter on global groups only- Since:
- jcms-10.0.8 / JCMS-10641
-
getOrganization
- Returns:
- true to filter on organization groups only
- Since:
- jcms-10.0.8 / JCMS-10641
-
setOrganization
- Parameters:
v- set filter on organization groups only- Since:
- jcms-10.0.8 / JCMS-10641
-
getVisibility
- Returns:
- visibility filter to apply
- Since:
- jcms-10.0.8 / JCMS-10641
-
setVisibility
- Parameters:
v- set filter on group visibility- Since:
- jcms-10.0.8 / JCMS-10641
-
getProfiling
- Returns:
- true to filter on profiling groups only
- Since:
- jcms-10.0.9 / JCMS-11117
-
setProfiling
- Parameters:
v- set filter on profiling groups only- Since:
- jcms-10.0.9 / JCMS-11117
-
setStart
public void setStart(int start) Set the start index to use for paging- Parameters:
start- the index of the first member to be displayed in current page
-
getStart
public int getStart()Get the start index to use for paging- Returns:
- the index of the first member to be displayed in current page
-
setPageSize
public void setPageSize(int pageSize) Set the page size- Parameters:
pageSize- the number of element to be displayed
-
getPageSize
public int getPageSize()Get the page size- Returns:
- the number of element to be displayed
-
setSort
Set the sorting criteria- Parameters:
sort- a field name that should be used for sorting
-
getSort
Retrieve current sorting criteria- Returns:
- a lucene field name that should be used for sorting
-
setReverse
public void setReverse(boolean reverse) Set the ordering of the sort criteria- Parameters:
reverse- true if the reverse order should be used
-
isReverse
public boolean isReverse()Check the ordering of the sort criteria- Returns:
- true if the reverse order should be used
-
setPagerAll
public void setPagerAll(boolean pagerAll) Set the pagerAll option of this handler- Parameters:
pagerAll- true if all item should be displayed
-
isPagerAll
public boolean isPagerAll()Get the paging option of this handler- Returns:
- true if all item should be displayed
-