Package org.opencms.workplace.tools.scheduler

Class CmsEditScheduledJobInfoDialog

java.lang.Object
org.opencms.workplace.CmsWorkplace
org.opencms.workplace.tools.CmsToolDialog
org.opencms.workplace.CmsDialog
org.opencms.workplace.CmsWidgetDialog
org.opencms.workplace.tools.scheduler.CmsEditScheduledJobInfoDialog
All Implemented Interfaces:
org.opencms.widgets.I_CmsWidgetDialog
public class CmsEditScheduledJobInfoDialog extends CmsWidgetDialog
Dialog to edit new and existing scheduled jobs in the administration view.

Since:
6.0.0

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    DIALOG_COPYJOB
    The action to copy a job to edit.
    protected org.opencms.scheduler.CmsScheduledJobInfo
    m_jobInfo
    The job info object that is edited on this dialog.
    protected String
    m_paramJobid
    Stores the value of the request parameter for the job id.
    protected String
    m_serverTime
    formatted current server time.
    static final String[]
    PAGES
    Defines which pages are valid for this dialog.
    static final String
    PARAM_JOBID
    Request parameter name for the job id.

    Fields inherited from class org.opencms.workplace.CmsWidgetDialog

    ACTION_ELEMENT_ADD, ACTION_ELEMENT_REMOVE, ACTION_ERROR, ACTION_SAVE, DIALOG_SAVE, EDITOR_ACTION_ELEMENT_ADD, EDITOR_ACTION_ELEMENT_REMOVE, HIDDEN_PARAM_PREFIX, m_commitErrors, m_dialogObject, m_pages, m_paramPage, m_validationErrorList, m_widgetParamValues, m_widgets

    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_ACTION_VALUE_FOR_CHANGED_INDEX, 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_ADMIN_PROJECT, PARAM_BASE, PARAM_FORCE, PARAM_PATH, PARAM_ROOT, PARAM_STYLE, STYLE_NEW

    Fields inherited from class org.opencms.workplace.CmsWorkplace

    DEBUG, DEFAULT_DATE_STRING, 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, INPUT_DEFAULT, INPUT_NONE, JSP_WORKPLACE_URI, PARAM_DIRECTPUBLISH, PARAM_MODELFILE, PARAM_NEWRESOURCETYPE, PARAM_PUBLISHSIBLINGS, PARAM_RELATEDRESOURCES, PARAM_RESOURCELIST, PARAM_SUBRESOURCES, PARAM_WP_EXPLORER_RESOURCE, PARAM_WP_PROJECT, PARAM_WP_SITE, PARAM_WP_START, PARAM_WP_VIEW, PATH_DIALOGS, PATH_WORKPLACE, REQUEST_ATTRIBUTE_MULTIPART, REQUEST_ATTRIBUTE_RELOADTREE, RES_PATH_FILETYPES, RFS_PATH_RESOURCES, SESSION_WORKPLACE_CLASS, VFS_DIR_DEFAULTBODIES, VFS_DIR_TEMPLATES, VFS_PATH_COMMONS, VFS_PATH_EDITORS, VFS_PATH_GALLERIES, VFS_PATH_LOCALES, VFS_PATH_MODELDIALOG, VFS_PATH_MODULES, VFS_PATH_NEWRESOURCEDIALOG, VFS_PATH_RESOURCES, VFS_PATH_SITES, VFS_PATH_SYSTEM, VFS_PATH_VIEWS, VFS_PATH_WORKPLACE, VIEW_ADMIN, VIEW_DIRECT_EDIT, VIEW_EXPLORER, VIEW_GALLERY, VIEW_LIST, VIEW_WORKPLACE

  • Constructor Summary

    Constructors
    Constructor
    Description
    CmsEditScheduledJobInfoDialog(javax.servlet.jsp.PageContext context, javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res)
    Public constructor with JSP variables.
    CmsEditScheduledJobInfoDialog(org.opencms.jsp.CmsJspActionElement jsp)
    Public constructor with JSP action element.

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    actionCommit()
    Commits the edited scheduled job to the scheduler.
    protected String
    createDialogHtml(String dialog)
    Creates the dialog HTML for all defined widgets of the named dialog (page).
    protected void
    defineWidgets()
    Creates the list of widgets for this dialog.
    protected List<org.opencms.widgets.CmsSelectWidgetOption>
    getComboClasses()
    Returns the example cron class names to show in the combo box.
    protected List<org.opencms.widgets.CmsSelectWidgetOption>
    getComboCronExpressions()
    Returns the example cron expressions to show in the combo box.
    protected String[]
    getPageArray()
    Returns the allowed pages for this dialog.
    String
    getParamJobid()
    Returns the job id parameter value.
    String
    getServerTime()
    Returns the server Time.
    protected void
    initMessages()
     
    protected void
    initScheduledJobObject()
    Initializes the scheduled job object to work with depending on the dialog state and request parameters.
    protected void
    initWorkplaceRequestValues(org.opencms.workplace.CmsWorkplaceSettings settings, javax.servlet.http.HttpServletRequest request)
     
    protected boolean
    isNewJob()
    Checks if the new job dialog has to be displayed.
    void
    setParamJobid(String jobid)
    Sets the job id parameter value.
    void
    setServerTime(String serverTime)
    Sets the server Time.
    protected void
    validateParamaters()
    Should be overridden for parameter validation.

    Methods inherited from class org.opencms.workplace.CmsWidgetDialog

    actionCancel, actionToggleElement, addCommitError, addWidget, buildAddElement, buildDialogForm, buildRemoveElement, clearDialogObject, closeDialogOnCommit, commitWidgetValues, commitWidgetValues, createDialogHtml, createDialogRowHtml, createDialogRowsHtml, createWidgetBlockEnd, createWidgetBlockStart, createWidgetErrorHeader, createWidgetTableEnd, createWidgetTableStart, defaultActionHtml, defaultActionHtmlContent, defaultActionHtmlEnd, defaultActionHtmlStart, dialogBlockEnd, dialogBlockStart, dialogButtonsCustom, displayDialog, displayDialog, fillWidgetValues, getButtonStyle, getCommitErrors, getDialogObject, getDialogTitle, getHelpMessageIds, getPages, getParamElementIndex, getParamElementName, getParameterDefinition, getParameters, getParamPage, getParamValue, getParamValue, getUserAgent, getValidationErrorList, getWidget, getWidgetHtmlEnd, getWidgetIncludes, getWidgetInitCalls, getWidgetInitMethods, getWidgets, hasCommitErrors, hasValidationErrors, paramsAsHidden, setCommitErrors, setDialogObject, setKeyPrefix, setPages, setParamElementIndex, setParamElementName, setParamPage, setValidationErrorList, widgetParamsAsHidden, widgetParamsAsHidden, writeDialog

    Methods inherited from class org.opencms.workplace.CmsDialog

    actionCloseDialog, appendDelimiter, buildAjaxResultContainer, buildAjaxWaitMessage, buildLockAdditionalOptions, buildLockConfirmationMessageJS, buildLockHeaderBox, checkResourcePermissions, checkResourcePermissions, computeCurrentFolder, dialog, dialogBlock, 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, openLaunchpad, openWorkplaceLink, pageHtml, pageHtml, setAction, setOnlineHelpUriCustom, setParamAction, setParamCloseLink, setParamDialogtype, setParamFramename, setParamIsPopup, setParamMessage, setParamOriginalParams, setParamPreActionDone, setParamRedirect, setParamResource, setParamTitle

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

    computeUpLevelLink, 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, canEditPermissionsForRoles, checkLock, checkLock, checkRole, decodeParamValue, fillParamValues, fillParamValues, generateCssStyle, generatePageEndExtended, generatePageEndSimple, generatePageStartExtended, generatePageStartSimple, getBroadcastMessageString, getCms, getEncoding, getExplorerFileListFullUri, getFrameSource, getJsp, getLocale, getMacroResolver, getMessages, getMultiPartFileItems, getParameterMap, getResourceUri, getResourceUri, getSession, getSettings, getSkinUri, getStartSiteRoot, getStartSiteRoot, getStaticResourceUri, getStaticResourceUri, getStyleUri, getStyleUri, getStyleUri, getTemporaryFileName, getWorkplaceExplorerLink, getWorkplaceExplorerLink, getWorkplaceSettings, htmlEnd, initSettings, initTimeWarp, initUserSettings, initWorkplaceMembers, initWorkplaceMembers, initWorkplaceSettings, isForwarded, isHelpEnabled, isSubElement, isTemporaryFile, key, key, keyDefault, nullToEmpty, paramsAsHidden, paramsAsParameterMap, paramsAsRequest, paramValues, resolveMacros, sendCmsRedirect, sendForward, setForwarded, shortKey, substituteSiteTitle, substituteSiteTitleStatic, switchToCurrentProject, switchToTempProject, updateUserPreferences

    Methods inherited from class java.lang.Object

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

    Methods inherited from interface org.opencms.widgets.I_CmsWidgetDialog

    button, buttonBar, buttonBarHorizontalLine, buttonBarSeparator, buttonBarSpacer, buttonBarStartTab, dialogHorizontalSpacer, getLocale, getMessages, useNewStyle

  • Field Details

  • Constructor Details

    • CmsEditScheduledJobInfoDialog

      public CmsEditScheduledJobInfoDialog(org.opencms.jsp.CmsJspActionElement jsp)
      Public constructor with JSP action element.

      Parameters:
      jsp - an initialized JSP action element

    • CmsEditScheduledJobInfoDialog

      public CmsEditScheduledJobInfoDialog(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 Details

    • actionCommit

      public void actionCommit()
      Commits the edited scheduled job to the scheduler.

      Specified by:
      actionCommit in class CmsWidgetDialog

    • getParamJobid

      public String getParamJobid()
      Returns the job id parameter value.

      Returns:
      the job id parameter value

    • getServerTime

      public String getServerTime()
      Returns the server Time.

      Returns:
      the server Time

    • setParamJobid

      public void setParamJobid(String jobid)
      Sets the job id parameter value.

      Parameters:
      jobid - the job id parameter value

    • setServerTime

      public void setServerTime(String serverTime)
      Sets the server Time.

      Parameters:
      serverTime - the server Time to set

    • createDialogHtml

      protected String createDialogHtml(String dialog)
      Creates the dialog HTML for all defined widgets of the named dialog (page).

      This overwrites the method from the super class to create a layout variation for the widgets.

      Overrides:
      createDialogHtml in class CmsWidgetDialog
      Parameters:
      dialog - the dialog (page) to get the HTML for
      Returns:
      the dialog HTML for all defined widgets of the named dialog (page)

    • defineWidgets

      protected void defineWidgets()
      Creates the list of widgets for this dialog.

      Specified by:
      defineWidgets in class CmsWidgetDialog

    • getComboClasses

      protected List<org.opencms.widgets.CmsSelectWidgetOption> getComboClasses()
      Returns the example cron class names to show in the combo box.

      The result list elements are of type CmsSelectWidgetOption.

      Returns:
      the example cron class names to show in the combo box

    • getComboCronExpressions

      protected List<org.opencms.widgets.CmsSelectWidgetOption> getComboCronExpressions()
      Returns the example cron expressions to show in the combo box.

      The result list elements are of type CmsSelectWidgetOption.

      Returns:
      the example cron expressions to show in the combo box

    • getPageArray

      protected String[] getPageArray()
      Description copied from class: CmsWidgetDialog
      Returns the allowed pages for this dialog.

      Specified by:
      getPageArray in class CmsWidgetDialog
      Returns:
      the allowed pages for this dialog
      See Also:

    • initMessages

      protected void initMessages()
      Overrides:
      initMessages in class org.opencms.workplace.CmsWorkplace
      See Also:
      • CmsWorkplace.initMessages()

    • initScheduledJobObject

      protected void initScheduledJobObject()
      Initializes the scheduled job object to work with depending on the dialog state and request parameters.

      Three initializations of the scheduled job object on first dialog call are possible:

      • edit an existing scheduled job
      • create a new scheduled job
      • copy an existing scheduled job and edit it

    • initWorkplaceRequestValues

      protected void initWorkplaceRequestValues(org.opencms.workplace.CmsWorkplaceSettings settings, javax.servlet.http.HttpServletRequest request)
      Overrides:
      initWorkplaceRequestValues in class CmsWidgetDialog
      See Also:
      • CmsWorkplace.initWorkplaceRequestValues(org.opencms.workplace.CmsWorkplaceSettings, javax.servlet.http.HttpServletRequest)

    • isNewJob

      protected boolean isNewJob()
      Checks if the new job dialog has to be displayed.

      Returns:
      true if the new job dialog has to be displayed

    • validateParamaters

      protected void validateParamaters() throws Exception
      Description copied from class: CmsWidgetDialog
      Should be overridden for parameter validation.

      The exception is never seen by the user, so it can be just a new Exception().

      Overrides:
      validateParamaters in class CmsWidgetDialog
      Throws:
      Exception - if the parameters are not valid
      See Also: