Class A_CmsUsersList
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_CmsUsersList
- Direct Known Subclasses:
CmsUserDataImportList
,CmsUsersAllOrgUnitsList
,CmsUsersList
Main user account management view.
- Since:
- 6.0.0
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
list action id constant.static final String
list action id constant.static final String
list action id constant.static final String
list action id constant.static final String
list action id constant.static final String
list action id constant.static final String
list action id constant.static final String
list column id constant.static final String
list column id constant.static final String
list column id constant.static final String
list column id constant.static final String
list column id constant.static final String
list column id constant.static final String
list column id constant.static final String
list column id constant.static final String
list column id constant.static final String
list column id constant.static final String
list action id constant.static final String
list action id constant.static final String
list item detail id constant.static final String
list item detail id constant.static final String
list item detail id constant.static final String
list action id constant.static final String
list action id constant.static final String
list action id constant.static final String
Path to the list buttons.Fields 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_COL
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
ConstructorDescriptionA_CmsUsersList
(org.opencms.jsp.CmsJspActionElement jsp, String listId, org.opencms.i18n.CmsMessageContainer listName) Public constructor.A_CmsUsersList
(org.opencms.jsp.CmsJspActionElement jsp, String listId, org.opencms.i18n.CmsMessageContainer listName, boolean lazy) Public constructor. -
Method Summary
Modifier and TypeMethodDescriptionvoid
This method should handle every defined list multi action, by comparing
with the id of the action to execute.A_CmsListDialog.getParamListAction()
void
This method should handle every defined list single action, by comparing
with the id of the action to execute.A_CmsListDialog.getParamListAction()
protected void
fillDetails
(String detailId) Lazy initialization for detail data.protected abstract String
Returns the path the group icon.protected List<CmsListItem>
Should generate a list with the list items to be displayed.Returns the organizational unit fqn parameter value.protected String
Returns the path the role edit icon.protected abstract List<org.opencms.file.CmsUser>
getUsers()
Returns a list of users.protected void
protected CmsListItem
makeListItemForUser
(org.opencms.file.CmsUser user) Makes a list item for a given user.protected abstract org.opencms.file.CmsUser
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
(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
Should be overridden for parameter validation.Methods inherited from class org.opencms.workplace.list.A_CmsListDialog
actionDialog, customHtmlEnd, customHtmlStart, defaultActionHtml, defaultActionHtmlContent, defaultActionHtmlEnd, defaultActionHtmlStart, 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, throwListUnsupportedActionException, writeDialog
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
-
Field Details
-
LIST_ACTION_ACTIVATE
list action id constant.- See Also:
-
LIST_ACTION_DEACTIVATE
list action id constant.- See Also:
-
LIST_ACTION_DELETE
list action id constant.- See Also:
-
LIST_ACTION_EDIT
list action id constant.- See Also:
-
LIST_ACTION_GROUPS
list action id constant.- See Also:
-
LIST_ACTION_ROLE
list action id constant.- See Also:
-
LIST_ACTION_ROLES
list action id constant.- See Also:
-
LIST_COLUMN_ACTIVATE
list column id constant.- See Also:
-
LIST_COLUMN_DELETE
list column id constant.- See Also:
-
LIST_COLUMN_DISPLAY
list column id constant.- See Also:
-
LIST_COLUMN_EDIT
list column id constant.- See Also:
-
LIST_COLUMN_EMAIL
list column id constant.- See Also:
-
LIST_COLUMN_ENABLED
list column id constant.- See Also:
-
LIST_COLUMN_GROUPS
list column id constant.- See Also:
-
LIST_COLUMN_LASTLOGIN
list column id constant.- See Also:
-
LIST_COLUMN_LOGIN
list column id constant.- See Also:
-
LIST_COLUMN_NAME
list column id constant.- See Also:
-
LIST_COLUMN_ROLE
list action id constant.- See Also:
-
LIST_DEFACTION_EDIT
list action id constant.- See Also:
-
LIST_DETAIL_ADDRESS
list item detail id constant.- See Also:
-
LIST_DETAIL_GROUPS
list item detail id constant.- See Also:
-
LIST_DETAIL_ROLES
list item detail id constant.- See Also:
-
LIST_MACTION_ACTIVATE
list action id constant.- See Also:
-
LIST_MACTION_DEACTIVATE
list action id constant.- See Also:
-
LIST_MACTION_DELETE
list action id constant.- See Also:
-
PATH_BUTTONS
Path to the list buttons.- See Also:
-
-
Constructor Details
-
A_CmsUsersList
public A_CmsUsersList(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 list name
-
A_CmsUsersList
public A_CmsUsersList(org.opencms.jsp.CmsJspActionElement jsp, String listId, org.opencms.i18n.CmsMessageContainer listName, boolean lazy) Public constructor.- Parameters:
jsp
- an initialized JSP action elementlistId
- the id of the listlistName
- the list namelazy
- the lazy flag
-
-
Method Details
-
executeListMultiActions
This method should handle every defined list multi action, by comparing
with the id of the action to execute.A_CmsListDialog.getParamListAction()
- Specified by:
executeListMultiActions
in classA_CmsListDialog
- Throws:
org.opencms.main.CmsRuntimeException
- to signal that an action is not supported
-
executeListSingleActions
Description copied from class:A_CmsListDialog
This method should handle every defined list single action, by comparing
with the id of the action to execute.A_CmsListDialog.getParamListAction()
- Specified by:
executeListSingleActions
in classA_CmsListDialog
- Throws:
IOException
- in case of errors when including a required sub-elementjavax.servlet.ServletException
- in case of errors when including a required sub-element- See Also:
-
getParamOufqn
Returns the organizational unit fqn parameter value.- Returns:
- the organizational unit fqn parameter value
-
setParamOufqn
Sets the organizational unit fqn parameter value.- Parameters:
ouFqn
- the organizational unit fqn parameter value
-
fillDetails
Description copied from class:A_CmsListDialog
Lazy initialization for detail data.Should fill the given detail column for every list item in
Should not throw any kind of exception.CmsHtmlList.getContent()
- Specified by:
fillDetails
in classA_CmsListDialog
- Parameters:
detailId
- the id of the detail to initialize- See Also:
-
getGroupIcon
Returns the path the group icon.- Returns:
- the path to the group icon
-
getListItems
Description copied from class:A_CmsListDialog
Should generate a list with the list items to be displayed.- Specified by:
getListItems
in classA_CmsListDialog
- Returns:
- a list of
sCmsListItem
- Throws:
org.opencms.main.CmsException
- if something goes wrong- See Also:
-
getRoleIcon
Returns the path the role edit icon.- Returns:
- the path to the role edit icon
-
getUsers
Returns a list of users.- Returns:
- the list of all users
- Throws:
org.opencms.main.CmsException
- if something goes wrong
-
initMessages
- Overrides:
initMessages
in classorg.opencms.workplace.CmsWorkplace
- See Also:
-
CmsWorkplace.initMessages()
-
makeListItemForUser
Makes a list item for a given user.- Parameters:
user
- the user- Returns:
- the list item
-
readUser
protected abstract org.opencms.file.CmsUser readUser(String name) throws org.opencms.main.CmsException Reads the user.- Parameters:
name
- the name of the user to read- Returns:
- the user
- Throws:
org.opencms.main.CmsException
- if something goes wrong
-
setColumns
Description copied from class:A_CmsListDialog
Should create the columns and add them to the given list metadata object.This method will be just executed once, the first time the constructor is called.
- Specified by:
setColumns
in classA_CmsListDialog
- Parameters:
metadata
- the list metadata- See Also:
-
setDeleteAction
Sets the needed delete action(s).- Parameters:
deleteCol
- the list column for deletion.
-
setEditAction
Sets the needed edit action(s).- Parameters:
editCol
- the list column for edition.
-
setIndependentActions
Description copied from class:A_CmsListDialog
Should add the independent actions to the given list metadata object.This method will be just executed once, the first time the constructor is called.
- Specified by:
setIndependentActions
in classA_CmsListDialog
- Parameters:
metadata
- the list metadata- See Also:
-
setMultiActions
Description copied from class:A_CmsListDialog
Should 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:
setMultiActions
in classA_CmsListDialog
- Parameters:
metadata
- the list metadata- See Also:
-
setUserData
Sets all needed data of the user into the list item object.- Parameters:
user
- the user to set the data foritem
- the list item object to set the data into
-
validateParamaters
Description copied from class:A_CmsListDialog
Should be overridden for parameter validation.- Overrides:
validateParamaters
in classA_CmsListDialog
- Throws:
Exception
- if the parameters are not valid- See Also:
-