org.kuali.rice.kns.service.impl
Class DictionaryValidationServiceImpl

java.lang.Object
  org.kuali.rice.kns.service.impl.DictionaryValidationServiceImpl

All Implemented Interfaces:

DictionaryValidationService

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

Field Summary

static String

VALIDATE_METHOD Constant defines a validation method for an attribute value.

Constructor Summary

DictionaryValidationServiceImpl()

Method Summary

List<CollectionConstraintProcessor>	getCollectionConstraintProcessors()
List<ConstraintProvider>	getConstraintProviders()
DataDictionaryService	getDataDictionaryService()
List<ConstraintProcessor>	getElementConstraintProcessors()
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	setElementConstraintProcessors(List<ConstraintProcessor> elementConstraintProcessors)
void	setMaintenanceDocumentDictionaryService(MaintenanceDocumentDictionaryService maintenanceDocumentDictionaryService) Sets the maintenanceDocumentDictionaryService attribute value.
void	setPersistenceService(PersistenceService persistenceService) Sets the persistenceService attribute value.
void	setPersistenceStructureService(PersistenceStructureService persistenceStructureService)
void	setTransactionalDocumentDictionaryService(TransactionalDocumentDictionaryService transactionalDocumentDictionaryService)
DictionaryValidationResult	validate(AttributeValueReader valueReader, boolean doOptionalProcessing)
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	validateAttributeFormat(String objectClassName, String attributeName, String attributeInValue, String errorKey) Deprecated. since 1.1
void	validateAttributeFormat(String objectClassName, String attributeName, String attributeInValue, String attributeDataType, String errorKey) Deprecated. since 1.1
void	validateAttributeRequired(String objectClassName, String attributeName, Object attributeValue, Boolean forMaintenance, String errorKey) Deprecated.
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.
void	validateBusinessObjectOnMaintenanceDocument(BusinessObject businessObject, String docTypeName) Deprecated. since 1.1
void	validateBusinessObjectsRecursively(BusinessObject businessObject, int depth) Validates the business object against the dictionary, uses reflection to get any child business objects, and recursively calls back.
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 overridden method ...
boolean	validateDefaultExistenceChecksForTransDoc(TransactionalDocument document) This overridden method ...
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	validateDocumentRecursively(Document document, int depth) Deprecated.
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

Constructor Detail

DictionaryValidationServiceImpl

public DictionaryValidationServiceImpl()

Method Detail

validate

public DictionaryValidationResult validate(Object object)

Description copied from interface: DictionaryValidationService

Validates an object using its class name as the entry name to look up its metadata in the dictionary.

Specified by:

validate in interface DictionaryValidationService

Parameters:

object - - an object to validate

Returns:

the dictionary validation result object associated with this validation

See Also:

DictionaryValidationService.validate(java.lang.Object)

validate

public DictionaryValidationResult validate(Object object,
                                           boolean doOptionalProcessing)

Description copied from interface: DictionaryValidationService

Validates an object using its class name as the entry name to look up its metadata in the dictionary.

Specified by:

validate in interface DictionaryValidationService

Parameters:

object - - an object to validate

doOptionalProcessing - true if the validation should do optional validation (e.g. to check if empty values are required or not), false otherwise

Returns:

the dictionary validation result object associated with this validation

See Also:

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

validate

public DictionaryValidationResult validate(Object object,
                                           String entryName)

Description copied from interface: DictionaryValidationService

Validates an object using the passed entry name to look up metadata in the dictionary

Specified by:

validate in interface DictionaryValidationService

Parameters:

object - - an object to validate

entryName - - the dictionary entry name to look up the metadata associated with this object

Returns:

the dictionary validation result object associated with this validation

See Also:

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

validate

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

Description copied from interface: DictionaryValidationService

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).

Specified by:

validate in interface DictionaryValidationService

Parameters:

object - - an object to validate

entryName - - the dictionary entry name to look up the metadata associated with this object

doOptionalProcessing - true if the validation should do optional validation (e.g. to check if empty values are required or not), false otherwise

Returns:

the dictionary validation result object associated with this validation

See Also:

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

validate

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

Description copied from interface: DictionaryValidationService

Validates a single attribute on the passed object using the passed entry name to look up metadata in the dictionary.

Specified by:

validate in interface DictionaryValidationService

Parameters:

object - - an object to validate

entryName - - the dictionary entry name to look up the metadata associated with this object

attributeName - - the name of the attribute (field) on the object that should be validated

