com.jalios.jcms.trash

Class TrashAppHandler

java.lang.Object

com.jalios.jcms.context.JcmsContext

com.jalios.jcms.context.JcmsJspContext

com.jalios.jcms.handler.JcmsFormHandler

com.jalios.jcms.handler.AbstractQueryHandler<Publication>

com.jalios.jcms.handler.QueryHandler

com.jalios.jcms.search.QueryAppHandler

com.jalios.jcms.trash.TrashAppHandler

All Implemented Interfaces:

JcmsConstants, JaliosConstants

public class TrashAppHandler
extends QueryAppHandler

Handler used to access Trash application.

Since:

jcms-10.0.5 / JCMS-8353

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TrashAppHandler.View

Nested classes/interfaces inherited from class com.jalios.jcms.handler.AbstractQueryHandler

AbstractQueryHandler.HiddenParamQhPrinter, AbstractQueryHandler.QueryHandlerPrinter, AbstractQueryHandler.QueryStringQhPrinter

Field Summary

Fields

Modifier and Type	Field and Description
protected QueryResultSet	resultSet
protected QueryHandler	secondQuery

Fields inherited from class com.jalios.jcms.search.QueryAppHandler

prevDateSince

Fields inherited from class com.jalios.jcms.handler.QueryHandler

REVISION, TEXT_MODE_ADVANCED, TEXT_MODE_ALL_WORDS, TEXT_MODE_ANY_WORD, TEXT_MODE_EXACT

Fields inherited from class com.jalios.jcms.handler.JcmsFormHandler

contextMap, editFieldSet, formStep, noRedirect, noSendRedirect, op, opFinish, opNext, opPrevious, popupEdition, redirect, redirectOnClosePopup, workspaceForced

Fields 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_SET_ATTRIBUTE, jsboSet, jsfoSet, out, pageContext, SHOW_EDIT_ICON, STYLE_HEADER

Fields 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, workspace

Fields inherited from interface com.jalios.jcms.JcmsConstants

ADATE_SEARCH, ADMIN_NOTES_PROP, ADVANCED_TAB, AJAX_MODE_ATTR, ARCHIVES_DIR, ASCII_WIDTH, CATEGORY_TAB, CDATE_SEARCH, CLASS_PROPERTY, COMMON_ALARM, CONTENT_TAB, COOKIE_MAX_AGE, COUNTRY_SPRITE, 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, 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_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, PREVIOUS_TAB, PRINT_VIEW, PRIVATE_FILE_ACCESS, PUBLIC_FILE_ACCESS, RAW_CONTENT_ICON_PREFIX, READ_RIGHT_TAB, SDATE_SEARCH, SEARCHENGINE_ALARM, SESSION_AUTHORIZED_FILENAMES_SET, SPRITE_ICON_PREFIX, STATS_REPORT_DIR, STATUS_PROP, STORE_XML, SUCCESS_MSG, SVG_ICON_PREFIX, SVGINLINE_ICON_PREFIX, TEMPLATE_TAB, 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, UDATE_SEARCH, UPDATE_RIGHT_TAB, UPLOAD_DIR, UPLOAD_PERMISSION_SIZE_PROP_PREFIX, URL_REGEXP, VID_LOGGED_MEMBER, WARNING_MSG, WEBAPP_PROP, WFEXPRESS_ALARM, WFREMINDER_ALARM, WORKFLOW_TAB, WORKFLOW_XML

Fields 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_YEAR

Constructor Summary

Constructors

Constructor and Description
TrashAppHandler()

Method Summary

Modifier and Type	Method and Description
void	addFrontEndDependencies()
java.util.Set<Workspace>	getAvailableTrashWorkspaceSet()
DateSettings	getBeginDateSettings()
DateSettings	getEndDateSettings()
ControlSettings<?>	getOpAuthorSettings()
QueryResultSet	getResultSet() Return results of a query done using this QueryHandler.
java.util.SortedSet<Publication>	getSortedResultSet()
ControlSettings<?>	getViewSettings()
ControlSettings<?>	getWorkspacesSettings()
void	init() Method to implement if you need to initialize your handler from parameter received, prior to all security validation.
boolean	isAllView()
protected java.lang.String	printParams(AbstractQueryHandler.QueryHandlerPrinter printer) Print current QueryHandler params using specified QueryHandlerPrinter.
boolean	processAction() Method to be implemented to check/validate action to be performed and process them.
void	setTrashWrkspc(java.lang.String... wsIds)
void	setTypes(java.lang.String... types)
void	setView(java.lang.String viewStr)
boolean	showViews()
boolean	showWorkspaceColumn()

Methods inherited from class com.jalios.jcms.search.QueryAppHandler

getDateSettings, getDateSinceSettings, getDateTypeSettings, getMemberSearchUrl, getWorkspaceSearchUrl, setPrevDateSince, showMemberSearch, showWorkspaceSearch

