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

#include "NwSavedFolderItem.h"

/** \details
  This class represents a simple folder of selection sets.

  <group OdNw_Classes>
*/
class NWDBEXPORT OdNwSavedFolderSetItem : public OdNwSavedFolderItem
{
  //DOM-IGNORE-BEGIN
  ODRX_DECLARE_MEMBERS(OdNwSavedFolderSetItem);
  //DOM-IGNORE-END

public:
  /** \details
    Default constructor. Creates a new object of the OdNwSavedFolderSetItem
    class.
  */
  OdNwSavedFolderSetItem();

public:
  /** \details
    Virtual destructor. Frees allocated resources.
  */
  virtual ~OdNwSavedFolderSetItem();

public:
  /** \details
    Adds saved folder item.
    \param name               [in] Name of saved set folder item.
    \param pRes               [out] Receives eOk if the appending operation is successful, or an appropriate error code otherwise.
    \returns OdNwObjectId with an OdNwSavedFolderSetItem object.
  */
  OdNwObjectId addItemFolder(const OdString& sName, OdResult* pRes = NULL);

  /** \details
    Adds seletion sets item with explicit selection.
    \param name               [in] Name of selection set.
    \param aExplicitSelection [in] List of object id of OdNwModelItem.
    \param pRes               [out] Receives eOk if the appending operation is successful, or an appropriate error code otherwise.
    \returns OdNwObjectId with an OdNwSelectionSetItem object.
    \remarks
       Adding selection sets item with type NwSelectionSetItemType::PATHLINK.
  */
  OdNwObjectId addItemExplicit(const OdString& name, OdNwObjectIdArray&& aExplicitSelection, OdResult* pRes = NULL);
};

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

#endif //__TNW_SAVEDFOLDERSETITEM_H__