Package org.opencms.workplace.tools.accounts

Class CmsShowGroupUsersList

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_CmsGroupUsersList

org.opencms.workplace.tools.accounts.CmsShowGroupUsersList

public class CmsShowGroupUsersList
extends A_CmsGroupUsersList

User groups overview view.

Since:

6.0.0

Field Summary

Fields

Modifier and Type	Field	Description
static final String	LIST_ACTION_EDIT	list action id constant.
static final String	LIST_COLUMN_LASTLOGIN	list column id constant.
static final String	LIST_ID	list id constant.

Fields inherited from class org.opencms.workplace.tools.accounts.A_CmsGroupUsersList

LIST_ACTION_ICON, LIST_ACTION_STATE, LIST_COLUMN_FULLNAME, LIST_COLUMN_ICON, LIST_COLUMN_LOGIN, LIST_COLUMN_NAME, LIST_COLUMN_ORGUNIT, LIST_COLUMN_STATE, LIST_DETAIL_OTHEROU

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

Constructors

Modifier	Constructor	Description
	CmsShowGroupUsersList(javax.servlet.jsp.PageContext context, javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res)	Public constructor with JSP variables.
	CmsShowGroupUsersList(javax.servlet.jsp.PageContext context, javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res, boolean lazy)	Public constructor with JSP variables.
	CmsShowGroupUsersList(org.opencms.jsp.CmsJspActionElement jsp)	Public constructor.
	CmsShowGroupUsersList(org.opencms.jsp.CmsJspActionElement jsp, boolean lazy)	Public constructor.
protected	CmsShowGroupUsersList(org.opencms.jsp.CmsJspActionElement jsp, String listId)	Protected constructor.
protected	CmsShowGroupUsersList(org.opencms.jsp.CmsJspActionElement jsp, String listId, boolean lazy)	Protected constructor.

Method Summary

Modifier and Type	Method	Description
String	defaultActionHtmlStart()	Generates the dialog starting html code.
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 List<CmsListItem>	getListItems()	Should generate a list with the list items to be displayed.
protected org.opencms.file.CmsUserSearchParameters	getSearchParams()	Gets the search parameters.
protected org.opencms.file.CmsUserSearchParameters.SortKey	getSortKey(String column)	Gets the sort key for a column.
protected List<org.opencms.file.CmsUser>	getUsers(boolean withOtherOus)	Returns a list of users to display.
protected void	setColumns(CmsListMetadata meta)	Should create the columns and add them to the given list metadata object.
protected void	setDefaultAction(CmsListColumnDefinition loginCol)	Sets the optional login default action.
protected void	setIconAction(CmsListColumnDefinition iconCol)	Sets the needed icon action(s).
protected void	setMultiActions(CmsListMetadata metadata)	Should add the multi actions to the given list metadata object.
protected void	setStateActionCol(CmsListMetadata metadata)	Sets the optional state change action column.

Methods inherited from class org.opencms.workplace.tools.accounts.A_CmsGroupUsersList

actionDialog, fillDetails, getIconPath, getParamGroupid, getParamGroupname, getParamOufqn, hasOuDetail, hasUsersInOtherOus, initializeDetail, initMessages, makeListItem, makeListItemForUser, setIndependentActions, setParamGroupid, setParamOufqn, setUserData, updateGroupList, validateParamaters

Methods inherited from class org.opencms.workplace.list.A_CmsListDialog

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, 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

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

LIST_ACTION_EDIT

public static final String LIST_ACTION_EDIT

list action id constant.

See Also:

• Constant Field Values

LIST_COLUMN_LASTLOGIN

public static final String LIST_COLUMN_LASTLOGIN

list column id constant.

See Also:

• Constant Field Values

LIST_ID

public static final String LIST_ID

list id constant.

See Also:

• Constant Field Values

Constructor Details

CmsShowGroupUsersList

public CmsShowGroupUsersList(org.opencms.jsp.CmsJspActionElement jsp)

Public constructor.

Parameters:

jsp - an initialized JSP action element

CmsShowGroupUsersList

public CmsShowGroupUsersList(org.opencms.jsp.CmsJspActionElement jsp,
 boolean lazy)

Public constructor.

Parameters:

jsp - an initialized JSP action element

lazy - true for lazy initialization

CmsShowGroupUsersList

