org.kuali.rice.krad.service
Interface RiceApplicationConfigurationService

All Known Implementing Classes:

RiceApplicationConfigurationServiceImpl

public interface RiceApplicationConfigurationService

This interface defines methods that a KualiConfiguration Service must provide. Provides methods for getting string resources.

Method Summary

String	getBaseHelpUrl(String businessObjectClassName)
String	getBaseInquiryUrl(String businessObjectClassName)
String	getBaseLookupUrl(String businessObjectClassName)
AttributeDefinition	getBusinessObjectAttributeDefinition(String businessObjectClassName, String attributeName) This method will return the attribute definition from the local data dictionary.
String	getConfigurationParameter(String parameterName) Given a property name (parameterName), returns the value associated with it.
List<Component>	getNonDatabaseComponents() This method can be used to supplement the list of ParameterDetailTypes defined in the database from other sources.
boolean	isResponsibleForPackage(String packageName) Checks whether this application is responsible for the package given.
boolean	supportsBusinessObjectClass(String businessObjectClassName) Checks whether this application supports the given business object (whether it is defined in the data dictionary)

Method Detail

getConfigurationParameter

String getConfigurationParameter(String parameterName)

Given a property name (parameterName), returns the value associated with it.

Parameters:

parameterName -

Returns:

String associated with the given parameterName

getNonDatabaseComponents

List<Component> getNonDatabaseComponents()

This method can be used to supplement the list of ParameterDetailTypes defined in the database from other sources.

Returns:

List containing the detailed types configured in non-database sources

isResponsibleForPackage

boolean isResponsibleForPackage(String packageName)

Checks whether this application is responsible for the package given. It will ensure that it falls within a set of configured parent packages.

supportsBusinessObjectClass

boolean supportsBusinessObjectClass(String businessObjectClassName)

Checks whether this application supports the given business object (whether it is defined in the data dictionary)

getBusinessObjectAttributeDefinition

AttributeDefinition getBusinessObjectAttributeDefinition(String businessObjectClassName,
                                                         String attributeName)

This method will return the attribute definition from the local data dictionary. It assumes that the #supportsBusinessObjectClass(java.lang.String) method has already been checked to make sure that this service will handle that class. If not present, this method will return null. This method also returns null if the given attribute definition can not be found on the business object.

getBaseLookupUrl

String getBaseLookupUrl(String businessObjectClassName)

getBaseInquiryUrl

String getBaseInquiryUrl(String businessObjectClassName)

getBaseHelpUrl

String getBaseHelpUrl(String businessObjectClassName)