ICatalogEdit Class Reference

Provides access to members for editing a Catalog. More...

#include <gdb_catalog.h>

Inheritance diagram for ICatalogEdit:

Public Member Functions
virtual GDBResult SDK_CALLTYPE	StartEditing ()=0 throw ()
	Starts editing the catalog.
virtual GDBResult SDK_CALLTYPE	StopEditing (bool save_edits, sdk::base::ISDKResource *resource)=0 throw ()
	Stops editing the catalog. More...
virtual GDBResult SDK_CALLTYPE	IsBeingEdited () const =0 throw ()
	Indicates if the catalog is being edited.
virtual GDBResult SDK_CALLTYPE	CreateCatalogEntry (ICatalogEntry **entry)=0 throw ()
	Creates catalog entry. More...
virtual GDBResult SDK_CALLTYPE	AddCatalogEntry (const CatalogEntryKey *entry_key, ICatalogEntry *entry)=0 throw ()
	Adds or replaces a catalog entry. More...
virtual GDBResult SDK_CALLTYPE	DeleteEntry (const CatalogEntryKey *entry_key)=0 throw ()
	Deletes a catalog entry specified by the entry identifier. More...
virtual GDBResult SDK_CALLTYPE	SetCatalogProperty (CatalogPropertyID id, const SDKAny *value)=0 throw ()
	Sets the value of the specified property. More...
Public Member Functions inherited from ISDKComponent
virtual SDKAtomicRefCount SDK_CALLTYPE	AddRef () const =0 throw ()
	Increments the reference count for an interface on a component.
virtual SDKAtomicRefCount SDK_CALLTYPE	Release () const =0 throw ()
	Decrements the reference count for an interface on a component.
virtual SDKResult SDK_CALLTYPE	GetInterface (const InterfaceId &id, void **obj_ptr)=0 throw ()
	Returns pointers to the supported interfaces on a component.
template<typename _Itf >
SDKResult	GetInterface (_Itf **obj_ptr) throw ()
	Returns pointers to the supported interfaces on a component.

Detailed Description

Provides access to members for editing a Catalog.

Member Function Documentation

StopEditing()

virtual GDBResult SDK_CALLTYPE StopEditing ( bool  save_edits, sdk::base::ISDKResource *  resource  ) throw ( )

pure virtual

Stops editing the catalog.

Parameters

[in]	save_edits	Controls if edits are saved or discarded.
[in]	resource	An optional reference to the resource to save to.

CreateCatalogEntry()

virtual GDBResult SDK_CALLTYPE CreateCatalogEntry ( ICatalogEntry **  entry ) throw ( )

pure virtual

Creates catalog entry.

Parameters

[out]

entry

A pointer to the empty catalog entry instance.

Returns

kSDKResult_Succeeded

kSDKResult_NotImplemented

kSDKResult_Failed

AddCatalogEntry()

virtual GDBResult SDK_CALLTYPE AddCatalogEntry ( const CatalogEntryKey *  entry_key, ICatalogEntry *  entry  ) throw ( )

pure virtual

Adds or replaces a catalog entry.

Parameters

[in]	entry_key	Pointer to the CatalogEntryKey for the new entry.
[in]	entry	Pointer to the catalog entry instance.

Returns

kSDKResult_Succeeded

kSDKResult_NotImplemented

kSDKResult_Failed

DeleteEntry()

virtual GDBResult SDK_CALLTYPE DeleteEntry ( const CatalogEntryKey *  entry_key ) throw ( )

pure virtual

Deletes a catalog entry specified by the entry identifier.

Parameters

[out]

entry_key

Pointer to the entry identifier.

Returns

kSDKResult_Succeeded

kSDKResult_NotImplemented

kSDKResult_NotExist

SetCatalogProperty()

virtual GDBResult SDK_CALLTYPE SetCatalogProperty ( CatalogPropertyID  id, const SDKAny *  value  ) throw ( )

pure virtual

Sets the value of the specified property.

Parameters

[in]	id	A catalog property id.
[in]	value	Pointer to the value of a specified property.

Returns

kSDKResult_Succeeded

kSDKResult_NotImplemented

kSDKResult_Failed

---

The documentation for this class was generated from the following file:

• gdb_catalog.h