Methods inherited from class com.jalios.jcms.handler.QueryHandler

addHighlightAttributes, appendAdvanced, appendAdvanced, clearHighlightAttributes, getAbility, getAdvanced, getAllCidSet, getBeginAndEndDates, getBeginDate, getBeginDay, getBeginMonth, getBeginYear, getCategorySet, getCatMode, getCatName, getCheckPstatus, getCids, getCidsOff, getClassOffSet, getClassSet, getContentLangs, getContentTypesFromDocumentKind, getDateSinceInt, getDateType, getDescription, getDescription, getDocumentKinds, getDocumentKindsGroupMap, getDocumentKindsMap, getEndDate, getEndDay, getEndMonth, getEndYear, getExactCat, getExactType, getGids, getGidsOff, getHighlightedMember, getHist, getHistLevel, getHistoryList, getIntPstatus, getLangs, getLogger, getMids, getMidsOff, getMidsOpAuthor, getMode, getMostRecentTextAndModeInHistory, getMostRecentTextInHistoryVisitor, getPagerAll, getPageSize, getPortalIds, getPstatus, getQueryFilterContext, getRefinedWorkspace, getReplaceFileDoc, getResolvedWorkspaceSet, getReverse, getSearchedFields, getSearchInDB, getSearchInFiles, getSearchInMembers, getSearchInPub, getSearchInSubWorkspaces, getSearchInTrash, getSort, getStart, getText, getTextSearch, getTypes, getTypesCommonSuperClass, getTypesOff, getUnresolvedContentLangs, getUnresolvedLangs, getUserLang, getWfId, getWorkspaceSet, isExpanded, isHybridSearch, isModeAdvanced, isModeAll, isModeAny, isModeExact, parseQueryStringParam, setAbility, setAdvanced, setBeginDate, setBeginDateStr, setBeginDateW3c, setBeginDay, setBeginMonth, setBeginYear, setCatMode, setCatName, setCheckPstatus, setCids, setCidsOff, setContentLangs, setDateSince, setDateSince, setDateType, setDocumentKinds, setEndDate, setEndDateStr, setEndDateW3c, setEndDay, setEndMonth, setEndYear, setExactCat, setExactType, setGids, setGidsOff, setHist, setHistLevel, setHistoryList, setIgnoreDefaultTypes, setLangs, setMids, setMidsOff, setMidsOpAuthor, setMode, setPagerAll, setPageSize, setPortalIds, setPstatus, setReplaceFileDoc, setReverse, setSearchedFields, setSearchInDB, setSearchInFiles, setSearchInMembers, setSearchInPub, setSearchInSubWorkspaces, setSearchInTrash, setSort, setStart, setText, setTextSearch, setTypesOff, setWfId, setWorkspace, setWorkspaceSet, setWrkspc, toString

Methods inherited from class com.jalios.jcms.handler.AbstractQueryHandler

getAttribute, getAttributeMap, getDataSet, getHiddenParams, getQueryString, init, parseQueryString, removeAttribute, setAttribute, setDataSet

Methods inherited from class com.jalios.jcms.handler.JcmsFormHandler

afterValidation, checkMissingField, getAvailableMainLanguage, getClosePopupUrl, getControllerContext, getEditFieldSet, getFormStep, getFormStepCount, getFormStepFinishLabel, getFormStepHiddenFields, getFormStepLabels, getFormStepPrefixProp, 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, getRedirect, getRedirectOnClosePopup, getWorkspace, isFieldEdition, isFieldMissing, isFormStepClickable, isPartialFieldEdition, isPopupEdition, isWorkspaceForced, mapStringArrayToMapStringList, mapStringListToMapStringArray, performFinish, performNext, performPrevious, processStatus, sanitize, sanitize, sendRedirect, sendRedirect, setEditField, setFormStep, setNoRedirect, setNoSendRedirect, setOpFinish, setOpNext, setOpPrevious, setPopupEdition, setRedirect, setRedirectOnClosePopup, setWs, showCancelButton, showFinishButton, showNextButton, showPreviousButton, updateUploadedField, updateUploadedFields, validate, validateFinish, validateNext, validatePrevious

Methods inherited from class com.jalios.jcms.context.JcmsJspContext

