lib/org.dmfs.tasks.contract/TaskContract/Instances

Instances

class Instances : TaskContract.TaskColumns, TaskContract.InstanceColumns

A table containing one entry per task instance. This table is writable in order to allow modification of single instances of a task. Write operations to this table will be converted into operations on overrides and forwarded to the task table.

Note: The DTSTART, DUE values of instances of recurring tasks represent the actual instance values, i.e. they are different for each instance (DURATION is always null).

Also, none of the instances are recurring themselves, so RRULE, RDATE and EXDATE are always null.

TODO: Insert all instances of recurring tasks.

The following operations are supported:

Insert

Note, the data of an insert must not contain the fields RRULE, RDATE or EXDATE. If the new instance belongs to an existing task the data must contain the fields ORIGINAL_INSTANCE_ID and ORIGINAL_INSTANCE_TIME. Also note, this table supports writing DURATION (if the instance has a DTSTART), but reading it back will always return a nullDURATION and a non-nullDUE date. Reading the task in the tasks table will, however, return the original DURATION.

If there already is an instance (with or without override) for the given ORIGINAL_INSTANCE_ID and ORIGINAL_INSTANCE_TIME an exception is thrown.


absent or empty	A new non-recurring task is created with the given values.
a valid Tasks row `_ID`	An RDATE for the given ORIGINAL_INSTANCE_TIME time is added to the given master task, any EXDATE for this time is removed. The task is inserted as an override to the given master. No fields are inherited though. ORIGINAL_INSTANCE_ALLDAY will be set to IS_ALLDAY of the master. Note, if the given master is non-recurring, this operation will turn it into a recurring task.
invalid Tasks row `_ID`	An exception is thrown.

Update

Note, the data of an update must not contain any fields related to recurrence (RRULE, RDATE, EXDATE, ORIGINAL_INSTANCE_ID, ORIGINAL_INSTANCE_TIME and ORIGINAL_INSTANCE_ALLDAY). Also note, this table supports writing DURATION (if the instance has a DTSTART), but reading it back will always return a nullDURATION and a non-nullDUE date. Reading the task in the tasks table will, however, return the original DURATION.


Recurring master task	A new override is created with the given data. Note, any fields which are not provided are inherited from the master, except for DTSTART and DUE which will be inherited from the instance and DURATION, RRULE, RDATE and EXDATE which are set to `null`. ORIGINAL_INSTANCE_ID, ORIGINAL_INSTANCE_TIME and ORIGINAL_INSTANCE_ALLDAY will be set accordingly.
Single instance task	The task is updated with the given values.
Recurrence override with existing master	The task is updated with the given values.
Recurrence override without existing master	The task is updated with the given values.

Delete


Recurring master task	An EXDATE for this instance is added, any RDATE for this instance is removed. The instance row is removed. TODO: mark the task deleted if the remaining recurrence set is empty
Single instance task	The _DELETED flag of the task is set.
Recurrence override with existing master	The _DELETED flag of the override is set, an EXDATE for this instance is added to the master, any RDATE for this instance is removed from the master. TODO: mark the master deleted if the remaining recurrence set of the master is empty
Recurrence override without existing master	The _DELETED flag of the task is set.

Author

Yannic Ahrens

Marten Gajda

Constructors

Instances

constructor()

Properties

_COUNT

val _COUNT: String = "_count"

_ID

val _ID: String = "_id"

The row id of a task.

ACCOUNT_NAME

val ACCOUNT_NAME: String = "account_name"

The name of the account the task belongs to.

ACCOUNT_TYPE

val ACCOUNT_TYPE: String = "account_type"

The type of the account the task belongs to.

CLASSIFICATION

val CLASSIFICATION: String = "class"

The classification of a task.

CLASSIFICATION_CONFIDENTIAL

val CLASSIFICATION_CONFIDENTIAL: Int = 2

Classification value for confidential tasks.

CLASSIFICATION_DEFAULT

val CLASSIFICATION_DEFAULT: Integer

Default value of CLASSIFICATION.

CLASSIFICATION_PRIVATE

val CLASSIFICATION_PRIVATE: Int = 1

Classification value for private tasks.

CLASSIFICATION_PUBLIC

val CLASSIFICATION_PUBLIC: Int = 0

Classification value for public tasks.

COMPLETED

val COMPLETED: String = "completed"

Date of completion of this task in milliseconds since the epoch or null if this task has not been completed yet.

COMPLETED_IS_ALLDAY

val COMPLETED_IS_ALLDAY: String = "completed_is_allday"

Indicates that the date of completion is an all-day date.

CONTENT_URI_PATH

val CONTENT_URI_PATH: String = "instances"

CREATED

val CREATED: String = "created"

When this task has been created in milliseconds since the epoch.

DEFAULT_SORT_ORDER

val DEFAULT_SORT_ORDER: String = "instance_due_sorting"

DESCRIPTION

val DESCRIPTION: String = "description"

The description of a task.

DISTANCE_FROM_CURRENT

val DISTANCE_FROM_CURRENT: String = "distance_from_current"

