org.kuali.rice.kns.service.impl

Class MaintenanceDocumentDictionaryServiceImpl

java.lang.Object

org.kuali.rice.kns.service.impl.MaintenanceDocumentDictionaryServiceImpl

All Implemented Interfaces:

MaintenanceDocumentDictionaryService

Deprecated.

Only used by KNS classes, use KRAD.

@Deprecated
public class MaintenanceDocumentDictionaryServiceImpl
extends Object
implements MaintenanceDocumentDictionaryService

This class is the service implementation for the MaintenanceDocumentDictionary structure. Defines the API for the interacting with Document-related entries in the data dictionary. This is the default implementation, that is delivered with Kuali.

Field Summary

Fields

Modifier and Type	Field and Description
protected static org.apache.log4j.Logger	LOG Deprecated.

Constructor Summary

Constructors

Constructor and Description
MaintenanceDocumentDictionaryServiceImpl() Deprecated.

Method Summary

Methods

Modifier and Type	Method and Description
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 businessObjectClass) Deprecated. for isue KULRice 3070
Boolean	getAllowsRecordDeletion(MaintenanceDocument document) Deprecated. for issue KULRice3070, see if need delete button
Class	getCollectionBusinessObjectClass(String docTypeName, String collectionName) Deprecated. Returns the business object used to store the values for the given collection.
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.
DataDictionary	getDataDictionary() Deprecated.
Class	getDataObjectClass(String docTypeName) Deprecated. The instance of the business object class associated with this document type name
Collection	getDefaultExistenceChecks(Class businessObjectClass) 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
protected DocumentType	getDocumentType(String documentTypeName) Deprecated. Gets the workflow document type for the given documentTypeName
String	getDocumentTypeName(Class businessObjectClass) Deprecated. The document type name for a class instance
String	getFieldDefaultValue(Class boClass, String fieldName) Deprecated. This method returns the defaultValue as it would appear in the UI on a maintenance document.
String	getFieldDefaultValue(String docTypeName, String fieldName) Deprecated. This method returns the defaultValue as it would appear in the UI on a maintenance document.
List	getLockingKeys(String docTypeName) Deprecated. A List of field names used as locking keys
Class	getMaintainableClass(String docTypeName) Deprecated.
MaintainableCollectionDefinition	getMaintainableCollection(String docTypeName, String collectionName) Deprecated. Returns the definition for the maintainable collection identified by "collectionName".
List<MaintainableCollectionDefinition>	getMaintainableCollections(MaintainableCollectionDefinition parentCollection) Deprecated. Returns a list of all collections within the given collection
List<MaintainableCollectionDefinition>	getMaintainableCollections(String docTypeName) Deprecated. Gets a list of all top-level maintainable collections on the document
MaintainableFieldDefinition	getMaintainableField(String docTypeName, String fieldName) Deprecated. Returns the definition for the maintainable field identified by "fieldName".
MaintainableItemDefinition	getMaintainableItem(String docTypeName, String itemName) Deprecated. Returns the definition for the maintainable item identified by "itemName".
List	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 businessObjectClass) Deprecated. for issue KULRice 3072
void	setDataDictionaryService(DataDictionaryService dataDictionaryService) Deprecated.
Boolean	translateCodes(Class businessObjectClass) Deprecated.
void	validateMaintainableCollectionsAddLineRequiredFields(MaintenanceDocument document, PersistableBusinessObject businessObject, String collectionName) Deprecated.
void	validateMaintainableCollectionsForDuplicateEntries(MaintenanceDocument document) Deprecated. default implementation checks for duplicats based on keys of objects only
void	validateMaintenanceRequiredFields(MaintenanceDocument document) Deprecated. Validates the maintenance document contains values for the fields declared as required in the maintenance document data dictionary file.

Methods inherited from class java.lang.Object

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

Field Detail

LOG

protected static org.apache.log4j.Logger LOG

Deprecated.

Constructor Detail

MaintenanceDocumentDictionaryServiceImpl

public MaintenanceDocumentDictionaryServiceImpl()

Deprecated.

Method Detail

getDocumentType

protected DocumentType getDocumentType(String documentTypeName)

Deprecated.

Gets the workflow document type for the given documentTypeName

Parameters:

documentTypeName -

Returns:

getMaintenanceLabel

public String getMaintenanceLabel(String docTypeName)

Deprecated.

Description copied from interface: MaintenanceDocumentDictionaryService

Retrieves the label for a maintenance document type

Specified by:

getMaintenanceLabel in interface MaintenanceDocumentDictionaryService

Parameters:

docTypeName - - doc type to retrieve label for

Returns:

String doc type label

See Also:

MaintenanceDocumentDictionaryService.getMaintenanceLabel(java.lang.String)

getMaintenanceDescription

public String getMaintenanceDescription(String docTypeName)

Deprecated.

Description copied from interface: MaintenanceDocumentDictionaryService

Retrieves the description of the maintenance document

Specified by:

getMaintenanceDescription in interface MaintenanceDocumentDictionaryService

Returns:

The description as a String.

See Also:

MaintenanceDocumentDictionaryService.getMaintenanceDescription(java.lang.String)

getMaintainableClass

@Deprecated
public Class getMaintainableClass(String docTypeName)

Deprecated.

Description copied from interface: MaintenanceDocumentDictionaryService

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

Specified by:

getMaintainableClass in interface MaintenanceDocumentDictionaryService

Returns:

A class instance.

See Also:

MaintenanceDocumentDictionaryService.getMaintainableClass(java.lang.String)

getDataObjectClass

public Class getDataObjectClass(String docTypeName)

Deprecated.

Description copied from interface: MaintenanceDocumentDictionaryService

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

Specified by:

getDataObjectClass in interface MaintenanceDocumentDictionaryService

Returns:

The class instance corresponding to the document type name.

See Also:

MaintenanceDocumentDictionaryService.getDataObjectClass(java.lang.String)

getDocumentTypeName

public String getDocumentTypeName(Class businessObjectClass)

Deprecated.

Description copied from interface: MaintenanceDocumentDictionaryService

The document type name for a class instance

Specified by:

getDocumentTypeName in interface MaintenanceDocumentDictionaryService

Returns:

The document type name for the class as a String.

See Also:

MaintenanceDocumentDictionaryService.getDocumentTypeName(java.lang.Class)

getMaintainableSections

@Deprecated
public List getMaintainableSections(String docTypeName)

Deprecated.

Description copied from interface: MaintenanceDocumentDictionaryService

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

Specified by:

getMaintainableSections in interface MaintenanceDocumentDictionaryService

Returns:

A List of maintable section objects.

See Also:

MaintenanceDocumentDictionaryService.getMaintainableSections(java.lang.String)

getDefaultExistenceChecks

public Collection getDefaultExistenceChecks(Class businessObjectClass)

Deprecated.

Description copied from interface: MaintenanceDocumentDictionaryService

The collection of ReferenceDefinition objects defined as DefaultExistenceChecks for the MaintenanceDocument

Specified by:

getDefaultExistenceChecks in interface MaintenanceDocumentDictionaryService

Returns:

A Collection of ReferenceDefinitions

See Also:

MaintenanceDocumentDictionaryService.getDefaultExistenceChecks(java.lang.Class)

getDefaultExistenceChecks

public Collection getDefaultExistenceChecks(String docTypeName)

Deprecated.

Description copied from interface: MaintenanceDocumentDictionaryService

The collection of ReferenceDefinition objects defined as DefaultExistenceChecks for the MaintenanceDocument

Specified by:

getDefaultExistenceChecks in interface MaintenanceDocumentDictionaryService

Returns:

A Collection of ReferenceDefinitions

See Also:

MaintenanceDocumentDictionaryService.getDefaultExistenceChecks(java.lang.String)

getLockingKeys

public List getLockingKeys(String docTypeName)

Deprecated.

Description copied from interface: MaintenanceDocumentDictionaryService

A List of field names used as locking keys

Specified by:

getLockingKeys in interface MaintenanceDocumentDictionaryService

