Inheritance diagram for Facade::ITaskMonitorFacade:

Public Types
enum	{ kDefaultIID = IID_ITASKMONITORFACADE }

typedef std::vector< TaskInfo >	TaskInfoArray

typedef adobe::name_t	TaskPropertyKey

typedef adobe::any_regular_t	TaskPropertyValue

typedef std::pair< const TaskPropertyKey, const TaskPropertyValue >	TaskProperty

typedef adobe::dictionary_t	TaskProperties

Public Member Functions
virtual TaskInfoArray	GetCurrentTasks () const =0

virtual TaskInfo	GetTaskInfo (TaskInfo::TaskID taskID) const =0

virtual void	CancelAllTasks ()=0

virtual TaskInfoArray	WaitForAllTasks ()=0

virtual TaskInfoArray	FilterTasks (const TaskPropertyKey &propertyKey, const TaskPropertyValue &propertyValue) const =0

virtual TaskInfoArray	FilterTasks (const TaskProperties &properties) 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 class provides a public facade for getting information about active tasks. This facade

should closely mirror the task management functions available from scripting.

Member Function Documentation

virtual void Facade::ITaskMonitorFacade::CancelAllTasks ( )

pure virtual

Signals all registered tasks to cancel. The tasks may not notice this signal right away,

so code that depends on all tasks being canceled should call WaitForAllTasks after this call returns.

virtual TaskInfoArray Facade::ITaskMonitorFacade::FilterTasks	(	const TaskPropertyKey &	propertyKey,
		const TaskPropertyValue &	propertyValue
	)		const

pure virtual

Returns the array of active background tasks that contain propertyValue for the key propertyKey

Returns: TaskInfoArray containing a TaskInfo for each task with propertyKey, propertyValue pair

virtual TaskInfoArray Facade::ITaskMonitorFacade::FilterTasks ( const TaskProperties & properties ) const

pure virtual

Returns the array of active background tasks that satisfy all of the entries in properties

Returns: TaskInfoArray containing a TaskInfo for each task that matched all entries in properties

virtual TaskInfoArray Facade::ITaskMonitorFacade::GetCurrentTasks ( ) const

pure virtual

Retrieves the list of the current tasks. Note that the current list of tasks is subject

to change, but once a task is represented in a TaskInfoArray its TaskInfo will remain accessible even if the task completes or is canceled.

virtual TaskInfo Facade::ITaskMonitorFacade::GetTaskInfo ( TaskInfo::TaskID taskID ) const

pure virtual

Gets the TaskInfo for a TaskID

Returns: the TaskInfo or an invalid TaskInfo if no registered task has a matching id

virtual TaskInfoArray Facade::ITaskMonitorFacade::WaitForAllTasks ( )

pure virtual

Waits for all registered tasks to complete.

Returns: TaskInfoArray containing a TaskInfo for each active task at call time.