Package org.opencms.workplace.tools.accounts

Class A_CmsUserGroupsList

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_CmsUserGroupsList

Direct Known Subclasses:

CmsNotUserGroupsList, CmsShowUserGroupsList, CmsUserGroupsList

public abstract class A_CmsUserGroupsList
extends A_CmsListDialog

Generalized user groups view.

Since:

6.0.0

Field Summary

Fields

Modifier and Type	Field	Description
static final String	LIST_ACTION_ICON	list action id constant.
static final String	LIST_ACTION_ICON_DIRECT	list action id constant.
static final String	LIST_ACTION_ICON_INDIRECT	list action id constant.
static final String	LIST_ACTION_STATE_DIRECT	list action id constant.
static final String	LIST_ACTION_STATE_INDIRECT	list action id constant.
static final String	LIST_COLUMN_DESCRIPTION	list column id constant.
static final String	LIST_COLUMN_DISPLAY	list column id constant.
static final String	LIST_COLUMN_ICON	list column id constant.
static final String	LIST_COLUMN_NAME	list column id constant.
static final String	LIST_COLUMN_ORGUNIT	list column id constant.
static final String	LIST_COLUMN_STATE	list column id constant.
static final String	LIST_DETAIL_OTHEROU	list item detail id constant.

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
protected	A_CmsUserGroupsList(org.opencms.jsp.CmsJspActionElement jsp, String listId, org.opencms.i18n.CmsMessageContainer listName, boolean searchable)	Public constructor.

Method Summary

Modifier and Type	Method	Description
protected void	fillDetails(String detailId)	Lazy initialization for detail data.
protected abstract List<org.opencms.file.CmsGroup>	getGroups(boolean withOtherOus)	Returns a list of groups to display.
protected List<CmsListItem>	getListItems()	Should generate a list with the list items to be displayed.
String	getParamOufqn()	Returns the organizational unit parameter value.
String	getParamUserid()	Returns the user id parameter value.
String	getParamUsername()	Returns the User name parameter value.
boolean	hasGroupsInOtherOus()	Returns if the list of groups has groups of other organizational units.
protected void	initializeDetail(String detailId)	Lazy details initialization.
protected void	initMessages()
protected void	setColumns(CmsListMetadata metadata)	Should create the columns and add them to the given list metadata object.
protected abstract void	setDefaultAction(CmsListColumnDefinition nameCol)	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	setParamOufqn(String ouFqn)	Sets the user organizational unit value.
void	setParamUserid(String userId)	Sets the user id parameter value.
void	setParamUsername(String username)	Sets the User name parameter value.
protected abstract void	setStateActionCol(CmsListMetadata metadata)	Sets the optional state change action column.
protected void	validateParamaters()	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, executeListMultiActions, executeListSingleActions, 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, setMultiActions, 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_ICON

public static final String LIST_ACTION_ICON

list action id constant.

See Also:

• Constant Field Values

LIST_ACTION_ICON_DIRECT

public static final String LIST_ACTION_ICON_DIRECT

list action id constant.

See Also:

• Constant Field Values

LIST_ACTION_ICON_INDIRECT

public static final String LIST_ACTION_ICON_INDIRECT

list action id constant.

See Also:

• Constant Field Values

LIST_ACTION_STATE_DIRECT

public static final String LIST_ACTION_STATE_DIRECT

list action id constant.

See Also:

• Constant Field Values

LIST_ACTION_STATE_INDIRECT

public static final String LIST_ACTION_STATE_INDIRECT

list action id constant.

See Also:

• Constant Field Values

LIST_COLUMN_DESCRIPTION

public static final String LIST_COLUMN_DESCRIPTION

list column id constant.

See Also:

• Constant Field Values

LIST_COLUMN_DISPLAY

public static final String LIST_COLUMN_DISPLAY

list column id constant.

See Also:

• Constant Field Values

LIST_COLUMN_ICON

public static final String LIST_COLUMN_ICON

list column id constant.

See Also:

• Constant Field Values

LIST_COLUMN_NAME

public static final String LIST_COLUMN_NAME

