/////////////////////////////////////////////////////////////////////////////// 
// 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_SAVEDITEMSELEMENT_H_
#define _NW_SAVEDITEMSELEMENT_H_

#include "NwExport.h"
#include "NwObject.h"

class OdNwSavedItem;

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

/** \details
  This class represents geometry.

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

public:
  /** \details
    Default constructor. Creates a new OdNwSavedItemsElement object.
  */
  OdNwSavedItemsElement();

protected:
  /** \details
    Constructor for objects of the OdNwSavedItemsElement class. Creates a new
    OdNwSavedItemsElement object for the specified item.

    \param pImpl [in] Item to create an OdNwSavedItemsElement object for.
  */
  explicit OdNwSavedItemsElement(OdNwObjectImpl* pImpl);

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

public:
  /** \details
    Gets an array of object IDs of OdNwSavedItemPtr objects.

    \param aSavedItems [out] OdArray with object IDs of OdNwSavedItemPtr objects.

    \returns eOk if successful, or an appropriate error code otherwise.
  */
  OdResult getSavedItems(OdNwObjectIdArray& aSavedItems) const;
  
  /** \details
    Returns a smart pointer to the OdNwSavedItemPtr object.

    \param streamName [in] Name of the stream.
    \param savedItemPath [in] Path to saved item element.
    \param res [out] Receives eOk if the appending operation is successful, or appropriate error code
    otherwise.

    \returns Smart pointer to the OdNwSavedItemPtr object if resolving successful, or empty objects otherwise.
  */
  OdNwSavedItemPtr resolveReference(OdString streamName, OdString savedItemPath, OdResult& res);

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

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

#endif // _NW_SAVEDITEMSELEMENT_H_