org.opencms.workplace.commons
Class CmsPublishScheduled

java.lang.Object
  org.opencms.workplace.CmsWorkplace
      org.opencms.workplace.tools.CmsToolDialog
          org.opencms.workplace.CmsDialog
              org.opencms.workplace.commons.CmsPublishScheduled

public class CmsPublishScheduled
extends CmsDialog

Provides methods for the publish scheduled dialog.

The following files use this class:

• /commons/publishscheduled.jsp

Since:

7.5.1

Version:

$Revision: 1.5 $

Author:

Mario Jaeger

Field Summary

static java.lang.String	DIALOG_TYPE The dialog type.
static java.lang.String	PARAM_ENABLE_NOTIFICATION Request parameter name for the activation of the notification.
static java.lang.String	PARAM_PUBLISHSCHEDULEDDATE Request parameter name for the publish date.
static java.lang.String	PARAM_RESETPUBLISHSCHEDULED Request parameter name for the reset publish date.

Fields inherited from class org.opencms.workplace.CmsDialog

ACTION_CANCEL, ACTION_CLOSEPOPUP, ACTION_CLOSEPOPUP_SAVE, ACTION_CONFIRMED, ACTION_CONTINUE, ACTION_DEFAULT, ACTION_LOCKS_CONFIRMED, ACTION_OK, ACTION_REPORT_BEGIN, ACTION_REPORT_END, ACTION_REPORT_UPDATE, ACTION_SET, ACTION_WAIT, ATTRIBUTE_THROWABLE, BUTTON_ADVANCED, BUTTON_BACK, BUTTON_CANCEL, BUTTON_CLOSE, BUTTON_CONTINUE, BUTTON_DETAILS, BUTTON_DISCARD, BUTTON_EDIT, BUTTON_OK, BUTTON_OK_NO_SUBMIT, BUTTON_SET, DIALOG_BACK, DIALOG_CANCEL, DIALOG_CONFIRMED, DIALOG_CONTINUE, DIALOG_INITIAL, DIALOG_LOCKS_CONFIRMED, DIALOG_OK, DIALOG_SET, DIALOG_WAIT, PARAM_ACTION, PARAM_CLOSELINK, PARAM_DIALOGTYPE, PARAM_ERRORSTACK, PARAM_FILE, PARAM_FRAMENAME, PARAM_ISPOPUP, PARAM_LOCK, PARAM_MESSAGE, PARAM_ORIGINALPARAMS, PARAM_PREACTIONDONE, PARAM_REDIRECT, PARAM_RESOURCE, PARAM_TARGET, PARAM_THREAD, PARAM_THREAD_HASNEXT, PARAM_TITLE, REPORT_BEGIN, REPORT_END, REPORT_UPDATE

Fields inherited from class org.opencms.workplace.tools.CmsToolDialog

PARAM_BASE, PARAM_FORCE, PARAM_PATH, PARAM_ROOT, PARAM_STYLE, STYLE_NEW

Fields inherited from class org.opencms.workplace.CmsWorkplace

DEBUG, DEFAULT_LANGUAGE, DEFAULT_LOCALE, DIALOG_PATH_COMMON, FILE_DIALOG_CLOSE, FILE_DIALOG_SCREEN_CONFIRM, FILE_DIALOG_SCREEN_ERROR, FILE_DIALOG_SCREEN_ERRORPAGE, FILE_DIALOG_SCREEN_WAIT, FILE_EXPLORER_FILELIST, FILE_REPORT_OUTPUT, HTML_END, HTML_START, PARAM_WP_EXPLORER_RESOURCE, PARAM_WP_PROJECT, PARAM_WP_SITE, PATH_DIALOGS, PATH_WORKPLACE, REQUEST_ATTRIBUTE_MULTIPART, REQUEST_ATTRIBUTE_RELOADTREE, RFS_PATH_RESOURCES, SESSION_WORKPLACE_CLASS, TEMP_FILE_PREFIX, VFS_DIR_DEFAULTBODIES, VFS_DIR_TEMPLATES, VFS_PATH_COMMONS, VFS_PATH_EDITORS, VFS_PATH_GALLERIES, VFS_PATH_LOCALES, VFS_PATH_MODULES, VFS_PATH_RESOURCES, VFS_PATH_SYSTEM, VFS_PATH_VIEWS, VFS_PATH_WORKPLACE

Constructor Summary

