org.kuali.rice.kew.service.impl
Class KEWModuleService

java.lang.Object
  extended by org.kuali.rice.krad.service.impl.RemoteModuleServiceBase
      extended by org.kuali.rice.krad.service.impl.ModuleServiceBase
          extended by org.kuali.rice.kew.service.impl.KEWModuleService
All Implemented Interfaces:
ModuleService, org.springframework.beans.factory.Aware, org.springframework.beans.factory.InitializingBean, org.springframework.context.ApplicationContextAware

public class KEWModuleService
extends ModuleServiceBase

The ModuleService for KEW

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
protected  DocumentTypeService docTypeService
           
 
Fields inherited from class org.kuali.rice.krad.service.impl.ModuleServiceBase
businessObjectDictionaryService, businessObjectService, LOG
 
Fields inherited from class org.kuali.rice.krad.service.impl.RemoteModuleServiceBase
applicationContext, kualiConfigurationService, kualiModuleService, lookupService, moduleConfiguration
 
Constructor Summary
KEWModuleService()
           
 
Method Summary
protected  DocumentTypeService getDocumentTypeService()
           
<T extends ExternalizableBusinessObject>
T
getExternalizableBusinessObject(Class<T> businessObjectClass, Map<String,Object> fieldValues)
          This overridden method calls the DocumentTypeService instead of the underlying KNS service.
 String getExternalizableBusinessObjectInquiryUrl(Class inquiryBusinessObjectClass, Map<String,String[]> parameters)
          This overridden method rewrites the URL.
 boolean goToCentralRiceForInquiry()
          This method determines whether or not the central rice server should be used for lookups.
 List<List<String>> listAlternatePrimaryKeyFieldNames(Class businessObjectInterfaceClass)
          We want to be able to use name as an alternate key
 List<String> listPrimaryKeyFieldNames(Class businessObjectInterfaceClass)
          These are the "primary" keys for the DocTypeService.
 void setDocumentTypeService(DocumentTypeService docTypeService)
           
 
Methods inherited from class org.kuali.rice.krad.service.impl.ModuleServiceBase
getBaseLookupUrl, getBusinessObjectDictionaryService, getBusinessObjectService, getExternalizableBusinessObjectLookupUrl, getExternalizableBusinessObjectsList, getInquiryUrl, getRunMode, isExternalizableBusinessObjectInquirable, isExternalizableBusinessObjectLookupable
 
Methods inherited from class org.kuali.rice.krad.service.impl.RemoteModuleServiceBase
afterPropertiesSet, createNewObjectFromExternalizableClass, getBaseInquiryUrl, getBusinessObjectRelationship, getExternalizableBusinessObjectDictionaryEntry, getExternalizableBusinessObjectImplementation, getExternalizableBusinessObjectsListForLookup, getExternalizableDataObjectInquiryUrl, getExternalizableDataObjectLookupUrl, getKualiConfigurationService, getKualiModuleService, getLookupService, getModuleConfiguration, getRiceBaseLookupUrl, getUrlParameters, isExternalizable, isLocked, isResponsibleFor, isResponsibleForJob, retrieveExternalizableBusinessObjectIfNecessary, retrieveExternalizableBusinessObjectsList, setApplicationContext, setKualiConfigurationService, setKualiModuleService, setModuleConfiguration
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface org.kuali.rice.krad.service.ModuleService
createNewObjectFromExternalizableClass, getExternalizableBusinessObjectDictionaryEntry, getExternalizableBusinessObjectImplementation, getExternalizableBusinessObjectsListForLookup, getExternalizableDataObjectInquiryUrl, getExternalizableDataObjectLookupUrl, getModuleConfiguration, isExternalizable, isLocked, isResponsibleFor, isResponsibleForJob, retrieveExternalizableBusinessObjectIfNecessary, retrieveExternalizableBusinessObjectsList
 
Methods inherited from interface org.springframework.beans.factory.InitializingBean
afterPropertiesSet
 
Methods inherited from interface org.springframework.context.ApplicationContextAware
setApplicationContext
 

Field Detail

docTypeService

protected DocumentTypeService docTypeService
Constructor Detail

KEWModuleService

public KEWModuleService()
Method Detail

listPrimaryKeyFieldNames

public List<String> listPrimaryKeyFieldNames(Class businessObjectInterfaceClass)
These are the "primary" keys for the DocTypeService. We are considering both name and documentTypeId to be unique.

Specified by:
listPrimaryKeyFieldNames in interface ModuleService
Overrides:
listPrimaryKeyFieldNames in class RemoteModuleServiceBase
Returns:
See Also:
RemoteModuleServiceBase.listPrimaryKeyFieldNames(java.lang.Class)

getExternalizableBusinessObject

public <T extends ExternalizableBusinessObject> T getExternalizableBusinessObject(Class<T> businessObjectClass,
                                                                                  Map<String,Object> fieldValues)
This overridden method calls the DocumentTypeService instead of the underlying KNS service. Allows you to search on name and docTypeId

Specified by:
getExternalizableBusinessObject in interface ModuleService
Overrides:
getExternalizableBusinessObject in class ModuleServiceBase
Returns:
See Also:
ModuleServiceBase.getExternalizableBusinessObject(java.lang.Class, java.util.Map)

getDocumentTypeService

protected DocumentTypeService getDocumentTypeService()
Returns:
the docTypeService

setDocumentTypeService

public void setDocumentTypeService(DocumentTypeService docTypeService)
Parameters:
docTypeService - the docTypeService to set

getExternalizableBusinessObjectInquiryUrl

public String getExternalizableBusinessObjectInquiryUrl(Class inquiryBusinessObjectClass,
                                                        Map<String,String[]> parameters)
This overridden method rewrites the URL.

Specified by:
getExternalizableBusinessObjectInquiryUrl in interface ModuleService
Overrides:
getExternalizableBusinessObjectInquiryUrl in class ModuleServiceBase
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.
See Also:
ModuleServiceBase.getExternalizableBusinessObjectInquiryUrl(java.lang.Class, java.util.Map)

listAlternatePrimaryKeyFieldNames

public List<List<String>> listAlternatePrimaryKeyFieldNames(Class businessObjectInterfaceClass)
We want to be able to use name as an alternate key

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:


Copyright © 2005-2012 The Kuali Foundation. All Rights Reserved.