Package org.kuali.rice.kew.service.impl

Class KEWModuleService

java.lang.Object
org.kuali.rice.krad.service.impl.RemoteModuleServiceBase
org.kuali.rice.krad.service.impl.ModuleServiceBase
org.kuali.rice.kew.service.impl.KEWModuleService
All Implemented Interfaces:
org.kuali.rice.krad.service.ModuleService, org.springframework.beans.factory.Aware, org.springframework.beans.factory.InitializingBean, org.springframework.context.ApplicationContextAware
public class KEWModuleService extends org.kuali.rice.krad.service.impl.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

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

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    protected org.kuali.rice.kew.api.doctype.DocumentTypeService
    docTypeService
     

    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
    Description
    KEWModuleService()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    protected org.kuali.rice.kew.api.doctype.DocumentTypeService
    getDocumentTypeService()
     
    <T extends org.kuali.rice.krad.bo.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()
     
    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(org.kuali.rice.kew.api.doctype.DocumentTypeService docTypeService)
     

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

    getBaseLookupUrl, 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, getLegacyDataAdapter, getLookupService, getModuleConfiguration, getRiceBaseLookupUrl, getUrlParameters, isExternalizable, 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.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, retrieveExternalizableBusinessObjectIfNecessary, retrieveExternalizableBusinessObjectsList

  • Field Details

    • docTypeService

      protected org.kuali.rice.kew.api.doctype.DocumentTypeService docTypeService

  • Constructor Details

    • KEWModuleService

      public KEWModuleService()

  • Method Details

    • 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 org.kuali.rice.krad.service.ModuleService
      Overrides:
      listPrimaryKeyFieldNames in class org.kuali.rice.krad.service.impl.RemoteModuleServiceBase
      See Also:
      • RemoteModuleServiceBase.listPrimaryKeyFieldNames(java.lang.Class)

    • getExternalizableBusinessObject

      public <T extends org.kuali.rice.krad.bo.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 org.kuali.rice.krad.service.ModuleService
      Overrides:
      getExternalizableBusinessObject in class org.kuali.rice.krad.service.impl.ModuleServiceBase
      See Also:
      • ModuleServiceBase.getExternalizableBusinessObject(java.lang.Class, java.util.Map)

    • getDocumentTypeService

      protected org.kuali.rice.kew.api.doctype.DocumentTypeService getDocumentTypeService()
      Returns:
      the docTypeService

    • setDocumentTypeService

      public void setDocumentTypeService(org.kuali.rice.kew.api.doctype.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 org.kuali.rice.krad.service.ModuleService
      Overrides:
      getExternalizableBusinessObjectInquiryUrl in class org.kuali.rice.krad.service.impl.ModuleServiceBase
      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 org.kuali.rice.krad.service.ModuleService
      Overrides:
      listAlternatePrimaryKeyFieldNames in class org.kuali.rice.krad.service.impl.RemoteModuleServiceBase
      See Also:
      • ModuleService.listAlternatePrimaryKeyFieldNames(java.lang.Class)

    • goToCentralRiceForInquiry

      public boolean goToCentralRiceForInquiry()
      Specified by:
      goToCentralRiceForInquiry in interface org.kuali.rice.krad.service.ModuleService
      Overrides:
      goToCentralRiceForInquiry in class org.kuali.rice.krad.service.impl.ModuleServiceBase