public class ArchiveQueryHandler extends AbstractQueryHandler<ArchivedPublication>
AbstractQueryHandler.HiddenParamQhPrinter, AbstractQueryHandler.QueryHandlerPrinter, AbstractQueryHandler.QueryStringQhPrinter
Modifier and Type | Field and Description |
---|---|
protected java.lang.String |
mode |
protected short |
originalType |
protected boolean |
pagerAll |
protected int |
pageSize |
protected int |
pageStart |
protected boolean |
reverse |
static java.lang.String |
REVISION |
protected java.lang.String |
sort |
protected java.lang.String |
text |
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 |
---|
ArchiveQueryHandler()
Constructs a new empty
ArchiveQueryHandler with default option. |
ArchiveQueryHandler(java.lang.String queryString)
Constructs a new
ArchiveQueryHandler by parsing the specified query string. |
ArchiveQueryHandler(java.lang.String queryString,
javax.servlet.http.HttpServletRequest request)
Constructs a new
ArchiveQueryHandler 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 |
---|---|
protected org.apache.log4j.Logger |
getLogger() |
java.lang.String |
getMode() |
java.lang.String |
getOriginalType()
Retrieves the type of archive being search.
|
PageResult<ArchivedPublication> |
getPageResult()
Returns a new PageResult of archive for the current settings of this handler.
|
Workspace |
getRefinedWorkspace()
Retrieves the Workspace that archives must belong to in order to be found.
|
java.lang.String |
getText()
Retrieves the text being search in 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)
Method to be implemented by subclass to provide params
printing in query or hidden input format.
|
void |
setMode(java.lang.String mode) |
void |
setOriginalType(java.lang.String originalTypeStr)
Set the type of archive being search.
|
void |
setOriginalTypeShort(short originalType)
Set the type of archive being search.
|
void |
setPagerAll(boolean pagerAll) |
void |
setPageSize(int pageSize) |
void |
setReverse(boolean reverse) |
void |
setSort(java.lang.String sort) |
void |
setStart(int start) |
void |
setText(java.lang.String text)
Set the text to search in Archive
|
void |
setWrkspc(java.lang.String wsId)
Sets the Workspace that archive 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
protected short originalType
protected java.lang.String text
protected java.lang.String mode
protected java.lang.String sort
protected boolean reverse
protected int pageStart
protected int pageSize
protected boolean pagerAll
public ArchiveQueryHandler()
ArchiveQueryHandler
with default option.public ArchiveQueryHandler(java.lang.String queryString)
ArchiveQueryHandler
by parsing the specified query string.
See ArchiveQueryHandler(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&ws=j_42"
public ArchiveQueryHandler(java.lang.String queryString, javax.servlet.http.HttpServletRequest request)
ArchiveQueryHandler
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)
"originalType"
: setOriginalType(String)
"wrkspc"
: setWrkspc(String)
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<ArchivedPublication>
protected void parseQueryStringParam(java.lang.String key, java.lang.String[] values)
AbstractQueryHandler
parseQueryStringParam
in class AbstractQueryHandler<ArchivedPublication>
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)
AbstractQueryHandler
protected String printParams(QueryHandlerPrinter printer) { printer.printParam("foo", getFoo()); printer.printParam("bar", getBar()); return printer.toString(); }
printParams
in class AbstractQueryHandler<ArchivedPublication>
printer
- a QueryHandlerPrinter to usepublic java.lang.String toString()
toString
in class java.lang.Object
public PageResult<ArchivedPublication> getPageResult()
public java.lang.String getText()
public void setText(java.lang.String text)
text
- any string to look for in Archivepublic void setMode(java.lang.String mode)
public java.lang.String getMode()
public java.lang.String getOriginalType()
public void setOriginalType(java.lang.String originalTypeStr)
originalTypeStr
- "content" or "form"public void setOriginalTypeShort(short originalType)
originalType
- -1 for all archive, otherwise use ArchivedPublication.TYPE_CONTENT or ArchivedPublication.TYPE_FORMpublic void setWrkspc(java.lang.String wsId)
wsId
- an id of Workspace or null to disable filter on Archive's Workspacepublic Workspace getRefinedWorkspace()
public void setSort(java.lang.String sort)
public void setReverse(boolean reverse)
public void setStart(int start)
public void setPageSize(int pageSize)
public void setPagerAll(boolean pagerAll)
Copyright © 2001-2010 Jalios SA. All Rights Reserved.