addAvoidanceLink, addBodyAttributes, addCSSHeader, addCSSHeader, addCSSHeader, addCSSHeader, addCustomHeader, addHandlebarTemplate, addHttpEquivHeader, addHttpNameHeader, addJavaScript, addJavaScript, addJavaScript, addJavaScriptCode, addPrefetchHeader, addStyleHeader, addStyleHeader, addWebAssets, checkAccess, checkAccess, checkCSRF, debugDisplayContext, disablePacker, forceEditIcon, forceUpdate, getAjaxRequestAttribute, getAjaxRequestId, getAllHeadersDiffMap, getAllHeadersMap, getAvoidanceLinks, getBackOfficeCSSHeader, getBackOfficeJavaScriptSet, getBodyAttributes, getContentForm, getCSSHeaders, getCtxCategories, getCurrentCategory, getCustomHeaders, getDocType, getFinalCSSFooterMap, getFinalCSSMap, getFinalJavaScriptSet, getFrontOfficeCSSHeader, getFrontOfficeJavaScriptSet, getHandlebarTemplates, getHttpEquivHeaders, getHttpNameHeaders, getJavaScriptCodeSet, getJavaScriptSet, getJSONBridge, getPageContext, getPageTitle, getPageZone, getPortal, getPortalCategory, getPortlet, getPublication, getStyleHeaders, getTemplateUsage, internalSetupEmptyHeader, isEditIcon, isEditIcon, isEditIconForPublish, isEditIconForPublish, isPrintView, registerDisplayContext, removeAjaxRequestAttribute, setAjaxRequestAttribute, setAjaxRequestId, setAllHeadersDiffMap, setDocType, setEditIcon, setPageContext, setPageTitle, setPageZone, setShowEditIcon, setTemplateUsage, showEditIcon, showEditIcon, showEditIcon, workaroundBrowserBaseHrefBug

Methods inherited from class com.jalios.jcms.context.JcmsContext

addCookie, addMsg, addMsg, addMsgSession, addMsgSession, addToastr, addToastr, addToastrSession, addToastrSession, applySelector, 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, getUploadedFile, getUploadedFileList, getUrlWithCommonUpdatedParams, getUserCountry, getUserLocale, getUserZoneId, getWarningMsg, getWarningMsgList, getWarningMsgSession, getWarningMsgSessionList, glp, isAdmin, isAdminZone, isAjaxRequest, isDBMember, isDebug, isDebugTemplate, isInFrontOffice, isLogged, isWebdavAccess, isWorkZone, removeMessage, removeMessage, retrieveUploadedFile, 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, validateRegexp, validateSchedule

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

secondQuery

protected QueryHandler secondQuery

resultSet

protected QueryResultSet resultSet

Constructor Detail

TrashAppHandler

public TrashAppHandler()

Method Detail

processAction

public boolean processAction()
                      throws java.io.IOException

Description copied from class: JcmsFormHandler

Method to be implemented to check/validate action to be performed and process them.

Default implementation is to return false. No need to call super method.

This method may NOT be invoked at all if security validation are not met.

You must ensure your handler and JSP can work properly without any code invoked in this method.

Overrides:

processAction in class JcmsFormHandler

Returns:

false if no redirection is needed, true otherwise

Throws:

java.io.IOException - IO Exception

addFrontEndDependencies

public void addFrontEndDependencies()

init

public void init()

Description copied from class: JcmsFormHandler

Method to implement if you need to initialize your handler from parameter received, prior to all security validation.

You must absolutely not perform any action which modify data or site configuration.

Therefore it is strongly recommend NOT TO implement this method, or use very wisely.

Overrides:

init in class QueryAppHandler

getResultSet

public QueryResultSet getResultSet()

Description copied from class: QueryHandler

Return results of a query done using this QueryHandler.

Warning: This method process the query each time it is invoked, therefore do not call it multiple times if you don't need it.

Overrides:

getResultSet in class QueryHandler

Returns:

a QueryResultSet containing all results of this query, it is a HashSet and therefore it is NOT sorted. use either getAsSortedSet() or getAsSortedSet(Comparator) to obtain a sorted Set.

getSortedResultSet

public java.util.SortedSet<Publication> getSortedResultSet()

printParams

protected java.lang.String printParams(AbstractQueryHandler.QueryHandlerPrinter printer)

Description copied from class: QueryHandler

Print current QueryHandler params using specified QueryHandlerPrinter.

Overrides:

printParams in class QueryHandler

Parameters:

printer - a QueryHandlerPrinter to use

Returns:

a string containing all parameters of this handler printed using specified QueryHandlerPrinter.

setTypes

public void setTypes(java.lang.String... types)

Overrides:

setTypes in class QueryHandler

showViews

public boolean showViews()

setView

public void setView(java.lang.String viewStr)

isAllView

public boolean isAllView()

getViewSettings

public ControlSettings<?> getViewSettings()

setTrashWrkspc

public void setTrashWrkspc(java.lang.String... wsIds)

getAvailableTrashWorkspaceSet

public java.util.Set<Workspace> getAvailableTrashWorkspaceSet()

showWorkspaceColumn

public boolean showWorkspaceColumn()

getWorkspacesSettings

public ControlSettings<?> getWorkspacesSettings()

getBeginDateSettings

public DateSettings getBeginDateSettings()

Overrides:

getBeginDateSettings in class QueryAppHandler

getEndDateSettings

public DateSettings getEndDateSettings()

Overrides:

getEndDateSettings in class QueryAppHandler

getOpAuthorSettings

public ControlSettings<?> getOpAuthorSettings()