/////////////////////////////////////////////////////////////////////////////// 
// 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_WHERE_RULES_ENTITIES_VALIDATION_TASK_H
#define _DAI_WHERE_RULES_ENTITIES_VALIDATION_TASK_H

#include "daiInstanceValidationTask.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 class that implements checking of Where-Rule constraints of Entity type for an application instance.
  Validation algorithm assumes that during iteration through entities of the application instance, all Where-Rule constraints defined in the entity data type are checked.
  */
  class DAI_EXPORT WhereRulesEntitiesValidationTask : public InstanceValidationTask
  {
    //DOM-IGNORE-BEGIN
    ODRX_VALIDATION_DECLARE_MEMBERS(WhereRulesEntitiesValidationTask);
    //DOM-IGNORE-END

  public:

    /** \details
    Checks whether a specified entity instance attributes meet Where-Rule constraints of the Defined type attribute.
    \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 the method execution this object contains the list of Where-Rule constraints which are violated by the specified entity instance.
    \returns 
    * <link OdDAI::Logical::True, True> if the validation is passed. It means that there is no violated Where-Rule constraints within a specified application instance. 
    * <link OdDAI::Logical::False, False> if at least one Where-Rule constraint is violated within the specified application instance.
    * <link OdDAI::Logical::Unknown, Unknown> if the expression of one or more Where-Rule constraints are unknown or are not defined.
    */
    virtual OdDAI::Logical validate(OdDAI::InstanceValidationContext* pInstanceCtx, OdSharedPtr<InvalidValidationParamsBase>& invalidParams) final;
    
    /** \details
    Retrieves the description of the validation task.
    \returns An <exref target="../tkernel_api_cpp/OdAnsiString.html">ANSI string</exref> that contains the description of the validation task.
    */
    virtual OdAnsiString description() const final;

  private:
    OdDAI::Logical checkWhereRules(OdDAI::ApplicationInstance* pInstance, OdDAI::Entity* pEntity, OdArray<WhereRule*>& invalidWhereRules);
  };
  
  /** \details
  A data type that represents a smart pointer to an <link OdDAI::WhereRulesEntitiesValidationTask, WhereRulesEntitiesValidationTask> object.
  */
  typedef OdSmartPtr<WhereRulesEntitiesValidationTask> WhereRulesEntitiesValidationTaskPtr;
}

#include "TD_PackPop.h"

#endif //_DAI_WHERE_RULES_ENTITIES_VALIDATION_TASK_H