Package org.kuali.rice.krad.service.impl

Class ModuleServiceBase

java.lang.Object

org.kuali.rice.krad.service.impl.RemoteModuleServiceBase

org.kuali.rice.krad.service.impl.ModuleServiceBase

All Implemented Interfaces:

ModuleService, org.springframework.beans.factory.Aware, org.springframework.beans.factory.InitializingBean, org.springframework.context.ApplicationContextAware

public class ModuleServiceBase
extends RemoteModuleServiceBase
implements ModuleService

Base implementation of the module service

Author:

Kuali Rice Team (rice.collab@kuali.org)

Nested Class Summary

Nested classes/interfaces inherited from class org.kuali.rice.krad.service.impl.RemoteModuleServiceBase

RemoteModuleServiceBase.BaseLookupUrlsHolder

Field Summary

Fields

Modifier and Type	Field	Description
protected static final org.apache.logging.log4j.Logger	LOG

Fields inherited from class org.kuali.rice.krad.service.impl.RemoteModuleServiceBase

applicationContext, kualiConfigurationService, kualiModuleService, legacyDataAdapter, lookupService, moduleConfiguration

Constructor Summary

Constructors

Constructor	Description
ModuleServiceBase()

Method Summary

Modifier and Type	Method	Description
protected String	getBaseLookupUrl()	Returns the base URL to use for lookup requests to objects within the module
<T extends ExternalizableBusinessObject> T	getExternalizableBusinessObject(Class<T> businessObjectClass, Map<String,Object> fieldValues)	This method gets the externalizable business object, given its type and a map of primary keys and values
String	getExternalizableBusinessObjectInquiryUrl(Class inquiryBusinessObjectClass, Map<String,String[]> parameters)	Deprecated.
String	getExternalizableBusinessObjectLookupUrl(Class inquiryBusinessObjectClass, Map<String,String> parameters)	Deprecated.
<T extends ExternalizableBusinessObject> List<T>	getExternalizableBusinessObjectsList(Class<T> externalizableBusinessObjectClass, Map<String,Object> fieldValues)	This method gets the list of externalizable business objects, given its type and a map of primary keys and values.
protected String	getInquiryUrl(Class inquiryBusinessObjectClass)	Deprecated.
protected RunMode	getRunMode(String module)
boolean	goToCentralRiceForInquiry()	This method determines whether or not the central rice server should be used for lookups.
boolean	isExternalizableBusinessObjectInquirable(Class boClass)
boolean	isExternalizableBusinessObjectLookupable(Class boClass)

Methods inherited from class org.kuali.rice.krad.service.impl.RemoteModuleServiceBase

afterPropertiesSet, createNewObjectFromExternalizableClass, getBaseInquiryUrl, getBusinessObjectRelationship, getExternalizableBusinessObjectDictionaryEntry, getExternalizableBusinessObjectImplementation, getExternalizableBusinessObjectsListForLookup, getExternalizableDataObjectInquiryUrl, getExternalizableDataObjectLookupUrl, getKualiConfigurationService, getKualiModuleService, getLegacyDataAdapter, getLookupService, getModuleConfiguration, getRiceBaseLookupUrl, getUrlParameters, isExternalizable, isLocked, isNonBlankValueForKey, isResponsibleFor, listAlternatePrimaryKeyFieldNames, listPrimaryKeyFieldNames, packagePrefixesMatchesDataObject, persistenceProvidersMatchDataObject, retrieveExternalizableBusinessObjectIfNecessary, retrieveExternalizableBusinessObjectsList, setApplicationContext, setKualiConfigurationService, setKualiModuleService, setModuleConfiguration, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.springframework.context.ApplicationContextAware

setApplicationContext

Methods inherited from interface org.springframework.beans.factory.InitializingBean

afterPropertiesSet

Methods inherited from interface org.kuali.rice.krad.service.ModuleService

createNewObjectFromExternalizableClass, getExternalizableBusinessObjectDictionaryEntry, getExternalizableBusinessObjectImplementation, getExternalizableBusinessObjectsListForLookup, getExternalizableDataObjectInquiryUrl, getExternalizableDataObjectLookupUrl, getModuleConfiguration, isExternalizable, isLocked, isResponsibleFor, listAlternatePrimaryKeyFieldNames, listPrimaryKeyFieldNames, retrieveExternalizableBusinessObjectIfNecessary, retrieveExternalizableBusinessObjectsList

