/////////////////////////////////////////////////////////////////////////////// 
// Copyright (C) 2002-2025, Open Design Alliance (the "Alliance"). 
// All rights reserved. 
// 
// This software and its documentation and related materials are owned by 
// the Alliance. The software may only be incorporated into application 
// programs owned by members of the Alliance, subject to a signed 
// Membership Agreement and Supplemental Software License Agreement with the
// Alliance. The structure and organization of this software are the valuable  
// trade secrets of the Alliance and its suppliers. The software is also 
// protected by copyright law and international treaty provisions. Application  
// programs incorporating this software must include the following statement 
// with their copyright notices:
//   
//   This application incorporates Open Design Alliance software pursuant to a license 
//   agreement with Open Design Alliance.
//   Open Design Alliance Copyright (C) 2002-2025 by Open Design Alliance. 
//   All rights reserved.
//
// By use of this software, its documentation or related materials, you 
// acknowledge and accept the above terms.
///////////////////////////////////////////////////////////////////////////////

#ifndef  _DAI_MODEL_VALIDATION_TASK_H
#define _DAI_MODEL_VALIDATION_TASK_H

#include "daiValidationTask.h"
#include "daiModel.h"

#include "TD_PackPush.h"

/** \details
Implements the Data Access Interface (DAI) that provides functionality for manipulating data that is defined within the EXPRESS SCHEMA format.
*/
namespace OdDAI
{
  /** \details
  A base class that implements a model validation task.
  */
  class DAI_EXPORT ModelValidationTask : public ValidationTask
  {
    //DOM-IGNORE-BEGIN
    ODRX_DECLARE_MEMBERS(ModelValidationTask);
    //DOM-IGNORE-END

  public:

    /** \details
    Checks constraints within a specified model and forms a list of the model's instances that violate any of the constraints.
    \param pCtx     [in] A raw pointer to the <link OdDAI::ValidationContext, validation context> object that contains the model to be validated.
    \param invalidParams [out] A shared pointer to an <link OdDAI::ValidationTask::InvalidValidationParamsBase, InvalidValidationParamsBase> object. 
                               After method execution, this object contains a list of the model's instances that violate constraints.
    \returns 
    * <link OdDAI::Logical::True, True> if the validation passes. This means that all constraints within the model are met.
    * <link OdDAI::Logical::False, False> if any constraint within the model is violated.
    * <link OdDAI::Logical::Unknown, Unknown> if the expression of one or more of the model's constraints are unknown or are not defined.
    */
    virtual Logical validate(OdDAI::ValidationContext* pCtx, OdSharedPtr<InvalidValidationParamsBase>& invalidParams) = 0;
  };
  
  /** \details
  A data type that represents a smart pointer to an <link OdDAI::ModelValidationTask, ModelValidationTask> object.
  */
  typedef OdSmartPtr<ModelValidationTask> ModelValidationTaskPtr;
}

#include "TD_PackPop.h"

#endif //_DAI_MODEL_VALIDATION_TASK_H