com.imsweb.validation.internal.Processor Maven / Gradle / Ivy

Go to download
/*
 * Copyright (C) 2004 Information Management Services, Inc.
 */
package com.imsweb.validation.internal;

import java.util.Collection;

import com.imsweb.validation.ValidatingContext;
import com.imsweb.validation.ValidationException;
import com.imsweb.validation.entities.RuleFailure;
import com.imsweb.validation.entities.Validatable;

/**
 * A Processor is responsible for running the edits on a given Validatable.
 * 
 * It is very similar to a Validator, but unlike it, it is structured to be used internally by the validation engine.
 * 

 * Created on Apr 26, 2011 by depryf
 * @author depryf
 */
public interface Processor {

    /**
     * Calculates the edits on the passed validatable object
     * 
     * Created on Nov 15, 2007 by depryf
     * @param validatable the Validatable to process
     * @param procCtx a processing context
     * @return a collection of RuleFailure, maybe empty but never null
     * @throws ValidationException
     */
    Collection process(Validatable validatable, ValidatingContext procCtx) throws ValidationException;
}