org.kuali.rice.krad.service
Interface DocumentDictionaryService

All Known Implementing Classes:

DocumentDictionaryServiceImpl

public interface DocumentDictionaryService

Defines methods that a DocumentEntry Service must provide, and the API for the interacting with Document-related entries in the data dictionary

Author:

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

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
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
Class<?>	getDocumentClassByName(String documentTypeName) Retrieves the document class configured on the document entry associated with the given document type name
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
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

Method Detail

getLabel

String getLabel(String documentTypeName)

Retrieves the label for the document as described in its data dictionary entry

Parameters:

documentTypeName - - document type name for the document entry to retrieve label for

Returns:

String document label

getMaintenanceDocumentTypeName

String getMaintenanceDocumentTypeName(Class dataObjectClass)

Retrieves the configured document type name for the maintenance document entry associated with the given data object class

Parameters:

dataObjectClass - - data object class for maintenance entry to retrieve

Returns:

String document type name for maintenance document

getDescription

String getDescription(String documentTypeName)

Retrieves the full description of the document as described in its data dictionary entry

Parameters:

documentTypeName - - document type name for the document entry to retrieve description for

Returns:

String documents full description

getDefaultExistenceChecks

Collection getDefaultExistenceChecks(Class dataObjectClass)

Retrieves the collection of ReferenceDefinition objects defined as DefaultExistenceChecks for the MaintenanceDocument associated with the given data object class

Parameters:

dataObjectClass - - data object class for maintenance document

Returns:

Collection reference definitions for default existence checks

getDefaultExistenceChecks

Collection getDefaultExistenceChecks(Document document)

Retrieves the collection of ReferenceDefinition objects defined as DefaultExistenceChecks for the document instance

Parameters:

document - - document instance to pull document type for associated document entry

Returns:

Collection reference definitions for default existence checks

getDefaultExistenceChecks

Collection getDefaultExistenceChecks(String docTypeName)

Retrieves the collection of ReferenceDefinition objects defined as DefaultExistenceChecks for the document entry associated with the given document type name

Parameters:

docTypeName - - document type name for document entry to pull existence checks for

Returns:

Collection reference definitions for default existence checks

getMaintenanceDataObjectClass

Class<?> getMaintenanceDataObjectClass(String docTypeName)

Retrieves the data object class configured for the maintenance entry associated with the given document type name

Parameters:

docTypeName - - document type name associated with maintenance document entry

Returns:

Class data object class associated with maintenance document entry

getMaintainableClass

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

Parameters:

docTypeName - - document type name to retrieve maintainable for

Returns:

Class maintainable class for document type name

getBusinessRulesClass

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

Parameters:

document - - document instance to retrieve rule class for

Returns:

Class businessRulesClass associated with the given document type

getAllowsCopy

Boolean getAllowsCopy(Document document)

Returns whether or not this document's data dictionary file has flagged it to allow document copies

Parameters:

document - - document instance to check copy flag for

Returns:

boolean true if copies are allowed, false otherwise

getAllowsNewOrCopy

Boolean getAllowsNewOrCopy(String docTypeName)

Returns whether or not this document's data dictionary file has flagged it to allow maintenance new or copy actions

Parameters:

document - - maintenance document instance to check new or copy flag for

Returns:

boolean true if new or copy maintenance actions are allowed

getMaintenanceDocumentEntry

MaintenanceDocumentEntry getMaintenanceDocumentEntry(String docTypeName)

Retrieves the maintenance document entry that is associated with the given document type name

Parameters:

docTypeName - - document type name to retrieve maintenance document entry for

Returns:

MaintenanceDocumentEntry instance associated with document type

getDocumentClassByName

Class<?> getDocumentClassByName(String documentTypeName)

Retrieves the document class configured on the document entry associated with the given document type name

Parameters:

documentTypeName - - document type name to retrieve class for

Returns:

Class document class associated with document type name

getAllowsRecordDeletion

Boolean getAllowsRecordDeletion(Class dataObjectClass)

Indicates whether the given data object class is configured to allow record deletions

Parameters:

dataObjectClass - - class for the data object to check

Returns:

Boolean true if record deletion is allowed, false if not allowed, null if not configured

getAllowsRecordDeletion

Boolean getAllowsRecordDeletion(MaintenanceDocument document)

Indicates whether the given maintenance document is configured to allow record deletions

Parameters:

document - - maintenance document instance to check

Returns:

Boolean true if record deletion is allowed, false if not allowed, null if not configured

getLockingKeys

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

Parameters:

docTypeName - - document type name to retrieve maintenance document entry for

Returns:

List list of locking key property names

getPreserveLockingKeysOnCopy

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

Parameters:

dataObjectClass - - class for the data object to check

Returns:

boolean true if locking keys should be copied, false if they should be cleared