/////////////////////////////////////////////////////////////////////////////// 
// 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_VALIDATION_HEALER_H
#define _DAI_VALIDATION_HEALER_H

#include "OdaCommon.h"
#include "daiBuildOptions.h"
#include "RxObject.h"
#include "daiLogicalType.h"
#include "daiValidationTask.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
  An abstract class that describes the interface for a validation healer.
  */
  class DAI_EXPORT ValidationHealer : public OdRxObject
  {
    //DOM-IGNORE-BEGIN
    ODRX_DECLARE_MEMBERS(ValidationHealer);
    //DOM-IGNORE-END
  public:
    /** \details
    Performs an attempt to heal an instance that violates validation constraints. 
    \param model         [in] A raw pointer to the <link OdDAI::Model, model> object to heal.
    \param invalidParams [in] A shared pointer to an <link OdDAI::ValidationTask::InvalidValidationParamsBase, InvalidValidationParamsBase> object. 
                              After method execution, this object contains invalid instances.
    \returns 
    * <link OdDAI::Logical::True, True> if incorrectness is successfully healed.
    * <link OdDAI::Logical::False, False> if incorrectness  is not healed.
    */
    virtual Logical heal(OdDAI::Model* model, ValidationTask::InvalidValidationParamsBase* invalidParams) = 0;
  };
  /** \details
  A data type that represents a smart pointer to an <link OdDAI::ValidationHealer, ValidationHealer> object.
  */
  typedef OdSmartPtr<ValidationHealer> ValidationHealerPtr;
}

#include "TD_PackPop.h"

#endif // _DAI_VALIDATION_HEALER_H