/////////////////////////////////////////////////////////////////////////////// 
// 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_HEADER_SECTION_VALIDATION_TASK_H
#define _DAI_HEADER_SECTION_VALIDATION_TASK_H

#include "daiModelValidationTask.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 attributes of Header Entities within Header Section.
  */
  class DAI_EXPORT HeaderSectionValidationTask : public ModelValidationTask
  {
    //DOM-IGNORE-BEGIN
    ODRX_VALIDATION_DECLARE_MEMBERS(HeaderSectionValidationTask);
    //DOM-IGNORE-END

    /** \details
    Validates attributes of Header Entity, checks unset attributes and invalid string width.
    \param pHeaderEntity    [in] A pointer to the Header Entity to be validated.
    \param invalidInstances [out] A pointer to an InvalidRxArrayValidationParams. After method execution, it contains a list of global rules that are violated.
    \returns true only if all validations were executed.
    */
    bool headerEntityValidation(ApplicationInstancePtr pHeaderEntity, InvalidRxArrayValidationParams* invalidInstances);

  public:

    /** \details
    Checks a model's Header Section and forms a list of violated rules.
    \param pCtx          [in] A raw pointer to the <link OdDAI::ValidationContext, validation context> object that contains a model to be validated.
    \param invalidParams [out] A shared pointer to an <link OdDAI::ValidationTask::InvalidValidationParamsBase, InvalidValidationParamsBase> object.
                                  After method execution, it contains a list of global rules that are violated.
    \returns
    * <link OdDAI::Logical::True, True> if the validation passes.
    * <link OdDAI::Logical::False, False> if any global rule constraint is violated.
    * <link OdDAI::Logical::Unknown, Unknown> if the constraint expression is unknown or is not defined.
    */
    Logical validate(ValidationContext* pCtx, 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::HeaderSectionValidationTask, HeaderSectionValidationTask> object.
  */
  typedef OdSmartPtr<HeaderSectionValidationTask> HeaderSectionValidationTaskPtr;
}

#include "TD_PackPop.h"

#endif // !_DAI_HEADER_SECTION_VALIDATION_TASK_H