lib/at.bitfire.synctools.storage.jtx/JtxCollection

JtxCollection

class JtxCollection(val provider: JtxCollectionProvider, val values: ContentValues)

Represents a locally stored jtx collection (journals, notes, tasks). Communicates with the jtx Board content provider via provider.

Methods that use ContentValues operate directly on rows of the JtxContract.JtxICalObject table. Methods that use Entity operate on JtxContract.JtxICalObject rows together with associated sub-rows (attendees, categories, alarms, etc.).

Parameters

provider

jtx collection provider

values

content values as read from the jtx Board provider; JtxContract.JtxCollection.ID must be set

Throws

IllegalArgumentException

when JtxContract.JtxCollection.ID is not set

Constructors

JtxCollection

constructor(provider: JtxCollectionProvider, values: ContentValues)

Types

Companion

object Companion

Properties

account

val account: Account

client

val client: ContentProviderClient

color

val color: Int?

see JtxContract.JtxCollection.COLOR

description

val description: String?

see JtxContract.JtxCollection.DESCRIPTION

displayName

val displayName: String?

see JtxContract.JtxCollection.DISPLAYNAME

val id: Long

see JtxContract.JtxCollection.ID

jtxObjectsUri

val jtxObjectsUri: Uri

provider

val provider: JtxCollectionProvider

readonly

val readonly: Boolean

see JtxContract.JtxCollection.READONLY

supportsVEvent

val supportsVEvent: Boolean

see JtxContract.JtxCollection.SUPPORTSVEVENT

supportsVJournal

val supportsVJournal: Boolean

see JtxContract.JtxCollection.SUPPORTSVJOURNAL

supportsVTodo

val supportsVTodo: Boolean

see JtxContract.JtxCollection.SUPPORTSVTODO

syncId

val syncId: Long?

see JtxContract.JtxCollection.SYNC_ID

url

val url: String?

see JtxContract.JtxCollection.URL

values

val values: ContentValues

Functions

addJtxObject

fun addJtxObject(entity: Entity): Long

Inserts a new jtx object into this collection.

fun addJtxObject(entity: Entity, batch: JtxBatchOperation)

countJtxObjects

fun countJtxObjects(where: String?, whereArgs: Array<String>?): Int

Counts jtx objects in this collection that match the given selection criteria.

delete

fun delete(): Int

Deletes this collection from the jtx Board content provider.

deleteAllJtxObjects

@VisibleForTesting

fun deleteAllJtxObjects()

Deletes all jtx objects of this collection from the local storage.

deleteJtxObject

fun deleteJtxObject(id: Long)

Deletes a jtx object row. The jtx Board provider automatically deletes associated sub-rows.

findJtxObject

fun findJtxObject(where: String?, whereArgs: Array<String>?, sortOrder: String? = null): Entity?

Gets the first object from this jtx collection that matches the given query.

findJtxObjectRow

fun findJtxObjectRow(projection: Array<String>?, where: String?, whereArgs: Array<String>?): ContentValues?

Gets the first jtx object row (without sub-rows) that matches the given query.

findJtxObjects

fun findJtxObjects(where: String?, whereArgs: Array<String>?): List<Entity>

Queries jtx objects from this jtx collection.

getJtxObject

fun getJtxObject(id: Long): Entity?

Gets a specific jtx object, identified by its ID, from this collection.

getJtxObjectRow

fun getJtxObjectRow(id: Long, projection: Array<String>? = null, where: String? = null, whereArgs: Array<String>? = null): ContentValues?

Gets the main row of a specific jtx object, identified by its ID, from this collection.

iterateJtxObjectRows

fun iterateJtxObjectRows(projection: Array<String>?, where: String?, whereArgs: Array<String>?, body: (ContentValues) -> Unit)

Iterates jtx object rows (without sub-rows) from this collection.

iterateJtxObjects

fun iterateJtxObjects(where: String?, whereArgs: Array<String>?, body: (Entity) -> Unit)

Iterates jtx objects (with sub-rows) from this collection.

jtxObjectUri

fun jtxObjectUri(id: Long): Uri

update

fun update(values: ContentValues): Int

Updates this collection in the jtx Board content provider.

updateJtxObject

fun updateJtxObject(id: Long, entity: Entity)

Updates a jtx object's main row and refreshes all sub-rows.

fun updateJtxObject(id: Long, entity: Entity, batch: JtxBatchOperation)

Enqueues an update of a jtx object's main row and refreshes all sub-rows into batch.

updateJtxObjectRow

fun updateJtxObjectRow(id: Long, values: ContentValues)

fun updateJtxObjectRow(id: Long, values: ContentValues, batch: JtxBatchOperation)

Updates a specific jtx object's main row with the given values. Doesn't influence sub-rows.

updateJtxObjectRows

fun updateJtxObjectRows(values: ContentValues, where: String?, whereArgs: Array<String>?): Int

Updates jtx object rows in this collection.