|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.kuali.rice.krad.service.impl.DocumentDictionaryServiceImpl
public class DocumentDictionaryServiceImpl
Implementation of DocumentDictionaryService
which reads configuration
from the data dictionary
Constructor Summary | |
---|---|
DocumentDictionaryServiceImpl()
|
Method Summary | |
---|---|
Boolean |
getAllowsCopy(Document document)
Returns whether or not this document's data dictionary file has flagged it to allow document copies |
Boolean |
getAllowsNewOrCopy(String docTypeName)
Returns whether or not this document's data dictionary file has flagged it to allow maintenance new or copy actions |
Boolean |
getAllowsRecordDeletion(Class dataObjectClass)
Indicates whether the given data object class is configured to allow record deletions |
Boolean |
getAllowsRecordDeletion(MaintenanceDocument document)
Indicates whether the given maintenance document is configured to allow record deletions |
Class<? extends BusinessRule> |
getBusinessRulesClass(Document document)
Retrieves the configured business rule class configured for the document entry that is associated with the document type of the given document instance |
protected DataDictionary |
getDataDictionary()
|
protected DataDictionaryService |
getDataDictionaryService()
|
Collection |
getDefaultExistenceChecks(Class dataObjectClass)
Retrieves the collection of ReferenceDefinition objects defined as DefaultExistenceChecks for the MaintenanceDocument associated with the given data object class |
Collection |
getDefaultExistenceChecks(Document document)
Retrieves the collection of ReferenceDefinition objects defined as DefaultExistenceChecks for the document instance |
Collection |
getDefaultExistenceChecks(String docTypeName)
Retrieves the collection of ReferenceDefinition objects defined as DefaultExistenceChecks for the document entry associated with the given document type name |
String |
getDescription(String documentTypeName)
Retrieves the full description of the document as described in its data dictionary entry |
DocumentAuthorizer |
getDocumentAuthorizer(Document document)
Retrieves the DocumentAuthorizer configured on the document entry for the document type associated
with the document instance |
DocumentAuthorizer |
getDocumentAuthorizer(String documentType)
Retrieves the DocumentAuthorizer configured on the document entry with the given document type
name |
Class<?> |
getDocumentClassByName(String documentTypeName)
Retrieves the document class configured on the document entry associated with the given document type name |
protected DocumentEntry |
getDocumentEntry(Document document)
Retrieves the document entry for the document type of the given document instance |
DocumentEntry |
getDocumentEntry(String documentTypeName)
Retrieves the document entry that is associated with the given document type name |
DocumentEntry |
getDocumentEntryByClass(Class<? extends Document> documentClass)
Retrieves the document entry that is associated with the given document class |
DocumentPresentationController |
getDocumentPresentationController(Document document)
Retrieves the DocumentPresentationController configured on the document entry for the document type
associated with the document instance |
DocumentPresentationController |
getDocumentPresentationController(String documentType)
Retrieves the DocumentPresentationController configured on the document entry with the given document
type name |
protected DocumentType |
getDocumentType(String documentTypeName)
Gets the workflow document type dto for the given documentTypeName |
String |
getDocumentTypeByClass(Class<? extends Document> documentClass)
Retrieves the document type configured on the document entry associated with the given document class |
String |
getLabel(String documentTypeName)
Retrieves the label for the document as described in its data dictionary entry |
List<String> |
getLockingKeys(String docTypeName)
Retrieves the list of property names that are configured as locking keys for the maintenance document entry associated with the given document type name |
Class<? extends Maintainable> |
getMaintainableClass(String docTypeName)
Retrieves the maintainable class instance that is configured in the maintenance document entry associated with the given document type name |
Class<?> |
getMaintenanceDataObjectClass(String docTypeName)
Retrieves the data object class configured for the maintenance entry associated with the given document type name |
protected MaintenanceDocumentEntry |
getMaintenanceDocumentEntry(Class dataObjectClass)
Retrieves the maintenance document entry associated with the given data object class |
MaintenanceDocumentEntry |
getMaintenanceDocumentEntry(String docTypeName)
Retrieves the maintenance document entry that is associated with the given document type name |
String |
getMaintenanceDocumentTypeName(Class dataObjectClass)
Retrieves the configured document type name for the maintenance document entry associated with the given data object class |
boolean |
getPreserveLockingKeysOnCopy(Class dataObjectClass)
Indicates whether the configured locking keys for a class should be cleared on a maintenance copy action or values carried forward |
void |
setDataDictionaryService(DataDictionaryService dataDictionaryService)
|
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public DocumentDictionaryServiceImpl()
Method Detail |
---|
public String getLabel(String documentTypeName)
DocumentDictionaryService
getLabel
in interface DocumentDictionaryService
documentTypeName
- - document type name for the document entry to retrieve label for
DocumentDictionaryService.getLabel(java.lang.String)
public String getMaintenanceDocumentTypeName(Class dataObjectClass)
DocumentDictionaryService
getMaintenanceDocumentTypeName
in interface DocumentDictionaryService
dataObjectClass
- - data object class for maintenance entry to retrieve
DocumentDictionaryService.getMaintenanceDocumentTypeName(java.lang.Class)
public String getDescription(String documentTypeName)
DocumentDictionaryService
getDescription
in interface DocumentDictionaryService
documentTypeName
- - document type name for the document entry to retrieve description for
DocumentDictionaryService.getDescription(java.lang.String)
public Collection getDefaultExistenceChecks(Class dataObjectClass)
DocumentDictionaryService
getDefaultExistenceChecks
in interface DocumentDictionaryService
dataObjectClass
- - data object class for maintenance document
DocumentDictionaryService.getDefaultExistenceChecks(java.lang.Class)
public Collection getDefaultExistenceChecks(Document document)
DocumentDictionaryService
getDefaultExistenceChecks
in interface DocumentDictionaryService
document
- - document instance to pull document type for associated document entry
DocumentDictionaryService.getDefaultExistenceChecks(java.lang.Class)
public Collection getDefaultExistenceChecks(String docTypeName)
DocumentDictionaryService
getDefaultExistenceChecks
in interface DocumentDictionaryService
docTypeName
- - document type name for document entry to pull existence checks for
DocumentDictionaryService.getDefaultExistenceChecks(java.lang.Class)
public Class<?> getMaintenanceDataObjectClass(String docTypeName)
DocumentDictionaryService
getMaintenanceDataObjectClass
in interface DocumentDictionaryService
docTypeName
- - document type name associated with maintenance document entry
DocumentDictionaryService.getMaintenanceDataObjectClass(java.lang.String)
public Class<? extends Maintainable> getMaintainableClass(String docTypeName)
DocumentDictionaryService
getMaintainableClass
in interface DocumentDictionaryService
docTypeName
- - document type name to retrieve maintainable for
org.kuali.rice.krad.service.impl.DocumentDictionaryService#getMaintainableClass
public Class<? extends BusinessRule> getBusinessRulesClass(Document document)
DocumentDictionaryService
getBusinessRulesClass
in interface DocumentDictionaryService
document
- - document instance to retrieve rule class for
DocumentDictionaryService.getBusinessRulesClass(org.kuali.rice.krad.document.Document)
public Boolean getAllowsCopy(Document document)
DocumentDictionaryService
getAllowsCopy
in interface DocumentDictionaryService
document
- - document instance to check copy flag for
DocumentDictionaryService.getAllowsCopy(org.kuali.rice.krad.document.Document)
public Boolean getAllowsNewOrCopy(String docTypeName)
DocumentDictionaryService
getAllowsNewOrCopy
in interface DocumentDictionaryService
docTypeName
- - document type name to retrieve maintenance document entry for
DocumentDictionaryService.getAllowsNewOrCopy(java.lang.String)
public DocumentEntry getDocumentEntry(String documentTypeName)
DocumentDictionaryService
getDocumentEntry
in interface DocumentDictionaryService
documentTypeName
- - document type name to retrieve document entry for
DocumentDictionaryService.getDocumentEntry(java.lang.String)
public DocumentEntry getDocumentEntryByClass(Class<? extends Document> documentClass)
DocumentDictionaryService
getDocumentEntryByClass
in interface DocumentDictionaryService
documentClass
- - document class to retrieve document entry for
DocumentDictionaryService.getDocumentEntryByClass(java.lang.Class extends
org.kuali.rice.krad.document.Document>)
public MaintenanceDocumentEntry getMaintenanceDocumentEntry(String docTypeName)
DocumentDictionaryService
getMaintenanceDocumentEntry
in interface DocumentDictionaryService
docTypeName
- - document type name to retrieve maintenance document entry for
DocumentDictionaryService.getMaintenanceDocumentEntry(java.lang.String)
public Class<?> getDocumentClassByName(String documentTypeName)
DocumentDictionaryService
getDocumentClassByName
in interface DocumentDictionaryService
documentTypeName
- - document type name to retrieve class for
DocumentDictionaryService.getDocumentClassByName(java.lang.String)
public String getDocumentTypeByClass(Class<? extends Document> documentClass)
DocumentDictionaryService
getDocumentTypeByClass
in interface DocumentDictionaryService
documentClass
- - class for document to retrieve the document type for
DocumentDictionaryService.getDocumentTypeByClass(java.lang.Class extends org.kuali.rice.krad.document.Document>)
public Boolean getAllowsRecordDeletion(Class dataObjectClass)
DocumentDictionaryService
getAllowsRecordDeletion
in interface DocumentDictionaryService
dataObjectClass
- - class for the data object to check
DocumentDictionaryService.getAllowsRecordDeletion(java.lang.Class)
public Boolean getAllowsRecordDeletion(MaintenanceDocument document)
DocumentDictionaryService
getAllowsRecordDeletion
in interface DocumentDictionaryService
document
- - maintenance document instance to check
DocumentDictionaryService.getAllowsRecordDeletion(java.lang.Class)
public List<String> getLockingKeys(String docTypeName)
DocumentDictionaryService
getLockingKeys
in interface DocumentDictionaryService
docTypeName
- - document type name to retrieve maintenance document entry for
DocumentDictionaryService.getLockingKeys(java.lang.String)
public boolean getPreserveLockingKeysOnCopy(Class dataObjectClass)
DocumentDictionaryService
getPreserveLockingKeysOnCopy
in interface DocumentDictionaryService
dataObjectClass
- - class for the data object to check
DocumentDictionaryService.getPreserveLockingKeysOnCopy(java.lang.Class)
public DocumentAuthorizer getDocumentAuthorizer(String documentType)
DocumentDictionaryService
DocumentAuthorizer
configured on the document entry with the given document type
name
getDocumentAuthorizer
in interface DocumentDictionaryService
documentType
- - document type name to retrieve document entry and associated authorizer for
DocumentDictionaryService.getDocumentAuthorizer(java.lang.String)
public DocumentAuthorizer getDocumentAuthorizer(Document document)
DocumentDictionaryService
DocumentAuthorizer
configured on the document entry for the document type associated
with the document instance
getDocumentAuthorizer
in interface DocumentDictionaryService
document
- - document instance to retrieve document entry and associated authorizer for
DocumentDictionaryService.getDocumentAuthorizer(java.lang.String)
public DocumentPresentationController getDocumentPresentationController(String documentType)
DocumentDictionaryService
DocumentPresentationController
configured on the document entry with the given document
type name
getDocumentPresentationController
in interface DocumentDictionaryService
documentType
- - document type name to retrieve document entry and associated presentation controller for
DocumentDictionaryService.getDocumentPresentationController(java.lang.String)
public DocumentPresentationController getDocumentPresentationController(Document document)
DocumentDictionaryService
DocumentPresentationController
configured on the document entry for the document type
associated with the document instance
getDocumentPresentationController
in interface DocumentDictionaryService
document
- - document instance to retrieve document entry and associated presentation controller for
DocumentDictionaryService.getDocumentPresentationController(java.lang.String)
protected MaintenanceDocumentEntry getMaintenanceDocumentEntry(Class dataObjectClass)
dataObjectClass
- - data object class to retrieve maintenance document entry for
protected DocumentEntry getDocumentEntry(Document document)
document
- - document instance to retrieve document entry for
protected DocumentType getDocumentType(String documentTypeName)
documentTypeName
- - document type name to retrieve document type dto
protected DataDictionary getDataDictionary()
protected DataDictionaryService getDataDictionaryService()
public void setDataDictionaryService(DataDictionaryService dataDictionaryService)
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |