/////////////////////////////////////////////////////////////////////////////// 
// 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_SESSION_VALIDATION_NOTIFIER_H
#define _DAI_SESSION_VALIDATION_NOTIFIER_H

#include "daiValidationNotifier.h"
#include "daiSession.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 provides functionality for  notification of a <link OdDAI::Session, session object> about validation task status.
  */
  class DAI_EXPORT SessionValidationNotifier : public ValidationNotifier
  {
    //DOM-IGNORE-BEGIN
    ODRX_DECLARE_MEMBERS(SessionValidationNotifier);
    //DOM-IGNORE-END

  public:

    /** \details
    Creates a new object for validation task status notifications for a specified <link OdDAI::Session, session>.
    \param session [in] A raw pointer to the <link OdDAI::Session, session> object.
    \returns A smart pointer to the created notifier object.
    */
    static OdSmartPtr<SessionValidationNotifier> createObject(Session* session);

    /** \details
    Sends a notification with specific validation information to the associated <link OdDAI::Session, session>.
    \param instanceId     [in] An <link OdDAIObjectId, OdDAI object identifier> of the entity instance that is being validated.
    \param validationTask [in] A smart pointer to the <link OdDAI::ValidationTask, validation task> object.
    \param invalidParams  [in] A shared pointer to the <link OdDAI::ValidationTask::InvalidValidationParamsBase, InvalidValidationParamsBase> instance 
                               that contains an array of pointers to instances that do not pass the validation check.
    \param result         [in] A validation check <link OdDAI::Logical, result>.
    */
    void onValidationResult(OdDAIObjectId instanceId, ValidationTaskPtr validationTask, OdSharedPtr<ValidationTask::InvalidValidationParamsBase> invalidParams, Logical result) final;
    
    /** \details
    Sends a notification with specific validation information to the associated <link OdDAI::Session, session>.
    \param validationTask [in] A smart pointer to the <link OdDAI::ValidationTask, validation task> object.
    \param invalidObjects [in] An array of <link OdDAIObjectId, OdDAI object identifiers> of the entity instances that do not pass the validation check.
    \param result         [in] A validation check <link OdDAI::Logical, result>.
    */
    void onValidationResult(ValidationTaskPtr validationTask, const OdDAIObjectIds& invalidObjects, Logical result) final;

    /** \details
    Sets a new <link OdDAI::Session, session> object for the validation notifier instance.
    \param session [in] A raw pointer to the <link OdDAI::Session, session> object to be associated with the validation notifier instance.
    */
    void setSession(Session* session);

  private:
    SessionPtr m_session;
  };

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

#include "TD_PackPop.h"

#endif //_DAI_SESSION_VALIDATION_NOTIFIER_H