CmsPublishScheduled(CmsJspActionElement jsp)
Public constructor.

CmsPublishScheduled(javax.servlet.jsp.PageContext context, javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res)
Public constructor with JSP variables.

Method Summary

void	actionCloseDialog() Used to close the current JSP dialog.
void	actionUpdate() Performs the resource operation, will be called by the JSP page.
protected java.lang.String	getLocalizedType(int flags) Returns a localized String for "Group", if the flag of a group ACE, and the localization for "User" otherwise.
java.lang.String	getParamPublishscheduleddate() Returns the value of the publish scheduled date.
protected void	initWorkplaceRequestValues(CmsWorkplaceSettings settings, javax.servlet.http.HttpServletRequest request) Analyzes the request for workplace parameters and adjusts the workplace settings accordingly.
protected boolean	performDialogOperation() Modifies the time shift publish date of a resource.
void	setDialogTitle(java.lang.String singleKey) Sets the title of the dialog.
void	setParamPublishscheduleddate(java.lang.String paramPublishscheduleddate) Sets the value of the reset expire parameter.

Methods inherited from class org.opencms.workplace.CmsDialog

appendDelimiter, buildAjaxResultContainer, buildAjaxWaitMessage, buildLockAdditionalOptions, buildLockConfirmationMessageJS, buildLockDialog, buildLockDialog, buildLockHeaderBox, checkResourcePermissions, checkResourcePermissions, computeCurrentFolder, dialog, dialogBlock, dialogBlockEnd, dialogBlockStart, dialogButtonRow, dialogButtonRowEnd, dialogButtonRowStart, dialogButtons, dialogButtonsClose, dialogButtonsClose, dialogButtonsCloseDetails, dialogButtonsHtml, dialogButtonsOk, dialogButtonsOk, dialogButtonsOkCancel, dialogButtonsOkCancel, dialogButtonsOkCancelAdvanced, dialogButtonsSetOkCancel, dialogContent, dialogContentEnd, dialogContentStart, dialogEnd, dialogHead, dialogHorizontalSpacer, dialogLockButtons, dialogRow, dialogRowEnd, dialogRowStart, dialogScriptSubmit, dialogSeparator, dialogSpacer, dialogStart, dialogStart, dialogSubheadline, dialogToggleStart, dialogWhiteBox, dialogWhiteBoxEnd, dialogWhiteBoxStart, getAction, getAdministrationBackLink, getCancelAction, getDialogRealUri, getDialogUri, getOnlineHelpUriCustom, getParamAction, getParamCloseLink, getParamDialogtype, getParamFramename, getParamIsPopup, getParamMessage, getParamOriginalParams, getParamPreActionDone, getParamRedirect, getParamResource, getParamTitle, getState, hasCorrectLockstate, hasSiblings, htmlStart, htmlStart, htmlStart, htmlStartStyle, includeErrorpage, initCmsDialog, isPopup, isPreEditor, pageHtml, pageHtml, setAction, setOnlineHelpUriCustom, setParamAction, setParamCloseLink, setParamDialogtype, setParamFramename, setParamIsPopup, setParamMessage, setParamOriginalParams, setParamPreActionDone, setParamRedirect, setParamResource, setParamTitle

Methods inherited from class org.opencms.workplace.tools.CmsToolDialog

dialogTitle, getAdminTool, getCurrentToolPath, getParamBase, getParamForce, getParamPath, getParamRoot, getParamStyle, getParentPath, getToolManager, iconsBlockArea, iconsBlockAreaEnd, iconsBlockAreaStart, initAdminTool, pageBody, pageHtmlStyle, setParamBase, setParamForce, setParamPath, setParamRoot, setParamStyle, useNewStyle

Methods inherited from class org.opencms.workplace.CmsWorkplace

