Inheritance diagram for IBGTasksUtils:

Public Types
enum	{ kDefaultIID = IID_IBGTASKSUTILS }

Public Member Functions
virtual bool16	IsDocumentInUseByBGTasks (const UIDRef &documentRef, bool bDoDetailChecking=false) const =0

virtual bool16	IsDataBaseInUseByBGTasks (IDataBase *db, bool bDoDetailChecking=false) const =0

virtual bool16	IsTargetFileInUseByBGTasks (const IDFile &targetFile) const =0

virtual PMString	CreateDocActionWarningAboutBGTasks (const UIDRef &item, const ActionID &action) 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

Member Function Documentation

virtual PMString IBGTasksUtils::CreateDocActionWarningAboutBGTasks	(	const UIDRef &	item,
		const ActionID &	action
	)		const

pure virtual

Create the error string for a document action that fails because the document is in use by background tasks.

Parameters

item	[IN]: the document
action	[IN]: the failed action

Returns: a PMString containing an error string with the action and document inserted

virtual bool16 IBGTasksUtils::IsDataBaseInUseByBGTasks	(	IDataBase *	db,
		bool	bDoDetailChecking = `false`
	)		const

pure virtual

Check if any background task is using a database or its clones

Parameters

db	the IDataBase in question
bDoDetailChecking	if kTrue, perform additional checks to confirm that no running background thread is still using the db

virtual bool16 IBGTasksUtils::IsDocumentInUseByBGTasks	(	const UIDRef &	documentRef,
		bool	bDoDetailChecking = `false`
	)		const

pure virtual

Check if any background task is using the document described by documentRef.

Note: If documentRef is kInvalidUIDRef it checks if there are any user tasks.

Parameters

documentRef	a UIDRef for the document
bDoDetailChecking	if kTrue, perform additional checks to confirm that no running background thread is still using the document

virtual bool16 IBGTasksUtils::IsTargetFileInUseByBGTasks ( const IDFile & targetFile ) const

pure virtual

Check if any background task is exporting to the file targetFile. Intended to prevent export filename collisions.

Parameters

targetFile The file to check

Public Types