Returns:

the dictionary validation result object associated with this validation

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)

Description copied from interface: DictionaryValidationService

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).

Specified by:

validate in interface DictionaryValidationService

Parameters:

object - - an object to validate

entryName - - the dictionary entry name to look up the metadata associated with this object

attributeName - - the name of the attribute (field) on the object that should be validated

doOptionalProcessing - true if the validation should do optional validation (e.g. to check if empty values are required or not), false otherwise

Returns:

the dictionary validation result object associated with this validation

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)

Description copied from interface: DictionaryValidationService

Same as {@link DictionaryValidationService#validate(Object, String, boolean) except that it provides an explicit data dictionary entry to use for the purpose of validation.

Specified by:

validate in interface DictionaryValidationService

Parameters:

object - - an object to validate

entryName - - the dictionary entry name to use in association with error look ups

entry - - the dictionary entry to use for validation

doOptionalProcessing - true if the validation should do optional validation (e.g. to check if empty values are required or not), false otherwise

Returns:

the dictionary validation result object associated with this validation

validate

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

Description copied from interface: DictionaryValidationService

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. This limits the amount of validation that can be done to constraints that directly affect this attribute.

Specified by:

validate in interface DictionaryValidationService

Parameters:

entryName - - the dictionary entry name to use in association with error look ups

attributeName - - the dictionary entry attribute name to use in association with error look ups

attributeValue - - the value of the attribute being validated

validate

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

Description copied from interface: DictionaryValidationService

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).

Specified by:

validate in interface DictionaryValidationService

Parameters:

entryName - - the dictionary entry name to use in association with error look ups

attributeName - - the dictionary entry attribute name to use in association with error look ups

attributeValue - - the value of the attribute being validated

doOptionalProcessing - - true if the validation should do optional validation (e.g. to check if empty values are required or not), false otherwise

validateDocument

public void validateDocument(Document document)

Description copied from interface: DictionaryValidationService

Validates the contents of a document (i.e. attributes within a document) against the data dictionary.

Specified by:

validateDocument in interface DictionaryValidationService

Parameters:

document - - document to validate

See Also:

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

validateDocumentAttribute

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

Description copied from interface: DictionaryValidationService

Validates the specified attribute of the given document against the data dictionary.

Specified by:

validateDocumentAttribute in interface DictionaryValidationService

See Also:

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

validateDocumentRecursively

@Deprecated
public void validateDocumentRecursively(Document document,
                                                   int depth)

Deprecated.

Description copied from interface: DictionaryValidationService

Validates the contents of a document (i.e. attributes within a document) against the data dictionary. Recursively checks business objects of the document.

Specified by:

validateDocumentRecursively in interface DictionaryValidationService

Parameters:

document - - document to validate

depth - - Specify how deep the recrusion should go (0 based). If a negative number is supplied, it's infinite.

See Also:

DictionaryValidationService.validateDocumentRecursively(org.kuali.rice.kns.document.Document, int)

validateDocumentAndUpdatableReferencesRecursively

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

Description copied from interface: DictionaryValidationService

Validates the contents of a document and recursively validates any of its updatable references

Specified by:

validateDocumentAndUpdatableReferencesRecursively in interface DictionaryValidationService

Parameters:

document - the document

maxDepth - the maximum numbers of levels to recurse

validateRequired - whether to validate whether a field is required and is currently blank

validateDocumentAndUpdatableReferencesRecursively

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

Description copied from interface: DictionaryValidationService

Validates the contents of a document and recursively validates any of its updatable references

Specified by:

validateDocumentAndUpdatableReferencesRecursively in interface DictionaryValidationService

Parameters:

document - the document

maxDepth - the maximum numbers of levels to recurse

validateRequired - whether to validate whether a field is required and is currently blank

chompLastLetterSFromCollectionName - if true, the error path for any collections encountered will have the last "s" removed from the collection name if it ends with the letter "s". If false, this method acts like DictionaryValidationService.validateDocumentAndUpdatableReferencesRecursively(Document, int, boolean)

validateBusinessObject

public void validateBusinessObject(BusinessObject businessObject)

Description copied from interface: DictionaryValidationService

Validates the business object primitive attributes against the data dictionary. Adds errors to the map as they are encountered.

Specified by:

validateBusinessObject in interface DictionaryValidationService

Parameters:

businessObject - - business object to validate

See Also:

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

validateBusinessObject

public void validateBusinessObject(BusinessObject businessObject,
                                   boolean validateRequired)

