Class CmsShowUserRolesList
java.lang.Object
org.opencms.workplace.CmsWorkplace
org.opencms.workplace.tools.CmsToolDialog
org.opencms.workplace.CmsDialog
org.opencms.workplace.list.A_CmsListDialog
org.opencms.workplace.tools.accounts.A_CmsRolesList
org.opencms.workplace.tools.accounts.CmsShowUserRolesList
User roles overview view.
- Since:
- 6.5.6
-
Field Summary
FieldsFields inherited from class org.opencms.workplace.tools.accounts.A_CmsRolesList
LIST_ACTION_ICON, LIST_COLUMN_DEPENDENCY, LIST_COLUMN_GROUP_NAME, LIST_COLUMN_HIDDEN_NAME, LIST_COLUMN_ICON, LIST_COLUMN_NAME, LIST_DETAIL_DESCRIPTION, LIST_DETAIL_PATH, PATH_BUTTONSFields inherited from class org.opencms.workplace.list.A_CmsListDialog
ACTION_LIST_INDEPENDENT_ACTION, ACTION_LIST_MULTI_ACTION, ACTION_LIST_SEARCH, ACTION_LIST_SELECT_PAGE, ACTION_LIST_SINGLE_ACTION, ACTION_LIST_SORT, ICON_ACTIVE, ICON_ADD, ICON_DELETE, ICON_DETAILS_HIDE, ICON_DETAILS_SHOW, ICON_DISABLED, ICON_INACTIVE, ICON_MINUS, ICON_MULTI_ACTIVATE, ICON_MULTI_ADD, ICON_MULTI_DEACTIVATE, ICON_MULTI_DELETE, ICON_MULTI_MINUS, KEY_META_DATA_CACHE, LIST_INDEPENDENT_ACTION, LIST_MULTI_ACTION, LIST_SEARCH, LIST_SELECT_PAGE, LIST_SINGLE_ACTION, LIST_SORT, m_lazy, PARAM_FORMNAME, PARAM_LIST_ACTION, PARAM_PAGE, PARAM_SEARCH_FILTER, PARAM_SEL_ITEMS, PARAM_SORT_COLFields 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_UPDATEFields inherited from class org.opencms.workplace.tools.CmsToolDialog
PARAM_ADMIN_PROJECT, PARAM_BASE, PARAM_FORCE, PARAM_PATH, PARAM_ROOT, PARAM_STYLE, STYLE_NEWFields 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
ConstructorsModifierConstructorDescriptionCmsShowUserRolesList(javax.servlet.jsp.PageContext context, javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res) Public constructor with JSP variables.CmsShowUserRolesList(org.opencms.jsp.CmsJspActionElement jsp) Public constructor.CmsShowUserRolesList(org.opencms.jsp.CmsJspActionElement jsp, String listId) Public constructor.protectedCmsShowUserRolesList(org.opencms.jsp.CmsJspActionElement jsp, String listId, org.opencms.i18n.CmsMessageContainer listName) Public constructor. -
Method Summary
Modifier and TypeMethodDescriptionprotected StringGenerates the dialog starting html code.voidThis method should handle every defined list multi action, by comparingwith the id of the action to execute.A_CmsListDialog.getParamListAction()voidThis method should handle every defined list single action, by comparingwith the id of the action to execute.A_CmsListDialog.getParamListAction()getIconPath(CmsListItem item) Returns the right icon path for the given list item.Returns the User id parameter value.protected List<org.opencms.security.CmsRole> getRoles()Returns all roles to display.protected booleanReturns true if the list of users has users of other organizational units.protected booleanReturns if the organizational unit details button should be displayed.protected voidsetIndependentActions(CmsListMetadata metadata) Should add the independent actions to the given list metadata object.protected voidsetMultiActions(CmsListMetadata metadata) Should add the multi actions to the given list metadata object.voidsetParamUserid(String userid) Sets the User id parameter value.voidWrites the dialog html code, only if theis set.CmsDialog.ACTION_DEFAULTMethods inherited from class org.opencms.workplace.tools.accounts.A_CmsRolesList
fillDetails, getListItems, getParamOufqn, setColumns, setParamOufqn, validateParamatersMethods inherited from class org.opencms.workplace.list.A_CmsListDialog
actionDialog, customHtmlEnd, customHtmlStart, defaultActionHtml, defaultActionHtmlContent, defaultActionHtmlEnd, displayDialog, displayDialog, executeDefaultActions, executeListIndepActions, executeSearch, executeSelectPage, executeSort, fillList, getList, getListId, getListObject, getListState, getMetadata, getMetadata, getMetadataCache, getParamFormName, getParamListAction, getParamPage, getParamSearchFilter, getParamSelItems, getParamSortCol, getSelectedItem, getSelectedItems, initializeDetail, initWorkplaceRequestValues, isActive, listRecovery, listSave, refreshList, removeList, setList, setListObject, setParamFormName, setParamListAction, setParamPage, setParamSearchFilter, setParamSelItems, setParamSortCol, setSearchAction, throwListUnsupportedActionExceptionMethods 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, setParamTitleMethods 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, useNewStyleMethods 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, paramsAsHidden, paramsAsParameterMap, paramsAsRequest, paramValues, resolveMacros, sendCmsRedirect, sendForward, setForwarded, shortKey, substituteSiteTitle, substituteSiteTitleStatic, switchToCurrentProject, switchToTempProject, updateUserPreferences
-
Field Details
-
LIST_ID
list id constant.- See Also:
-
-
Constructor Details
-
CmsShowUserRolesList
Public constructor.- Parameters:
jsp- an initialized JSP action element
-
CmsShowUserRolesList
Public constructor.- Parameters:
jsp- an initialized JSP action elementlistId- the id of the list
-
CmsShowUserRolesList
public CmsShowUserRolesList(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 contextreq- the JSP requestres- the JSP response
-
CmsShowUserRolesList
protected CmsShowUserRolesList(org.opencms.jsp.CmsJspActionElement jsp, String listId, org.opencms.i18n.CmsMessageContainer listName) Public constructor.- Parameters:
jsp- an initialized JSP action elementlistId- the id of the listlistName- the name of the list
-
-
Method Details
-
executeListMultiActions
Description copied from class:A_CmsListDialogThis method should handle every defined list multi action, by comparingwith the id of the action to execute.A_CmsListDialog.getParamListAction()- Specified by:
executeListMultiActionsin classA_CmsListDialog- Throws:
org.opencms.main.CmsRuntimeException- to signal that an action is not supported- See Also:
-
executeListSingleActions
Description copied from class:A_CmsListDialogThis method should handle every defined list single action, by comparingwith the id of the action to execute.A_CmsListDialog.getParamListAction()- Specified by:
executeListSingleActionsin classA_CmsListDialog- Throws:
org.opencms.main.CmsRuntimeException- to signal that an action is not supported- See Also:
-
getIconPath
Description copied from class:A_CmsRolesListReturns the right icon path for the given list item.- Specified by:
getIconPathin classA_CmsRolesList- Parameters:
item- the list item to get the icon path for- Returns:
- the icon path for the given role
- See Also:
-
getParamUserid
Returns the User id parameter value.- Returns:
- the User id parameter value
-
setParamUserid
Sets the User id parameter value.- Parameters:
userid- the userid to set
-
writeDialog
Description copied from class:A_CmsListDialogWrites the dialog html code, only if theis set.CmsDialog.ACTION_DEFAULT- Overrides:
writeDialogin classA_CmsListDialog- Throws:
IOException- if writing to the JSP out fails, or in case of errros forwarding to the required result page- See Also:
-
defaultActionHtmlStart
Description copied from class:A_CmsListDialogGenerates the dialog starting html code.- Overrides:
defaultActionHtmlStartin classA_CmsListDialog- Returns:
- html code
- See Also:
-
getRoles
Description copied from class:A_CmsRolesListReturns all roles to display.- Specified by:
getRolesin classA_CmsRolesList- Returns:
- a list of
CmsRoleobjects - Throws:
org.opencms.main.CmsException- if something goes wrong- See Also:
-
hasRolesInOtherOus
Returns true if the list of users has users of other organizational units.- Returns:
trueif the list of users has users of other organizational units
-
includeOuDetails
Description copied from class:A_CmsRolesListReturns if the organizational unit details button should be displayed.- Overrides:
includeOuDetailsin classA_CmsRolesList- Returns:
- if the organizational unit details button should be displayed
- See Also:
-
setIndependentActions
Description copied from class:A_CmsListDialogShould add the independent actions to the given list metadata object.This method will be just executed once, the first time the constructor is called.
- Overrides:
setIndependentActionsin classA_CmsRolesList- Parameters:
metadata- the list metadata- See Also:
-
setMultiActions
Description copied from class:A_CmsListDialogShould add the multi actions to the given list metadata object.This method will be just executed once, the first time the constructor is called.
- Specified by:
setMultiActionsin classA_CmsListDialog- Parameters:
metadata- the list metadata- See Also:
-