///////////////////////////////////////////////////////////////////////////////
// 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 __NW_TIME_LINER_DATA_SOURCE_ITEM_H__
#define __NW_TIME_LINER_DATA_SOURCE_ITEM_H__

#include "NwSavedItem.h"

class OdNwTimeLinerField;

/** \details
  This template class is a specialization of the OdSmartPtr class for OdNwTimeLinerField object pointers.
*/
typedef OdSmartPtr<OdNwTimeLinerField> OdNwTimeLinerFieldPtr;
/**
 This class represents timeliner data source item.
 
 <group OdNw_Classes>
*/
class NWDBEXPORT OdNwTimeLinerDataSourceItem : public OdNwSavedItem
{
  //DOM-IGNORE-BEGIN
  ODRX_DECLARE_MEMBERS(OdNwTimeLinerDataSourceItem);
  //DOM-IGNORE-END
public:
  /** \details
    Default constructor.
  */
  OdNwTimeLinerDataSourceItem();

  /** \details
    Virtual destructor. Frees allocated resources.
  */
  virtual ~OdNwTimeLinerDataSourceItem();

  /** \details
    Returns the database provider ID.
   
    \returns Database provider ID as an OdString value.
  */
  OdString getProviderId() const;

  /** \details
    Returns the database provider name.
   
    \returns Database provider name as an OdString value.
  */
  OdString getProviderName() const;

  /** \details
    Returns the database provider version.
   
    \returns Version number as a double value.
  */
  double getProviderVersion() const;
  
  /** \details
   Returns the database synchronization time.
   
    \returns Time that tasks were last imported.
  */
  time_t getSyncTime() const;
  
  /** \details
    Returns the identifier that defines the project that is being linked to.
   
    \returns Project identifier as an OdString value.
  */
  OdString getProjectIdentifier() const;
  
  /** \details
    Returns the field that defines type of the task import.
   
    \returns OdNwTimeLinerFieldPtr defining task type field.
  */
  OdNwTimeLinerFieldPtr getTaskType() const;
  
  /** \details
    Returns the field that defines the display ID import.
   
    \returns OdNwTimeLinerFieldPtr definig the display ID import field.
  */
  OdNwTimeLinerFieldPtr getTaskSyncId() const;
  
  /** \details
    Returns the field that defines the planned start date import.
   
    \returns OdNwTimeLinerFieldPtr defining the planned start date import field.
  */
  OdNwTimeLinerFieldPtr getTaskPlannedStart() const;
  
  /** \details
    Returns the field that defines the planned end date import.
   
    \returns OdNwTimeLinerFieldPtr defining the planned end date import field.
  */
  OdNwTimeLinerFieldPtr getTaskPlannedEnd() const;
  
  /** \details
    Returns the field that defines the actual start date import.
   
    \returns OdNwTimeLinerFieldPtr defining the the actual start date import field.
  */
  OdNwTimeLinerFieldPtr getTaskActualStart() const;
  
  /** \details
    Returns the field that defines the actual end date import.
   
    \returns OdNwTimeLinerFieldPtr defining the the actual end date import field.
  */
  OdNwTimeLinerFieldPtr getTaskActualEnd() const;
  
  /** \details
    Returns the field that defines the material cost import.
   
    \returns OdNwTimeLinerFieldPtr defining the material cost import field.
  */
  OdNwTimeLinerFieldPtr getTaskMaterialCost() const;
  
  /** \details
    Returns the field that defines the labor cost import.
   
    \returns OdNwTimeLinerFieldPtr defining the labor cost import field.
  */
  OdNwTimeLinerFieldPtr getTaskLaborCost() const;
  
  /** \details
    Returns the field that defines the equipment cost import.
   
    \returns OdNwTimeLinerFieldPtr defining the equipment cost import field.
  */
  OdNwTimeLinerFieldPtr getTaskEquipmentCost() const;
  
  /** \details
    Returns the field that defines the subcontractor cost import.
   
    \returns OdNwTimeLinerFieldPtr defining the subcontractor cost import field.
  */
  OdNwTimeLinerFieldPtr getTaskSubcontractorCost() const;
  
  /** \details
    Returns the task name field.
   
    \returns Task name field as an OdString value.
  */
  OdString getCsvTaskNameName() const;

  /** \details
    Returns the display ID field.
   
    \returns Task display ID field as an OdString value.
  */
  OdString getCsvDisplayIdName() const;

  /** \details
    Returns the task name field index.
   
    \returns Task name field index as an OdString value.
  */
  OdString getCsvTaskNameIdx() const;

  /** \details
    Returns the display ID index field.
   
    \returns Task display ID field index as an OdString value.
  */
  OdString getCsvDisplayIdIdx() const;
  
  /** \details
    Indicates whether the first row in the CSV file contain the column names.
   
    \returns The true value if the first row contain the column names, or false otherwise.
  */
  bool getCsvUseRow1AsHeader() const;
  /** \details
    Indicates whether the user specified date format should be used.
   
    \returns The true value if the user specified date format should be used, or false otherwise.
  */
  bool getCsvUseUserDataTimeFormat() const;
  /** \details
    Returns the user specified date time format.
   
    \returns The user specified date time format as an OdString value.
  */
  OdString getCsvDateFormat() const;
  /** \details
    Returns the number of rows.
   
    \returns The number of rows as an integer value.
  */
  int getCsvNumRow() const;
};

/** \details
  This template class is a specialization of the OdSmartPtr class for OdNwTimeLinerDataSourceItem object pointers.
*/
typedef OdSmartPtr<OdNwTimeLinerDataSourceItem> OdNwTimeLinerDataSourceItemPtr;

#endif /* __NW_TIME_LINER_DATA_SOURCE_ITEM_H__ */