org.alfresco.web.bean.groups

Class GroupsDialog

java.lang.Object

org.alfresco.web.bean.dialog.BaseDialogBean

org.alfresco.web.bean.groups.GroupsDialog

All Implemented Interfaces:

Serializable, IContextListener, ChangeViewSupport, FilterViewSupport, IDialogBean

public class GroupsDialog
extends BaseDialogBean
implements IContextListener, FilterViewSupport, ChangeViewSupport

Backing Bean for the Groups Management pages.

Author:

Kevin Roast

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	GroupsDialog.AuthorityNamePropertyResolver
class	GroupsDialog.AuthorityPropertyResolver Simple dynamic resolver class to return authority properties at runtime
static class	GroupsDialog.UserAuthorityDetails Simple wrapper bean exposing user authority and person details for JSF results list

Field Summary

Fields

Modifier and Type	Field and Description
protected String	filterMode Filter mode
protected String	group Currently visible Group Authority
protected String	groupName
protected List<Map<String,String>>	groups Groups
protected UIRichList	groupsRichList Component references
static String	KEY_GROUP
protected List<IBreadcrumbHandler>	location Groups path breadcrumb location
static String	PARAM_GROUP
static String	PARAM_GROUP_NAME
protected UIRichList	usersRichList
protected String	viewMode RichList view mode

Fields inherited from class org.alfresco.web.bean.dialog.BaseDialogBean

browseBean, isFinished, navigator, parameters

Constructor Summary

Constructors

Constructor and Description
GroupsDialog() Default Constructor

Method Summary

Modifier and Type	Method and Description
void	areaChanged() Method called by UIContextService.areaChanged() to inform all registered beans that the user has changed area i.e.
String	cancel() Method handler called when the cancel button of the dialog is pressed
void	clickGroup(javax.faces.event.ActionEvent event) Action called when a Group folder is clicked.
void	contextUpdated() Method called by UIContextService.notifyBeans() to inform all registered beans that all UI Beans should refresh dump all cached data and settings.
void	filterModeChanged(javax.faces.event.ActionEvent event)
protected String	finishImpl(javax.faces.context.FacesContext context, String outcome) Performs the actual processing for the wizard.
Object	getActionsContext() Returns the object to use as the context for the main and more actions that may be configured by the dialog
String	getCancelButtonLabel() Returns the label to use for the cancel button
String	getContainerSubTitle() Returns the subtitle to be used for the dialog
List<UIListItem>	getFilterItems()
String	getFilterMode()
String	getGroup()
String	getGroupName()
List<Map<String,String>>	getGroups()
UIRichList	getGroupsRichList()
String	getGroupsSearchCriteria()
List<IBreadcrumbHandler>	getLocation()
List<Map<String,Object>>	getUsers()
UIRichList	getUsersRichList()
List<UIListItem>	getViewItems()
String	getViewMode()
boolean	isAllowSearchGroups()
protected void	removeFromBreadcrumb(String group)
void	removeUser(javax.faces.event.ActionEvent event) Remove specified user from the current group
void	restored() Called when the dialog is restored after a nested dialog is closed
String	searchGroups() Event handler called when the user wishes to search for a group
void	setAuthService(org.alfresco.service.cmr.security.AuthorityService authService)
protected void	setCurrentGroup(String group, String groupName) Set the current Group Authority.
void	setFilterMode(String filterMode)
void	setGroupsRichList(UIRichList groupsRichList)
void	setGroupsSearchCriteria(String groupsSearchCriteria) Simple setter
void	setPersonService(org.alfresco.service.cmr.security.PersonService personService)
void	setUsersRichList(UIRichList usersRichList)
void	setViewMode(String viewMode)
String	showAllGroups() Action handler to show all the sub-groups in the group
void	spaceChanged() Method called by UIContextService.spaceChanged() to inform all registered beans that the current space has changed.
protected void	updateUILocation(String group) Update the breadcrumb with the clicked Group location
void	viewModeChanged(javax.faces.event.ActionEvent event)

Methods inherited from class org.alfresco.web.bean.dialog.BaseDialogBean

doPostCommitProcessing, finish, formatErrorMessage, getActionsConfigId, getAdditionalButtons, getCheckOutCheckInService, getContainerDescription, getContainerTitle, getDefaultCancelOutcome, getDefaultFinishOutcome, getDictionaryService, getErrorMessageId, getErrorOutcome, getFileFolderService, getFinishButtonDisabled, getFinishButtonLabel, getMoreActionsConfigId, getNamespaceService, getNodeService, getRuleService, getSearchService, getTransactionService, init, isFinished, setBrowseBean, setDictionaryService, setFileFolderService, setNamespaceService, setNavigator, setNodeService, setSearchService

Methods inherited from class java.lang.Object

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

Field Detail

KEY_GROUP

public static final String KEY_GROUP

See Also:

Constant Field Values

PARAM_GROUP

public static final String PARAM_GROUP

See Also:

Constant Field Values

PARAM_GROUP_NAME

public static final String PARAM_GROUP_NAME

See Also:

Constant Field Values

groupsRichList

protected UIRichList groupsRichList

Component references

usersRichList

protected UIRichList usersRichList

groups

protected List<Map<String,String>> groups

Groups

group

protected String group

Currently visible Group Authority

groupName

protected String groupName

viewMode

protected String viewMode

RichList view mode

filterMode

protected String filterMode

Filter mode

location

protected List<IBreadcrumbHandler> location

Groups path breadcrumb location

Constructor Detail

GroupsDialog

public GroupsDialog()

Default Constructor

Method Detail

finishImpl

protected String finishImpl(javax.faces.context.FacesContext context,
                            String outcome)
                     throws Exception

Description copied from class: BaseDialogBean