Description copied from interface: DictionaryValidationService

Validates the business object primitive attributes against the data dictionary. Adds errors to the map as they are encountered.

Specified by:

validateBusinessObject in interface DictionaryValidationService

Parameters:

businessObject - - business object to validate

validateRequired - - whether to execute required field checks

See Also:

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

validateBusinessObjectOnMaintenanceDocument

@Deprecated
public void validateBusinessObjectOnMaintenanceDocument(BusinessObject businessObject,
                                                                   String docTypeName)

Deprecated. since 1.1

Specified by:

validateBusinessObjectOnMaintenanceDocument in interface DictionaryValidationService

See Also:

DictionaryValidationService.validateBusinessObjectOnMaintenanceDocument(org.kuali.rice.kns.bo.BusinessObject, java.lang.String)

isBusinessObjectValid

public boolean isBusinessObjectValid(BusinessObject businessObject)

Description copied from interface: DictionaryValidationService

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. Adds errors to the map as they are encountered.

Makes no error path adjustments

Specified by:

isBusinessObjectValid in interface DictionaryValidationService

Parameters:

businessObject - - business object to validate

Returns:

boolean validOrNot

See Also:

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

isBusinessObjectValid

public boolean isBusinessObjectValid(BusinessObject businessObject,
                                     String prefix)

Description copied from interface: DictionaryValidationService

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. Adds errors to the map as they are encountered.

Makes no error path adjustments

Specified by:

isBusinessObjectValid in interface DictionaryValidationService

Parameters:

businessObject - - business object to validate

prefix - - error prefix

Returns:

boolean valid or not

See Also:

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

validateBusinessObjectsRecursively

public void validateBusinessObjectsRecursively(BusinessObject businessObject,
                                               int depth)

Description copied from interface: DictionaryValidationService

Validates the business object against the dictionary, uses reflection to get any child business objects, and recursively calls back. Adds errors to the map as they are encountered.

Specified by:

validateBusinessObjectsRecursively in interface DictionaryValidationService

Parameters:

businessObject - - business object to validate

depth - - Specify how deep the recrusion should go (0 based). If a negative number is supplied, it's infinite.

validateAttributeFormat

@Deprecated
public void validateAttributeFormat(String objectClassName,
                                               String attributeName,
                                               String attributeInValue,
                                               String errorKey)

Deprecated. since 1.1

Description copied from interface: DictionaryValidationService

Validates an attribute of a given class for proper min, max length, syntax, and required.

Specified by:

validateAttributeFormat in interface DictionaryValidationService

Parameters:

objectClassName - - name of the dd entry

attributeName - - name of attribute in the bo class

attributeInValue - - current value to validate

errorKey - - key to place the errors under

See Also:

objectClassName is the docTypeName

validateAttributeFormat

@Deprecated
public void validateAttributeFormat(String objectClassName,
                                               String attributeName,
                                               String attributeInValue,
                                               String attributeDataType,
                                               String errorKey)

Deprecated. since 1.1

The attributeDataType parameter should be one of the data types specified by the SearchableAttribute interface; will default to DATA_TYPE_STRING if a data type other than the ones from SearchableAttribute is specified.

Specified by:

validateAttributeFormat in interface DictionaryValidationService

Parameters:

objectClassName - - name of the dd entry

attributeName - - name of attribute in the bo class

attributeInValue - - current value to validate

attributeDataType - - data type that this attribute should be treated as for validation purposes

errorKey - - key to place the errors under

See Also:

objectClassName is the docTypeName

validateAttributeRequired

@Deprecated
public void validateAttributeRequired(String objectClassName,
                                                 String attributeName,
                                                 Object attributeValue,
                                                 Boolean forMaintenance,
                                                 String errorKey)

Deprecated.

Description copied from interface: DictionaryValidationService

Validates an attribute of a given class for required check.

Specified by:

validateAttributeRequired in interface DictionaryValidationService

Parameters:

objectClassName - - name of the dd entry

attributeName - - name of attribute in the bo class

attributeValue - - current value to validate

errorKey - - key to place to errors under

See Also:

DictionaryValidationService.validateAttributeRequired(java.lang.String, java.lang.String, java.lang.Object, java.lang.Boolean, java.lang.String)

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)

Description copied from interface: DictionaryValidationService

