Inheritance diagram for Facade::IArticleFacade:

Public Types
enum	{ kDefaultIID = IID_IARTICLEFACADE }

Public Member Functions
virtual UID	CreateArticle (IDataBase *database, const PMString &name)=0

virtual ErrorCode	AddArticle (const UIDList &articleList, int32 pos=-1)=0

virtual UID	CreateAndAddArticle (IDataBase *database, const PMString &name, int32 pos=-1)=0

virtual ErrorCode	RemoveArticles (const UIDList &articleList)=0

virtual ErrorCode	DeleteArticle (const UIDList &articleList)=0

virtual ErrorCode	MoveArticles (const UIDList &articleList, int32 toPos)=0

virtual ErrorCode	SetArticleName (const UIDRef &article, const PMString &name)=0

virtual ErrorCode	SetArticleExportStatus (const UIDList &articleList, bool16 useForExport)=0

virtual ErrorCode	AddMembers (const UIDRef &article, const UIDList &memberList, int32 pos=-1)=0

virtual ErrorCode	AutoPopulateArticle (const UIDList &articleList)=0

virtual ErrorCode	RemoveMembers (const UIDRef &article, const UIDList &memberList)=0

virtual ErrorCode	MoveMembers (const UIDRef &article, const UIDList &memberList, int32 toPos=-1)=0

virtual ErrorCode	AddChildren (const UIDRef &group, const UIDList &childList, int32 pos=-1)=0

virtual ErrorCode	RemoveChildren (const UIDRef &group, const UIDList &childList)=0

virtual ErrorCode	MoveChildren (const UIDRef &group, const UIDList &childList, int32 toPos=-1)=0

Public Member Functions inherited from IPMUnknown
virtual IPMUnknown *	QueryInterface (PMIID interfaceID) const =0

virtual void	AddRef () const =0

virtual void	Release () const =0

Member Function Documentation

virtual ErrorCode Facade::IArticleFacade::AddArticle	(	const UIDList &	articleList,
		int32	pos = `-1`
	)

pure virtual

Add Article(s) to a document at the specified position.

Parameters

articleList	IN the UIDList of Articles to be added.
pos	IN 0 based position at which to add the Articles. Specify -1 to add to the end.

Returns: kSuccess if the Article was successfully added, else an error code.

virtual ErrorCode Facade::IArticleFacade::AddChildren	(	const UIDRef &	group,
		const UIDList &	childList,
		int32	pos = `-1`
	)

pure virtual

Add children at the specified position in a Group.

Parameters

group	IN the group to which the children need to be added.
childList	IN the children that need to be added.
pos	IN 0 based position at which to add the children. Specify -1 to add to the end.

Returns: kSuccess if the children were successfully added, else an error code.

virtual ErrorCode Facade::IArticleFacade::AddMembers	(	const UIDRef &	article,
		const UIDList &	memberList,
		int32	pos = `-1`
	)

pure virtual

Add members to an Article at the specified position.

Parameters

article	IN The article to which members need to be added.
memberList	IN The ordered list of members that need to be added.
pos	IN 0 based starting position at which the members will be added. Specify -1 to add to the end.

Returns: kSuccess if the members were successfully added, else an error code.

virtual ErrorCode Facade::IArticleFacade::AutoPopulateArticle ( const UIDList & articleList )

pure virtual

Utility method to Auto Populate Articles with page items of the entire document.

Parameters

articleList IN the articles which need to be auto-populated.

Returns: kSuccess if the members were successfully added, else an error code.

virtual UID Facade::IArticleFacade::CreateAndAddArticle	(	IDataBase *	database,
		const PMString &	name,
		int32	pos = `-1`
	)

pure virtual

Create and Add an Article to the document.

Parameters

database	IN the database in which the Article is created and added.
name	IN The name of the Article.
pos	IN 0 based position at which to add the Articles. Specify -1 to add to the end.

Returns: UID of the added Article.

virtual UID Facade::IArticleFacade::CreateArticle	(	IDataBase *	database,
		const PMString &	name
	)

pure virtual

Create an Article with the specified name. Does not add it to the document.

Parameters

database	IN the database in which the Article is created.
name	IN The name of the Article.

Returns: UID of the created Article.

virtual ErrorCode Facade::IArticleFacade::DeleteArticle ( const UIDList & articleList )

pure virtual

Delete Articles from a Document.

Parameters

articleList IN The UIDList of Articles to be deleted.

Returns: kSuccess if the Articles were successfully deleted, else an error code.

virtual ErrorCode Facade::IArticleFacade::MoveArticles	(	const UIDList &	articleList,
		int32	toPos
	)

pure virtual

Move Articles to new position within the same document.

Parameters

articleList	IN The UIDList of Articles to be moved.
toPos	IN 0 based starting position at which the Articles will be moved.

Returns: kSuccess if the Articles were successfully moved, else an error code.

virtual ErrorCode Facade::IArticleFacade::MoveChildren	(	const UIDRef &	group,
		const UIDList &	childList,
		int32	toPos = `-1`
	)

pure virtual

Move children within a Group.

Parameters

group	IN the group in which the children need to be moved.
childList	IN the ordered list of children that need to be moved.
pos	IN 0 based position at which to move the children. Specify -1 to move to the end.

Returns: kSuccess if the children were successfully moved, else an error code.

virtual ErrorCode Facade::IArticleFacade::MoveMembers	(	const UIDRef &	article,
		const UIDList &	memberList,
		int32	toPos = `-1`
	)

pure virtual

Move members to new position within the same Article.

Parameters

memberList	IN The members that need to be moved.
toPos	IN 0 based starting position at which the members will be moved. Specify -1 to move to the end.

Returns: kSuccess if the members were successfully moved, else an error code.

virtual ErrorCode Facade::IArticleFacade::RemoveArticles ( const UIDList & articleList )

pure virtual

Remove Articles from a Document. Does not delete the Articles.

Parameters

articleList IN The UIDList of Articles to be removed.

Returns: kSuccess if the Articles were successfully removed, else an error code.

virtual ErrorCode Facade::IArticleFacade::RemoveChildren	(	const UIDRef &	group,
		const UIDList &	childList
	)

pure virtual

Remove children from a Group.

Parameters

group	IN the group from which the children need to be removed.
childList	IN the children that need to be removed.

Returns: kSuccess if the children were successfully removed, else an error code.

virtual ErrorCode Facade::IArticleFacade::RemoveMembers	(	const UIDRef &	article,
		const UIDList &	memberList
	)

pure virtual

Remove members from an Article.

Parameters

article	IN The article from which the members need to be removed.
memberList	IN The list of members that need to be removed.

Returns: kSuccess if the members were successfully removed, else an error code.

virtual ErrorCode Facade::IArticleFacade::SetArticleExportStatus	(	const UIDList &	articleList,
		bool16	useForExport
	)

pure virtual

Set the export status of an Article.

Parameters

articleList	IN The UIDList of Articles whose export status needs to be changed.
useForExport	IN ktrue if the articles should be used for export, kFalse otherwise.

Returns: kSuccess if the Articles export status were successfully changed, else an error code.

virtual ErrorCode Facade::IArticleFacade::SetArticleName	(	const UIDRef &	article,
		const PMString &	name
	)

pure virtual

Set the name of an Article.

Parameters

articleList	IN The UIDList of Articles to be moved.
name	IN The name of the Article.

Returns: kSuccess if the Article was successfully named, else an error code.

Public Types

Public Member Functions

Member Function Documentation