org.kuali.rice.kns.service
Interface MaintenanceDocumentDictionaryService

All Known Implementing Classes:

MaintenanceDocumentDictionaryServiceImpl

Deprecated.

@Deprecated
public interface MaintenanceDocumentDictionaryService

Defines methods that a MaintenanceDocumentDictionary Service must provide. Defines 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(MaintenanceDocument document) Deprecated. Returns whether or not this document's data dictionary file has flagged it to allow document copies
Boolean	getAllowsNewOrCopy(String docTypeName) Deprecated. Returns whether or not this document's data dictionary file has flagged it to allow maintenance new or copy actions
Boolean	getAllowsRecordDeletion(Class dataObjectClass) Deprecated. Indicates whether the given data object class is configured to allow record deletions
Boolean	getAllowsRecordDeletion(MaintenanceDocument document) Deprecated. Indicates whether the given maintenance document is configured to allow record deletions
Class<? extends BusinessRule>	getBusinessRulesClass(MaintenanceDocument document) Deprecated. Retrieves the configured business rule class for the maintenance document
Class	getCollectionBusinessObjectClass(String docTypeName, String collectionName) Deprecated.
String	getCollectionFieldDefaultValue(String docTypeName, String collectionName, String fieldName) Deprecated.
Class	getDataObjectClass(String docTypeName) Deprecated. The instance of the business object class associated with this document type name
Collection	getDefaultExistenceChecks(Class dataObjectClass) Deprecated. The collection of ReferenceDefinition objects defined as DefaultExistenceChecks for the MaintenanceDocument
Collection	getDefaultExistenceChecks(String docTypeName) Deprecated. The collection of ReferenceDefinition objects defined as DefaultExistenceChecks for the MaintenanceDocument
String	getDocumentTypeName(Class dataObjectClass) Deprecated. The document type name for a class instance
String	getFieldDefaultValue(Class boClass, String fieldName) Deprecated.
String	getFieldDefaultValue(String docTypeName, String fieldName) Deprecated.
List	getLockingKeys(String docTypeName) Deprecated. A List of field names used as locking keys
Class	getMaintainableClass(String docTypeName) Deprecated. Retrieves an instance of the class that represents the maintenance document.
MaintainableCollectionDefinition	getMaintainableCollection(String docTypeName, String collectionName) Deprecated.
List<MaintainableCollectionDefinition>	getMaintainableCollections(MaintainableCollectionDefinition parentCollection) Deprecated.
List<MaintainableCollectionDefinition>	getMaintainableCollections(String docTypeName) Deprecated.
MaintainableFieldDefinition	getMaintainableField(String docTypeName, String fieldName) Deprecated.
MaintainableItemDefinition	getMaintainableItem(String docTypeName, String itemName) Deprecated.
List<MaintainableSectionDefinition>	getMaintainableSections(String docTypeName) Deprecated.
String	getMaintenanceDescription(String docTypeName) Deprecated. Retrieves the description of the maintenance document
MaintenanceDocumentEntry	getMaintenanceDocumentEntry(String docTypeName) Deprecated.
String	getMaintenanceLabel(String docTypeName) Deprecated. Retrieves the label for a maintenance document type
boolean	getPreserveLockingKeysOnCopy(Class dataObjectClass) Deprecated. Indicates whether the configured locking keys for a class should be cleared on a maintenance copy action or values carried forward
Boolean	translateCodes(Class businessObjectClass) Deprecated.
void	validateMaintainableCollectionsAddLineRequiredFields(MaintenanceDocument document, PersistableBusinessObject businessObject, String collectionName) Deprecated.
void	validateMaintainableCollectionsForDuplicateEntries(MaintenanceDocument document) Deprecated. validates the collections of the maintenance document checking to see if duplicate entries in the collection exist
void	validateMaintenanceRequiredFields(MaintenanceDocument document) Deprecated.

Method Detail

getMaintenanceLabel

String getMaintenanceLabel(String docTypeName)

Deprecated.

Retrieves the label for a maintenance document type

