Class DocumentDictionaryServiceImpl

java.lang.Object
org.kuali.rice.krad.service.impl.DocumentDictionaryServiceImpl
All Implemented Interfaces:
org.kuali.rice.krad.service.DocumentDictionaryService

public class DocumentDictionaryServiceImpl extends Object implements org.kuali.rice.krad.service.DocumentDictionaryService
Implementation of DocumentDictionaryService which reads configuration from the data dictionary
Author:
Kuali Rice Team (rice.collab@kuali.org)
  • Constructor Details

    • DocumentDictionaryServiceImpl

      public DocumentDictionaryServiceImpl()
  • Method Details

    • getLabel

      public String getLabel(String documentTypeName)
      Specified by:
      getLabel in interface org.kuali.rice.krad.service.DocumentDictionaryService
      See Also:
      • DocumentDictionaryService.getLabel(java.lang.String)
    • getMaintenanceDocumentTypeName

      public String getMaintenanceDocumentTypeName(Class dataObjectClass)
      Specified by:
      getMaintenanceDocumentTypeName in interface org.kuali.rice.krad.service.DocumentDictionaryService
      See Also:
      • DocumentDictionaryService.getMaintenanceDocumentTypeName(java.lang.Class)
    • getDescription

      public String getDescription(String documentTypeName)
      Specified by:
      getDescription in interface org.kuali.rice.krad.service.DocumentDictionaryService
      See Also:
      • DocumentDictionaryService.getDescription(java.lang.String)
    • getDefaultExistenceChecks

      public Collection getDefaultExistenceChecks(Class dataObjectClass)
      Specified by:
      getDefaultExistenceChecks in interface org.kuali.rice.krad.service.DocumentDictionaryService
      See Also:
      • DocumentDictionaryService.getDefaultExistenceChecks(java.lang.Class)
    • getDefaultExistenceChecks

      public Collection getDefaultExistenceChecks(org.kuali.rice.krad.document.Document document)
      Specified by:
      getDefaultExistenceChecks in interface org.kuali.rice.krad.service.DocumentDictionaryService
      See Also:
      • DocumentDictionaryService.getDefaultExistenceChecks(java.lang.Class)
    • getDefaultExistenceChecks

      public Collection getDefaultExistenceChecks(String docTypeName)
      Specified by:
      getDefaultExistenceChecks in interface org.kuali.rice.krad.service.DocumentDictionaryService
      See Also:
      • DocumentDictionaryService.getDefaultExistenceChecks(java.lang.Class)
    • getMaintenanceDataObjectClass

      public Class<?> getMaintenanceDataObjectClass(String docTypeName)
      Specified by:
      getMaintenanceDataObjectClass in interface org.kuali.rice.krad.service.DocumentDictionaryService
      See Also:
      • DocumentDictionaryService.getMaintenanceDataObjectClass(java.lang.String)
    • getMaintainableClass

      public Class<? extends org.kuali.rice.krad.maintenance.Maintainable> getMaintainableClass(String docTypeName)
      Specified by:
      getMaintainableClass in interface org.kuali.rice.krad.service.DocumentDictionaryService
      See Also:
      • invalid reference
        org.kuali.rice.krad.service.impl.DocumentDictionaryService#getMaintainableClass
    • getBusinessRulesClass

      public Class<? extends org.kuali.rice.krad.rules.rule.BusinessRule> getBusinessRulesClass(org.kuali.rice.krad.document.Document document)
      Specified by:
      getBusinessRulesClass in interface org.kuali.rice.krad.service.DocumentDictionaryService
      See Also:
      • DocumentDictionaryService.getBusinessRulesClass(org.kuali.rice.krad.document.Document)
    • getAllowsCopy

      public Boolean getAllowsCopy(org.kuali.rice.krad.document.Document document)
      Specified by:
      getAllowsCopy in interface org.kuali.rice.krad.service.DocumentDictionaryService
      See Also:
      • DocumentDictionaryService.getAllowsCopy(org.kuali.rice.krad.document.Document)
    • getAllowsNewOrCopy

      public Boolean getAllowsNewOrCopy(String docTypeName)
      Specified by:
      getAllowsNewOrCopy in interface org.kuali.rice.krad.service.DocumentDictionaryService
      See Also:
      • DocumentDictionaryService.getAllowsNewOrCopy(java.lang.String)
    • getDocumentEntry

      public org.kuali.rice.krad.datadictionary.DocumentEntry getDocumentEntry(String documentTypeName)
      Specified by:
      getDocumentEntry in interface org.kuali.rice.krad.service.DocumentDictionaryService
      See Also:
      • DocumentDictionaryService.getDocumentEntry(java.lang.String)
    • getDocumentEntryByClass

      public org.kuali.rice.krad.datadictionary.DocumentEntry getDocumentEntryByClass(Class<? extends org.kuali.rice.krad.document.Document> documentClass)
      Specified by:
      getDocumentEntryByClass in interface org.kuali.rice.krad.service.DocumentDictionaryService
      See Also:
      • DocumentDictionaryService.getDocumentEntryByClass(java.lang.Class<? extends org.kuali.rice.krad.document.Document>)
    • getMaintenanceDocumentEntry

      public org.kuali.rice.krad.datadictionary.MaintenanceDocumentEntry getMaintenanceDocumentEntry(String docTypeName)
      Specified by:
      getMaintenanceDocumentEntry in interface org.kuali.rice.krad.service.DocumentDictionaryService
      See Also:
      • DocumentDictionaryService.getMaintenanceDocumentEntry(java.lang.String)
    • getDocumentClassByName

      public Class<?> getDocumentClassByName(String documentTypeName)
      Specified by:
      getDocumentClassByName in interface org.kuali.rice.krad.service.DocumentDictionaryService
      See Also:
      • DocumentDictionaryService.getDocumentClassByName(java.lang.String)
    • getDocumentTypeByClass

      public String getDocumentTypeByClass(Class<? extends org.kuali.rice.krad.document.Document> documentClass)
      Specified by:
      getDocumentTypeByClass in interface org.kuali.rice.krad.service.DocumentDictionaryService
      See Also:
      • DocumentDictionaryService.getDocumentTypeByClass(java.lang.Class<? extends org.kuali.rice.krad.document.Document>)
    • getAllowsRecordDeletion

      public Boolean getAllowsRecordDeletion(Class dataObjectClass)
      Specified by:
      getAllowsRecordDeletion in interface org.kuali.rice.krad.service.DocumentDictionaryService
      See Also:
      • DocumentDictionaryService.getAllowsRecordDeletion(java.lang.Class)
    • getAllowsRecordDeletion

      public Boolean getAllowsRecordDeletion(org.kuali.rice.krad.maintenance.MaintenanceDocument document)
      Specified by:
      getAllowsRecordDeletion in interface org.kuali.rice.krad.service.DocumentDictionaryService
      See Also:
      • DocumentDictionaryService.getAllowsRecordDeletion(java.lang.Class)
    • getLockingKeys

      public List<String> getLockingKeys(String docTypeName)
      Specified by:
      getLockingKeys in interface org.kuali.rice.krad.service.DocumentDictionaryService
      See Also:
      • DocumentDictionaryService.getLockingKeys(java.lang.String)
    • getPreserveLockingKeysOnCopy

      public boolean getPreserveLockingKeysOnCopy(Class dataObjectClass)
      Specified by:
      getPreserveLockingKeysOnCopy in interface org.kuali.rice.krad.service.DocumentDictionaryService
      See Also:
      • DocumentDictionaryService.getPreserveLockingKeysOnCopy(java.lang.Class)
    • getClearValueOnCopyPropertyNames

      public List<String> getClearValueOnCopyPropertyNames(Class dataObjectClass)
      Specified by:
      getClearValueOnCopyPropertyNames in interface org.kuali.rice.krad.service.DocumentDictionaryService
      See Also:
      • DocumentDictionaryService.getClearValueOnCopyPropertyNames(java.lang.Class)
    • getDocumentAuthorizer

      public org.kuali.rice.krad.document.DocumentAuthorizer getDocumentAuthorizer(String documentType)
      Specified by:
      getDocumentAuthorizer in interface org.kuali.rice.krad.service.DocumentDictionaryService
      See Also:
      • DocumentDictionaryService.getDocumentAuthorizer(java.lang.String)
    • getDocumentAuthorizer

      public org.kuali.rice.krad.document.DocumentAuthorizer getDocumentAuthorizer(org.kuali.rice.krad.document.Document document)
      Specified by:
      getDocumentAuthorizer in interface org.kuali.rice.krad.service.DocumentDictionaryService
      See Also:
      • DocumentDictionaryService.getDocumentAuthorizer(java.lang.String)
    • getDocumentPresentationController

      public org.kuali.rice.krad.document.DocumentPresentationController getDocumentPresentationController(String documentType)
      Specified by:
      getDocumentPresentationController in interface org.kuali.rice.krad.service.DocumentDictionaryService
      See Also:
      • DocumentDictionaryService.getDocumentPresentationController(java.lang.String)
    • getDocumentPresentationController

      public org.kuali.rice.krad.document.DocumentPresentationController getDocumentPresentationController(org.kuali.rice.krad.document.Document document)
      Specified by:
      getDocumentPresentationController in interface org.kuali.rice.krad.service.DocumentDictionaryService
      See Also:
      • DocumentDictionaryService.getDocumentPresentationController(java.lang.String)
    • getMaintenanceDocumentEntry

      protected org.kuali.rice.krad.datadictionary.MaintenanceDocumentEntry getMaintenanceDocumentEntry(Class dataObjectClass)
      Retrieves the maintenance document entry associated with the given data object class
      Parameters:
      dataObjectClass - - data object class to retrieve maintenance document entry for
      Returns:
      MaintenanceDocumentEntry for associated data object class
    • getDocumentEntry

      protected org.kuali.rice.krad.datadictionary.DocumentEntry getDocumentEntry(org.kuali.rice.krad.document.Document document)
      Retrieves the document entry for the document type of the given document instance
      Parameters:
      document - - document instance to retrieve document entry for
      Returns:
      DocumentEntry instance found for document type
    • getDocumentType

      protected org.kuali.rice.kew.api.doctype.DocumentType getDocumentType(String documentTypeName)
      Gets the workflow document type dto for the given documentTypeName
      Parameters:
      documentTypeName - - document type name to retrieve document type dto
      Returns:
      DocumentType for given document type name
    • getDataDictionary

      protected org.kuali.rice.krad.datadictionary.DataDictionary getDataDictionary()
    • getDataDictionaryService

      protected org.kuali.rice.krad.service.DataDictionaryService getDataDictionaryService()
    • setDataDictionaryService

      public void setDataDictionaryService(org.kuali.rice.krad.service.DataDictionaryService dataDictionaryService)