This method examines the populated BusinessObject bo instance passed in for a member named by the referenceName. If this member exists, and if this member is a descendent of BusinessObject, then an existence check proceeds. First the foreign keys for this reference are gathered, and then examined to see if they have values. If they do not have values, the method ends with a true return value. If they all have values, then an object with those primary keys is retrieve from the database. If one is retrieve, then the reference exists, and True is returned. Otherwise, false is returned. This method assumes that you already have the errorPath set exactly as desired, and adds new errors to the errorMap with no prefix, other than what has already been pushed onto the errorMap.

Specified by:

validateReferenceExists in interface DictionaryValidationService

Parameters:

bo - - The bo whose reference is being tested.

reference - - The ReferenceDefinition to be existence tested.

Returns:

True if no exceptions occur and the object exists in the db, false otherwise.

See Also:

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

validateReferenceExists

public boolean validateReferenceExists(BusinessObject bo,
                                       String referenceName)

Description copied from interface: DictionaryValidationService

This method examines the populated BusinessObject bo instance passed in for a member named by the referenceName. If this member exists, and if this member is a descendent of BusinessObject, then an existence check proceeds. First the foreign keys for this reference are gathered, and then examined to see if they have values. If they do not have values, the method ends with a true return value. If they all have values, then an object with those primary keys is retrieve from the database. If one is retrieve, then the reference exists, and True is returned. Otherwise, false is returned. This method assumes that you already have the errorPath set exactly as desired, and adds new errors to the errorMap with no prefix, other than what has already been pushed onto the errorMap.

Specified by:

validateReferenceExists in interface DictionaryValidationService

Parameters:

bo - - The bo whose reference is being tested.

referenceName - - The name of the member to be existence tested.

Returns:

True if no exceptions occur and the object exists in the db, false otherwise.

See Also:

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

validateReferenceIsActive

public boolean validateReferenceIsActive(BusinessObject bo,
                                         ReferenceDefinition reference)

Description copied from interface: DictionaryValidationService

This method retrieves the reference from the DB, and then tests whether the object is active. It will return false if there is no activeIndicator field on this object, if the object doesnt exist in the DB, if the field doesnt exist or cannot be cast as a boolean, if the field value is null, or if the field value is false. It will only return true if the reference bo is present, the field is present, it is a boolean and non-null, and the value is true. This method assumes that you already have the errorPath set exactly as desired, and adds new errors to the errorMap with no prefix, other than what has already been pushed onto the errorMap.

Specified by:

validateReferenceIsActive in interface DictionaryValidationService

Returns:

See Also:

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

validateReferenceIsActive

public boolean validateReferenceIsActive(BusinessObject bo,
                                         String referenceName)

Description copied from interface: DictionaryValidationService

This method retrieves the reference from the DB, and then tests whether the object is active. It will return false if there is no activeIndicator field on this object, if the object doesnt exist in the DB, if the field doesnt exist or cannot be cast as a boolean, if the field value is null, or if the field value is false. It will only return true if the reference bo is present, the field is present, it is a boolean and non-null, and the value is true. This method assumes that you already have the errorPath set exactly as desired, and adds new errors to the errorMap with no prefix, other than what has already been pushed onto the errorMap.

Specified by:

validateReferenceIsActive in interface DictionaryValidationService

Returns:

See Also:

org.kuali.rice.kns.service.DictionaryValidationService#validateReferenceIsActive(org.kuali.rice.kns.bo.BusinessObject, java.lang.String, java.lang.String, boolean)

validateReferenceExistsAndIsActive

public boolean validateReferenceExistsAndIsActive(BusinessObject bo,
                                                  ReferenceDefinition reference)

Description copied from interface: DictionaryValidationService

This method intelligently tests the designated reference on the bo for both existence and active status, where appropriate. It will not test anything if the foreign-key fields for the given reference arent filled out with values, and it will not test active status if the reference doesnt exist. Further, it will only test active status where the correct flag is set. On failures of either sort, it will put the relevant errors into the GlobalVariables errorMap, and return a false. If there are no failures, or nothing can be tested because the foreign-key fields arent fully filled out, it will return true and add no errors. This method assumes that you already have the errorPath set exactly as desired, and adds new errors to the errorMap with no prefix, other than what has already been pushed onto the errorMap.

Specified by:

validateReferenceExistsAndIsActive in interface DictionaryValidationService

Parameters:

bo - - the BusinessObject instance to be tested.

reference - - the ReferenceDefinition to control the nature of the testing.

Returns:

true or false as per the criteria above

See Also:

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

validateReferenceExistsAndIsActive

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

