org.kuali.rice.kns.service
Interface KualiModuleService

public interface KualiModuleService

Method Summary

String	getComponentCode(Class<?> documentOrStepClass)
List<String>	getDataDictionaryPackages()
List<ModuleService>	getInstalledModuleServices() get the list of all installed module services
ModuleService	getModuleService(String moduleId) Returns the module service with the given ID or null if the module ID is not found.
ModuleService	getModuleServiceByNamespaceCode(String namespaceCode) Returns the module service with the given moduleCode or null if the moduleCode is not found.
String	getNamespaceCode(Class<?> documentOrStepClass)
String	getNamespaceName(String namespaceCode) This method gets namespace name for the given namespace code
ModuleService	getResponsibleModuleService(Class boClass) Given a class, this method will return the module service which is responsible for authorizing access to it.
ModuleService	getResponsibleModuleServiceForJob(String jobName) Given a job name, this method will return the module service which is responsible for handling it.
boolean	isModuleServiceInstalled(String namespaceCode)
void	setInstalledModuleServices(List<ModuleService> moduleServices)

Method Detail

getInstalledModuleServices

List<ModuleService> getInstalledModuleServices()

get the list of all installed module services

Returns:

getModuleService

ModuleService getModuleService(String moduleId)

Returns the module service with the given ID or null if the module ID is not found.

Parameters:

moduleId -

Returns:

getModuleServiceByNamespaceCode

ModuleService getModuleServiceByNamespaceCode(String namespaceCode)

Returns the module service with the given moduleCode or null if the moduleCode is not found.

Parameters:

namespaceCode -

Returns:

isModuleServiceInstalled

boolean isModuleServiceInstalled(String namespaceCode)

getResponsibleModuleService

ModuleService getResponsibleModuleService(Class boClass)

Given a class, this method will return the module service which is responsible for authorizing access to it. It returns null if no module is found.

Parameters:

boClass -

Returns:

ModuleService representing the service responsible for the passed in Class

Throws:

ModuleServiceNotFoundException - if boClass is an ExternalizableBusinessObject that no ModuleService is responsible for.

getResponsibleModuleServiceForJob

ModuleService getResponsibleModuleServiceForJob(String jobName)

Given a job name, this method will return the module service which is responsible for handling it. It returns null if no module is found.

Parameters:

jobName -

Returns:

setInstalledModuleServices

void setInstalledModuleServices(List<ModuleService> moduleServices)

getDataDictionaryPackages

List<String> getDataDictionaryPackages()

getNamespaceName

String getNamespaceName(String namespaceCode)

This method gets namespace name for the given namespace code

Parameters:

namespaceCode -

Returns:

getNamespaceCode

String getNamespaceCode(Class<?> documentOrStepClass)

getComponentCode

String getComponentCode(Class<?> documentOrStepClass)