addMessages, addMessages, allParamsAsHidden, allParamsAsRequest, allParamValues, bodyEnd, bodyStart, bodyStart, buildSelect, buildSelect, button, button, buttonBar, buttonBar, buttonBarHorizontalLine, buttonBarLabel, buttonBarLabel, buttonBarLine, buttonBarLineSpacer, buttonBarSeparator, buttonBarSpacer, buttonBarStartTab, checkLock, checkLock, checkRole, decodeParamValue, fillParamValues, fillParamValues, getBroadcastMessageString, getCms, getEncoding, getExplorerFileListFullUri, getFrameSource, getJsp, getLocale, getMacroResolver, getMessages, getMultiPartFileItems, getParameterMap, getResourceUri, getResourceUri, getSession, getSettings, getSkinUri, getStyleUri, getStyleUri, getStyleUri, getTemporaryFileName, htmlEnd, initMessages, initSettings, initTimeWarp, initUserSettings, initWorkplaceMembers, initWorkplaceSettings, isForwarded, isHelpEnabled, isSubElement, isTemporaryFile, isTemporaryFileName, key, key, keyDefault, nullToEmpty, paramsAsHidden, paramsAsHidden, paramsAsParameterMap, paramsAsRequest, paramValues, resolveMacros, sendCmsRedirect, sendForward, setForwarded, shortKey, switchToCurrentProject, switchToTempProject

Methods inherited from class java.lang.Object

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

Field Detail

DIALOG_TYPE

public static final java.lang.String DIALOG_TYPE

The dialog type.

See Also:

Constant Field Values

PARAM_ENABLE_NOTIFICATION

public static final java.lang.String PARAM_ENABLE_NOTIFICATION

Request parameter name for the activation of the notification.

See Also:

Constant Field Values

PARAM_PUBLISHSCHEDULEDDATE

public static final java.lang.String PARAM_PUBLISHSCHEDULEDDATE

Request parameter name for the publish date.

See Also:

Constant Field Values

PARAM_RESETPUBLISHSCHEDULED

public static final java.lang.String PARAM_RESETPUBLISHSCHEDULED

Request parameter name for the reset publish date.

See Also:

Constant Field Values

Constructor Detail

CmsPublishScheduled

public CmsPublishScheduled(CmsJspActionElement jsp)

Public constructor.

Parameters:

jsp - an initialized JSP action element

CmsPublishScheduled

public CmsPublishScheduled(javax.servlet.jsp.PageContext context,
                           javax.servlet.http.HttpServletRequest req,
                           javax.servlet.http.HttpServletResponse res)

Public constructor with JSP variables.

Parameters:

context - the JSP page context

req - the JSP request

res - the JSP response

Method Detail

actionCloseDialog

public void actionCloseDialog()
                       throws javax.servlet.jsp.JspException

Description copied from class: CmsDialog

Used to close the current JSP dialog.

This method tries to include the URI stored in the workplace settings. This URI is determined by the frame name, which has to be set in the frame name parameter.

Overrides:

actionCloseDialog in class CmsDialog

Throws:

javax.servlet.jsp.JspException - if including an element fails

See Also:

CmsDialog.actionCloseDialog()

actionUpdate

public void actionUpdate()
                  throws javax.servlet.jsp.JspException

Performs the resource operation, will be called by the JSP page.

Throws:

javax.servlet.jsp.JspException - if problems including sub-elements occur

getParamPublishscheduleddate

public java.lang.String getParamPublishscheduleddate()

Returns the value of the publish scheduled date.

Returns:

the value of the publish scheduled date

setDialogTitle

public void setDialogTitle(java.lang.String singleKey)

Sets the title of the dialog.

Parameters:

singleKey - the key for the single operation

setParamPublishscheduleddate

public void setParamPublishscheduleddate(java.lang.String paramPublishscheduleddate)

Sets the value of the reset expire parameter.

Parameters:

paramPublishscheduleddate - the value of the publish scheduled date

getLocalizedType

protected java.lang.String getLocalizedType(int flags)

Returns a localized String for "Group", if the flag of a group ACE, and the localization for "User" otherwise.

Parameters:

flags - the flags of the ACE

Returns:

localization for "Group", if the flag belongs to a group ACE

initWorkplaceRequestValues

protected void initWorkplaceRequestValues(CmsWorkplaceSettings settings,
                                          javax.servlet.http.HttpServletRequest request)

Description copied from class: CmsWorkplace

Analyzes the request for workplace parameters and adjusts the workplace settings accordingly.

Overrides:

initWorkplaceRequestValues in class CmsDialog

Parameters:

settings - the workplace settings

request - the current request

See Also:

CmsWorkplace.initWorkplaceRequestValues(org.opencms.workplace.CmsWorkplaceSettings, javax.servlet.http.HttpServletRequest)

performDialogOperation

protected boolean performDialogOperation()
                                  throws CmsException,
                                         java.text.ParseException

Modifies the time shift publish date of a resource.

Returns:

true, if the operation was performed, otherwise false

Throws:

CmsException - if something goes wrong

java.text.ParseException - if something goes wrong