ICreateIndexPageEntryCmdData Class Reference

#include <ICreateIndexPageEntryCmdData.h>

Inheritance diagram for ICreateIndexPageEntryCmdData:

Public Types
enum	{ kDefaultIID = IID_ICREATEINDEXPAGEENTRYCMDDATA }

Public Member Functions
virtual const UIDRef &	GetTopicListUIDRef () const =0
virtual void	SetTopicListUIDRef (const UIDRef &topicListUID)=0
virtual const IndexTopicEntry &	GetTopicEntry () const =0
virtual void	SetTopicEntry (const IndexTopicEntry &topicEntry)=0
virtual const UID	GetTopicSectionUID () const =0
virtual void	SetTopicSectionUID (const UID topicSectionUID)=0
virtual int32	GetTopicNodeId () const =0
virtual void	SetTopicNodeId (int32 indexTopicNodeId)=0
virtual bool16	GetDoNotifyFlag () const =0
virtual void	SetDoNotifyFlag (bool16 notify)=0
virtual bool16	GetSortPRefs () const =0
virtual void	SetSortPRefs (bool16 bSortPRefs)=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

Interface data for creating an index page entry.

Member Function Documentation

virtual bool16 ICreateIndexPageEntryCmdData::GetDoNotifyFlag ( ) const

pure virtual

Gets the notification flag's value.

Returns

the value of the notify flag.

virtual bool16 ICreateIndexPageEntryCmdData::GetSortPRefs ( ) const

pure virtual

Gets the sort flag value (if the page references should be sorted).

Returns

the value of the sort flag.

virtual const IndexTopicEntry& ICreateIndexPageEntryCmdData::GetTopicEntry ( ) const

pure virtual

Gets the IndexTopicEntry.

Returns

the IndexTopicEntry.

virtual const UIDRef& ICreateIndexPageEntryCmdData::GetTopicListUIDRef ( ) const

pure virtual

Gets the target topic list UIDRef.

Returns

the UIDRef of the topic list

virtual int32 ICreateIndexPageEntryCmdData::GetTopicNodeId ( ) const

pure virtual

Gets the topic node id.

Returns

the id of the topic node.

virtual const UID ICreateIndexPageEntryCmdData::GetTopicSectionUID ( ) const

pure virtual

Gets the topic section UID.

Returns

the UID of the topic section.

virtual void ICreateIndexPageEntryCmdData::SetDoNotifyFlag ( bool16  notify )

pure virtual

Sets the notification flag's value. [IN] - the value of the notify flag.

virtual void ICreateIndexPageEntryCmdData::SetSortPRefs ( bool16  bSortPRefs )

pure virtual

Sets the sort flag value (if the page references should be sorted). [IN] - the value of the sort flag.

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

pure virtual

Sets the IndexTopicEntry.

Parameters

topicEntry

[IN] - the IndexTopicEntry data.

virtual void ICreateIndexPageEntryCmdData::SetTopicListUIDRef ( const UIDRef &  topicListUID )

pure virtual

Sets the target topic list UIDRef.

Parameters

topicListUID

[IN] - the UIDRef of the topic list.

virtual void ICreateIndexPageEntryCmdData::SetTopicNodeId ( int32  indexTopicNodeId )

pure virtual

Sets the topic node id.

Parameters

indexTopicNodeId

[IN] - the id of the topic node.

virtual void ICreateIndexPageEntryCmdData::SetTopicSectionUID ( const UID  topicSectionUID )

pure virtual

Sets the topic section UID.

Parameters

topicSectionUID

[IN] - the UID of the topic section.