Parameters:

docTypeName - - doc type to retrieve label for

Returns:

String doc type label

getDocumentTypeName

String getDocumentTypeName(Class dataObjectClass)

Deprecated.

The document type name for a class instance

Parameters:

dataObjectClass -

Returns:

The document type name for the class as a String.

getMaintenanceDescription

String getMaintenanceDescription(String docTypeName)

Deprecated.

Retrieves the description of the maintenance document

Parameters:

docTypeName -

Returns:

The description as a String.

getDefaultExistenceChecks

Collection getDefaultExistenceChecks(Class dataObjectClass)

Deprecated.

The collection of ReferenceDefinition objects defined as DefaultExistenceChecks for the MaintenanceDocument

Parameters:

dataObjectClass -

Returns:

A Collection of ReferenceDefinitions

getDefaultExistenceChecks

Collection getDefaultExistenceChecks(String docTypeName)

Deprecated.

The collection of ReferenceDefinition objects defined as DefaultExistenceChecks for the MaintenanceDocument

Parameters:

docTypeName -

Returns:

A Collection of ReferenceDefinitions

getLockingKeys

List getLockingKeys(String docTypeName)

Deprecated.

A List of field names used as locking keys

Parameters:

docTypeName -

Returns:

A List of strings

getDataObjectClass

Class getDataObjectClass(String docTypeName)

Deprecated.

The instance of the business object class associated with this document type name

Parameters:

docTypeName -

Returns:

The class instance corresponding to the document type name.

getBusinessRulesClass

Class<? extends BusinessRule> getBusinessRulesClass(MaintenanceDocument document)

Deprecated.

Retrieves the configured business rule class for the maintenance document

Parameters:

document - - maintenance document instance to retrieve rule class for

Returns:

businessRulesClass associated with the given document's type

getAllowsCopy

Boolean getAllowsCopy(MaintenanceDocument document)

Deprecated.

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

Parameters:

document - - maintenance document instance to check copy flag for

Returns:

boolean true if copies are allowed, false otherwise

getAllowsNewOrCopy

Boolean getAllowsNewOrCopy(String docTypeName)

Deprecated.

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)

Deprecated.

getPreserveLockingKeysOnCopy

boolean getPreserveLockingKeysOnCopy(Class dataObjectClass)

Deprecated.

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

getAllowsRecordDeletion

Boolean getAllowsRecordDeletion(Class dataObjectClass)

Deprecated.

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)

Deprecated.

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

getMaintainableClass

Class getMaintainableClass(String docTypeName)

Deprecated.

Retrieves an instance of the class that represents the maintenance document. This is done by

Parameters:

docTypeName -

Returns:

A class instance.

getMaintainableSections

@Deprecated
List<MaintainableSectionDefinition> getMaintainableSections(String docTypeName)

Deprecated.

A List of maintainable section object instances corresponding to the document type name.

Parameters:

docTypeName -

Returns:

A List of maintable section objects.

getFieldDefaultValue

@Deprecated
String getFieldDefaultValue(Class boClass,
                                       String fieldName)

Deprecated.

This method returns the defaultValue as it would appear in the UI on a maintenance document. If both a defaultValue and a defaultValueFinderClass is present in the MaintainableFieldDefinition instance, then the defaultValue will be preferentially returned. If only one is present, then that will be returned. Note that if a defaultValueFinderClass value is present, then this method will attempt to create a new instance of the specified class. If this attempt to generate a new instance fails, the error will be suppressed, and an null result will be returned.

Parameters:

boClass - - the class of BO being maintained

fieldName - - the fieldName of the attribute for which the default is desired

Returns:

the default if one is available, null otherwise

getFieldDefaultValue

@Deprecated
String getFieldDefaultValue(String docTypeName,
                                       String fieldName)

Deprecated.

