za.org.coefficient.modules.user
Class UserAdmin

java.lang.Object
  za.org.coefficient.modules.BaseModule
      za.org.coefficient.modules.user.UserAdmin

All Implemented Interfaces:

CoefficientEventPublisher, ModuleLocal

public class UserAdmin
extends BaseModule

Field Summary

static java.lang.String	CONFIRMED_USER
private static java.lang.String	MESSAGE_1
private static java.lang.String	MESSAGE_2
private static java.lang.String	SUBJECT
private static java.lang.String	USER_PAGER

Constructor Summary

UserAdmin()

Method Summary

java.lang.String	canExecuteForRole(CoefficientContext ctx, java.lang.String methodName, Role usersHighestRole) This is a base implementation that will allow all methods to be invoked without regard to roles
CoefficientContext	changePassword(CoefficientContext ctx)
CoefficientContext	changeUserRole(CoefficientContext ctx)
CoefficientContext	confirmUser(CoefficientContext ctx)
CoefficientContext	editUsers(CoefficientContext ctx)
CoefficientContext	enterUserInfo(CoefficientContext ctx)
CoefficientUser	findUserForName(java.lang.String userName)
CoefficientUser	findWorkflowUser()
java.util.List	getAllUsers()
java.lang.String	getMainMethod() This method is used to determine which method should be invoked when the module is requested without an operation.
java.lang.String	getModuleDescription() This method is used to find the description of the module
java.lang.String	getModuleDisplayName() This method is used to find the display name of the module
java.util.List	getUsersWithSystemRole(Role role)
CoefficientContext	removeUser(CoefficientContext ctx)
CoefficientContext	savePassword(CoefficientContext ctx)
CoefficientContext	saveUser(CoefficientContext ctx)
CoefficientContext	viewUserInfo(CoefficientContext ctx)

Methods inherited from class za.org.coefficient.modules.BaseModule

createRSSItem, displayUsersData, getCoefficientContext, getModuleName, isProjectRequired, publishEvent, setCoefficientContext, showHelp

Methods inherited from class java.lang.Object

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

Field Detail

CONFIRMED_USER

public static final java.lang.String CONFIRMED_USER

See Also:

Constant Field Values

USER_PAGER

private static final java.lang.String USER_PAGER

See Also:

Constant Field Values

MESSAGE_1

private static final java.lang.String MESSAGE_1

MESSAGE_2

private static final java.lang.String MESSAGE_2

See Also:

Constant Field Values

SUBJECT

private static final java.lang.String SUBJECT

Constructor Detail

UserAdmin

public UserAdmin()

Method Detail

getAllUsers

public java.util.List getAllUsers()

getMainMethod

public java.lang.String getMainMethod()

Description copied from interface: ModuleLocal

This method is used to determine which method should be invoked when the module is requested without an operation.

Specified by:

getMainMethod in interface ModuleLocal

Specified by:

getMainMethod in class BaseModule

Returns:

name of the method that should be invoked

getModuleDescription

public java.lang.String getModuleDescription()

Description copied from interface: ModuleLocal

This method is used to find the description of the module

Specified by:

getModuleDescription in interface ModuleLocal

Specified by:

getModuleDescription in class BaseModule

Returns:

the description of the module

getModuleDisplayName

public java.lang.String getModuleDisplayName()

Description copied from interface: ModuleLocal

This method is used to find the display name of the module

Specified by:

getModuleDisplayName in interface ModuleLocal

Specified by:

getModuleDisplayName in class BaseModule

Returns:

the display name of the module

getUsersWithSystemRole

public java.util.List getUsersWithSystemRole(Role role)

canExecuteForRole

public java.lang.String canExecuteForRole(CoefficientContext ctx,
                                          java.lang.String methodName,
                                          Role usersHighestRole)

Description copied from class: BaseModule

This is a base implementation that will allow all methods to be invoked without regard to roles

Specified by:

canExecuteForRole in interface ModuleLocal

Overrides:

canExecuteForRole in class BaseModule

Returns:

null if we can execute the method an error message if not

changePassword

public CoefficientContext changePassword(CoefficientContext ctx)

changeUserRole

public CoefficientContext changeUserRole(CoefficientContext ctx)
                                  throws net.sf.hibernate.HibernateException

Throws:

net.sf.hibernate.HibernateException

confirmUser

public CoefficientContext confirmUser(CoefficientContext ctx)

editUsers

public CoefficientContext editUsers(CoefficientContext ctx)
                             throws java.lang.Exception

Throws:

java.lang.Exception

enterUserInfo

public CoefficientContext enterUserInfo(CoefficientContext ctx)

findWorkflowUser

public CoefficientUser findWorkflowUser()
                                 throws java.lang.Exception

Throws:

java.lang.Exception

findUserForName

public CoefficientUser findUserForName(java.lang.String userName)
                                throws java.lang.Exception

Throws:

java.lang.Exception

removeUser

public CoefficientContext removeUser(CoefficientContext ctx)
                              throws net.sf.hibernate.HibernateException

Throws:

net.sf.hibernate.HibernateException

savePassword

public CoefficientContext savePassword(CoefficientContext ctx)
                                throws net.sf.hibernate.HibernateException

Throws:

net.sf.hibernate.HibernateException

saveUser

public CoefficientContext saveUser(CoefficientContext ctx)
                            throws net.sf.hibernate.HibernateException

Throws:

net.sf.hibernate.HibernateException

viewUserInfo

public CoefficientContext viewUserInfo(CoefficientContext ctx)
                                throws java.lang.Exception

Throws:

java.lang.Exception