typedrest/net.typedrest.endpoints.generic/GenericCollectionEndpoint

GenericCollectionEndpoint

interface GenericCollectionEndpoint<TEntity, out TElementEndpoint : ElementEndpoint<TEntity>>

Endpoint for a collection of TEntitys addressable as TElementEndpoints.

Use the more constrained CollectionEndpoint when possible.

Type Parameters

TEntity

The type of individual elements in the collection.

TElementEndpoint

The type of ElementEndpoint to provide for individual TEntitys.

Inheritors

CollectionEndpoint

GenericCollectionEndpointImpl

Properties

createAllAllowed

abstract val createAllAllowed: Boolean?

Shows whether the server has indicated that createAll is currently allowed.

createAllowed

abstract val createAllowed: Boolean?

Shows whether the server has indicated that create is currently allowed.

readAllAllowed

abstract val readAllAllowed: Boolean?

Shows whether the server has indicated that readAll is currently allowed.

readRangeAllowed

abstract val readRangeAllowed: Boolean?

Shows whether the server has indicated that readRange is allowed.

setAllAllowed

abstract val setAllAllowed: Boolean?

Shows whether the server has indicated that setAll is currently allowed.

Functions

contains

fun <TEntity, TElementEndpoint : ElementEndpoint<TEntity>> GenericCollectionEndpoint<TEntity, TElementEndpoint>.contains(entity: TEntity): Boolean

Determines whether the collection contains a specific element.

create

abstract fun create(entity: TEntity): TElementEndpoint?

Adds an entity as a new element to the collection.

createAll

abstract fun createAll(entities: Iterable<TEntity>)

Adds (or updates) multiple entities as elements in the collection.

delete

fun <TEntity, TElementEndpoint : ElementEndpoint<TEntity>> GenericCollectionEndpoint<TEntity, TElementEndpoint>.delete(entity: TEntity)

Deletes an existing element from the collection.

get

abstract operator fun get(entity: TEntity): TElementEndpoint

Returns an ElementEndpoint for a specific child element.

merge

fun <TEntity, TElementEndpoint : ElementEndpoint<TEntity>> GenericCollectionEndpoint<TEntity, TElementEndpoint>.merge(entity: TEntity): TEntity?

Modifies an existing element in the collection by merging changes on the server-side.

readAll

abstract fun readAll(): List<TEntity>

Returns all entities in the collection.

readRange

abstract fun readRange(from: Long?, to: Long?): PartialResponse<TEntity>

Returns all entities within a specific range of the collection.

set

fun <TEntity, TElementEndpoint : ElementEndpoint<TEntity>> GenericCollectionEndpoint<TEntity, TElementEndpoint>.set(entity: TEntity): TEntity?

Sets/replaces an existing element in the collection.

setAll

abstract fun setAll(entities: Iterable<TEntity>)

Replaces the entire content of the collection with new entities.