public CmsShowGroupUsersList(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 context

req - the JSP request

res - the JSP response

CmsShowGroupUsersList

public CmsShowGroupUsersList(javax.servlet.jsp.PageContext context,
 javax.servlet.http.HttpServletRequest req,
 javax.servlet.http.HttpServletResponse res,
 boolean lazy)

Public constructor with JSP variables.

Parameters:

context - the JSP page context

req - the JSP request

res - the JSP response

lazy - the lazy flag

CmsShowGroupUsersList

protected CmsShowGroupUsersList(org.opencms.jsp.CmsJspActionElement jsp,
 String listId)

Protected constructor.

Parameters:

jsp - an initialized JSP action element

listId - the id of the specialized list

CmsShowGroupUsersList

protected CmsShowGroupUsersList(org.opencms.jsp.CmsJspActionElement jsp,
 String listId,
 boolean lazy)

Protected constructor.

Parameters:

jsp - an initialized JSP action element

listId - the id of the specialized list

lazy - the lazy flag

Method Details

defaultActionHtmlStart

public String defaultActionHtmlStart()

Description copied from class: A_CmsListDialog

Generates the dialog starting html code.

Overrides:

defaultActionHtmlStart in class A_CmsListDialog

Returns:

html code

See Also:

• A_CmsListDialog.defaultActionHtmlStart()

executeListMultiActions

public void executeListMultiActions()
                             throws org.opencms.main.CmsRuntimeException

Description copied from class: A_CmsListDialog

This method should handle every defined list multi action, by comparing A_CmsListDialog.getParamListAction() with the id of the action to execute.

Specified by:

executeListMultiActions in class A_CmsListDialog

Throws:

org.opencms.main.CmsRuntimeException - to signal that an action is not supported

See Also:

• A_CmsListDialog.executeListMultiActions()

executeListSingleActions

public void executeListSingleActions()
                              throws IOException,
javax.servlet.ServletException

Description copied from class: A_CmsListDialog

This method should handle every defined list single action, by comparing A_CmsListDialog.getParamListAction() with the id of the action to execute.

Specified by:

executeListSingleActions in class A_CmsListDialog

Throws:

IOException - in case of errors when including a required sub-element

javax.servlet.ServletException - in case of errors when including a required sub-element

See Also:

• A_CmsListDialog.executeListSingleActions()

getListItems

protected List<CmsListItem> getListItems()
                                  throws org.opencms.main.CmsException

Description copied from class: A_CmsListDialog

Should generate a list with the list items to be displayed.

Overrides:

getListItems in class A_CmsGroupUsersList

Returns:

a list of CmsListItems

Throws:

org.opencms.main.CmsException - if something goes wrong

See Also:

• A_CmsGroupUsersList.getListItems()

getSearchParams

protected org.opencms.file.CmsUserSearchParameters getSearchParams()
                                                            throws org.opencms.main.CmsException

Gets the search parameters.

Returns:

the search parameters

Throws:

org.opencms.main.CmsException - if something goes wrong

getSortKey

protected org.opencms.file.CmsUserSearchParameters.SortKey getSortKey(String column)

Gets the sort key for a column.

Parameters:

column - a column

Returns:

the sort key

getUsers

protected List<org.opencms.file.CmsUser> getUsers(boolean withOtherOus)
                                           throws org.opencms.main.CmsException

Description copied from class: A_CmsGroupUsersList

Returns a list of users to display.

Specified by:

getUsers in class A_CmsGroupUsersList

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

See Also:

• A_CmsGroupUsersList.getUsers(boolean)

setColumns

protected void setColumns(CmsListMetadata meta)

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.

Overrides:

setColumns in class A_CmsGroupUsersList

Parameters:

meta - the list metadata

See Also:

• A_CmsGroupUsersList.setColumns(org.opencms.workplace.list.CmsListMetadata)

setDefaultAction

protected void setDefaultAction(CmsListColumnDefinition loginCol)

Description copied from class: A_CmsGroupUsersList

Sets the optional login default action.

Specified by:

setDefaultAction in class A_CmsGroupUsersList

Parameters:

loginCol - the login column

See Also:

• A_CmsGroupUsersList.setDefaultAction(org.opencms.workplace.list.CmsListColumnDefinition)

setIconAction

protected void setIconAction(CmsListColumnDefinition iconCol)

Description copied from class: A_CmsGroupUsersList

Sets the needed icon action(s).

Specified by:

setIconAction in class A_CmsGroupUsersList

Parameters:

iconCol - the list column for edition.

See Also:

• A_CmsGroupUsersList.setIconAction(org.opencms.workplace.list.CmsListColumnDefinition)

setMultiActions

protected void setMultiActions(CmsListMetadata metadata)

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 class A_CmsListDialog

Parameters:

metadata - the list metadata

See Also:

• A_CmsListDialog.setMultiActions(org.opencms.workplace.list.CmsListMetadata)

setStateActionCol

protected void setStateActionCol(CmsListMetadata metadata)

Description copied from class: A_CmsGroupUsersList

Sets the optional state change action column.

Specified by:

setStateActionCol in class A_CmsGroupUsersList

Parameters:

metadata - the list metadata object

See Also:

• A_CmsGroupUsersList.setStateActionCol(org.opencms.workplace.list.CmsListMetadata)