Returns:

A List of strings

See Also:

MaintenanceDocumentDictionaryService.getLockingKeys(java.lang.String)

setDataDictionaryService

public void setDataDictionaryService(DataDictionaryService dataDictionaryService)

Deprecated.

Parameters:

dataDictionaryService -

getDataDictionary

public DataDictionary getDataDictionary()

Deprecated.

Returns:

getMaintenanceDocumentEntry

public MaintenanceDocumentEntry getMaintenanceDocumentEntry(String docTypeName)

Deprecated.

Specified by:

getMaintenanceDocumentEntry in interface MaintenanceDocumentDictionaryService

Parameters:

docTypeName -

Returns:

getFieldDefaultValue

public String getFieldDefaultValue(Class boClass,
                          String fieldName)

Deprecated.

Description copied from interface: MaintenanceDocumentDictionaryService

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.

Specified by:

getFieldDefaultValue in interface MaintenanceDocumentDictionaryService

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

See Also:

MaintenanceDocumentDictionaryService.getFieldDefaultValue(java.lang.Class, java.lang.String)

getFieldDefaultValue

public String getFieldDefaultValue(String docTypeName,
                          String fieldName)

Deprecated.

Description copied from interface: MaintenanceDocumentDictionaryService

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.

Specified by:

getFieldDefaultValue in interface MaintenanceDocumentDictionaryService

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

See Also:

MaintenanceDocumentDictionaryService.getFieldDefaultValue(java.lang.String, java.lang.String)

getCollectionFieldDefaultValue

public String getCollectionFieldDefaultValue(String docTypeName,
                                    String collectionName,
                                    String fieldName)

Deprecated.

Description copied from interface: MaintenanceDocumentDictionaryService

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.

Specified by:

getCollectionFieldDefaultValue in interface MaintenanceDocumentDictionaryService

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

See Also:

MaintenanceDocumentDictionaryService.getCollectionFieldDefaultValue(java.lang.String, java.lang.String, java.lang.String)

getAllowsCopy

public Boolean getAllowsCopy(MaintenanceDocument document)

Deprecated.

Description copied from interface: MaintenanceDocumentDictionaryService

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

Specified by:

getAllowsCopy in interface MaintenanceDocumentDictionaryService

Parameters:

document - - maintenance document instance to check copy flag for

Returns:

boolean true if copies are allowed, false otherwise

See Also:

MaintenanceDocumentDictionaryService.getAllowsCopy(MaintenanceDocument)

getAllowsNewOrCopy

public Boolean getAllowsNewOrCopy(String docTypeName)

Deprecated.

Description copied from interface: MaintenanceDocumentDictionaryService

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

Specified by:

getAllowsNewOrCopy in interface MaintenanceDocumentDictionaryService

Returns:

boolean true if new or copy maintenance actions are allowed

See Also:

MaintenanceDocumentDictionaryService.getAllowsNewOrCopy(java.lang.String)

getMaintainableItem

public MaintainableItemDefinition getMaintainableItem(String docTypeName,
                                             String itemName)

Deprecated.

Description copied from interface: MaintenanceDocumentDictionaryService

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

Specified by:

getMaintainableItem in interface MaintenanceDocumentDictionaryService

Returns:

The item or null if the item does not exist.

getMaintainableField

public MaintainableFieldDefinition getMaintainableField(String docTypeName,
                                               String fieldName)

Deprecated.

Description copied from interface: MaintenanceDocumentDictionaryService

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

Specified by:

getMaintainableField in interface MaintenanceDocumentDictionaryService

Returns:

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

getMaintainableCollection

public MaintainableCollectionDefinition getMaintainableCollection(String docTypeName,
                                                         String collectionName)

Deprecated.

Description copied from interface: MaintenanceDocumentDictionaryService

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

Specified by:

getMaintainableCollection in interface MaintenanceDocumentDictionaryService

Returns:

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

getCollectionBusinessObjectClass

public Class getCollectionBusinessObjectClass(String docTypeName,
                                     String collectionName)

Deprecated.

