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

Class DocumentDictionaryServiceImpl

java.lang.Object

org.kuali.rice.krad.service.impl.DocumentDictionaryServiceImpl

All Implemented Interfaces:

DocumentDictionaryService

public class DocumentDictionaryServiceImpl
extends Object
implements DocumentDictionaryService

Implementation of DocumentDictionaryService which reads configuration from the data dictionary

Author:

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

Constructor Summary

Constructors

Constructor	Description
DocumentDictionaryServiceImpl()

Method Summary

Modifier and Type	Method	Description
Boolean	getAllowsCopy(Document document)
Boolean	getAllowsNewOrCopy(String docTypeName)
Boolean	getAllowsRecordDeletion(Class dataObjectClass)
Boolean	getAllowsRecordDeletion(MaintenanceDocument document)
Class<? extends BusinessRule>	getBusinessRulesClass(Document document)
List<String>	getClearValueOnCopyPropertyNames(Class dataObjectClass)
protected DataDictionary	getDataDictionary()
protected DataDictionaryService	getDataDictionaryService()
Collection	getDefaultExistenceChecks(Class dataObjectClass)
Collection	getDefaultExistenceChecks(String docTypeName)
Collection	getDefaultExistenceChecks(Document document)
String	getDescription(String documentTypeName)
DocumentAuthorizer	getDocumentAuthorizer(String documentType)
DocumentAuthorizer	getDocumentAuthorizer(Document document)
Class<?>	getDocumentClassByName(String documentTypeName)
DocumentEntry	getDocumentEntry(String documentTypeName)
protected DocumentEntry	getDocumentEntry(Document document)	Retrieves the document entry for the document type of the given document instance
DocumentEntry	getDocumentEntryByClass(Class<? extends Document> documentClass)
DocumentPresentationController	getDocumentPresentationController(String documentType)
DocumentPresentationController	getDocumentPresentationController(Document document)
protected org.kuali.rice.kew.api.doctype.DocumentType	getDocumentType(String documentTypeName)	Gets the workflow document type dto for the given documentTypeName
String	getDocumentTypeByClass(Class<? extends Document> documentClass)
String	getLabel(String documentTypeName)
List<String>	getLockingKeys(String docTypeName)
Class<? extends Maintainable>	getMaintainableClass(String docTypeName)
Class<?>	getMaintenanceDataObjectClass(String docTypeName)
protected MaintenanceDocumentEntry	getMaintenanceDocumentEntry(Class dataObjectClass)	Retrieves the maintenance document entry associated with the given data object class
MaintenanceDocumentEntry	getMaintenanceDocumentEntry(String docTypeName)
String	getMaintenanceDocumentTypeName(Class dataObjectClass)
boolean	getPreserveLockingKeysOnCopy(Class dataObjectClass)
void	setDataDictionaryService(DataDictionaryService dataDictionaryService)

Methods inherited from class java.lang.Object

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

Constructor Details

DocumentDictionaryServiceImpl

public DocumentDictionaryServiceImpl()

Method Details

getLabel

public String getLabel(String documentTypeName)

Specified by:

getLabel in interface DocumentDictionaryService

See Also:

• DocumentDictionaryService.getLabel(java.lang.String)

getMaintenanceDocumentTypeName

public String getMaintenanceDocumentTypeName(Class dataObjectClass)

Specified by:

getMaintenanceDocumentTypeName in interface DocumentDictionaryService

See Also:

• DocumentDictionaryService.getMaintenanceDocumentTypeName(java.lang.Class)

getDescription

public String getDescription(String documentTypeName)

Specified by:

getDescription in interface DocumentDictionaryService

See Also:

• DocumentDictionaryService.getDescription(java.lang.String)

getDefaultExistenceChecks

public Collection getDefaultExistenceChecks(Class dataObjectClass)

Specified by:

getDefaultExistenceChecks in interface DocumentDictionaryService

See Also:

• DocumentDictionaryService.getDefaultExistenceChecks(java.lang.Class)

getDefaultExistenceChecks

public Collection getDefaultExistenceChecks(Document document)

Specified by:

getDefaultExistenceChecks in interface DocumentDictionaryService

See Also:

• DocumentDictionaryService.getDefaultExistenceChecks(java.lang.Class)

getDefaultExistenceChecks

public Collection getDefaultExistenceChecks(String docTypeName)

Specified by:

getDefaultExistenceChecks in interface DocumentDictionaryService

See Also:

• DocumentDictionaryService.getDefaultExistenceChecks(java.lang.Class)

getMaintenanceDataObjectClass

public Class<?> getMaintenanceDataObjectClass(String docTypeName)

Specified by:

getMaintenanceDataObjectClass in interface DocumentDictionaryService

See Also:

• DocumentDictionaryService.getMaintenanceDataObjectClass(java.lang.String)

getMaintainableClass

public Class<? extends Maintainable> getMaintainableClass(String docTypeName)

Specified by:

getMaintainableClass in interface DocumentDictionaryService

See Also:

• org.kuali.rice.krad.service.impl.DocumentDictionaryService#getMaintainableClass

getBusinessRulesClass

public Class<? extends BusinessRule> getBusinessRulesClass(Document document)

Specified by:

getBusinessRulesClass in interface DocumentDictionaryService

See Also:

• DocumentDictionaryService.getBusinessRulesClass(org.kuali.rice.krad.document.Document)

getAllowsCopy

public Boolean getAllowsCopy(Document document)

Specified by:

getAllowsCopy in interface DocumentDictionaryService

See Also:

• DocumentDictionaryService.getAllowsCopy(org.kuali.rice.krad.document.Document)

getAllowsNewOrCopy

public Boolean getAllowsNewOrCopy(String docTypeName)

Specified by:

getAllowsNewOrCopy in interface DocumentDictionaryService

See Also:

• DocumentDictionaryService.getAllowsNewOrCopy(java.lang.String)

getDocumentEntry

public DocumentEntry getDocumentEntry(String documentTypeName)

Specified by:

getDocumentEntry in interface DocumentDictionaryService

See Also:

• DocumentDictionaryService.getDocumentEntry(java.lang.String)

getDocumentEntryByClass

public DocumentEntry getDocumentEntryByClass(Class<? extends Document> documentClass)

Specified by:

getDocumentEntryByClass in interface DocumentDictionaryService

See Also:

• DocumentDictionaryService.getDocumentEntryByClass(java.lang.Class<? extends org.kuali.rice.krad.document.Document>)

getMaintenanceDocumentEntry

public MaintenanceDocumentEntry getMaintenanceDocumentEntry(String docTypeName)

Specified by:

getMaintenanceDocumentEntry in interface DocumentDictionaryService

See Also:

• DocumentDictionaryService.getMaintenanceDocumentEntry(java.lang.String)

getDocumentClassByName

public Class<?> getDocumentClassByName(String documentTypeName)

Specified by:

getDocumentClassByName in interface DocumentDictionaryService

See Also:

• DocumentDictionaryService.getDocumentClassByName(java.lang.String)

getDocumentTypeByClass

public String getDocumentTypeByClass(Class<? extends Document> documentClass)

Specified by:

getDocumentTypeByClass in interface 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 DocumentDictionaryService

See Also:

• DocumentDictionaryService.getAllowsRecordDeletion(java.lang.Class)

getAllowsRecordDeletion

public Boolean getAllowsRecordDeletion(MaintenanceDocument document)

Specified by:

getAllowsRecordDeletion in interface DocumentDictionaryService

See Also:

• DocumentDictionaryService.getAllowsRecordDeletion(java.lang.Class)

getLockingKeys

public List<String> getLockingKeys(String docTypeName)

Specified by:

getLockingKeys in interface DocumentDictionaryService

See Also:

• DocumentDictionaryService.getLockingKeys(java.lang.String)

getPreserveLockingKeysOnCopy

public boolean getPreserveLockingKeysOnCopy(Class dataObjectClass)

Specified by:

getPreserveLockingKeysOnCopy in interface DocumentDictionaryService

See Also:

• DocumentDictionaryService.getPreserveLockingKeysOnCopy(java.lang.Class)

getClearValueOnCopyPropertyNames

public List<String> getClearValueOnCopyPropertyNames(Class dataObjectClass)

Specified by:

getClearValueOnCopyPropertyNames in interface DocumentDictionaryService

See Also:

• DocumentDictionaryService.getClearValueOnCopyPropertyNames(java.lang.Class)

getDocumentAuthorizer

public DocumentAuthorizer getDocumentAuthorizer(String documentType)

Specified by:

getDocumentAuthorizer in interface DocumentDictionaryService

See Also:

• DocumentDictionaryService.getDocumentAuthorizer(java.lang.String)

getDocumentAuthorizer

public DocumentAuthorizer getDocumentAuthorizer(Document document)

Specified by:

getDocumentAuthorizer in interface DocumentDictionaryService

See Also:

• DocumentDictionaryService.getDocumentAuthorizer(java.lang.String)

getDocumentPresentationController

public DocumentPresentationController getDocumentPresentationController(String documentType)

Specified by:

getDocumentPresentationController in interface DocumentDictionaryService

See Also:

• DocumentDictionaryService.getDocumentPresentationController(java.lang.String)

getDocumentPresentationController

public DocumentPresentationController getDocumentPresentationController(Document document)

Specified by:

getDocumentPresentationController in interface DocumentDictionaryService

See Also:

• DocumentDictionaryService.getDocumentPresentationController(java.lang.String)

getMaintenanceDocumentEntry

protected 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 DocumentEntry getDocumentEntry(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 DataDictionary getDataDictionary()

getDataDictionaryService

protected DataDictionaryService getDataDictionaryService()

setDataDictionaryService

public void setDataDictionaryService(DataDictionaryService dataDictionaryService)