za.org.coefficient.interfaces
Interface ModuleLocal

All Known Implementing Classes:

About, About, AdminNavigate, AttributeDataManagement, AttributeManagement, AttributeSearch, BaseModule, BaseNavigate, BaseNavProjectModule, BaseProjectBrowse, BaseProjectModule, CategoryBrowse, CategoryManagement, ChangeTheme, Configuration, ConfirmProjects, DeleteProjects, DgroupsNavigation, Discussion, Error, Faq, FileUpload, GlobalProjectAdmin, Home, IssueTracker, Legal, Login, MailForum, MemberAdmin, MostActiveDiscussions, MostActiveProjects, MostRecentFileUploads, MostRecentProjects, MyData, Navigate, News, NewsAdmin, NewsBase, ProjectBrowse, ProjectModuleLinks, Projects, QuickSearch, Security, StatisticsDisplay, SwapTheme, Task, UserAdmin, Vote, VoteAdmin, Welcome, WorkflowAdmin

public interface ModuleLocal

This interface defines methods that must be implemented by a module of the system. A module will have methods invoked with a single parameter, za.org.coefficient.core.CoefficientContext .

Method Summary

java.lang.String	canExecuteForRole(CoefficientContext ctx, java.lang.String methodName, Role usersHighestRole) This method is used to determine if a named method can be executed for a specified system role.
CoefficientContext	getCoefficientContext()
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.lang.String	getModuleName() This method is used to find the system name of the module that is used to resolve the session bean
boolean	isProjectRequired() This method is used determine if we implement BaseProjectModule
void	setCoefficientContext(CoefficientContext ctx)
CoefficientContext	showHelp(CoefficientContext ctx) This method is used to show help on the your module.

Method Detail

setCoefficientContext

void setCoefficientContext(CoefficientContext ctx)

getCoefficientContext

CoefficientContext getCoefficientContext()

getMainMethod

java.lang.String getMainMethod()

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

Returns:

name of the method that should be invoked

getModuleDescription

java.lang.String getModuleDescription()

This method is used to find the description of the module

Returns:

the description of the module

getModuleDisplayName

java.lang.String getModuleDisplayName()

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

Returns:

the display name of the module

getModuleName

java.lang.String getModuleName()

This method is used to find the system name of the module that is used to resolve the session bean

Returns:

the system name of the module

canExecuteForRole

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

This method is used to determine if a named method can be executed for a specified system role.

Returns:

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

showHelp

CoefficientContext showHelp(CoefficientContext ctx)

This method is used to show help on the your module. You can get the op name by calling CoefficientContext.getLastNonHelpOp()

isProjectRequired

boolean isProjectRequired()

This method is used determine if we implement BaseProjectModule