Package org.opencms.workplace.tools.accounts

Class A_CmsGroupUsersList

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static java.lang.String LIST_ACTION_ICON
      list action id constant.
      static java.lang.String LIST_ACTION_STATE
      list action id constant.
      static java.lang.String LIST_COLUMN_FULLNAME
      list column id constant.
      static java.lang.String LIST_COLUMN_ICON
      list column id constant.
      static java.lang.String LIST_COLUMN_LOGIN
      list column id constant.
      static java.lang.String LIST_COLUMN_NAME
      list column id constant.
      static java.lang.String LIST_COLUMN_ORGUNIT
      list column id constant.
      static java.lang.String LIST_COLUMN_STATE
      list column id constant.
      static java.lang.String LIST_DETAIL_OTHEROU
      list item detail id constant.

      • 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 
      Modifier Constructor Description
      protected A_CmsGroupUsersList​(org.opencms.jsp.CmsJspActionElement jsp, java.lang.String listId, org.opencms.i18n.CmsMessageContainer listName, boolean searchable)
      Public constructor.
      protected A_CmsGroupUsersList​(org.opencms.jsp.CmsJspActionElement jsp, java.lang.String listId, org.opencms.i18n.CmsMessageContainer listName, boolean searchable, boolean lazy)
      Public constructor.

    • Method Summary

      All Methods Instance Methods Abstract Methods Concrete Methods 
      Modifier and Type Method Description
      void actionDialog()
      Performs the dialog actions depending on the initialized action.
      protected void fillDetails​(java.lang.String detailId)
      Lazy initialization for detail data.
      java.lang.String getIconPath​(CmsListItem item)
      Returns the right icon path for the given list item.
      protected java.util.List<CmsListItem> getListItems()
      Should generate a list with the list items to be displayed.
      java.lang.String getParamGroupid()
      Returns the user id parameter value.
      java.lang.String getParamGroupname()
      Returns the Group name parameter.
      java.lang.String getParamOufqn()
      Returns the organizational unit fqn parameter value.
      protected abstract java.util.List<org.opencms.file.CmsUser> getUsers​(boolean withOtherOus)
      Returns a list of users to display.
      protected boolean hasOuDetail()
      Checks whether users of other OUs should be shown.
      boolean hasUsersInOtherOus()
      Returns true if the list of users has users of other organizational units.
      protected void initializeDetail​(java.lang.String detailId)
      Lazy details initialization.
      protected void initMessages()  
      protected CmsListItem makeListItem​(org.opencms.file.CmsUser user)
      Makes a list item from a user.
      protected CmsListItem makeListItemForUser​(org.opencms.file.CmsUser user)
      Makes a list item for a given user.
      protected void setColumns​(CmsListMetadata metadata)
      Should create the columns and add them to the given list metadata object.
      protected abstract void setDefaultAction​(CmsListColumnDefinition loginCol)
      Sets the optional login default action.
      protected abstract void setIconAction​(CmsListColumnDefinition iconCol)
      Sets the needed icon action(s).
      protected void setIndependentActions​(CmsListMetadata metadata)
      Should add the independent actions to the given list metadata object.
      void setParamGroupid​(java.lang.String userId)
      Sets the user id parameter value.
      void setParamOufqn​(java.lang.String ouFqn)
      Sets the organizational unit fqn parameter value.
      protected abstract void setStateActionCol​(CmsListMetadata metadata)
      Sets the optional state change action column.
      protected void setUserData​(org.opencms.file.CmsUser user, CmsListItem item)
      Sets all needed data of the user into the list item object.
      void updateGroupList()
      Updates the main user list.
      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, 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, 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, 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

    • Constructor Detail

      • A_CmsGroupUsersList

        protected A_CmsGroupUsersList​(org.opencms.jsp.CmsJspActionElement jsp,
                              java.lang.String listId,
                              org.opencms.i18n.CmsMessageContainer listName,
                              boolean searchable)
        Public constructor.

        Parameters:
        jsp - an initialized JSP action element
        listId - the id of the list
        listName - the name of the list
        searchable - searchable flag

      • A_CmsGroupUsersList

        protected A_CmsGroupUsersList​(org.opencms.jsp.CmsJspActionElement jsp,
                              java.lang.String listId,
                              org.opencms.i18n.CmsMessageContainer listName,
                              boolean searchable,
                              boolean lazy)
        Public constructor.

        Parameters:
        jsp - an initialized JSP action element
        listId - the id of the list
        listName - the name of the list
        searchable - searchable flag
        lazy - the lazy flag

    • Method Detail

      • actionDialog

        public void actionDialog()
                  throws javax.servlet.jsp.JspException,
                         javax.servlet.ServletException,
                         java.io.IOException
        Description copied from class: A_CmsListDialog
        Performs the dialog actions depending on the initialized action.

        Overrides:
        actionDialog in class A_CmsListDialog
        Throws:
        javax.servlet.jsp.JspException - if dialog actions fail
        javax.servlet.ServletException - in case of errors forwarding to the required result page
        java.io.IOException - in case of errors forwarding to the required result page
        See Also:
        A_CmsListDialog.actionDialog()

      • getParamGroupid

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

        Returns:
        the user id parameter value

      • getParamGroupname

        public java.lang.String getParamGroupname()
        Returns the Group name parameter.

        Returns:
        the Group name parameter

      • getIconPath

        public java.lang.String getIconPath​(CmsListItem item)
        Returns the right icon path for the given list item.

        Parameters:
        item - the list item to get the icon path for
        Returns:
        the icon path for the given role

      • getParamOufqn

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

        Returns:
        the organizational unit fqn parameter value

      • hasUsersInOtherOus

        public boolean hasUsersInOtherOus()
        Returns true if the list of users has users of other organizational units.

        Returns:
        true if the list of users has users of other organizational units

      • makeListItemForUser

        protected CmsListItem makeListItemForUser​(org.opencms.file.CmsUser user)
        Makes a list item for a given user.

        Parameters:
        user - the user
        Returns:
        the list item

      • 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 fqn parameter value.

        Parameters:
        ouFqn - the organizational unit fqn parameter value

      • updateGroupList

        public void updateGroupList()
        Updates the main user list.

      • hasOuDetail

        protected boolean hasOuDetail()
        Checks whether users of other OUs should be shown.

        Returns:
        true if users of other OUs should be shown

      • makeListItem

        protected CmsListItem makeListItem​(org.opencms.file.CmsUser user)
        Makes a list item from a user.

        Parameters:
        user - a user
        Returns:
        a list item

      • setUserData

        protected void setUserData​(org.opencms.file.CmsUser user,
                           CmsListItem item)
        Sets all needed data of the user into the list item object.

        Parameters:
        user - the user to set the data for
        item - the list item object to set the data into

      • getUsers

        protected abstract java.util.List<org.opencms.file.CmsUser> getUsers​(boolean withOtherOus)
                                                              throws org.opencms.main.CmsException
        Returns a list of users to display.

        Parameters:
        withOtherOus - if not set only users of the current ou should be returned
        Returns:
        a list of <CmsUsers
        Throws:
        org.opencms.main.CmsException - if something goes wrong

      • initMessages

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

      • setStateActionCol

        protected abstract void setStateActionCol​(CmsListMetadata metadata)
        Sets the optional state change action column.

        Parameters:
        metadata - the list metadata object