/////////////////////////////////////////////////////////////////////////////// 
// 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_INSTANCE_VALIDATION_TASK_H
#define _DAI_INSTANCE_VALIDATION_TASK_H

#include "daiValidationTask.h"
#include "daiApplicationInstance.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 the validation of instances.
  */
  class DAI_EXPORT InstanceValidationTask : public ValidationTask
  {
    //DOM-IGNORE-BEGIN
    ODRX_DECLARE_MEMBERS(InstanceValidationTask);
    //DOM-IGNORE-END

  public:

    /** \details
    Checks whether attributes of the specified instance meet specified rules and forms a list of attributes that violate any of the rules.
    \param pInstanceCtx   [in] A raw pointer to the <link OdDAI::InstanceValidationContext, instance validation context> object that contains an entity instance 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 constraints that are violated and a list of attributes that violate constraints.
    \returns
    * <link OdDAI::Logical::True, True> if the validation passes.
    * <link OdDAI::Logical::False, False> if any constraint is violated.
    * <link OdDAI::Logical::Unknown, Unknown> if the constraint expression is unknown or is not defined.
    */
    virtual OdDAI::Logical validate(OdDAI::InstanceValidationContext* pInstanceCtx, OdSharedPtr<InvalidValidationParamsBase>& invalidParams) = 0;
  };

  /** \details
  A data type that represents a smart pointer to an <link OdDAI::InstanceValidationTask, InstanceValidationTask> object.
  */
  typedef OdSmartPtr<InstanceValidationTask> InstanceValidationTaskPtr;
}

#include "TD_PackPop.h"

#endif //_DAI_INSTANCE_VALIDATION_TASKS_H