IPreflightBookData Class Reference

#include <IPreflightBookData.h>

Inheritance diagram for IPreflightBookData:

Public Types
enum	{ kDefaultIID = IID_IPREFLIGHTBOOKDATA }

Public Member Functions
virtual void	SetBook (IBook *iBook)=0
virtual IBook *	QueryBook () const =0
virtual IPreflightBookOptions *	QueryOptions () const =0
virtual void	ClearData ()=0
virtual void	SetDataForContent (UID contentUID, IPreflightBookContentData *iData)=0
virtual IPreflightBookContentData *	QueryDataForContent (UID contentUID) const =0
virtual IPreflightBookContentData *	CreateDataForContent (UID contentUID)=0
virtual UID	FindContentByProcessID (uint32 processID) const =0
virtual void	GetContentList (UIDList &theList) const =0
virtual const IPreflightAggregatedResults *	CreateAggregatedResults (const UIDList *pList) const =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

This interface maintains the data/status for a particular book preflight operation.

See Also

IPreflightBookOptions for the options used for this preflight.

IPreflightBookController which is typically used to drive the process at a higher level.

Member Function Documentation

virtual void IPreflightBookData::ClearData ( )

pure virtual

Clear all of the data mapping.

virtual const IPreflightAggregatedResults* IPreflightBookData::CreateAggregatedResults ( const UIDList *  pList ) const

pure virtual

Create an aggregated version of the book preflight results.

Parameters

pList

IN If not nil, provides the content UIDs to generate results for (and the order). If nil, all chapters with results will be included.

Returns

A refcounted aggregated results, or nil if some kind of error occurs.

virtual IPreflightBookContentData* IPreflightBookData::CreateDataForContent ( UID  contentUID )

pure virtual

Create a new content data association for the book data. Erases any content already there. Note that this does an implicit SetDataForContent with the new data interface.

Parameters

contentUID

IN The book content UID you want to create an association for.

Returns

A refcounted content data interface, pre-associated to the book content.

virtual UID IPreflightBookData::FindContentByProcessID ( uint32  processID ) const

pure virtual

Find the content data with a given process ID.

Parameters

processID

IN The process ID you seek.

Returns

The UID of the content, or kInvalidUID if no such process was found.

virtual void IPreflightBookData::GetContentList ( UIDList &  theList ) const

pure virtual

Get the list of chapters/content for which we have mapping information.

Parameters

theList

OUT Receives the list. Cleared before filling.

virtual IBook* IPreflightBookData::QueryBook ( ) const

pure virtual

Get the book this preflight is associated with.

Returns

A refcounted book interface.

virtual IPreflightBookContentData* IPreflightBookData::QueryDataForContent ( UID  contentUID ) const

pure virtual

Given a book content UID, get the corresponding information (if any) for the preflight results/status of that content.

Parameters

contentUID

IN The UID of the content in which you're interested.

Returns

A refcounted entry or nil if there is no entry.

virtual IPreflightBookOptions* IPreflightBookData::QueryOptions ( ) const

pure virtual

Queries the options used for preflighting the book. This is usually just a copy of the persistent options for the book but will be different for, say, a package operation.

virtual void IPreflightBookData::SetBook ( IBook *  iBook )

pure virtual

Set the book this preflight is associated with. Note that this should only be done as part of initializing this interface.

Parameters

iBook

The book interface. This interface is NOT refcounted by this method; only the database is recorded. This is to avoid circular references since the book (

See Also

IPreflightBookRef) has a refcount on this interface.

virtual void IPreflightBookData::SetDataForContent ( UID  contentUID, IPreflightBookContentData *  iData  )

pure virtual

Set the data to associate with the given content UID.

Parameters

contentUID	IN The UID for which to set the associated data.
iData	IN The new data. If nil, the data is cleared (removed from the map). If not nil this is refcounted and the old data is replaced with the new one.