This method returns the defaultValue as it would appear in the UI on a maintenance document. If both a defaultValue and a defaultValueFinderClass is present in the MaintainableFieldDefinition instance, then the defaultValue will be preferentially returned. If only one is present, then that will be returned. Note that if a defaultValueFinderClass value is present, then this method will attempt to create a new instance of the specified class. If this attempt to generate a new instance fails, the error will be suppressed, and an null result will be returned.

Parameters:

docTypeName - - the document type name of the maintainable

fieldName - - the fieldName of the attribute for which the default is desired

Returns:

the default if one is available, null otherwise

getCollectionFieldDefaultValue

@Deprecated
String getCollectionFieldDefaultValue(String docTypeName,
                                                 String collectionName,
                                                 String fieldName)

Deprecated.

This method returns the defaultValue as it would appear in the UI on a maintenance document for a collection. If both a defaultValue and a defaultValueFinderClass is present in the MaintainableFieldDefinition instance, then the defaultValue will be preferentially returned. If only one is present, then that will be returned. Note that if a defaultValueFinderClass value is present, then this method will attempt to create a new instance of the specified class. If this attempt to generate a new instance fails, the error will be suppressed, and an null result will be returned.

Parameters:

docTypeName - - the document type name of the maintainable

collectionName - - the name attribute of the collection to which the field belongs

fieldName - - the fieldName of the attribute for which the default is desired

Returns:

the default if one is available, null otherwise

getCollectionBusinessObjectClass

@Deprecated
Class getCollectionBusinessObjectClass(String docTypeName,
                                                  String collectionName)

Deprecated.

Returns the business object used to store the values for the given collection.

Parameters:

docTypeName -

collectionName -

Returns:

getMaintainableItem

@Deprecated
MaintainableItemDefinition getMaintainableItem(String docTypeName,
                                                          String itemName)

Deprecated.

Returns the definition for the maintainable item identified by "itemName".

Parameters:

docTypeName -

itemName -

Returns:

The item or null if the item does not exist.

getMaintainableField

@Deprecated
MaintainableFieldDefinition getMaintainableField(String docTypeName,
                                                            String fieldName)

Deprecated.

Returns the definition for the maintainable field identified by "fieldName".

Parameters:

docTypeName -

fieldName -

Returns:

The field or null if the item does not exist or is not a field.

getMaintainableCollection

@Deprecated
MaintainableCollectionDefinition getMaintainableCollection(String docTypeName,
                                                                      String collectionName)

Deprecated.

Returns the definition for the maintainable collection identified by "collectionName".

Parameters:

docTypeName -

collectionName -

Returns:

The collection or null if the item does not exist or is not a collection.

getMaintainableCollections

@Deprecated
List<MaintainableCollectionDefinition> getMaintainableCollections(String docTypeName)

Deprecated.

Gets a list of all top-level maintainable collections on the document

Parameters:

docTypeName -

Returns:

getMaintainableCollections

@Deprecated
List<MaintainableCollectionDefinition> getMaintainableCollections(MaintainableCollectionDefinition parentCollection)

Deprecated.

Returns a list of all collections within the given collection

Parameters:

parentCollection -

Returns:

validateMaintenanceRequiredFields

@Deprecated
void validateMaintenanceRequiredFields(MaintenanceDocument document)

Deprecated.

Validates the maintenance document contains values for the fields declared as required in the maintenance document data dictionary file.

Parameters:

document -

validateMaintainableCollectionsForDuplicateEntries

void validateMaintainableCollectionsForDuplicateEntries(MaintenanceDocument document)

Deprecated.

validates the collections of the maintenance document checking to see if duplicate entries in the collection exist

Parameters:

document -

validateMaintainableCollectionsAddLineRequiredFields

@Deprecated
void validateMaintainableCollectionsAddLineRequiredFields(MaintenanceDocument document,
                                                                     PersistableBusinessObject businessObject,
                                                                     String collectionName)

Deprecated.

translateCodes

@Deprecated
Boolean translateCodes(Class businessObjectClass)

Deprecated.

Parameters:

businessObjectClass - - business object class for maintenance definition

Returns:

Boolean indicating whether translating of codes is configured to true in maintenance definition