org.alfresco.web.bean.users

Class UsersDialog

java.lang.Object

org.alfresco.web.bean.dialog.BaseDialogBean

org.alfresco.web.bean.users.UsersDialog

All Implemented Interfaces:

Serializable, IContextListener, ChangeViewSupport, IDialogBean

Direct Known Subclasses:

ChangeMyPasswordDialog, ChangePasswordDialog

public class UsersDialog
extends BaseDialogBean
implements IContextListener, ChangeViewSupport

Author:

Kevin Roast

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	BEAN_NAME
static String	ERROR_NEGATIVE_QUOTA
static String	ERROR_PASSWORD_MATCH
protected UsersBeanProperties	properties
NodePropertyResolver	resolverUserMutable
NodePropertyResolver	resolverUserQuota
NodePropertyResolver	resolverUserSizeLatest
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
UsersDialog() 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
String	changeUserDetails() Action handler called for the OK button press
void	contextUpdated() Method called by UIContextService.notifyBeans() to inform all registered beans that all UI Beans should refresh dump all cached data and settings.
String	deleteOK() Action handler called when the OK button is clicked on the Delete User page
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
List<Node>	getUsers()
int	getUsersSize()
Long	getUsersTotalQuota()
Long	getUsersTotalUsage()
List<UIListItem>	getViewItems()
String	getViewMode()
String	search() Event handler called when the user wishes to search for a user
void	setProperties(UsersBeanProperties properties)
void	setupUserAction(javax.faces.event.ActionEvent event) Action event called by all actions that need to setup a Person context on the Users bean before an action page is called.
void	setupUserAction(String personId) Called in preparation for actions that need to setup a Person context on the Users bean before an action page is called.
void	setViewMode(String viewMode)
String	showAll() Action handler to show all the users currently in the system
void	spaceChanged() Method called by UIContextService.spaceChanged() to inform all registered beans that the current space has changed.
void	viewModeChanged(javax.faces.event.ActionEvent event)

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

doPostCommitProcessing, finish, formatErrorMessage, getActionsConfigId, getAdditionalButtons, getCheckOutCheckInService, getContainerDescription, getContainerSubTitle, getContainerTitle, getDefaultCancelOutcome, getDefaultFinishOutcome, getDictionaryService, getErrorMessageId, getErrorOutcome, getFileFolderService, getFinishButtonDisabled, getFinishButtonLabel, getMoreActionsConfigId, getNamespaceService, getNodeService, getRuleService, getSearchService, getTransactionService, init, isFinished, restored, 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

BEAN_NAME

public static String BEAN_NAME

ERROR_PASSWORD_MATCH

public static final String ERROR_PASSWORD_MATCH

See Also:

Constant Field Values

ERROR_NEGATIVE_QUOTA

public static final String ERROR_NEGATIVE_QUOTA

See Also:

Constant Field Values

viewMode

protected String viewMode

RichList view mode

properties

protected UsersBeanProperties properties

resolverUserSizeLatest

public NodePropertyResolver resolverUserSizeLatest

resolverUserQuota

public NodePropertyResolver resolverUserQuota

resolverUserMutable

public NodePropertyResolver resolverUserMutable

Constructor Detail

UsersDialog

public UsersDialog()

Default Constructor

Method Detail

setProperties

public void setProperties(UsersBeanProperties properties)

Parameters:

properties - the properties to set

getUsers

public List<Node> getUsers()

Returns:

the list of user Nodes to display

getUsersSize

public int getUsersSize()

getUsersTotalUsage

public Long getUsersTotalUsage()

getUsersTotalQuota

public Long getUsersTotalQuota()

setupUserAction

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

Action event called by all actions that need to setup a Person context on the Users bean before an action page is called. The context will be a Person Node in setPerson() which can be retrieved on the action page from UsersDialog.getPerson().

setupUserAction

public void setupUserAction(String personId)

Called in preparation for actions that need to setup a Person context on the Users bean before an action page is called.

Parameters:

personId - String

deleteOK

public String deleteOK()

Action handler called when the OK button is clicked on the Delete User page

changeUserDetails

public String changeUserDetails()

Action handler called for the OK button press

search

public String search()

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

Returns:

The outcome

showAll

public String showAll()

Action handler to show all the users currently in the system

Returns:

The outcome

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

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

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

getViewItems

public List<UIListItem> getViewItems()

Specified by:

getViewItems 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

viewModeChanged

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

Specified by:

viewModeChanged in interface ChangeViewSupport

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()