Package org.opencms.workplace.tools.accounts

Class A_CmsEditGroupDialog

  • All Implemented Interfaces:
    org.opencms.widgets.I_CmsWidgetDialog
    Direct Known Subclasses:
    CmsEditGroupDialog
    public abstract class A_CmsEditGroupDialog
extends CmsWidgetDialog
    Skeleton dialog to create a new group or edit an existing group in the administration view.

    Since:
    6.0.0

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static java.lang.String KEY_PREFIX
      localized messages Keys prefix.
      protected org.opencms.file.CmsGroup m_group
      The user object that is edited on this dialog.
      static java.lang.String[] PAGES
      Defines which pages are valid for this dialog.
      static java.lang.String PARAM_GROUPID
      Request parameter name for the group id.
      static java.lang.String PARAM_GROUPNAME
      Request parameter name for the group name.

      • 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
      A_CmsEditGroupDialog​(org.opencms.jsp.CmsJspActionElement jsp)
      Public constructor with JSP action element.

    • Method Summary

      All Methods Instance Methods Abstract Methods Concrete Methods 
      Modifier and Type Method Description
      void actionCommit()
      Commits the edited group to the db.
      protected java.lang.String createDialogHtml​(java.lang.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.
      java.lang.String getAssignedOu()
      Returns the description of the parent ou.
      java.lang.String getDescription()
      Returns the localized description of a group.
      protected abstract java.lang.String getListClass()
      Returns the dialog class name of the list to refresh.
      protected abstract java.lang.String getListRootPath()
      Returns the root path for the list tool.
      java.lang.String getName()
      Returns the simple name of the group object.
      protected java.lang.String[] getPageArray()
      Returns the allowed pages for this dialog.
      java.lang.String getParamGroupid()
      Returns the user id parameter value.
      java.lang.String getParamOufqn()
      Returns the organizational unit parameter value.
      java.lang.String getParentGroup()
      Returns the parent Group name.
      protected void initGroupObject()
      Initializes the group object to work with depending on the dialog state and request parameters.
      protected void initMessages()  
      protected void initWorkplaceRequestValues​(org.opencms.workplace.CmsWorkplaceSettings settings, javax.servlet.http.HttpServletRequest request)  
      protected abstract boolean isEditable​(org.opencms.file.CmsGroup group)
      Tests if the given group is editable or not.
      void setAssignedOu​(java.lang.String assignedOu)
      The method is just needed for displaying reasons.
      void setDescription​(java.lang.String description)
      Sets the description for a group.
      void setName​(java.lang.String name)
      Sets the name of the group object.
      void setParamGroupid​(java.lang.String userId)
      Sets the user id parameter value.
      void setParamOufqn​(java.lang.String ouFqn)
      Sets the organizational unit parameter value.
      void setParentGroup​(java.lang.String parentGroup)
      Sets the parent Group name.
      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, 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_group

        protected org.opencms.file.CmsGroup m_group
        The user object that is edited on this dialog.

    • Constructor Detail

      • A_CmsEditGroupDialog

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

        Parameters:
        jsp - an initialized JSP action element

    • Method Detail

      • getAssignedOu

        public java.lang.String getAssignedOu()
        Returns the description of the parent ou.

        Returns:
        the description of the parent ou

      • getDescription

        public java.lang.String getDescription()
        Returns the localized description of a group.

        Returns:
        the localized description of a group

      • getName

        public java.lang.String getName()
        Returns the simple name of the group object.

        Returns:
        the simple name of the group object

      • getParamGroupid

        public java.lang.String getParamGroupid()
        Returns the user id parameter value.

        Returns:
        the user id parameter value

      • getParamOufqn

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

        Returns:
        the organizational unit parameter value

      • getParentGroup

        public java.lang.String getParentGroup()
        Returns the parent Group name.

        Returns:
        the parent Group name

      • setAssignedOu

        public void setAssignedOu​(java.lang.String assignedOu)
        The method is just needed for displaying reasons.

        Parameters:
        assignedOu - nothing to do with this parameter

      • setDescription

        public void setDescription​(java.lang.String description)
        Sets the description for a group.

        Parameters:
        description - the description for a group

      • setName

        public void setName​(java.lang.String name)
        Sets the name of the group object.

        Parameters:
        name - the name of the group object

      • setParamGroupid

        public void setParamGroupid​(java.lang.String userId)
        Sets the user id parameter value.

        Parameters:
        userId - the user id parameter value

      • setParamOufqn

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

        Parameters:
        ouFqn - the organizational unit parameter value

      • setParentGroup

        public void setParentGroup​(java.lang.String parentGroup)
        Sets the parent Group name.

        Parameters:
        parentGroup - the parent Group name to set

      • 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)

      • getListClass

        protected abstract java.lang.String getListClass()
        Returns the dialog class name of the list to refresh.

        Returns:
        the list dialog class name

      • getListRootPath

        protected abstract java.lang.String getListRootPath()
        Returns the root path for the list tool.

        Returns:
        the root path

      • initGroupObject

        protected void initGroupObject()
        Initializes the group object to work with depending on the dialog state and request parameters.

        Two initializations of the group object on first dialog call are possible:

        • edit an existing group
        • create a new group
        • view an existing group overview
        • view an existing group short info

      • initMessages

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

      • 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)

      • isEditable

        protected abstract boolean isEditable​(org.opencms.file.CmsGroup group)
        Tests if the given group is editable or not.

        Not editable means that no property can be changed.

        Parameters:
        group - the group to test
        Returns:
        the editable flag