001/**
002 * Copyright 2005-2018 The Kuali Foundation
003 *
004 * Licensed under the Educational Community License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 *
008 * http://www.opensource.org/licenses/ecl2.php
009 *
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 * See the License for the specific language governing permissions and
014 * limitations under the License.
015 */
016package org.kuali.rice.krad.datadictionary.validation.processor;
017
018import org.kuali.rice.core.api.util.RiceKeyConstants;
019import org.kuali.rice.krad.datadictionary.exception.AttributeValidationException;
020import org.kuali.rice.krad.datadictionary.validation.AttributeValueReader;
021import org.kuali.rice.krad.datadictionary.validation.ErrorLevel;
022import org.kuali.rice.krad.datadictionary.validation.ValidationUtils;
023import org.kuali.rice.krad.datadictionary.validation.constraint.Constraint;
024import org.kuali.rice.krad.datadictionary.validation.constraint.PrerequisiteConstraint;
025import org.kuali.rice.krad.datadictionary.validation.result.ConstraintValidationResult;
026
027import java.util.Collection;
028
029/**
030 * @param <C> constraint type
031 * @author Kuali Rice Team (rice.collab@kuali.org)
032 */
033public abstract class BasePrerequisiteConstraintProcessor<C extends Constraint> extends MandatoryElementConstraintProcessor<C> {
034
035    protected ConstraintValidationResult processPrerequisiteConstraint(PrerequisiteConstraint constraint,
036            AttributeValueReader attributeValueReader) throws AttributeValidationException {
037        ConstraintValidationResult constraintValidationResult = new ConstraintValidationResult(getName());
038
039        if (constraint == null) {
040            constraintValidationResult.setStatus(ErrorLevel.NOCONSTRAINT);
041            return constraintValidationResult;
042        }
043
044        // TODO: Does this code need to be able to look at more than just the other immediate members of the object?
045        String attributeName = constraint.getPropertyName();
046
047        if (ValidationUtils.isNullOrEmpty(attributeName)) {
048            throw new AttributeValidationException(
049                    "Prerequisite constraints must include the name of the attribute that is required");
050        }
051
052        Object value = attributeValueReader.getValue(attributeName);
053
054        boolean isSuccessful = true;
055
056        if (value instanceof java.lang.String) {
057            isSuccessful = ValidationUtils.hasText((String) value);
058        } else if (value instanceof Collection) {
059            isSuccessful = (((Collection<?>) value).size() > 0);
060        } else {
061            isSuccessful = (null != value) ? true : false;
062        }
063
064        if (!isSuccessful) {
065            String label = attributeValueReader.getLabel(attributeName);
066            if (label != null) {
067                attributeName = label;
068            }
069
070            constraintValidationResult.setError(RiceKeyConstants.ERROR_REQUIRES_FIELD, attributeName);
071            constraintValidationResult.setConstraintLabelKey(constraint.getMessageKey());
072            constraintValidationResult.setErrorParameters(constraint.getValidationMessageParamsArray());
073        }
074
075        return constraintValidationResult;
076    }
077
078}