org.kuali.rice.krad.service.impl

Class DictionaryValidationServiceImpl

java.lang.Object

org.kuali.rice.krad.service.impl.DictionaryValidationServiceImpl

All Implemented Interfaces:

DictionaryValidationService

Direct Known Subclasses:

DictionaryValidationServiceImpl

public class DictionaryValidationServiceImpl
extends Object
implements DictionaryValidationService

Validates Documents, Business Objects, and Attributes against the data dictionary. Including min, max lengths, and validating expressions. This is the default, Kuali delivered implementation. KULRICE - 3355 Modified to prevent infinite looping (to maxDepth) scenario when a parent references a child which references a parent

Author:

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

Field Summary

Fields

Modifier and Type	Field and Description
protected BusinessObjectService	businessObjectService
protected DataDictionaryService	dataDictionaryService
protected DocumentDictionaryService	documentDictionaryService
protected PersistenceService	persistenceService
protected PersistenceStructureService	persistenceStructureService
static String	VALIDATE_METHOD Constant defines a validation method for an attribute value.
protected WorkflowAttributePropertyResolutionService	workflowAttributePropertyResolutionService

Constructor Summary

Constructors

Constructor and Description
DictionaryValidationServiceImpl()

Method Summary

Modifier and Type	Method and Description
List<CollectionConstraintProcessor>	getCollectionConstraintProcessors()
List<ConstraintProvider>	getConstraintProviders()
DataDictionaryService	getDataDictionaryService()
DocumentDictionaryService	getDocumentDictionaryService()
List<ConstraintProcessor>	getElementConstraintProcessors()
protected WorkflowAttributePropertyResolutionService	getWorkflowAttributePropertyResolutionService()
boolean	isBusinessObjectValid(BusinessObject businessObject)
boolean	isBusinessObjectValid(BusinessObject businessObject, String prefix)
protected Set<BusinessObject>	newIdentitySet() creates a new IdentitySet.
void	setBusinessObjectService(BusinessObjectService businessObjectService) Sets the businessObjectService attribute value.
void	setCollectionConstraintProcessors(List<CollectionConstraintProcessor> collectionConstraintProcessors)
void	setConstraintProviders(List<ConstraintProvider> constraintProviders)
void	setDataDictionaryService(DataDictionaryService dataDictionaryService)
void	setDocumentDictionaryService(DocumentDictionaryService documentDictionaryService)
void	setElementConstraintProcessors(List<ConstraintProcessor> elementConstraintProcessors)
void	setPersistenceService(PersistenceService persistenceService) Sets the persistenceService attribute value.
void	setPersistenceStructureService(PersistenceStructureService persistenceStructureService)
DictionaryValidationResult	validate(AttributeValueReader valueReader, boolean doOptionalProcessing)
DictionaryValidationResult	validate(Object object)
DictionaryValidationResult	validate(Object object, boolean doOptionalProcessing)
DictionaryValidationResult	validate(Object object, String entryName)
DictionaryValidationResult	validate(Object object, String entryName, boolean doOptionalProcessing)
DictionaryValidationResult	validate(Object object, String entryName, DataDictionaryEntry entry, boolean doOptionalProcessing)
DictionaryValidationResult	validate(Object object, String entryName, String attributeName)
DictionaryValidationResult	validate(Object object, String entryName, String attributeName, boolean doOptionalProcessing)
void	validate(String entryName, String attributeName, Object attributeValue)
void	validate(String entryName, String attributeName, Object attributeValue, boolean doOptionalProcessing)
void	validateBusinessObject(BusinessObject businessObject)
void	validateBusinessObject(BusinessObject businessObject, boolean validateRequired)
protected void	validateBusinessObjectsFromDescriptors(Object object, PropertyDescriptor[] propertyDescriptors, int depth) iterates through the property descriptors looking for business objects or lists of business objects.
void	validateBusinessObjectsRecursively(BusinessObject businessObject, int depth)
boolean	validateDefaultExistenceChecks(BusinessObject bo)
boolean	validateDefaultExistenceChecksForNewCollectionItem(BusinessObject bo, BusinessObject newCollectionItem, String collectionName)
boolean	validateDefaultExistenceChecksForNewCollectionItem(TransactionalDocument document, BusinessObject newCollectionItem, String collectionName)
boolean	validateDefaultExistenceChecksForTransDoc(TransactionalDocument document)
void	validateDocument(Document document)
void	validateDocumentAndUpdatableReferencesRecursively(Document document, int maxDepth, boolean validateRequired)
void	validateDocumentAndUpdatableReferencesRecursively(Document document, int maxDepth, boolean validateRequired, boolean chompLastLetterSFromCollectionName)
void	validateDocumentAttribute(Document document, String attributeName, String errorPrefix)
void	validatePrimitiveFromDescriptor(String entryName, Object object, PropertyDescriptor propertyDescriptor, String errorPrefix, boolean validateRequired) Deprecated. since 1.1
boolean	validateReferenceExists(BusinessObject bo, ReferenceDefinition reference)
boolean	validateReferenceExists(BusinessObject bo, String referenceName)
boolean	validateReferenceExistsAndIsActive(BusinessObject bo, ReferenceDefinition reference)
boolean	validateReferenceExistsAndIsActive(BusinessObject bo, String referenceName, String attributeToHighlightOnFail, String displayFieldName)
boolean	validateReferenceIsActive(BusinessObject bo, ReferenceDefinition reference)
boolean	validateReferenceIsActive(BusinessObject bo, String referenceName)
protected void	validateUpdatabableReferencesRecursively(BusinessObject businessObject, int maxDepth, boolean validateRequired, boolean chompLastLetterSFromCollectionName, Set<BusinessObject> processedBOs)

