summaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
Diffstat (limited to 'docs')
-rw-r--r--docs/applicationdomaintypes.md46
1 files changed, 30 insertions, 16 deletions
diff --git a/docs/applicationdomaintypes.md b/docs/applicationdomaintypes.md
index 798fa13..56e3032 100644
--- a/docs/applicationdomaintypes.md
+++ b/docs/applicationdomaintypes.md
@@ -9,7 +9,7 @@ The definition of the domain model directly affects:
9The purpose of these domain types is strictly to be the interface and the types are not meant to be used by applications directly, or to be restricted by any other specifications (such as ical). By nature these types will be part of the evolving interface, and will need to be adjusted for every new property that an application accesses. 9The purpose of these domain types is strictly to be the interface and the types are not meant to be used by applications directly, or to be restricted by any other specifications (such as ical). By nature these types will be part of the evolving interface, and will need to be adjusted for every new property that an application accesses.
10 10
11### Application Domain Types 11### Application Domain Types
12This is a proposed set of types that we will need to evolve into what we actually require. Hierarchical types are required to be able to query for a result set of mixed types. 12This is the currently defined set of types. Hierarchical types are required to be able to query for a result set of mixed types, but are not necessarily structured as such in the inheritance model.
13 13
14* Entity 14* Entity
15 * Domain Object 15 * Domain Object
@@ -34,40 +34,54 @@ This is a proposed set of types that we will need to evolve into what we actuall
34 * Thread 34 * Thread
35 * Sink Resource 35 * Sink Resource
36 * Maildir Resource 36 * Maildir Resource
37 * IMAP Resource
38 * Account
37 39
38#### Properties 40#### Properties
39```no-highlight 41```no-highlight
40Entity: The smallest unit in the sink universe 42Entity: The smallest unit in the sink universe
41 id: unique identifier in the sink storage. Not persistant over db recreations and can therefore only be referenced from within the sink database. 43 id [QByteArray]: unique identifier in the sink storage. Not persistant over db recreations and can therefore only be referenced from within the sink database.
42``` 44```
43```no-highlight 45```no-highlight
44Domain Object: 46Domain Object:
45 uid: unique identifier of the domain object. 47 uid [QByteArray}: unique identifier of the domain object.
46 revision: revision of the entity 48 revision [int]: revision of the entity
47 resource: reference to SinkResource:id of the parent resource. 49 resource [SinkResource.id]: The parent resource.
48``` 50```
49```no-highlight 51```no-highlight
50Event: 52Event:
51 summary: A string containing a short summary of the event. 53 summary [QString]: A string containing a short summary of the event.
52 startDate: The start date of the event. 54 startDate [QDateTime]: The start date of the event.
53 startTime: The start time of the event. Optional. 55 startTime [QDateTime]: The start time of the event. Optional.
54``` 56```
55```no-highlight 57```no-highlight
56Mail: 58Mail:
57 uid: The message id. 59 uid [QByteArray]: The message id.
58 subject: The subject of the email. 60 subject [QString]: The subject of the email.
59 folder: The identifier of the parent folder. 61 folder [MailFolder.id]: The parent folder.
60 date: The date of the email. 62 date [QDateTime]: The date of the email.
61 mimeMessage: A string containing the path to the mime message 63 mimeMessage [QString]: A string containing the path to the mime message
64```
65```no-highlight
66Mail Folder:
67 parent [MailFolder.id]: The parent folder.
68 name [QString]: The user visible name of the folder.
69 icon [QString]: The name of the icon of the folder.
62``` 70```
63```no-highlight 71```no-highlight
64Sink Resource: 72Sink Resource:
65 type: The type of the resource. 73 type [QByteArray]: The type of the resource.
66 name: The name of the resource. 74 name [QString]: The name of the resource.
75 account [Account.id]: The identifier of the associated account.
67``` 76```
68```no-highlight 77```no-highlight
69Maildir Resource: 78Maildir Resource:
70 path: The path to the maildir. 79 path [QString]: The path to the maildir.
80```
81```no-highlight
82Account:
83 name [QString]: The name of the account.
84 icon [QString]: The name of the icon of the account.
71``` 85```
72 86
73### References/Hierachies 87### References/Hierachies