UserMembersBean (Alfresco 5.3.a-SNAPSHOT API)

java.lang.Object
- org.alfresco.web.bean.dialog.BaseDialogBean
- - org.alfresco.web.bean.users.UserMembersBean

All Implemented Interfaces:

Serializable, IContextListener, FilterViewSupport, IDialogBean

Direct Known Subclasses:

ContentUsersBean, SpaceUsersBean
```
public abstract class UserMembersBean
extends BaseDialogBean
implements IContextListener, FilterViewSupport
```
Bean backing the Manage Space/Content Permission pages.

Author:

Kevin Roast

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class UserMembersBean.PermissionWrapper
Wrapper class for list data model to display current roles for user

Nested Classes
Modifier and Type	Class and Description
`static class`	`UserMembersBean.PermissionWrapper` Wrapper class for list data model to display current roles for user

Field Summary

Fields
Modifier and Type Field and Description

protected BrowseBean browseBean
BrowseBean bean refernce
- Fields inherited from class org.alfresco.web.bean.dialog.BaseDialogBean
  isFinished, navigator, parameters

Fields
Modifier and Type	Field and Description
`protected BrowseBean`	`browseBean` BrowseBean bean refernce

Constructor Summary

Constructors
Constructor and Description

UserMembersBean()
Default constructor

Constructors
Constructor and Description
`UserMembersBean()` Default constructor

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addRole(ActionEvent event)` Action handler called when the Add Role button is pressed to process the current selection
`void`	`areaChanged()` Method called by UIContextService.areaChanged() to inform all registered beans that the user has changed area i.e.
`String`	`cancel()` Action called to Close the dialog
`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(ActionEvent event)`
`String`	`finishOK()` Action handler called when the Finish button is clicked on the Edit User Roles page
`protected AuthorityService`	`getAuthorityService()`
`List<UIListItem>`	`getFilterItems()`
`String`	`getFilterMode()`
`boolean`	`getHasChangePermissions()`
`abstract Node`	`getNode()` Returns the node that is being acted upon
`protected org.alfresco.service.cmr.repository.NodeService`	`getNodeService()`
`protected OwnableService`	`getOwnableService()`
`String`	`getOwner()` Return the owner username
`protected org.alfresco.service.cmr.security.PermissionService`	`getPermissionService()`
`String`	`getPersonAuthority()`
`String`	`getPersonName()`
`DataModel`	`getPersonRolesDataModel()` Returns the properties for current Person roles JSF DataModel
`protected PersonService`	`getPersonService()`
`protected org.alfresco.service.cmr.search.SearchService`	`getSearchService()`
`List<Map>`	`getUsers()`
`UIRichList`	`getUsersRichList()`
`void`	`inheritPermissionsValueChanged(ValueChangeEvent event)` Inherit parent Space permissions value changed by the user
`boolean`	`isInheritPermissions()`
`String`	`removeOK()` Action handler called when the OK button is clicked on the Remove User page
`void`	`removeRole(ActionEvent event)` Action handler called when the Remove button is pressed to remove a role from current user
`static String`	`roleListToString(FacesContext context, List<String> list)` Convert a list of user Roles to a comma separated string list.
`void`	`setAuthorityService(AuthorityService authorityService)`
`void`	`setBrowseBean(BrowseBean browseBean)`
`void`	`setFilterMode(String filterMode)`
`void`	`setInheritPermissions(boolean inheritPermissions)`
`void`	`setNodeService(org.alfresco.service.cmr.repository.NodeService nodeService)`
`void`	`setOwnableService(OwnableService ownableService)`
`void`	`setPermissionService(org.alfresco.service.cmr.security.PermissionService permissionService)`
`void`	`setPersonAuthority(String person)`
`void`	`setPersonName(String personName)`
`void`	`setPersonService(PersonService personService)`
`void`	`setSearchService(org.alfresco.service.cmr.search.SearchService searchService)`
`void`	`setupUserAction(ActionEvent event)` Action event called by all actions that need to setup a Person context on the UserMembers bean before an action page is called.
`void`	`setUsersRichList(UIRichList usersRichList)`
`void`	`spaceChanged()` Method called by UIContextService.spaceChanged() to inform all registered beans that the current space has changed.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - browseBean
```
protected BrowseBean browseBean
```
    BrowseBean bean refernce
- Constructor Detail
  - UserMembersBean
```
public UserMembersBean()
```
    Default constructor
- Method Detail
  - getNode
```
public abstract Node getNode()
```
    Returns the node that is being acted upon
    
    Returns:
    
    The node to manage permissions for
  - setNodeService
```
public void setNodeService(org.alfresco.service.cmr.repository.NodeService nodeService)
```
    Overrides:
    
    setNodeService in class BaseDialogBean
    
    Parameters:
    
    nodeService - The NodeService to set.
  - getNodeService
```
protected org.alfresco.service.cmr.repository.NodeService getNodeService()
```
    Overrides:
    
    getNodeService in class BaseDialogBean
  - setSearchService
```
public void setSearchService(org.alfresco.service.cmr.search.SearchService searchService)
```
    Overrides:
    
    setSearchService in class BaseDialogBean
    
    Parameters:
    
    searchService - The search service
  - getSearchService
```
protected org.alfresco.service.cmr.search.SearchService getSearchService()
```
    Overrides:
    
    getSearchService in class BaseDialogBean
  - setPermissionService
```
public void setPermissionService(org.alfresco.service.cmr.security.PermissionService permissionService)
```
    Parameters:
    
    permissionService - The PermissionService to set.
  - getPermissionService
```
protected org.alfresco.service.cmr.security.PermissionService getPermissionService()
```
  - setAuthorityService
```
public void setAuthorityService(AuthorityService authorityService)
```
    Parameters:
    
    authorityService - The AuthorityService to set.
  - getAuthorityService
```
protected AuthorityService getAuthorityService()
```
  - setOwnableService
```
public void setOwnableService(OwnableService ownableService)
```
    Parameters:
    
    ownableService - The ownableService to set.
  - getOwnableService
```
protected OwnableService getOwnableService()
```
  - setPersonService
```
public void setPersonService(PersonService personService)
```
    Parameters:
    
    personService - The personService to set.
  - getPersonService
```
protected PersonService getPersonService()
```
  - setBrowseBean
```
public void setBrowseBean(BrowseBean browseBean)
```
    Overrides:
    
    setBrowseBean in class BaseDialogBean
    
    Parameters:
    
    browseBean - The BrowseBean to set.
  - getUsersRichList
```
public UIRichList getUsersRichList()
```
    Returns:
    
    Returns the usersRichList.
  - setUsersRichList
```
public void setUsersRichList(UIRichList usersRichList)
```
    Parameters:
    
    usersRichList - The usersRichList to set.
  - getPersonRolesDataModel
```
public DataModel getPersonRolesDataModel()
```
    Returns the properties for current Person roles JSF DataModel
    
    Returns:
    
    JSF DataModel representing the current Person roles
  - getPersonAuthority
```
public String getPersonAuthority()
```
    Returns:
    
    Returns the current person authority.
  - setPersonAuthority
```
public void setPersonAuthority(String person)
```
    Parameters:
    
    person - The person person authority to set.
  - getPersonName
```
public String getPersonName()
```
    Returns:
    
    Returns the personName.
  - setPersonName
```
public void setPersonName(String personName)
```
    Parameters:
    
    personName - The personName to set.
  - getHasChangePermissions
```
public boolean getHasChangePermissions()
```
    Returns:
    
    true if the current user can change permissions on this Space
  - isInheritPermissions
```
public boolean isInheritPermissions()
```
    Returns:
    
    Returns the inherit parent permissions flag set for the current space.
  - setInheritPermissions
```
public void setInheritPermissions(boolean inheritPermissions)
```
    Parameters:
    
    inheritPermissions - The inheritPermissions to set.
  - getOwner
```
public String getOwner()
```
    Return the owner username
  - getUsers
```
public List<Map> getUsers()
```
    Returns:
    
    the list of user nodes for list data binding
  - roleListToString
```
public static String roleListToString(FacesContext context,
                                      List<String> list)