Methods inherited from class java.lang.Object

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

Field Detail

VALIDATE_METHOD

public static final String VALIDATE_METHOD

Constant defines a validation method for an attribute value.

Value is "validate"

See Also:

Constant Field Values

dataDictionaryService

protected DataDictionaryService dataDictionaryService

businessObjectService

protected BusinessObjectService businessObjectService

persistenceService

protected PersistenceService persistenceService

documentDictionaryService

protected DocumentDictionaryService documentDictionaryService

workflowAttributePropertyResolutionService

protected WorkflowAttributePropertyResolutionService workflowAttributePropertyResolutionService

persistenceStructureService

protected PersistenceStructureService persistenceStructureService

Constructor Detail

DictionaryValidationServiceImpl

public DictionaryValidationServiceImpl()

Method Detail

newIdentitySet

protected final Set<BusinessObject> newIdentitySet()

creates a new IdentitySet.

Returns:

a new Set

validate

public DictionaryValidationResult validate(Object object)

Specified by:

validate in interface DictionaryValidationService

See Also:

DictionaryValidationService.validate(java.lang.Object)

validate

public DictionaryValidationResult validate(Object object,
                                           boolean doOptionalProcessing)

Specified by:

validate in interface DictionaryValidationService

See Also:

DictionaryValidationService.validate(java.lang.Object, boolean)

validate

public DictionaryValidationResult validate(Object object,
                                           String entryName)

Specified by:

validate in interface DictionaryValidationService

See Also:

DictionaryValidationService.validate(java.lang.Object, java.lang.String)

validate

public DictionaryValidationResult validate(Object object,
                                           String entryName,
                                           boolean doOptionalProcessing)

Specified by:

validate in interface DictionaryValidationService

See Also:

DictionaryValidationService.validate(java.lang.Object, java.lang.String, boolean)

validate

public DictionaryValidationResult validate(Object object,
                                           String entryName,
                                           String attributeName)

Specified by:

validate in interface DictionaryValidationService

See Also:

DictionaryValidationService.validate(java.lang.Object, java.lang.String, java.lang.String)

validate

public DictionaryValidationResult validate(Object object,
                                           String entryName,
                                           String attributeName,
                                           boolean doOptionalProcessing)

Specified by:

validate in interface DictionaryValidationService

See Also:

DictionaryValidationService.validate(java.lang.Object, java.lang.String, java.lang.String, boolean)

validate

public DictionaryValidationResult validate(Object object,
                                           String entryName,
                                           DataDictionaryEntry entry,
                                           boolean doOptionalProcessing)

Specified by:

validate in interface DictionaryValidationService

validate

public void validate(String entryName,
                     String attributeName,
                     Object attributeValue)

Specified by:

validate in interface DictionaryValidationService

validate

public void validate(String entryName,
                     String attributeName,
                     Object attributeValue,
                     boolean doOptionalProcessing)

Specified by:

validate in interface DictionaryValidationService

validateDocument

public void validateDocument(Document document)

Specified by:

validateDocument in interface DictionaryValidationService

See Also:

DictionaryValidationService.validateDocument(org.kuali.rice.krad.document.Document)

validateDocumentAttribute

public void validateDocumentAttribute(Document document,
                                      String attributeName,
                                      String errorPrefix)

Specified by:

validateDocumentAttribute in interface DictionaryValidationService

See Also:

DictionaryValidationService.validateDocumentAttribute(org.kuali.rice.krad.document.Document, java.lang.String, java.lang.String)

validateDocumentAndUpdatableReferencesRecursively

public void validateDocumentAndUpdatableReferencesRecursively(Document document,
                                                              int maxDepth,
                                                              boolean validateRequired)

Specified by:

validateDocumentAndUpdatableReferencesRecursively in interface DictionaryValidationService

See Also:

DictionaryValidationService.validateDocumentAndUpdatableReferencesRecursively(org.kuali.rice.krad.document.Document, int, boolean)

validateDocumentAndUpdatableReferencesRecursively

public void validateDocumentAndUpdatableReferencesRecursively(Document document,
                                                              int maxDepth,
                                                              boolean validateRequired,
                                                              boolean chompLastLetterSFromCollectionName)

Specified by:

validateDocumentAndUpdatableReferencesRecursively in interface DictionaryValidationService

See Also:

DictionaryValidationService.validateDocumentAndUpdatableReferencesRecursively(org.kuali.rice.krad.document.Document, int, boolean, boolean)

validateUpdatabableReferencesRecursively

protected void validateUpdatabableReferencesRecursively(BusinessObject businessObject,
                                                        int maxDepth,
                                                        boolean validateRequired,
                                                        boolean chompLastLetterSFromCollectionName,
                                                        Set<BusinessObject> processedBOs)

isBusinessObjectValid

public boolean isBusinessObjectValid(BusinessObject businessObject)

Specified by:

isBusinessObjectValid in interface DictionaryValidationService

See Also:

DictionaryValidationService.isBusinessObjectValid(org.kuali.rice.krad.bo.BusinessObject)

isBusinessObjectValid

public boolean isBusinessObjectValid(BusinessObject businessObject,
                                     String prefix)

Specified by:

isBusinessObjectValid in interface DictionaryValidationService

See Also:

DictionaryValidationService.isBusinessObjectValid(org.kuali.rice.krad.bo.BusinessObject, String)

validateBusinessObjectsRecursively

public void validateBusinessObjectsRecursively(BusinessObject businessObject,
                                               int depth)

Parameters:

businessObject - - business object to validate

validateBusinessObject

public void validateBusinessObject(BusinessObject businessObject)

Specified by:

validateBusinessObject in interface DictionaryValidationService

See Also:

DictionaryValidationService.validateBusinessObject(org.kuali.rice.krad.bo.BusinessObject)

validateBusinessObject

public void validateBusinessObject(BusinessObject businessObject,
                                   boolean validateRequired)

Specified by:

validateBusinessObject in interface DictionaryValidationService

See Also:

DictionaryValidationService.validateBusinessObject(org.kuali.rice.krad.bo.BusinessObject, boolean)

validateBusinessObjectsFromDescriptors

protected void validateBusinessObjectsFromDescriptors(Object object,
                                                      PropertyDescriptor[] propertyDescriptors,
                                                      int depth)

iterates through the property descriptors looking for business objects or lists of business objects. calls validate method for each bo found

Parameters:

object -

propertyDescriptors -

validatePrimitiveFromDescriptor

@Deprecated
public void validatePrimitiveFromDescriptor(String entryName,
                                                        Object object,
                                                        PropertyDescriptor propertyDescriptor,
                                                        String errorPrefix,
                                                        boolean validateRequired)

Deprecated. since 1.1

calls validate format and required check for the given propertyDescriptor

Specified by:

validatePrimitiveFromDescriptor in interface DictionaryValidationService

Parameters:

entryName -

object -

propertyDescriptor -

errorPrefix -

validateReferenceExists

public boolean validateReferenceExists(BusinessObject bo,
                                       ReferenceDefinition reference)

Specified by:

validateReferenceExists in interface DictionaryValidationService

See Also:

DictionaryValidationService.validateReferenceExists(org.kuali.rice.krad.bo.BusinessObject, org.kuali.rice.krad.datadictionary.ReferenceDefinition)

validateReferenceExists

public boolean validateReferenceExists(BusinessObject bo,
                                       String referenceName)

Specified by:

validateReferenceExists in interface DictionaryValidationService

See Also:

DictionaryValidationService.validateReferenceExists(org.kuali.rice.krad.bo.BusinessObject, java.lang.String)

validateReferenceIsActive

public boolean validateReferenceIsActive(BusinessObject bo,
                                         ReferenceDefinition reference)

Specified by:

validateReferenceIsActive in interface DictionaryValidationService

See Also:

DictionaryValidationService.validateReferenceIsActive(org.kuali.rice.krad.bo.BusinessObject, org.kuali.rice.krad.datadictionary.ReferenceDefinition)

validateReferenceIsActive

public boolean validateReferenceIsActive(BusinessObject bo,
                                         String referenceName)

Specified by:

validateReferenceIsActive in interface DictionaryValidationService

See Also:

DictionaryValidationService.validateReferenceIsActive(org.kuali.rice.krad.bo.BusinessObject, String)

validateReferenceExistsAndIsActive

public boolean validateReferenceExistsAndIsActive(BusinessObject bo,
                                                  ReferenceDefinition reference)

Specified by:

validateReferenceExistsAndIsActive in interface DictionaryValidationService

