001/*
002 * Copyright 2011 The Kuali Foundation.
003 *
004 * Licensed under the Educational Community License, Version 1.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/ecl1.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.ole.sys.document.validation;
017
018import java.util.ArrayList;
019import java.util.Collection;
020import java.util.List;
021
022import org.kuali.ole.sys.document.validation.event.AttributedDocumentEvent;
023import org.kuali.rice.kew.api.WorkflowDocument;
024
025/**
026 * An abstract class that creates an easy way to do routeNode validations.  Basically,
027 * extenders set a validRouteNodeNames - a list of all valid route nodes to perform the validation.
028 */
029public abstract class RouteNodeValidation extends GenericValidation {
030    private static final org.apache.log4j.Logger LOG = org.apache.log4j.Logger.getLogger(RouteNodeValidation.class);
031
032    protected List<String> validRouteNodeNames;
033
034    @Override
035    public boolean stageValidation(AttributedDocumentEvent event) {
036        boolean valid = true;
037        if (LOG.isDebugEnabled()) {
038            LOG.debug("Staging validation for: "+getClass().getName()+" for event "+event.getClass().getName());
039        }
040        populateParametersFromEvent(event);
041
042        Collection<String> currentRouteLevels = new ArrayList<String>();
043        try {
044            WorkflowDocument workflowDoc = event.getDocument().getDocumentHeader().getWorkflowDocument();
045            currentRouteLevels = workflowDoc.getNodeNames();
046            for(String nodeName : validRouteNodeNames) {
047                if (currentRouteLevels.contains(nodeName) && workflowDoc.isApprovalRequested()) {
048                    return validate(event);
049                }
050            }
051
052        }
053        catch (Exception e) {
054            throw new RuntimeException(e);
055        }
056
057        return valid;
058
059
060    }
061
062
063
064
065
066    public void setValidRouteNodeNames(List<String> validRouteNodeNames) {
067        this.validRouteNodeNames = validRouteNodeNames;
068    }
069
070    /**
071     * @return list of valid route node names
072     */
073    public List<String> getValidRouteNodeNames() {
074        return validRouteNodeNames;
075    }
076
077
078
079
080
081}