com.jalios.jcms.tracking

Class ReaderTrackerQueryHandler

java.lang.Object

com.jalios.jcms.context.JcmsContext

com.jalios.jcms.context.JcmsJspContext

com.jalios.jcms.handler.JcmsFormHandler

com.jalios.jcms.tracking.ReaderTrackerQueryHandler

All Implemented Interfaces:

JcmsConstants, JaliosConstants

Direct Known Subclasses:

ReaderTrackerHandler

public class ReaderTrackerQueryHandler
extends JcmsFormHandler

Class to query publication's reader trackers.

Since:

jcms-10.0.6

Author:

Sylvain Devaux

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ACCESS_TYPE_PARAM
static java.lang.String	EXCLUDE_GROUP_PARAM
static java.lang.String	INCLUDE_GROUP_PARAM
static java.lang.String	ORDERBY_PARAM
static java.lang.String	READACK_ACKED
static java.lang.String	READACK_NOT_ACKED
static java.lang.String	READACK_PARAM
static java.lang.String	REVERSE_PARAM
static java.lang.String	TRACKED_PUB_PARAM

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

contextMap, csrfValidationEnabled, editFieldSet, formStep, noRedirect, noSendRedirect, op, opFinish, opNext, opPrevious, popupEdition, redirect, redirectOnClosePopup, REVISION, 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, DEFAULT_PHOTO_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, 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, 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
ReaderTrackerQueryHandler()

Method Summary

Modifier and Type	Method and Description
int	getAccessType()
java.util.Date	getAfter()
java.util.Set<Group>	getAvailableExcludeGroupSet()
java.util.Set<Group>	getAvailableIncludeGroupSet()
java.lang.String	getAvailableReadAck()
java.lang.String	getFormStepHiddenFields()
java.lang.String	getOrderBy()
java.lang.String	getQueryString()
java.util.Set<ReaderTrackerEntry>	getReaderTrackerEntrySet()
java.util.Set<ReaderTracker>	getReaderTrackerSet()
java.util.Collection<Member>	getRecipients()
boolean	getReverse()
Publication	getTrackedPub()
boolean	isOnlyAcked()
boolean	isOnlyNotAcked()
void	setAccessType(int accessType)
void	setAfter(java.util.Date date)
void	setExcludeGroups(java.lang.String[] v)
void	setIncludeGroups(java.lang.String[] v)
void	setOrderBy(java.lang.String orderBy)
void	setReadAck(java.lang.String v)
void	setRecipients(java.util.Collection<Member> recipients)
void	setReverse(boolean reverse)
void	setTrackedPubId(java.lang.String v)
java.lang.String	toString()

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

afterValidation, checkMissingField, getAvailableMainLanguage, getClosePopupUrl, getControllerContext, getEditFieldSet, getFormStep, getFormStepCount, getFormStepFinishLabel, 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, init, isFieldEdition, isFieldMissing, isFormStepClickable, isPartialFieldEdition, isPopupEdition, isWorkspaceForced, mapStringArrayToMapStringList, mapStringListToMapStringArray, performFinish, performNext, performPrevious, processAction, processStatus, sanitize, sanitize, sendRedirect, sendRedirect, setEditField, setFormStep, setNoRedirect, setNoSendRedirect, setOpFinish, setOpNext, setOpPrevious, setPopupEdition, setRedirect, setRedirectOnClosePopup, setWorkspace, setWs, showCancelButton, showFinishButton, showNextButton, showPreviousButton, updateUploadedField, updateUploadedFields, updateUploadedFields, validate, validateCSRF, 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, getUploadedFiles, getUploadedFiles, getUrlWithCommonUpdatedParams, getUserCountry, getUserLang, 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

ACCESS_TYPE_PARAM

public static final java.lang.String ACCESS_TYPE_PARAM

See Also:

Constant Field Values

EXCLUDE_GROUP_PARAM

public static final java.lang.String EXCLUDE_GROUP_PARAM

See Also:

Constant Field Values

INCLUDE_GROUP_PARAM

public static final java.lang.String INCLUDE_GROUP_PARAM

See Also:

Constant Field Values

ORDERBY_PARAM

public static final java.lang.String ORDERBY_PARAM

See Also:

Constant Field Values

READACK_ACKED

public static final java.lang.String READACK_ACKED

See Also:

Constant Field Values

READACK_NOT_ACKED

public static final java.lang.String READACK_NOT_ACKED

See Also:

Constant Field Values

READACK_PARAM

public static final java.lang.String READACK_PARAM

See Also:

Constant Field Values

REVERSE_PARAM

public static final java.lang.String REVERSE_PARAM

See Also:

Constant Field Values

TRACKED_PUB_PARAM

public static final java.lang.String TRACKED_PUB_PARAM

See Also:

Constant Field Values

Constructor Detail

ReaderTrackerQueryHandler

public ReaderTrackerQueryHandler()

Method Detail

getFormStepHiddenFields

public java.lang.String getFormStepHiddenFields()

Overrides:

getFormStepHiddenFields in class JcmsFormHandler

getQueryString

public java.lang.String getQueryString()

getReaderTrackerSet

public java.util.Set<ReaderTracker> getReaderTrackerSet()

getReaderTrackerEntrySet

public java.util.Set<ReaderTrackerEntry> getReaderTrackerEntrySet()

getAccessType

public int getAccessType()

setAccessType

public void setAccessType(int accessType)

setIncludeGroups

public void setIncludeGroups(java.lang.String[] v)

getAvailableIncludeGroupSet

public java.util.Set<Group> getAvailableIncludeGroupSet()

setExcludeGroups

public void setExcludeGroups(java.lang.String[] v)

getAvailableExcludeGroupSet

public java.util.Set<Group> getAvailableExcludeGroupSet()

setReadAck

public void setReadAck(java.lang.String v)

getAvailableReadAck

public java.lang.String getAvailableReadAck()

isOnlyAcked

public boolean isOnlyAcked()

isOnlyNotAcked

public boolean isOnlyNotAcked()

setRecipients

public void setRecipients(java.util.Collection<Member> recipients)

Parameters:

recipients - a custom recipientslist to apply query handler query on.

Since:

jcms-10.0.6

getRecipients

public java.util.Collection<Member> getRecipients()

getTrackedPub

public Publication getTrackedPub()

setTrackedPubId

public void setTrackedPubId(java.lang.String v)

getAfter

public java.util.Date getAfter()

setAfter

public void setAfter(java.util.Date date)

getOrderBy

public java.lang.String getOrderBy()

setOrderBy

public void setOrderBy(java.lang.String orderBy)

getReverse

public boolean getReverse()

setReverse

public void setReverse(boolean reverse)

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object