See Also:

DictionaryValidationService.validateReferenceExistsAndIsActive(org.kuali.rice.krad.bo.BusinessObject, org.kuali.rice.krad.datadictionary.ReferenceDefinition)

validateReferenceExistsAndIsActive

public boolean validateReferenceExistsAndIsActive(BusinessObject bo,
                                                  String referenceName,
                                                  String attributeToHighlightOnFail,
                                                  String displayFieldName)

Specified by:

validateReferenceExistsAndIsActive in interface DictionaryValidationService

See Also:

DictionaryValidationService.validateReferenceExistsAndIsActive(org.kuali.rice.krad.bo.BusinessObject, String, String, String)

validateDefaultExistenceChecks

public boolean validateDefaultExistenceChecks(BusinessObject bo)

Specified by:

validateDefaultExistenceChecks in interface DictionaryValidationService

See Also:

DictionaryValidationService.validateDefaultExistenceChecks(org.kuali.rice.krad.bo.BusinessObject)

validateDefaultExistenceChecksForNewCollectionItem

public boolean validateDefaultExistenceChecksForNewCollectionItem(BusinessObject bo,
                                                                  BusinessObject newCollectionItem,
                                                                  String collectionName)

Specified by:

validateDefaultExistenceChecksForNewCollectionItem in interface DictionaryValidationService

See Also:

DictionaryValidationService.validateDefaultExistenceChecksForNewCollectionItem(org.kuali.rice.krad.bo.BusinessObject, org.kuali.rice.krad.bo.BusinessObject, java.lang.String)

validateDefaultExistenceChecksForTransDoc

public boolean validateDefaultExistenceChecksForTransDoc(TransactionalDocument document)

Specified by:

validateDefaultExistenceChecksForTransDoc in interface DictionaryValidationService

See Also:

DictionaryValidationService.validateDefaultExistenceChecksForTransDoc(org.kuali.rice.krad.document.TransactionalDocument)

validateDefaultExistenceChecksForNewCollectionItem

public boolean validateDefaultExistenceChecksForNewCollectionItem(TransactionalDocument document,
                                                                  BusinessObject newCollectionItem,
                                                                  String collectionName)

Specified by:

validateDefaultExistenceChecksForNewCollectionItem in interface DictionaryValidationService

See Also:

DictionaryValidationService.validateDefaultExistenceChecksForNewCollectionItem(org.kuali.rice.krad.document.TransactionalDocument, org.kuali.rice.krad.bo.BusinessObject, String)

validate

public DictionaryValidationResult validate(AttributeValueReader valueReader,
                                           boolean doOptionalProcessing)

Specified by:

validate in interface DictionaryValidationService

getDataDictionaryService

public DataDictionaryService getDataDictionaryService()

Returns:

Returns the dataDictionaryService.

setDataDictionaryService

public void setDataDictionaryService(DataDictionaryService dataDictionaryService)

Parameters:

dataDictionaryService - The dataDictionaryService to set.

setBusinessObjectService

public void setBusinessObjectService(BusinessObjectService businessObjectService)

Sets the businessObjectService attribute value.

Parameters:

businessObjectService - The businessObjectService to set.

setPersistenceService

public void setPersistenceService(PersistenceService persistenceService)

Sets the persistenceService attribute value.

Parameters:

persistenceService - The persistenceService to set.

setPersistenceStructureService

public void setPersistenceStructureService(PersistenceStructureService persistenceStructureService)

getWorkflowAttributePropertyResolutionService

protected WorkflowAttributePropertyResolutionService getWorkflowAttributePropertyResolutionService()

getCollectionConstraintProcessors

public List<CollectionConstraintProcessor> getCollectionConstraintProcessors()

Returns:

the collectionConstraintProcessors

setCollectionConstraintProcessors

public void setCollectionConstraintProcessors(List<CollectionConstraintProcessor> collectionConstraintProcessors)

Parameters:

collectionConstraintProcessors - the collectionConstraintProcessors to set

getConstraintProviders

public List<ConstraintProvider> getConstraintProviders()

Returns:

the constraintProviders

setConstraintProviders

public void setConstraintProviders(List<ConstraintProvider> constraintProviders)

Parameters:

constraintProviders - the constraintProviders to set

getElementConstraintProcessors

public List<ConstraintProcessor> getElementConstraintProcessors()

Returns:

the elementConstraintProcessors

setElementConstraintProcessors

public void setElementConstraintProcessors(List<ConstraintProcessor> elementConstraintProcessors)

Parameters:

elementConstraintProcessors - the elementConstraintProcessors to set

getDocumentDictionaryService

public DocumentDictionaryService getDocumentDictionaryService()

setDocumentDictionaryService

public void setDocumentDictionaryService(DocumentDictionaryService documentDictionaryService)