za.org.coefficient.modules.user
Class MemberAdmin

java.lang.Object
  za.org.coefficient.modules.BaseModule
      za.org.coefficient.modules.BaseProjectModule
          za.org.coefficient.modules.user.MemberAdmin

All Implemented Interfaces:

CoefficientEventPublisher, ModuleLocal

public class MemberAdmin
extends BaseProjectModule

Field Summary

private static java.lang.String

MEMBER_PAGER

Constructor Summary

MemberAdmin()

Method Summary

CoefficientContext	acceptMembership(CoefficientContext ctx)
CoefficientContext	addMember(CoefficientContext ctx)
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	changeMemberRole(CoefficientContext ctx)
CoefficientContext	deleteAllForProject(CoefficientContext ctx)
CoefficientContext	displayMembers(CoefficientContext ctx)
CoefficientContext	editMembers(CoefficientContext ctx)
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
CoefficientContext	leaveProject(CoefficientContext ctx)
CoefficientContext	memberSelect(CoefficientContext ctx)
CoefficientContext	rejectMembership(CoefficientContext ctx)
void	removeAllProjectMembershipFor(CoefficientUser user)
CoefficientContext	removeMember(CoefficientContext ctx)
CoefficientContext	requestMembership(CoefficientContext ctx)
java.lang.String	viewMembers(CoefficientContext ctx)

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

getSummaryForProject, showSummaryForProject

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

MEMBER_PAGER

private static final java.lang.String MEMBER_PAGER

See Also:

Constant Field Values

Constructor Detail

MemberAdmin

public MemberAdmin()

Method Detail

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

addMember

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

Throws:

net.sf.hibernate.HibernateException

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

changeMemberRole

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

Throws:

net.sf.hibernate.HibernateException

deleteAllForProject

public CoefficientContext deleteAllForProject(CoefficientContext ctx)

Specified by:

deleteAllForProject in class BaseProjectModule

editMembers

public CoefficientContext editMembers(CoefficientContext ctx)

memberSelect

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

Throws:

java.lang.Exception

removeMember

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

Throws:

net.sf.hibernate.HibernateException

removeAllProjectMembershipFor

public void removeAllProjectMembershipFor(CoefficientUser user)
                                   throws net.sf.hibernate.HibernateException

Throws:

net.sf.hibernate.HibernateException

leaveProject

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

Throws:

net.sf.hibernate.HibernateException

requestMembership

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

Throws:

net.sf.hibernate.HibernateException

acceptMembership

public CoefficientContext acceptMembership(CoefficientContext ctx)

rejectMembership

public CoefficientContext rejectMembership(CoefficientContext ctx)

viewMembers

public java.lang.String viewMembers(CoefficientContext ctx)

displayMembers

public CoefficientContext displayMembers(CoefficientContext ctx)