com.helger.phive.api.execute.IValidationExecutionManager Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of phive-api Show documentation
phive - Philip Helger Integrative Validation Engine API
There is a newer version: 10.0.2
/*
 * Copyright (C) 2014-2024 Philip Helger (www.helger.com)
 * philip[at]helger[dot]com
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *         http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package com.helger.phive.api.execute;

import java.util.Locale;

import javax.annotation.Nonnull;
import javax.annotation.Nullable;

import com.helger.commons.state.EValidity;
import com.helger.phive.api.result.ValidationResultList;
import com.helger.phive.api.source.IValidationSource;

/**
 * Interface for an execution manager that applies a set of rules onto an object
 * to be validated (validation source).
 *
 * @author Philip Helger
 * @param 
 *        The validation source type to be used.
 */
public interface IValidationExecutionManager 
{
  /**
   * Perform a validation with all the contained executors and the system
   * default locale.
   *
   * @param aSource
   *        The source artefact to be validated. May not be null.
   *        contained executor a result is added to the result list.
   * @return The validation result list. Never null. For each
   *         contained executor a result is added to the result list.
   * @see #executeValidation(IValidationSource, ValidationResultList, Locale)
   */
  @Nonnull
  default ValidationResultList executeValidation (@Nonnull final SOURCETYPE aSource)
  {
    return executeValidation (aSource, (Locale) null);
  }

  /**
   * Perform a validation with all the contained executors.
   *
   * @param aSource
   *        The source artefact to be validated. May not be null.
   * @param aLocale
   *        Custom locale to use e.g. for error messages. May be
   *        null to use the system default locale.
   * @return The validation result list. Never null. For each
   *         contained executor a result is added to the result list.
   * @see #executeValidation(IValidationSource, ValidationResultList, Locale)
   */
  @Nonnull
  default ValidationResultList executeValidation (@Nonnull final SOURCETYPE aSource, @Nullable final Locale aLocale)
  {
    final ValidationResultList ret = new ValidationResultList ();
    executeValidation (aSource, ret, aLocale);
    return ret;
  }

  /**
   * Perform a validation with all the contained executors.
   *
   * @param aSource
   *        The source artefact to be validated. May not be null.
   * @param aValidationResults
   *        The result list to be filled. May not be null. Note:
   *        this list is NOT altered before start. For each contained executor a
   *        result is added to the result list.
   * @param aLocale
   *        Custom locale to use e.g. for error messages. May be
   *        null to use the system default locale.
   * @see #executeValidation(IValidationSource, Locale)
   */
  void executeValidation (@Nonnull SOURCETYPE aSource, @Nonnull ValidationResultList aValidationResults, @Nullable Locale aLocale);

  /**
   * Perform a fast validation that stops on the first error.
   *
   * @param aSource
   *        The source artefact to be validated. May not be null.
   * @return {@link EValidity#VALID} if the document is valid,
   *         {@link EValidity#INVALID} if the document is invalid. Never
   *         null.
   */
  @Nonnull
  EValidity executeFastValidation (@Nonnull SOURCETYPE aSource);
}