The distance of the instance from the current one.

DTSTART

val DTSTART: String = "dtstart"

When this task starts in milliseconds since the epoch.

DUE

val DUE: String = "due"

When this task is due in milliseconds since the epoch.

DURATION

val DURATION: String = "duration"

The duration of this task.

EXDATE

val EXDATE: String = "exdate"

A comma separated list of time Strings in RFC 5545 format (see RFC 5545 Section 3.3.4 and RFC 5545 Section 3.3.5) that contains dates of exceptions of a recurring task.

GEO

val GEO: String = "geo"

A geographic location related to the task.

HAS_ALARMS

val HAS_ALARMS: String = "has_alarms"

Indicates how many alarms a task has.

HAS_PROPERTIES

val HAS_PROPERTIES: String = "has_properties"

Indicates that this task has extended properties like attachments, alarms or relations.

INSTANCE_DUE

val INSTANCE_DUE: String = "instance_due"

The due date of an instance in milliseconds since the epoch or null if the instance has no due date.

INSTANCE_DUE_SORTING

val INSTANCE_DUE_SORTING: String = "instance_due_sorting"

This column should be used in an order clause to sort instances by due date.

INSTANCE_DURATION

val INSTANCE_DURATION: String = "instance_duration"

The duration of an instance in milliseconds or null if the instance has only one of start or due date or none of both.

INSTANCE_ORIGINAL_TIME

val INSTANCE_ORIGINAL_TIME: String = "instance_original_time"

The start of the original instance as specified in the master task.

INSTANCE_START

val INSTANCE_START: String = "instance_start"

The start date of an instance in milliseconds since the epoch or null if the instance has no start date.

INSTANCE_START_SORTING

val INSTANCE_START_SORTING: String = "instance_start_sorting"

This column should be used in an order clause to sort instances by start date.

IS_ALLDAY

val IS_ALLDAY: String = "is_allday"

Boolean: flag that indicates that this is an all-day task.

IS_CLOSED

val IS_CLOSED: String = "is_closed"

A flag that indicates a task is closed (no more work has to be done).

IS_NEW

val IS_NEW: String = "is_new"

A flag that indicates a task is new (i.e.

LAST_MODIFIED

val LAST_MODIFIED: String = "last_modified"

When this task had been modified the last time in milliseconds since the epoch.

LIST_ACCESS_LEVEL

val LIST_ACCESS_LEVEL: String = "list_access_level"

The access level of the list this task belongs.

LIST_COLOR

val LIST_COLOR: String = "list_color"

The color of the list this task belongs to as integer (0xaarrggbb).

LIST_ID

val LIST_ID: String = "list_id"

The id of the list this task belongs to.

LIST_NAME

val LIST_NAME: String = "list_name"

The name of the list this task belongs to as integer (0xaarrggbb).

LIST_OWNER

val LIST_OWNER: String = "list_owner"

The owner of the list this task belongs.

LOCATION

val LOCATION: String = "location"

The location of the task.

ORGANIZER

val ORGANIZER: String = "organizer"

The email address of the organizer if any, null otherwise.

ORIGINAL_INSTANCE_ALLDAY

val ORIGINAL_INSTANCE_ALLDAY: String = "original_instance_allday"

A flag indicating that the original instance was an all-day task.

ORIGINAL_INSTANCE_ID

val ORIGINAL_INSTANCE_ID: String = "original_instance_id"

The row id of the original event if this is an exception, null otherwise.

ORIGINAL_INSTANCE_SYNC_ID

val ORIGINAL_INSTANCE_SYNC_ID: String = "original_instance_sync_id"

The _sync_id of the original event if this is an exception, null otherwise.

ORIGINAL_INSTANCE_TIME

val ORIGINAL_INSTANCE_TIME: String = "original_instance_time"

The time in milliseconds since the Epoch of the original instance that is overridden by this instance or null if this task is not a recurring instance.

PARENT_ID

val PARENT_ID: String = "parent_id"

The row id of the parent task.

PERCENT_COMPLETE

val PERCENT_COMPLETE: String = "percent_complete"

A number between 0 and 100 that indicates the progress of the task or null.

PINNED

val PINNED: String = "pinned"

Indicates that this task has been pinned to the notification area.

PRIORITY

val PRIORITY: String = "priority"

The priority of a task.

PRIORITY_DEFAULT

val PRIORITY_DEFAULT: Int = 0

The default value of PRIORITY.

RDATE

val RDATE: String = "rdate"

A comma separated list of time Strings in RFC 5545 format (see RFC 5545 Section 3.3.4 and RFC 5545 Section 3.3.5) that contains dates of instances of e recurring task.

RRULE

val RRULE: String = "rrule"

A recurrence rule as specified in RFC 5545 Section 3.3.10.

SORTING

val SORTING: String = "sorting"

The sorting of this task under it's parent task.

STATUS

val STATUS: String = "status"

The status of this task.

STATUS_CANCELLED

val STATUS_CANCELLED: Int = 3

A specific status indicating that the task has been cancelled.