Field Details

LOG

protected static final org.apache.logging.log4j.Logger LOG

Constructor Details

ModuleServiceBase

public ModuleServiceBase()

Method Details

getExternalizableBusinessObject

public <T extends ExternalizableBusinessObject> T getExternalizableBusinessObject(Class<T> businessObjectClass,
 Map<String,Object> fieldValues)

Description copied from interface: ModuleService

This method gets the externalizable business object, given its type and a map of primary keys and values

Specified by:

getExternalizableBusinessObject in interface ModuleService

Parameters:

businessObjectClass -

fieldValues -

Returns:

business object

See Also:

• ModuleService.getExternalizableBusinessObject(java.lang.Class, java.util.Map)

getExternalizableBusinessObjectsList

public <T extends ExternalizableBusinessObject>
List<T> getExternalizableBusinessObjectsList(Class<T> externalizableBusinessObjectClass,
 Map<String,Object> fieldValues)

Description copied from interface: ModuleService

This method gets the list of externalizable business objects, given its type and a map of primary keys and values.

Specified by:

getExternalizableBusinessObjectsList in interface ModuleService

Parameters:

externalizableBusinessObjectClass -

fieldValues -

Returns:

list of business objects

See Also:

• ModuleService.getExternalizableBusinessObject(java.lang.Class, java.util.Map)

getExternalizableBusinessObjectInquiryUrl

@Deprecated
public String getExternalizableBusinessObjectInquiryUrl(Class inquiryBusinessObjectClass,
 Map<String,String[]> parameters)

Deprecated.

Description copied from interface: ModuleService

This method returns a URL so that the inquiry framework may redirect a user to the appropriate (possibly external) website at which to view inquiry information.

Specified by:

getExternalizableBusinessObjectInquiryUrl in interface ModuleService

Overrides:

getExternalizableBusinessObjectInquiryUrl in class RemoteModuleServiceBase

Parameters:

inquiryBusinessObjectClass - a ExternalizableBusinessObject managed by this module

parameters - any inquiry parameters, and the primary key values of the inquiryBusinessObjectClass would be in here

Returns:

a URL where externalizable business object information may be viewed.

getInquiryUrl

@Deprecated
protected String getInquiryUrl(Class inquiryBusinessObjectClass)

Deprecated.

Overrides:

getInquiryUrl in class RemoteModuleServiceBase

isExternalizableBusinessObjectLookupable

public boolean isExternalizableBusinessObjectLookupable(Class boClass)

Specified by:

isExternalizableBusinessObjectLookupable in interface ModuleService

Parameters:

boClass -

Returns:

true if the class is lookupable and externalizable

isExternalizableBusinessObjectInquirable

public boolean isExternalizableBusinessObjectInquirable(Class boClass)

Specified by:

isExternalizableBusinessObjectInquirable in interface ModuleService

Parameters:

boClass -

Returns:

true if the class is inquirable and externalizable

getExternalizableBusinessObjectLookupUrl

@Deprecated
public String getExternalizableBusinessObjectLookupUrl(Class inquiryBusinessObjectClass,
 Map<String,String> parameters)

Deprecated.

Description copied from interface: ModuleService

This method gets the lookup url for the given externalizable business object properties.

Specified by:

getExternalizableBusinessObjectLookupUrl in interface ModuleService

Overrides:

getExternalizableBusinessObjectLookupUrl in class RemoteModuleServiceBase

Parameters:

parameters -

Returns:

lookup url

goToCentralRiceForInquiry

public boolean goToCentralRiceForInquiry()

Description copied from interface: ModuleService

This method determines whether or not the central rice server should be used for lookups.

Specified by:

goToCentralRiceForInquiry in interface ModuleService

Overrides:

goToCentralRiceForInquiry in class RemoteModuleServiceBase

Returns:

true if the central rice server should be used for lookups

getBaseLookupUrl

protected String getBaseLookupUrl()

Returns the base URL to use for lookup requests to objects within the module

Overrides:

getBaseLookupUrl in class RemoteModuleServiceBase

Returns:

String base lookup URL

getRunMode

protected RunMode getRunMode(String module)