Class A_CmsUsersList

    • Constructor Summary

      Constructors 
      Constructor Description
      A_CmsUsersList​(org.opencms.jsp.CmsJspActionElement jsp, java.lang.String listId, org.opencms.i18n.CmsMessageContainer listName)
      Public constructor.
      A_CmsUsersList​(org.opencms.jsp.CmsJspActionElement jsp, java.lang.String listId, org.opencms.i18n.CmsMessageContainer listName, boolean lazy)
      Public constructor.
    • Method Summary

      All Methods Instance Methods Abstract Methods Concrete Methods 
      Modifier and Type Method Description
      void executeListMultiActions()
      This method should handle every defined list multi action, by comparing A_CmsListDialog.getParamListAction() with the id of the action to execute.
      void executeListSingleActions()
      This method should handle every defined list single action, by comparing A_CmsListDialog.getParamListAction() with the id of the action to execute.
      protected void fillDetails​(java.lang.String detailId)
      Lazy initialization for detail data.
      protected abstract java.lang.String getGroupIcon()
      Returns the path the group icon.
      protected java.util.List<CmsListItem> getListItems()
      Should generate a list with the list items to be displayed.
      java.lang.String getParamOufqn()
      Returns the organizational unit fqn parameter value.
      protected java.lang.String getRoleIcon()
      Returns the path the role edit icon.
      protected abstract java.util.List<org.opencms.file.CmsUser> getUsers()
      Returns a list of users.
      protected void initMessages()  
      protected CmsListItem makeListItemForUser​(org.opencms.file.CmsUser user)
      Makes a list item for a given user.
      protected abstract org.opencms.file.CmsUser readUser​(java.lang.String name)
      Reads the user.
      protected void setColumns​(CmsListMetadata metadata)
      Should create the columns and add them to the given list metadata object.
      protected abstract void setDeleteAction​(CmsListColumnDefinition deleteCol)
      Sets the needed delete action(s).
      protected abstract void setEditAction​(CmsListColumnDefinition editCol)
      Sets the needed edit action(s).
      protected void setIndependentActions​(CmsListMetadata metadata)
      Should add the independent actions to the given list metadata object.
      protected void setMultiActions​(CmsListMetadata metadata)
      Should add the multi actions to the given list metadata object.
      void setParamOufqn​(java.lang.String ouFqn)
      Sets the organizational unit fqn parameter value.
      protected void setUserData​(org.opencms.file.CmsUser user, CmsListItem item)
      Sets all needed data of the user into the list item object.
      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