Administration
From TaskDepender
(→Introduction) |
(→Functionality) |
||
| Line 1: | Line 1: | ||
''This page describes the Administration layer of the TaskDepender™ program.'' | ''This page describes the Administration layer of the TaskDepender™ program.'' | ||
| − | == | + | == Description == |
| − | The Administration is an API to the database that in one direction shields the GUI from handling the database transactions and in the other direction shields the Administration from being dependent on the implementation of the GUI. | + | The Administration is an API to the [[Database|database]] that in one direction shields the GUI from handling the database transactions and in the other direction shields the Administration from being dependent on the implementation of the [[GUI]]. |
| + | |||
| + | == Functionality == | ||
| + | |||
| + | === Consistency === | ||
| + | |||
| + | Besides the API functions, the Administration API also requires some internal methods to ensure consistency and implement the restrictions. There are: | ||
| + | * [[Checking cyclicity]] | ||
| + | |||
| + | === Other methods === | ||
| + | |||
| + | * [[Create tasks and deliverables lists]] | ||
| + | * [[Find methods]] | ||
== Design == | == Design == | ||
| Line 21: | Line 33: | ||
The Administration numbers the actions and the GUI can undo that action. Internally in the Administration the complete administration is filled again when the database has rolled back the action. | The Administration numbers the actions and the GUI can undo that action. Internally in the Administration the complete administration is filled again when the database has rolled back the action. | ||
| − | The Administration can return lists of | + | === API === |
| + | |||
| + | The Administration can return a [[Task class|task]], a [[Tasks administration class|lists of tasks]], a [[Deliverable class|deliverable]] or a [[Deliverables administration class|lists of Deliverables]]. | ||
| + | |||
| + | == Implementation == | ||
| + | |||
| + | <syntaxhighlight lang="cpp"> | ||
| + | class AdminC | ||
| + | { | ||
| + | private: | ||
| + | sqlite3 *DatabaseHandle; // SQLite db handle. | ||
| + | char *DatabaseFilename; | ||
| + | |||
| + | uint EditsCounter; | ||
| + | |||
| + | uint32 AllowedActions; | ||
| + | |||
| + | bool Cyclic( TaskC *beginTask, TaskC *endTask ); | ||
| + | void DeleteDeliverable( uint32 id ); | ||
| + | void DeleteTask( uint32 id ); | ||
| + | |||
| + | IntegerArrayC *SelectedTasksIds; | ||
| + | IntegerArrayC *SelectedDeliverablesIds; | ||
| + | |||
| + | public: | ||
| + | AdminC(void); | ||
| + | ~AdminC(void); | ||
| + | |||
| + | TasksAdminC *TasksAdmin; | ||
| + | DeliverablesAdminC *DeliverablesAdmin; | ||
| + | |||
| + | void DeleteSelectedElements(void); | ||
| + | |||
| + | void Disconnect( TaskC *task, DeliverableC *deliverable ); | ||
| + | void Connect( TaskC *task, DeliverableC | ||
| + | |||
| + | void DetermineContainedElements(void); | ||
| + | |||
| + | void Undo(void); | ||
| + | |||
| + | AdminC *Copy(void); | ||
| + | }; | ||
| + | </syntaxhighlight> | ||
| − | == | + | == Used classes and structures == |
| − | [[ | + | * [[Generic types]] |
| + | * [[Task class]] | ||
| + | * [[Tasks administration class]] | ||
| + | * [[Deliverable class]] | ||
| + | * [[Deliverables administration class]] | ||
