/////////////////////////////////////////////////////////////////////////////// 
// 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_REQUIRED_EXPLICIT_ATTRS_ASSIGNED_VALIDATION_TASK_H
#define _DAI_REQUIRED_EXPLICIT_ATTRS_ASSIGNED_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 checks whether all mandatory attributes are present in a specified application instance and their values are set.
  This validation checks whether any mandatory attributes have an unset value.
  */
  class DAI_EXPORT RequiredExplicitAttrsAssignedValidationTask : public InstanceValidationTask
  {
    //DOM-IGNORE-BEGIN
    ODRX_VALIDATION_DECLARE_MEMBERS(RequiredExplicitAttrsAssignedValidationTask);
    //DOM-IGNORE-END

  public:

    /** \details
    Checks whether a specified instance has mandatory attributes with unset values and forms a list of such attributes, if any.
    \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 the instance's mandatory attributes that have unset values.
    \returns
    * <link OdDAI::Logical::True, True> if the validation passes. This means that all the instance's mandatory attributes have a value.
    * <link OdDAI::Logical::False, False> if the value of at least one of the instance's mandatory attributes is not set.
    */
    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.
    */
    OdAnsiString description() const final;
  };

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

#include "TD_PackPop.h"

#endif //_DAI_REQUIRED_EXPLICIT_ATTRS_ASSIGNED_VALIDATION_TASK_H