ICreateTopicEntryCmdData Class Reference

#include <ICreateTopicEntryCmdData.h>

Inheritance diagram for ICreateTopicEntryCmdData:

Public Types
enum	{ kDefaultIID = IID_ICREATETOPICENTRYCMDDATA }

Public Member Functions
virtual const UIDRef &	GetTopicListUIDRef () const =0
virtual void	SetTopicListUIDRef (const UIDRef &topicListUIDRef)=0
virtual const IndexTopicEntry &	GetTopicEntry () const =0
virtual void	SetTopicEntry (const IndexTopicEntry &topicEntry)=0
virtual bool16	GetDoNotifyFlag () const =0
virtual void	SetDoNotifyFlag (bool16 notify)=0
virtual const UID	GetTopicSectionUID () const =0
virtual const int32	GetTopicNodeId () const =0
virtual void	SetTopicSectionUID (const UID sectionUID)=0
virtual void	SetTopicNodeId (const int32 nodeId)=0
Public Member Functions inherited from IPMUnknown
virtual IPMUnknown *	QueryInterface (PMIID interfaceID) const =0
virtual void	AddRef () const =0
virtual void	Release () const =0

Detailed Description

Command data interface used for creating a topic entry.

Member Function Documentation

virtual bool16 ICreateTopicEntryCmdData::GetDoNotifyFlag ( ) const

pure virtual

Retrieves the "notify" flag.

Returns

the value of the flag.

virtual const IndexTopicEntry& ICreateTopicEntryCmdData::GetTopicEntry ( ) const

pure virtual

Retrieves the topic entry property.

See Also

IndexTopicEntry.

Returns

the topic entry property.

virtual const UIDRef& ICreateTopicEntryCmdData::GetTopicListUIDRef ( ) const

pure virtual

Retrieves the topic list property.

Returns

UIDRef of the topic list.

virtual const int32 ICreateTopicEntryCmdData::GetTopicNodeId ( ) const

pure virtual

Retrieves the node id of the created topic. This method can be called by the client of the command only after the command is done.

Returns

the node id of the topic.

virtual const UID ICreateTopicEntryCmdData::GetTopicSectionUID ( ) const

pure virtual

Retrieves the topic section where the entry was created. This method can be called by the client of the command only after the command is done.

Returns

UID

virtual void ICreateTopicEntryCmdData::SetDoNotifyFlag ( bool16  notify )

pure virtual

Sets the "notify" flag.

Parameters

notify

[IN] - value of the flag.

virtual void ICreateTopicEntryCmdData::SetTopicEntry ( const IndexTopicEntry &  topicEntry )

pure virtual

Sets the topic entry property.

Parameters

topicEntry

[IN] - the topic entry that needs to be created.

virtual void ICreateTopicEntryCmdData::SetTopicListUIDRef ( const UIDRef &  topicListUIDRef )

pure virtual

Sets the topic list property.

Parameters

topicListUIDRef

[IN] - UIDRef of the topic list.

virtual void ICreateTopicEntryCmdData::SetTopicNodeId ( const int32  nodeId )

pure virtual

Sets the topic node id of the created topic. This method should be called only by the command itself.

Parameters

nodeId

[IN] - the topic node id.

virtual void ICreateTopicEntryCmdData::SetTopicSectionUID ( const UID  sectionUID )

pure virtual

Sets the topic section UID of the created topic. This method should be called only by the command itself.

Parameters

sectionUID

[IN] - the UID of the topic section.