org.kuali.rice.kim.service.impl

Class KimModuleService

java.lang.Object

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

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

org.kuali.rice.kim.service.impl.KimModuleService

All Implemented Interfaces:

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

public class KimModuleService
extends ModuleServiceBase

This is a description of what this class does - kellerj don't forget to fill this in.

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 inherited from class org.kuali.rice.krad.service.impl.ModuleServiceBase

LOG

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

applicationContext, kualiConfigurationService, kualiModuleService, legacyDataAdapter, lookupService, moduleConfiguration

Constructor Summary

Constructors

Constructor and Description
KimModuleService()

Method Summary

Methods

Modifier and Type	Method and Description
<T extends ExternalizableBusinessObject> T	getExternalizableBusinessObject(Class<T> businessObjectClass, Map<String,Object> fieldValues) This overridden method ...
<T extends ExternalizableBusinessObject> List<T>	getExternalizableBusinessObjectsList(Class<T> externalizableBusinessObjectClass, Map<String,Object> fieldValues) This overridden method ...
<T extends ExternalizableBusinessObject> List<T>	getExternalizableBusinessObjectsListForLookup(Class<T> externalizableBusinessObjectClass, Map<String,Object> fieldValues, boolean unbounded) This method gets the list of externalizable business objects for lookup, given its type and a map of primary keys and values.
protected GroupService	getGroupService()
protected IdentityService	getIdentityService()
protected String	getInquiryUrl(Class inquiryBusinessObjectClass)
protected RoleService	getKimRoleService()
protected PersonService	getPersonService()
protected KimTypeInfoService	getTypeInfoService()
protected Properties	getUrlParameters(String businessObjectClassAttribute, Map<String,String[]> parameters)
boolean	goToCentralRiceForInquiry() This method determines whether or not the central rice server should be used for lookups.
boolean	isExternalizable(Class boClazz) This method determines whether or not a bo class is externalizable.
List<List<String>>	listAlternatePrimaryKeyFieldNames(Class businessObjectInterfaceClass) This overridden method ...
List	listPrimaryKeyFieldNames(Class businessObjectInterfaceClass) This overridden method ...

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

getBaseLookupUrl, getExternalizableBusinessObjectInquiryUrl, getExternalizableBusinessObjectLookupUrl, getRunMode, isExternalizableBusinessObjectInquirable, isExternalizableBusinessObjectLookupable

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

afterPropertiesSet, createNewObjectFromExternalizableClass, getBaseInquiryUrl, getBusinessObjectRelationship, getExternalizableBusinessObjectDictionaryEntry, getExternalizableBusinessObjectImplementation, getExternalizableDataObjectInquiryUrl, getExternalizableDataObjectLookupUrl, getKualiConfigurationService, getKualiModuleService, getLegacyDataAdapter, getLookupService, getModuleConfiguration, getRiceBaseLookupUrl, isLocked, isNonBlankValueForKey, isResponsibleFor, 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.kuali.rice.krad.service.ModuleService

createNewObjectFromExternalizableClass, getExternalizableBusinessObjectDictionaryEntry, getExternalizableBusinessObjectImplementation, getExternalizableDataObjectInquiryUrl, getExternalizableDataObjectLookupUrl, getModuleConfiguration, isLocked, isResponsibleFor, retrieveExternalizableBusinessObjectIfNecessary, retrieveExternalizableBusinessObjectsList

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

afterPropertiesSet

Methods inherited from interface org.springframework.context.ApplicationContextAware

setApplicationContext

Constructor Detail

KimModuleService

public KimModuleService()

Method Detail

getExternalizableBusinessObject

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

This overridden method ...

Specified by:

getExternalizableBusinessObject in interface ModuleService

Overrides:

getExternalizableBusinessObject in class ModuleServiceBase

Returns:

business object

See Also:

ModuleServiceBase.getExternalizableBusinessObject(java.lang.Class, java.util.Map)

getExternalizableBusinessObjectsList

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

This overridden method ...

Specified by:

getExternalizableBusinessObjectsList in interface ModuleService

Overrides:

getExternalizableBusinessObjectsList in class ModuleServiceBase

Returns:

list of business objects

See Also:

ModuleServiceBase.getExternalizableBusinessObjectsList(java.lang.Class, java.util.Map)

getExternalizableBusinessObjectsListForLookup

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

Description copied from interface: ModuleService

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

Specified by:

getExternalizableBusinessObjectsListForLookup in interface ModuleService

Overrides:

getExternalizableBusinessObjectsListForLookup in class RemoteModuleServiceBase

Returns:

list of business objects

See Also:

ModuleService.getExternalizableBusinessObjectsListForLookup(java.lang.Class, java.util.Map, boolean)

listPrimaryKeyFieldNames

public List listPrimaryKeyFieldNames(Class businessObjectInterfaceClass)

This overridden method ...

Specified by:

listPrimaryKeyFieldNames in interface ModuleService

Overrides:

listPrimaryKeyFieldNames in class RemoteModuleServiceBase

Returns:

list of primary key field names

See Also:

RemoteModuleServiceBase.listPrimaryKeyFieldNames(java.lang.Class)

getPersonService

protected PersonService getPersonService()

getKimRoleService

protected RoleService getKimRoleService()

getGroupService

protected GroupService getGroupService()

getIdentityService

protected IdentityService getIdentityService()

getTypeInfoService

protected KimTypeInfoService getTypeInfoService()

getUrlParameters

protected Properties getUrlParameters(String businessObjectClassAttribute,
                          Map<String,String[]> parameters)

Overrides:

getUrlParameters in class RemoteModuleServiceBase

isExternalizable

public boolean isExternalizable(Class boClazz)

Description copied from interface: ModuleService

This method determines whether or not a bo class is externalizable.

Specified by:

isExternalizable in interface ModuleService

Overrides:

isExternalizable in class RemoteModuleServiceBase

Returns:

true if the class is externalizable

See Also:

ModuleService.isExternalizable(java.lang.Class)

getInquiryUrl

protected String getInquiryUrl(Class inquiryBusinessObjectClass)

Overrides:

getInquiryUrl in class ModuleServiceBase

listAlternatePrimaryKeyFieldNames

public List<List<String>> listAlternatePrimaryKeyFieldNames(Class businessObjectInterfaceClass)

Description copied from class: RemoteModuleServiceBase

This overridden method ...

Specified by:

listAlternatePrimaryKeyFieldNames in interface ModuleService

Overrides:

listAlternatePrimaryKeyFieldNames in class RemoteModuleServiceBase

Returns:

List of List of Strings.

See Also:

ModuleService.listAlternatePrimaryKeyFieldNames(java.lang.Class)

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 ModuleServiceBase

Returns:

true if the central rice server should be used for lookups