DictionaryValidationServiceImpl (Rice 2.0.0-rc3 API)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

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
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
`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
`DictionaryValidationServiceImpl()`

Method Summary
`List<CollectionConstraintProcessor>`	`getCollectionConstraintProcessors()`
`List<ConstraintProvider>`	`getConstraintProviders()`
`DataDictionaryService`	`getDataDictionaryService()`
`DocumentDictionaryService`	`getDocumentDictionaryService()`
`List<ConstraintProcessor>`	`getElementConstraintProcessors()`
`protected WorkflowAttributePropertyResolutionService`	`getWorkflowAttributePropertyResolutionService()`
`boolean`	`isBusinessObjectValid(BusinessObject businessObject)` Encapsulates `{@link #validateBusinessObject(BusinessObject) and returns boolean so one doesn't need to check the ErrorMap.Validates the business object primitive attributes against the data dictionary.`
`boolean`	`isBusinessObjectValid(BusinessObject businessObject, String prefix)` Encapsulates `{@link #validateBusinessObject(BusinessObject) and returns boolean so one doesn't need to check the ErrorMap.Validates the business object primitive attributes against the data dictionary.`
`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)` Same as other validate method except, allows you to provide the attributeValueReader directly for evaluation
`DictionaryValidationResult`	`validate(Object object)` Validates an object using its class name as the entry name to look up its metadata in the dictionary.
`DictionaryValidationResult`	`validate(Object object, boolean doOptionalProcessing)` Validates an object using its class name as the entry name to look up its metadata in the dictionary.
`DictionaryValidationResult`	`validate(Object object, String entryName)` Validates an object using the passed entry name to look up metadata in the dictionary
`DictionaryValidationResult`	`validate(Object object, String entryName, boolean doOptionalProcessing)` Same as `DictionaryValidationService.validate(java.lang.Object, java.lang.String)` except that it provides a boolean parameter for the calling method to choose whether to do optional processing (generally to check if blank/empty values are required or not).
`DictionaryValidationResult`	`validate(Object object, String entryName, DataDictionaryEntry entry, boolean doOptionalProcessing)` Same as {@link DictionaryValidationService#validate(Object, String, boolean) except that it provides an explicit data dictionary entry to use for the purpose of validation.
`DictionaryValidationResult`	`validate(Object object, String entryName, String attributeName)` Validates a single attribute on the passed object using the passed entry name to look up metadata in the dictionary.
`DictionaryValidationResult`	`validate(Object object, String entryName, String attributeName, boolean doOptionalProcessing)` Same as `DictionaryValidationService.validate(Object, String, String)` except that it provides a boolean parameter for the calling method to choose whether to do optional processing (generally to check if blank/empty values are required or not).
`void`	`validate(String entryName, String attributeName, Object attributeValue)` Instead of validating an object with dictionary metadata, or validating a specific member of an object by name, validates a specific attribute of an object by passing in the attribute value itself.
`void`	`validate(String entryName, String attributeName, Object attributeValue, boolean doOptionalProcessing)` Same as `DictionaryValidationService.validate(String, String, Object)` except that it provides a boolean parameter for the calling method to choose whether to do optional processing (generally to check if blank/empty values are required or not).
`void`	`validateBusinessObject(BusinessObject businessObject)` Validates the business object primitive attributes against the data dictionary.
`void`	`validateBusinessObject(BusinessObject businessObject, boolean validateRequired)` Validates the business object primitive attributes against the data dictionary.
`protected void`	`validateBusinessObjectsFromDescriptors(Object object, PropertyDescriptor[] propertyDescriptors, int depth)` iterates through the property discriptors looking for business objects or lists of business objects.
`void`	`validateBusinessObjectsRecursively(BusinessObject businessObject, int depth)`
`boolean`	`validateDefaultExistenceChecks(BusinessObject bo)` This method does an existence check against all references of a BusinessObject as defined in the MaintenanceDocument.xml file for that business object.
`boolean`	`validateDefaultExistenceChecksForNewCollectionItem(BusinessObject bo, BusinessObject newCollectionItem, String collectionName)` Does an existence check against all references configured as a default existence check in the maintenance document data dictionary file for the given business object Appropriate errors will also be placed in the GlobalVariables.ErrorMap.
`boolean`	`validateDefaultExistenceChecksForNewCollectionItem(TransactionalDocument document, BusinessObject newCollectionItem, String collectionName)` This method does an existence check against all references of a transactionalDocument Appropriate errors will also be placed in the GlobalVariables.ErrorMap.
`boolean`	`validateDefaultExistenceChecksForTransDoc(TransactionalDocument document)` This method does an existence check against all references of a transactionalDocument Appropriate errors will also be placed in the GlobalVariables.ErrorMap.
`void`	`validateDocument(Document document)` Validates the contents of a document (i.e.
`void`	`validateDocumentAndUpdatableReferencesRecursively(Document document, int maxDepth, boolean validateRequired)` Validates the contents of a document and recursively validates any of its updatable references
`void`	`validateDocumentAndUpdatableReferencesRecursively(Document document, int maxDepth, boolean validateRequired, boolean chompLastLetterSFromCollectionName)` Validates the contents of a document and recursively validates any of its updatable references
`void`	`validateDocumentAttribute(Document document, String attributeName, String errorPrefix)` Validates the specified attribute of the given document against the data dictionary.
`void`	`validatePrimitiveFromDescriptor(String entryName, Object object, PropertyDescriptor propertyDescriptor, String errorPrefix, boolean validateRequired)` Deprecated. since 1.1
`boolean`	`validateReferenceExists(BusinessObject bo, ReferenceDefinition reference)` This method examines the populated BusinessObject bo instance passed in for a member named by the referenceName.
`boolean`	`validateReferenceExists(BusinessObject bo, String referenceName)` This method examines the populated BusinessObject bo instance passed in for a member named by the referenceName.
`boolean`	`validateReferenceExistsAndIsActive(BusinessObject bo, ReferenceDefinition reference)` This method intelligently tests the designated reference on the bo for both existence and active status, where appropriate.
`boolean`	`validateReferenceExistsAndIsActive(BusinessObject bo, String referenceName, String attributeToHighlightOnFail, String displayFieldName)` This method intelligently tests the designated reference on the bo for both existence and active status, where appropriate.
`boolean`	`validateReferenceIsActive(BusinessObject bo, ReferenceDefinition reference)` This method retrieves the reference from the DB, and then tests whether the object is active.
`boolean`	`validateReferenceIsActive(BusinessObject bo, String referenceName)` This method retrieves the reference from the DB, and then tests whether the object is active.

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