DHIS2 Android SDK/org.hisp.dhis.android.core.relationship/RelationshipCollectionRepository

RelationshipCollectionRepository

class RelationshipCollectionRepository : BaseReadOnlyWithUidCollectionRepositoryImpl<Relationship, RelationshipCollectionRepository> , ReadWriteWithUidCollectionRepository<Relationship, Relationship>

Properties

Link copied to clipboard

Functions

Link copied to clipboard
open override fun add(o: Relationship): Single<String>

Adds a new object to the given collection in an asynchronous way based on the provided CreateProjection. It returns a Single<String> with the generated UID, which is completed when the object is added to the database. It adds an object with a State.TO_POST, which will be uploaded to the server in the next upload.

Link copied to clipboard
open override fun blockingAdd(o: Relationship): String

Adds a new object to the given collection in a synchronous way based on the provided CreateProjection. It blocks the current thread and returns the generated UID. It adds an object with a State.TO_POST, which will be uploaded to the server in the next upload. Important: this is a blocking method and it should not be executed in the main thread. Consider the asynchronous version .add.

Link copied to clipboard
open override fun blockingCount(): Int

Get the count of elements. Important: this is a blocking method and it should not be executed in the main thread. Consider the asynchronous version .count.

Link copied to clipboard
open override fun blockingGet(): List<Relationship>

Get the list of objects in a synchronous way. Important: this is a blocking method and it should not be executed in the main thread. Consider the asynchronous version .get.

Link copied to clipboard
open override fun blockingGetUids(): List<String>

Get the list of uids of objects in scope in a synchronous way. Important: this is a blocking method and it should not be executed in the main thread. Consider the asynchronous version .getUids.

Link copied to clipboard
open override fun blockingIsEmpty(): Boolean

Check if selection of objects with applied filters is empty in a synchronous way. Important: this is a blocking method and it should not be executed in the main thread. Consider the asynchronous version .isEmpty.

Link copied to clipboard
fun byCreated(): DateFilterConnector<RelationshipCollectionRepository>
Link copied to clipboard
fun byLastUpdated(): DateFilterConnector<RelationshipCollectionRepository>
Link copied to clipboard
fun byName(): StringFilterConnector<RelationshipCollectionRepository>
Link copied to clipboard
Link copied to clipboard
fun bySyncState(): EnumFilterConnector<RelationshipCollectionRepository, State>
Link copied to clipboard
fun byUid(): StringFilterConnector<RelationshipCollectionRepository>
Link copied to clipboard
open override fun count(): Single<Int>

Get the count of elements in an asynchronous way, returning a Single.

Link copied to clipboard
open override fun get(): Single<List<Relationship>>

Get the objects in scope in an asynchronous way, returning a Single<List>.

Link copied to clipboard
fun getByItem(searchItem: RelationshipItem): List<Relationship>

Returns the relationship accessible by the searchItem, it means the searchItem is the owner or the relationship is bidirectional. It does not include deleted relationships.

fun getByItem(searchItem: RelationshipItem, includeDeleted: Boolean): List<Relationship>

Returns the relationship accessible by the searchItem, it means the searchItem is the owner or the relationship is bidirectional.

fun getByItem(searchItem: RelationshipItem, includeDeleted: Boolean, onlyAccessible: Boolean): List<Relationship>

Returns the relationship linked to the searchItem.

Link copied to clipboard
open override fun getPaged(pageSize: Int): LiveData<PagedList<Relationship>>

Handy method to use in conjunction with PagedListAdapter to build paged lists.

Link copied to clipboard
Link copied to clipboard
open override fun getPagingData(pageSize: Int): Flow<PagingData<Relationship>>

Uses Paging3 library and return a Flow

Link copied to clipboard
open override fun getUids(): Single<List<String>>

Get the list of uids of objects in scope in an asynchronous way, returning a Single<List<String>>.

Link copied to clipboard
open override fun isEmpty(): Single<Boolean>

Check if selection of objects in current scope with applied filters is empty in an asynchronous way, returning a Single.

Link copied to clipboard
open override fun one(): ReadOnlyOneObjectRepositoryFinalImpl<Relationship>

Get a ReadOnlyObjectRepository pointing to the first element in the list.

Link copied to clipboard
open override fun uid(uid: String?): ReadWriteObjectRepository<Relationship>

Returns a new ReadOnlyObjectRepository whose scope is the one of the current repository plus the equal filter applied to the uid. This method is equivalent to byUid().eq(uid).one().

Link copied to clipboard