za.org.coefficient.modules.configuration
Class Configuration

java.lang.Object
  za.org.coefficient.modules.BaseModule
      za.org.coefficient.modules.configuration.Configuration

All Implemented Interfaces:

CoefficientEventPublisher, ModuleLocal

public class Configuration
extends BaseModule

Constructor Summary

Configuration()

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
CoefficientConfiguration	getConfiguration(java.lang.String forClass)
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	save(CoefficientContext ctx)
void	saveConfiguration(CoefficientConfiguration cc)
CoefficientContext	view(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

Constructor Detail

Configuration

public Configuration()

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

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

view

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

Throws:

java.lang.Exception

save

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

Throws:

java.lang.Exception

getConfiguration

public CoefficientConfiguration getConfiguration(java.lang.String forClass)
                                          throws java.lang.Exception

Returns:

is the configuration if one exists, null otherwise

Throws:

java.lang.Exception

saveConfiguration

public void saveConfiguration(CoefficientConfiguration cc)
                       throws java.lang.Exception

Throws:

java.lang.Exception