Tome::Task Class Reference

Automated task that may result in a list of messages, warnings and errors. More...

#include <task.h>

Inheritance diagram for Tome::Task:

Public Member Functions
	Task ()
	Constructs a new automated task that may result in a list of messages, warnings and errors.
virtual const QString	getDisplayName () const =0
	Gets the localized display name of this task, as shown next to progress bars. More...
virtual const MessageList	execute (const TaskContext &context) const =0
	Executes this task, generating a list of messages, warnings and errors. More...

Detailed Description

Automated task that may result in a list of messages, warnings and errors.

Member Function Documentation

execute()

virtual const MessageList Tome::Task::execute ( const TaskContext &  context ) const

pure virtual

Executes this task, generating a list of messages, warnings and errors.

Parameters

context

Controllers required for executing the task.

Returns

List of messages, warnings and errors.

Implemented in Tome::ComponentHasNoFieldsTask, Tome::FieldAlwaysHasItsDefaultValueTask, Tome::FieldIsNeverUsedTask, Tome::FieldTypeDoesNotExistTask, Tome::ListItemTypeDoesNotExistTask, Tome::ListItemTypeNotSupportedTask, Tome::MapKeyTypeDoesNotExistTask, Tome::MapKeyTypeNotSupportedTask, Tome::MapValueTypeDoesNotExistTask, Tome::MapValueTypeNotSupportedTask, Tome::ReferencedFileDoesNotExistTask, Tome::ReferencedRecordDoesNotExistTask, Tome::TypeFacetViolatedTask, and Tome::TypeIsNeverUsedTask.

getDisplayName()

virtual const QString Tome::Task::getDisplayName ( ) const

pure virtual

Gets the localized display name of this task, as shown next to progress bars.

Returns

Localized display name of this task.

Implemented in Tome::ComponentHasNoFieldsTask, Tome::FieldAlwaysHasItsDefaultValueTask, Tome::FieldIsNeverUsedTask, Tome::FieldTypeDoesNotExistTask, Tome::ListItemTypeDoesNotExistTask, Tome::ListItemTypeNotSupportedTask, Tome::MapKeyTypeDoesNotExistTask, Tome::MapKeyTypeNotSupportedTask, Tome::MapValueTypeDoesNotExistTask, Tome::MapValueTypeNotSupportedTask, Tome::ReferencedFileDoesNotExistTask, Tome::ReferencedRecordDoesNotExistTask, Tome::TypeFacetViolatedTask, and Tome::TypeIsNeverUsedTask.

---

The documentation for this class was generated from the following files:

• Source/Tome/Features/Tasks/Controller/task.h
• Source/Tome/Features/Tasks/Controller/task.cpp