Class CmsRoleOverviewDialog

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static java.lang.String KEY_PREFIX
      localized messages Keys prefix.
      protected org.opencms.security.CmsRole m_role
      The role object that is viewed on this dialog.
      static java.lang.String[] PAGES
      Defines which pages are valid for this dialog.
      • 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
      CmsRoleOverviewDialog​(javax.servlet.jsp.PageContext context, javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res)
      Public constructor with JSP variables.
      CmsRoleOverviewDialog​(org.opencms.jsp.CmsJspActionElement jsp)
      Public constructor with JSP action element.
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void actionCommit()
      Commits the edited object after pressing the "OK" button.
      protected java.lang.String createDialogHtml​(java.lang.String dialog)
      Creates the dialog HTML for all defined widgets of the named dialog (page).
      protected java.lang.String defaultActionHtmlEnd()
      Generates the dialog ending html code.
      protected void defineWidgets()
      Defines the list of parameters for this dialog.
      java.lang.String getDependency()
      Returns a String inculding all parent roles of the role object.
      java.lang.String getDescription()
      Returns the localized description of the role object.
      java.lang.String getName()
      Returns the localized name of the role object.
      protected java.lang.String[] getPageArray()
      Returns the allowed pages for this dialog.
      java.lang.String getParamOufqn()
      Returns the organizational unit parameter value.
      java.lang.String getParamRole()
      Returns the role name parameter value.
      protected void initRoleObject()
      Initializes the group object.
      void setDependency​(java.lang.String dependency)
      This method is needed only for displaying reasons.
      void setDescription​(java.lang.String description)
      This method is needed only for displaying reasons.
      void setName​(java.lang.String name)
      This method is needed only for displaying reasons.
      void setParamOufqn​(java.lang.String ouFqn)
      Sets the user organizational unit value.
      void setParamRole​(java.lang.String role)
      Sets the role name value.
      protected void validateParamaters()
      Should be overridden for parameter validation.
      • 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, initMessages, 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 Detail

      • PAGES

        public static final java.lang.String[] PAGES
        Defines which pages are valid for this dialog.
      • m_role

        protected org.opencms.security.CmsRole m_role
        The role object that is viewed on this dialog.
    • Constructor Detail

      • CmsRoleOverviewDialog

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

        Parameters:
        jsp - an initialized JSP action element
      • CmsRoleOverviewDialog

        public CmsRoleOverviewDialog​(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

      • getDependency

        public java.lang.String getDependency()
        Returns a String inculding all parent roles of the role object.

        Returns:
        a String inculding all parent roles of the role object
      • getDescription

        public java.lang.String getDescription()
        Returns the localized description of the role object.

        Returns:
        the localized description of the role object
      • getName

        public java.lang.String getName()
        Returns the localized name of the role object.

        Returns:
        the localized name of the role object
      • getParamOufqn

        public java.lang.String getParamOufqn()
        Returns the organizational unit parameter value.

        Returns:
        the organizational unit parameter value
      • getParamRole

        public java.lang.String getParamRole()
        Returns the role name parameter value.

        Returns:
        the role name parameter value
      • setDependency

        public void setDependency​(java.lang.String dependency)
        This method is needed only for displaying reasons.

        Parameters:
        dependency - nothing to do with this parameter
      • setDescription

        public void setDescription​(java.lang.String description)
        This method is needed only for displaying reasons.

        Parameters:
        description - nothing to do with this parameter
      • setName

        public void setName​(java.lang.String name)
        This method is needed only for displaying reasons.

        Parameters:
        name - nothing to do with this parameter
      • setParamOufqn

        public void setParamOufqn​(java.lang.String ouFqn)
        Sets the user organizational unit value.

        Parameters:
        ouFqn - the organizational unit parameter value
      • setParamRole

        public void setParamRole​(java.lang.String role)
        Sets the role name value.

        Parameters:
        role - the role name parameter value
      • createDialogHtml

        protected java.lang.String createDialogHtml​(java.lang.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)
      • initRoleObject

        protected void initRoleObject()
        Initializes the group object.