public class MemberQueryHandler extends AbstractQueryHandler<Member>
AbstractQueryHandler.HiddenParamQhPrinter, AbstractQueryHandler.QueryHandlerPrinter, AbstractQueryHandler.QueryStringQhPrinter
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
REVISION |
contextMap, editFieldSet, noRedirect, noSendRedirect, popupEdition, redirect, redirectOnClosePopup, workspaceForced
AJAX_REQUEST_ATTRIBUTES, BODY_HEADER, CSS_HEADER, cssboMap, cssfoMap, CUSTOM_HEADER, editIcon, HTTPEQUIV_HEADER, httpequivMap, HTTPNAME_HEADER, httpnameMap, initEditIcon, JAVASCRIPT_CODE_SET_ATTRIBUTE, JAVASCRIPT_SET_ATTRIBUTE, jsboSet, jsfoSet, out, pageContext, SHOW_EDIT_ICON, STYLE_HEADER
browser, caddy, channel, inFO, initDone, initWorkspace, isAdmin, isAjaxRequest, isDBMember, isDebug, isLogged, loggedMember, request, response, userCountry, userLang, userLocale, workspace
ADATE_SEARCH, ADMIN_NOTES_PROP, ADVANCED_TAB, ARCHIVES_DIR, ASCII_WIDTH, CATEGORY_TAB, CDATE_SEARCH, COMMON_ALARM, CONTENT_TAB, COOKIE_MAX_AGE, CTRL_TOPIC_INTERNAL, CTRL_TOPIC_REF, CTRL_TOPIC_VALUE, CTRL_TOPIC_WRITE, CUSTOM_PROP, DOCCHOOSER_HEIGHT, DOCCHOOSER_WIDTH, DOCS_DIR, EDATE_SEARCH, EMAIL_REGEXP, ERROR_MSG, FORBIDDEN_FILE_ACCESS, FORBIDDEN_REDIRECT, FORCE_REDIRECT, ICON_ARCHIVE, ICON_LOCK, ICON_LOCK_STRONG, ICON_WARN, ICON_WH_BOOK_CLOSED, ICON_WH_BOOK_OPEN, INFORMATION_MSG, JALIOS_JUNIT_PROP, JCMS_CADDY, JCMS_MSG_LIST, JSYNC_DOWNLOAD_DIR, JSYNC_SYNC_ALARM, 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, PDATE_SEARCH, PHOTO_DIR, PHOTO_ICON, PHOTO_ICON_HEIGHT, PHOTO_ICON_WIDTH, PHOTO_LARGE, PHOTO_LARGE_HEIGHT, PHOTO_LARGE_WIDTH, PHOTO_NORMAL, PHOTO_NORMAL_HEIGHT, PHOTO_NORMAL_WIDTH, PHOTO_SMALL, PHOTO_SMALL_HEIGHT, PHOTO_SMALL_WIDTH, PHOTO_TINY, PHOTO_TINY_HEIGHT, PHOTO_TINY_WIDTH, PREVIOUS_TAB, PRINT_VIEW, PRIVATE_FILE_ACCESS, PUBLIC_FILE_ACCESS, READ_RIGHT_TAB, SDATE_SEARCH, SEARCHENGINE_ALARM, SESSION_AUTHORIZED_FILENAMES_SET, STATS_REPORT_DIR, STATUS_PROP, STORE_XML, TEMPLATE_TAB, THUMBNAIL_LARGE_HEIGHT, THUMBNAIL_LARGE_WIDTH, THUMBNAIL_SMALL_HEIGHT, THUMBNAIL_SMALL_WIDTH, TYPES_ICON_ALT_PROP, TYPES_ICON_SUFFIX_PROP, TYPES_ICON_TITLE_PROP, TYPES_PREFIX_PROP, TYPES_THUMB_SUFFIX_PROP, UDATE_SEARCH, UPDATE_RIGHT_TAB, UPLOAD_DIR, URL_REGEXP, WARNING_MSG, WEBAPP_PROP, WFEXPRESS_ALARM, WFREMINDER_ALARM, WORKFLOW_TAB, WORKFLOW_XML
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_YEAR
Constructor and Description |
---|
MemberQueryHandler()
Constructs a new empty
MemberQueryHandler with default option. |
MemberQueryHandler(java.lang.String queryString)
Constructs a new
MemberQueryHandler by parsing the specified query string. |
MemberQueryHandler(java.lang.String queryString,
javax.servlet.http.HttpServletRequest request)
Constructs a new
MemberQueryHandler by parsing the
specified query string and using informations available
from the specified request (logged member, user language, etc). |
Modifier and Type | Method and Description |
---|---|
boolean |
getAdmin()
Retrieve the value of the administrator filter.
|
java.lang.String |
getGid()
Retrieve the group id used by this Query
|
java.lang.String[] |
getGids()
Retrieve the groups id used by this Query
|
java.util.Set<Group> |
getGroupSet()
Retrieves the groups that members must belong to in order to be found.
|
protected org.apache.log4j.Logger |
getLogger() |
Workspace |
getRefinedWorkspace()
Retrieves the Workspace that members must belong to in order to be found.
|
java.util.Set<Member> |
getResultSet()
Return results of a query done using this
MemberQueryHandler . |
java.util.Set<Member> |
getResultSet(java.util.Comparator<? super Member> comparator)
Return results of a query done using this
GroupQueryHandler . |
java.lang.String |
getText()
Retrieves the text being search in this query
|
int |
getUsage()
Retrieve the usage that members must be in order to be found.
|
boolean |
getWorker()
Retrieve the value of the worker filter.
|
boolean |
isAdminFilterEnabled()
Retrieve whether the admin filter is used or not for this query
|
boolean |
isWorkerFilterEnabled()
Retrieve whether the worker filter is used or not for this query
|
protected void |
parseQueryStringParam(java.lang.String key,
java.lang.String[] values)
Method to be implemented by subclass to decode parameter from queryString.
|
protected java.lang.String |
printParams(AbstractQueryHandler.QueryHandlerPrinter printer)
Print current QueryHandler params using specified QueryHandlerPrinter.
|
void |
setAdmin(boolean admin)
Set the administrator filter option.
|
void |
setAdminFilterEnabled(boolean enabled)
Set whether the admin filter is used or not for this query
|
void |
setGid(java.lang.String gid)
Sets the group that members must belong to in order to be found.
|
void |
setGids(java.lang.String[] gids)
Sets the group that members must belong to in order to be found.
|
void |
setText(java.lang.String text)
Set the text to search in Member
|
void |
setUsage(int usage)
Set the usage that members must be in order to be found.
|
void |
setWorker(boolean worker)
Set the worker filter option.
|
void |
setWorkerFilterEnabled(boolean enabled)
Set whether the worker filter is used or not for this query
|
void |
setWrkspc(java.lang.String wsId)
Sets the Workspace that members must belong to in order to be found.
|
java.lang.String |
toString() |
getAttribute, getAttributeMap, getDataSet, getHiddenParams, getQueryString, init, parseQueryString, removeAttribute, setAttribute, setDataSet
afterValidation, checkMissingField, getControllerContext, getEditFieldSet, getHiddenField, getHiddenField, getHiddenField, getHiddenField, getHiddenField, getHiddenField, getHiddenField, getHiddenField, getHiddenField, getHiddenField, getHiddenField, getHiddenField, getHiddenField, getHiddenField, getHiddenField, getHiddenFieldML, getMainLangValue, getMainLangValueArray, getMLMap, getMLMapArray, getRedirect, getRedirectOnClosePopup, getWorkspace, init, isFieldEdition, isFieldMissing, isPartialFieldEdition, isPopupEdition, isWorkspaceForced, processAction, processStatus, sendRedirect, sendRedirect, setEditField, setNoRedirect, setNoSendRedirect, setPopupEdition, setRedirect, setRedirectOnClosePopup, setWorkspace, setWs, updateUploadedField, updateUploadedFields, validate
addBodyAttributes, addCSSHeader, addCSSHeader, addCSSHeader, addCSSHeader, addCustomHeader, addHttpEquivHeader, addHttpNameHeader, addJavaScript, addJavaScript, addJavaScript, addJavaScriptCode, addPrefetchHeader, addStyleHeader, addStyleHeader, checkAccess, checkAccess, checkCSRF, debugDisplayContext, disablePacker, forceEditIcon, forceUpdate, getAjaxRequestAttribute, getAjaxRequestId, getAllHeadersDiffMap, getAllHeadersMap, getBackOfficeCSSHeader, getBackOfficeJavaScriptSet, getBodyAttributes, getContentForm, getCSSHeaders, getCtxCategories, getCurrentCategory, getCustomHeaders, getDocType, getFinalCSSMap, getFinalJavaScriptSet, getFormElementCount, getFrontOfficeCSSHeader, getFrontOfficeJavaScriptSet, getHttpEquivHeaders, getHttpNameHeaders, getJavaScriptCodeSet, getJavaScriptSet, getJSONBridge, getPackVersion, getPageContext, getPageTitle, getPageZone, getPortal, getPortalCategory, getPortlet, getPublication, getStyleHeaders, getTemplateUsage, internalSetupEmptyHeader, isEditIcon, isEditIcon, isPrintView, registerDisplayContext, removeAjaxRequestAttribute, setAjaxRequestAttribute, setAjaxRequestId, setAllHeadersDiffMap, setDocType, setEditIcon, setFormElementCount, setPageContext, setPageTitle, setPageZone, setShowEditIcon, setTemplateUsage, showEditIcon, showEditIcon, workaroundBrowserBaseHrefBug
addCookie, addMsg, addMsg, addMsgSession, addMsgSession, applySelector, forceWorkspaceUpdate, getBaseUrl, getBrowser, getCaddy, getContextPath, getErrorMsg, getErrorMsgList, getErrorMsgSession, getErrorMsgSessionList, getInfoMsg, getInfoMsgList, getInfoMsgSession, getInfoMsgSessionList, getLoggedMember, getMsgList, getMsgSessionList, getRequest, getResponse, getSession, getUploadedFile, getUploadedFileList, getUrlWithCommonUpdatedParams, getUserCountry, getUserLang, getUserLocale, getWarningMsg, getWarningMsgList, getWarningMsgSession, getWarningMsgSessionList, glp, isAdmin, isAjaxRequest, isDBMember, isDebug, isInFrontOffice, isLogged, isWebdavAccess, removeMessage, removeMessage, retrieveUploadedFile, select, sendForbidden, sendForbidden, sendRedirect, sendRedirect, sendRedirect, setErrorMsg, setErrorMsg, setErrorMsgSession, setErrorMsgSession, setInfoMsg, setInfoMsg, setInfoMsgSession, setInfoMsgSession, setLoggedMember, setRequest, setResponse, setWarningMsg, setWarningMsg, setWarningMsgSession, setWarningMsgSession, validateRegexp, validateSchedule
public static final java.lang.String REVISION
public MemberQueryHandler()
MemberQueryHandler
with default option.public MemberQueryHandler(java.lang.String queryString)
MemberQueryHandler
by parsing the specified query string.
See MemberQueryHandler(String, HttpServletRequest)
for a list of the
decoded parameters.
queryString
- a query String consisting of parameters (key=value) to be set in this handler.
"text=welcome&gid=j_42"
public MemberQueryHandler(java.lang.String queryString, javax.servlet.http.HttpServletRequest request)
MemberQueryHandler
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.
"text"
: setText(String)
"gid"
: setGid(String)
"gids"
: setGids(String[])
"wrkspc"
: setWrkspc(String)
"usage"
: setUsage(int)
"admin"
: setAdmin(boolean)
"worker"
: setWorker(boolean)
queryString
- a query String consisting of parameters (key=value) to be set in this handler.
"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.protected org.apache.log4j.Logger getLogger()
getLogger
in class AbstractQueryHandler<Member>
protected void parseQueryStringParam(java.lang.String key, java.lang.String[] values)
AbstractQueryHandler
parseQueryStringParam
in class AbstractQueryHandler<Member>
key
- the parameter name, never null nor empty.values
- the parameter values, NEVER NULL NOR EMPTY.
You can safely invoke paramValues[0]
protected java.lang.String printParams(AbstractQueryHandler.QueryHandlerPrinter printer)
printParams
in class AbstractQueryHandler<Member>
printer
- a QueryHandlerPrinter to usepublic java.lang.String toString()
toString
in class java.lang.Object
public java.util.Set<Member> getResultSet()
MemberQueryHandler
.
Warning: This method process the query each time it is invoked, therefore do not call it multiple times if you don't need it.
Set
containing all Member
found by this query.public java.util.Set<Member> getResultSet(java.util.Comparator<? super Member> comparator)
GroupQueryHandler
.
Warning: This method process the query each time it is invoked, therefore do not call it multiple times if you don't need it.
comparator
- the optionnal Comparator to sort the return collectionSet
containing all Member
found by this query,
sorted using specified comparator if any.public java.lang.String getText()
public void setText(java.lang.String text)
text
- any string to look for in Memberspublic java.lang.String getGid()
public void setGid(java.lang.String gid)
gid
- an id of Group or null to disable filter on Member's Grouppublic java.lang.String[] getGids()
public void setGids(java.lang.String[] gids)
Member must belong to at least one of them.
gids
- an array of id of Group or null to disable filter on Member's Grouppublic java.util.Set<Group> getGroupSet()
Member must belong to at least one of them.
public void setWrkspc(java.lang.String wsId)
wsId
- an id of Workspace or null to disable filter on Member's Workspacepublic Workspace getRefinedWorkspace()
public void setAdmin(boolean admin)
Automatically invoke setAdminFilterEnabled(boolean)
) to enable filter.
admin
- true to retrieve only administrators, false to retrieve all but administratorspublic boolean getAdmin()
Important : this value is used only if isAdminFilterEnabled is true !
public void setAdminFilterEnabled(boolean enabled)
enabled
- true if the value of getAdmin()
is used for this query, false otherwise.public boolean isAdminFilterEnabled()
getAdmin()
is used for this query, false otherwise.public void setWorker(boolean worker)
Automatically invoke setWorkerFilterEnabled(boolean)
) to enable filter.
worker
- true to retrieve only workers only, false to retrieve all but workerspublic boolean getWorker()
Important : this value is used only if isWorkerFilterEnabled is true !
public void setWorkerFilterEnabled(boolean enabled)
enabled
- true if the value of getWorker()
is used for this query, false otherwise.public boolean isWorkerFilterEnabled()
getWorker()
is used for this query, false otherwise.public void setUsage(int usage)
usage
- the usage to find, set to -1 to ignoreMember.USAGE_ACCOUNT
,
Member.USAGE_CONTACT
public int getUsage()
Copyright © 2001-2010 Jalios SA. All Rights Reserved.