```
    Convert a list of user Roles to a comma separated string list. Each individual role will be looked up in message bundle to convert to a human readable string value.
    
    Parameters:
    
    context - FacesContext
    
    list - List of Role names
    
    Returns:
    
    Comma separated string of human readable roles
  - 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()
  - filterModeChanged
```
public void filterModeChanged(ActionEvent event)
```
    Specified by:
    
    filterModeChanged in interface FilterViewSupport
    
    See Also:
    
    FilterViewSupport.filterModeChanged(javax.faces.event.ActionEvent)
  - getFilterItems
```
public List<UIListItem> getFilterItems()
```
    Specified by:
    
    getFilterItems in interface FilterViewSupport
    
    See Also:
    
    FilterViewSupport.getFilterItems()
  - getFilterMode
```
public String getFilterMode()
```
    Specified by:
    
    getFilterMode in interface FilterViewSupport
    
    See Also:
    
    FilterViewSupport.getFilterMode()
  - setFilterMode
```
public void setFilterMode(String filterMode)
```
    Specified by:
    
    setFilterMode in interface FilterViewSupport
    
    See Also:
    
    FilterViewSupport.setFilterMode(java.lang.String)
  - cancel
```
public String cancel()
```
    Action called to Close the dialog
    
    Specified by:
    
    cancel in interface IDialogBean
    
    Overrides:
    
    cancel in class BaseDialogBean
    
    Returns:
    
    The outcome to return
  - setupUserAction
```
public void setupUserAction(ActionEvent event)
```
    Action event called by all actions that need to setup a Person context on the UserMembers bean before an action page is called. The context will be a Authority in setPersonAuthority() which can be retrieved on the action page from UserMembersBean.setPersonAuthority().
  - inheritPermissionsValueChanged
```
public void inheritPermissionsValueChanged(ValueChangeEvent event)
```
    Inherit parent Space permissions value changed by the user
  - addRole
```
public void addRole(ActionEvent event)
```
    Action handler called when the Add Role button is pressed to process the current selection
  - removeRole
```
public void removeRole(ActionEvent event)
```
    Action handler called when the Remove button is pressed to remove a role from current user
  - finishOK
```
public String finishOK()
```
    Action handler called when the Finish button is clicked on the Edit User Roles page
  - removeOK
```
public String removeOK()
```
    Action handler called when the OK button is clicked on the Remove User page

Class UserMembersBean

Nested Class Summary

Field Summary

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

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

Field Detail

browseBean

Constructor Detail

UserMembersBean

Method Detail

getNode

setNodeService

getNodeService

setSearchService

getSearchService

setPermissionService

getPermissionService

setAuthorityService

getAuthorityService

setOwnableService

getOwnableService

setPersonService

getPersonService

setBrowseBean

getUsersRichList

setUsersRichList

getPersonRolesDataModel

getPersonAuthority

setPersonAuthority

getPersonName

setPersonName

getHasChangePermissions

isInheritPermissions

setInheritPermissions

getOwner

getUsers

roleListToString

contextUpdated

areaChanged

spaceChanged

filterModeChanged

getFilterItems

getFilterMode

setFilterMode

cancel

setupUserAction

inheritPermissionsValueChanged

addRole

removeRole

finishOK

removeOK