Performs the actual processing for the wizard. NOTE: This method is called within the context of a transaction so no transaction handling is required

Specified by:

finishImpl in class BaseDialogBean

Parameters:

context - FacesContext

outcome - The default outcome

Returns:

The outcome

Throws:

Exception

cancel

public String cancel()

Description copied from interface: IDialogBean

Method handler called when the cancel button of the dialog is pressed

Specified by:

cancel in interface IDialogBean

Overrides:

cancel in class BaseDialogBean

Returns:

The outcome to return

getContainerSubTitle

public String getContainerSubTitle()

Description copied from interface: IDialogBean

Returns the subtitle to be used for the dialog

If this returns null the DialogManager will lookup the subtitle via the dialog configuration

Specified by:

getContainerSubTitle in interface IDialogBean

Overrides:

getContainerSubTitle in class BaseDialogBean

Returns:

The subtitle or null if the subtitle is to be acquired via configuration

getCancelButtonLabel

public String getCancelButtonLabel()

Description copied from interface: IDialogBean

Returns the label to use for the cancel button

Specified by:

getCancelButtonLabel in interface IDialogBean

Overrides:

getCancelButtonLabel in class BaseDialogBean

Returns:

The cancel button label

restored

public void restored()

Description copied from interface: IDialogBean

Called when the dialog is restored after a nested dialog is closed

Specified by:

restored in interface IDialogBean

Overrides:

restored in class BaseDialogBean

getActionsContext

public Object getActionsContext()

Description copied from interface: IDialogBean

Returns the object to use as the context for the main and more actions that may be configured by the dialog

Specified by:

getActionsContext in interface IDialogBean

Overrides:

getActionsContext in class BaseDialogBean

Returns:

Object to use as the context for actions

getFilterItems

public List<UIListItem> getFilterItems()

Specified by:

getFilterItems in interface FilterViewSupport

filterModeChanged

public void filterModeChanged(javax.faces.event.ActionEvent event)

Specified by:

filterModeChanged in interface FilterViewSupport

getFilterMode

public String getFilterMode()

Specified by:

getFilterMode in interface FilterViewSupport

setFilterMode

public void setFilterMode(String filterMode)

Specified by:

setFilterMode in interface FilterViewSupport

getViewItems

public List<UIListItem> getViewItems()

Specified by:

getViewItems in interface ChangeViewSupport

viewModeChanged

public void viewModeChanged(javax.faces.event.ActionEvent event)

Specified by:

viewModeChanged in interface ChangeViewSupport

getViewMode

public String getViewMode()

Specified by:

getViewMode in interface ChangeViewSupport

setViewMode

public void setViewMode(String viewMode)

Specified by:

setViewMode in interface ChangeViewSupport

getGroup

public String getGroup()

getGroupName

public String getGroupName()

setAuthService

public void setAuthService(org.alfresco.service.cmr.security.AuthorityService authService)

setPersonService

public void setPersonService(org.alfresco.service.cmr.security.PersonService personService)

getGroupsRichList

public UIRichList getGroupsRichList()

setGroupsRichList

public void setGroupsRichList(UIRichList groupsRichList)

getUsersRichList

public UIRichList getUsersRichList()

setUsersRichList

public void setUsersRichList(UIRichList usersRichList)

getLocation

public List<IBreadcrumbHandler> getLocation()

Returns:

Breadcrumb location list

isAllowSearchGroups

public boolean isAllowSearchGroups()

Returns:

true if user is in the root group

getGroups

public List<Map<String,String>> getGroups()

Returns:

The list of group objects to display. Returns the list of root groups or the list of sub-groups for the current group if set.

getGroupsSearchCriteria

public String getGroupsSearchCriteria()

Returns:

Returns the groups search criteria

searchGroups

public String searchGroups()

Event handler called when the user wishes to search for a group

Returns:

The outcome

showAllGroups

public String showAllGroups()

Action handler to show all the sub-groups in the group

Returns:

The outcome

getUsers

public List<Map<String,Object>> getUsers()

Returns:

The list of user objects to display. Returns the list of user for the current group.

setCurrentGroup

protected void setCurrentGroup(String group,
                               String groupName)

Set the current Group Authority.

Setting this value causes the UI to update and display the specified node as current.

Parameters:

group - The current group authority.

clickGroup

public void clickGroup(javax.faces.event.ActionEvent event)

Action called when a Group folder is clicked. Navigate into the Group and show child Groups and child Users.

setGroupsSearchCriteria

public void setGroupsSearchCriteria(String groupsSearchCriteria)

Simple setter

Parameters:

groupsSearchCriteria - String

removeUser

public void removeUser(javax.faces.event.ActionEvent event)

Remove specified user from the current group

updateUILocation

protected void updateUILocation(String group)

Update the breadcrumb with the clicked Group location

removeFromBreadcrumb

protected void removeFromBreadcrumb(String group)

contextUpdated

public void contextUpdated()

Description copied from interface: IContextListener

Method called by UIContextService.notifyBeans() to inform all registered beans that all UI Beans should refresh dump all cached data and settings.

Specified by:

contextUpdated in interface IContextListener

See Also:

IContextListener.contextUpdated()

areaChanged

public void areaChanged()

Description copied from interface: IContextListener

Method called by UIContextService.areaChanged() to inform all registered beans that the user has changed area i.e. from company home to my home.

Specified by:

areaChanged in interface IContextListener

See Also:

IContextListener.areaChanged()

spaceChanged

public void spaceChanged()

Description copied from interface: IContextListener

Method called by UIContextService.spaceChanged() to inform all registered beans that the current space has changed.

Specified by:

spaceChanged in interface IContextListener

See Also:

IContextListener.spaceChanged()