list column id constant.

See Also:

• Constant Field Values

LIST_COLUMN_ORGUNIT

public static final String LIST_COLUMN_ORGUNIT

list column id constant.

See Also:

• Constant Field Values

LIST_COLUMN_STATE

public static final String LIST_COLUMN_STATE

list column id constant.

See Also:

• Constant Field Values

LIST_DETAIL_OTHEROU

public static final String LIST_DETAIL_OTHEROU

list item detail id constant.

See Also:

• Constant Field Values

Constructor Details

A_CmsUserGroupsList

protected A_CmsUserGroupsList(org.opencms.jsp.CmsJspActionElement jsp,
 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

Method Details

getParamOufqn

public String getParamOufqn()

Returns the organizational unit parameter value.

Returns:

the organizational unit parameter value

getParamUserid

public String getParamUserid()

Returns the user id parameter value.

Returns:

the user id parameter value

getParamUsername

public String getParamUsername()

Returns the User name parameter value.

Returns:

the User name parameter value

hasGroupsInOtherOus

public boolean hasGroupsInOtherOus()

Returns if the list of groups has groups of other organizational units.

Returns:

if the list of groups has groups of other organizational units

setParamOufqn

public void setParamOufqn(String ouFqn)

Sets the user organizational unit value.

Parameters:

ouFqn - the organizational unit parameter value

setParamUserid

public void setParamUserid(String userId)

Sets the user id parameter value.

Parameters:

userId - the user id parameter value

setParamUsername

public void setParamUsername(String username)

Sets the User name parameter value.

Parameters:

username - the username to set

fillDetails

protected void fillDetails(String detailId)

Description copied from class: A_CmsListDialog

Lazy initialization for detail data.

Should fill the given detail column for every list item in CmsHtmlList.getContent() Should not throw any kind of exception.

Specified by:

fillDetails in class A_CmsListDialog

Parameters:

detailId - the id of the detail to initialize

See Also:

• A_CmsListDialog.fillDetails(java.lang.String)

getGroups

protected abstract List<org.opencms.file.CmsGroup> getGroups(boolean withOtherOus)
                                                      throws org.opencms.main.CmsException

Returns a list of groups to display.

Parameters:

withOtherOus - if not set only groups of the current ou should be returned

Returns:

a list of invalid input: '<'CmsGroups

Throws:

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

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.

Specified by:

getListItems in class A_CmsListDialog

Returns:

a list of CmsListItems

Throws:

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

See Also:

• A_CmsListDialog.getListItems()

initializeDetail

protected void initializeDetail(String detailId)

Description copied from class: A_CmsListDialog

Lazy details initialization.

Overrides:

initializeDetail in class A_CmsListDialog

Parameters:

detailId - the id of the detail column

See Also:

• A_CmsListDialog.initializeDetail(java.lang.String)

initMessages

protected void initMessages()

Overrides:

initMessages in class org.opencms.workplace.CmsWorkplace

See Also:

• CmsWorkplace.initMessages()

setColumns

protected void setColumns(CmsListMetadata metadata)

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

Parameters:

metadata - the list metadata

See Also:

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

setDefaultAction

protected abstract void setDefaultAction(CmsListColumnDefinition nameCol)

Sets the optional login default action.

Parameters:

nameCol - the group name column

setIconAction

protected abstract void setIconAction(CmsListColumnDefinition iconCol)

Sets the needed icon action(s).

Parameters:

iconCol - the list column for edition.

setIndependentActions

protected void setIndependentActions(CmsListMetadata metadata)

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

Parameters:

metadata - the list metadata

See Also:

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

setStateActionCol

protected abstract void setStateActionCol(CmsListMetadata metadata)

Sets the optional state change action column.

Parameters:

metadata - the list metadata object

validateParamaters

protected void validateParamaters()
                           throws Exception

Description copied from class: A_CmsListDialog

Should be overridden for parameter validation.

Overrides:

validateParamaters in class A_CmsListDialog

Throws:

Exception - if the parameters are not valid

See Also:

• A_CmsListDialog.validateParamaters()