Description copied from interface: MaintenanceDocumentDictionaryService

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

Specified by:

getCollectionBusinessObjectClass in interface MaintenanceDocumentDictionaryService

Returns:

getMaintainableCollections

public List<MaintainableCollectionDefinition> getMaintainableCollections(String docTypeName)

Deprecated.

Description copied from interface: MaintenanceDocumentDictionaryService

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

Specified by:

getMaintainableCollections in interface MaintenanceDocumentDictionaryService

Returns:

getMaintainableCollections

public List<MaintainableCollectionDefinition> getMaintainableCollections(MaintainableCollectionDefinition parentCollection)

Deprecated.

Description copied from interface: MaintenanceDocumentDictionaryService

Returns a list of all collections within the given collection

Specified by:

getMaintainableCollections in interface MaintenanceDocumentDictionaryService

Returns:

validateMaintenanceRequiredFields

public void validateMaintenanceRequiredFields(MaintenanceDocument document)

Deprecated.

Description copied from interface: MaintenanceDocumentDictionaryService

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

Specified by:

validateMaintenanceRequiredFields in interface MaintenanceDocumentDictionaryService

See Also:

org.kuali.rice.kns.service.MaintenanceDocumentDictionaryService#validateMaintenanceRequiredFields(org.kuali.rice.krad.maintenance.MaintenanceDocument)

validateMaintainableCollectionsAddLineRequiredFields

public void validateMaintainableCollectionsAddLineRequiredFields(MaintenanceDocument document,
                                                        PersistableBusinessObject businessObject,
                                                        String collectionName)

Deprecated.

Specified by:

validateMaintainableCollectionsAddLineRequiredFields in interface MaintenanceDocumentDictionaryService

validateMaintainableCollectionsForDuplicateEntries

public void validateMaintainableCollectionsForDuplicateEntries(MaintenanceDocument document)

Deprecated.

default implementation checks for duplicats based on keys of objects only

Specified by:

validateMaintainableCollectionsForDuplicateEntries in interface MaintenanceDocumentDictionaryService

See Also:

org.kuali.rice.kns.service.MaintenanceDocumentDictionaryService#validateMaintainableCollectionsForDuplicateEntries(org.kuali.rice.krad.maintenance.MaintenanceDocument)

getPreserveLockingKeysOnCopy

public boolean getPreserveLockingKeysOnCopy(Class businessObjectClass)

Deprecated.

for issue KULRice 3072

Specified by:

getPreserveLockingKeysOnCopy in interface MaintenanceDocumentDictionaryService

Parameters:

businessObjectClass - - class for the data object to check

Returns:

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

See Also:

org.kuali.rice.kns.service.MaintenanceDocumentDictionaryService#getgetPreserveLockingKeysOnCopy(java.lang.Class)

getAllowsRecordDeletion

public Boolean getAllowsRecordDeletion(Class businessObjectClass)

Deprecated.

for isue KULRice 3070

Specified by:

getAllowsRecordDeletion in interface MaintenanceDocumentDictionaryService

Parameters:

businessObjectClass - - class for the data object to check

Returns:

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

See Also:

MaintenanceDocumentDictionaryService.getAllowsRecordDeletion(java.lang.Class)

getAllowsRecordDeletion

public Boolean getAllowsRecordDeletion(MaintenanceDocument document)

Deprecated.

for issue KULRice3070, see if need delete button

Specified by:

getAllowsRecordDeletion in interface MaintenanceDocumentDictionaryService

Parameters:

document - - maintenance document instance to check

Returns:

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

See Also:

org.kuali.rice.kns.service.MaintenanceDocumentDictionaryService#getAllowsRecordDeletion(org.kuali.rice.krad.maintenance.MaintenanceDocument)

translateCodes

public Boolean translateCodes(Class businessObjectClass)

Deprecated.

Specified by:

translateCodes in interface MaintenanceDocumentDictionaryService

Parameters:

businessObjectClass - - business object class for maintenance definition

Returns:

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

See Also:

MaintenanceDocumentDictionaryService.translateCodes(java.lang.Class)