Description copied from interface: DictionaryValidationService

This method intelligently tests the designated reference on the bo for both existence and active status, where appropriate. It will not test anything if the foreign-key fields for the given reference arent filled out with values, and it will not test active status if the reference doesnt exist. Note that it will not fail or raise any error if all of the foreign-keys are filled with a value. If this needs to be tested (ie, the 'if any field is filled, then all must be filled' rule), you'll have to do that separately. Further, it will only test active status where the correct flag is set. On failures of either sort, it will put the relevant errors into the GlobalVariables errorMap, and return a false. If there are no failures, or nothing can be tested because the foreign-key fields arent fully filled out, it will return true and add no errors. This method assumes that you already have the errorPath set exactly as desired, and adds new errors to the errorMap with no prefix, other than what has already been pushed onto the errorMap.

Specified by:

validateReferenceExistsAndIsActive in interface DictionaryValidationService

Parameters:

bo - - the BusinessObject instance to be tested.

referenceName - - the member name on the bo to be tested for existence and active-state

attributeToHighlightOnFail - - the fieldName to highlight with the error message on a failure

displayFieldName - - the human-readable display name of the failed field, to go in the error message

Returns:

true or false as per the criteria above

See Also:

org.kuali.rice.kns.service.DictionaryValidationService#validateReferenceExistsAndIsActive(org.kuali.rice.kns.bo.BusinessObject, java.lang.String, java.lang.String, boolean, boolean, java.lang.String, java.lang.String)

validateDefaultExistenceChecks

public boolean validateDefaultExistenceChecks(BusinessObject bo)

Description copied from interface: DictionaryValidationService

This method does an existence check against all references of a BusinessObject as defined in the MaintenanceDocument.xml file for that business object. Appropriate errors will also be placed in the GlobalVariables.ErrorMap. This method assumes that you already have the errorPath set exactly as desired, and adds new errors to the errorMap with no prefix, other than what has already been pushed onto the errorMap.

Specified by:

validateDefaultExistenceChecks in interface DictionaryValidationService

Parameters:

bo - - BusinessObject instance that should be tested

Returns:

true if all passed existence tests, false if any failed

See Also:

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

validateDefaultExistenceChecksForNewCollectionItem

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

Description copied from interface: DictionaryValidationService

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. This method assumes that you already have the errorPath set exactly as desired, and adds new errors to the errorMap with no prefix, other than what has already been pushed onto the errorMap.

Specified by:

validateDefaultExistenceChecksForNewCollectionItem in interface DictionaryValidationService

Parameters:

bo - parent business object instance to retrieve default checks for

newCollectionItem - new collection line to validate

collectionName - name of the collection in the parent

Returns:

true if all passed existence tests, false if any failed

See Also:

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

validateDefaultExistenceChecksForTransDoc

public boolean validateDefaultExistenceChecksForTransDoc(TransactionalDocument document)

This overridden method ...

Specified by:

validateDefaultExistenceChecksForTransDoc in interface DictionaryValidationService

Parameters:

document - document instance that should be tested

Returns:

true if all passed existence tests, false if any failed

See Also:

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

validateDefaultExistenceChecksForNewCollectionItem

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

This overridden method ...

Specified by:

validateDefaultExistenceChecksForNewCollectionItem in interface DictionaryValidationService

Parameters:

document - document instance that should be tested

newCollectionItem - that should be tested

collectionName - that should be tested

Returns:

true if all passed existence tests, false if any failed

See Also:

org.kuali.rice.kns.service.DictionaryValidationService#validateDefaultExistenceChecksForNewCollectionItem(org.kuali.rice.kns.document.TransactionalDocument, org.kuali.rice.kns.bo.PersistableBusinessObject)

validate

public DictionaryValidationResult validate(AttributeValueReader valueReader,
                                           boolean doOptionalProcessing)

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.

setMaintenanceDocumentDictionaryService

public void setMaintenanceDocumentDictionaryService(MaintenanceDocumentDictionaryService maintenanceDocumentDictionaryService)

Sets the maintenanceDocumentDictionaryService attribute value.

Parameters:

maintenanceDocumentDictionaryService - The maintenanceDocumentDictionaryService to set.

setTransactionalDocumentDictionaryService

public void setTransactionalDocumentDictionaryService(TransactionalDocumentDictionaryService transactionalDocumentDictionaryService)

Parameters:

transactionalDocumentDictionaryService - the transactionalDocumentDictionaryService 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)

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