kotlin-odata/com.sap.cloud.mobile.kotlin.odata/EntitySet

EntitySet

open class EntitySet : BindingPath

Encapsulates the metadata of an OData entity set. Also used for OData {@link com.sap.cloud.mobile.kotlin.odata.EntitySet#isSingleton EntitySet.isSingleton} entities.

See Also:: DataService.createEntity, DataService.updateEntity, DataService.deleteEntity, DataService.getEntity, DataService.getEntityList.

Constructors

constructor()

Types

object Companion

open class Index

Metadata for an index on the containing entity set.

open class IndexList : ListBase, Iterable<EntitySet.Index>

A list of item type {@link com.sap.cloud.mobile.kotlin.odata.EntitySet.Index}.

Properties

var activeSet: String

open val annotationList: AnnotationList

open val annotationMap: AnnotationMap

open val annotations: AnnotationMap

var canBeRemoved: Boolean

var checkDeletes: Boolean

var checkUpdates: Boolean

var contextPath: String

val defaultSelect: SelectItemList

downloadBatchSize

var downloadBatchSize: Int

downloadEntitiesByDefault

var downloadEntitiesByDefault: Boolean

downloadQueriesCanOverlap

var downloadQueriesCanOverlap: Boolean

downloadStreamsByDefault

var downloadStreamsByDefault: Boolean

downloadWithoutDeltaLinks

var downloadWithoutDeltaLinks: Boolean

var draftSet: String

var encodedPath: String

var entityType: EntityType

estimatedDeltaDownloadTime

var estimatedDeltaDownloadTime: Double?

estimatedInitialDownloadTime

var estimatedInitialDownloadTime: Double?

estimatedStreamDownloadTime

var estimatedStreamDownloadTime: Double?

failBeforeSavingAnyEntity

var failBeforeSavingAnyEntity: Boolean

failBeforeSavingDeltaLink

var failBeforeSavingDeltaLink: Boolean

var generatedKey: Boolean

var hasBackendETag: Boolean

var hashTracking: Boolean

var hasLocalDraft: Boolean

var hasOfflineKey: Boolean

hasOfflineState

var hasOfflineState: Boolean

hasVersionColumn

var hasVersionColumn: Boolean

var indexes: EntitySet.IndexList

var isClientOnly: Boolean

var isContainment: Boolean

open var isDownloadable: Boolean

var isExtension: Boolean

isImportedFromSQL

var isImportedFromSQL: Boolean

var isLocalDraft: Boolean

var isNullable: Boolean

var isRemoved: Boolean

var isSingleton: Boolean

var isSynthesized: Boolean

isSynthesizedTarget

open var isSynthesizedTarget: Boolean

var isSystem: Boolean

open var isUploadable: Boolean

var keyGenerator: String?

var localName: String

val metrics: EntitySetMetrics

open val name: String

openAPICompatibleClient

var openAPICompatibleClient: Boolean

val pathBindings: EntitySetMap

var qualifiedName: String

open var resourcePath: String

var schema: String?

selectAfterCreate

var selectAfterCreate: Boolean

selectAfterUpdate

var selectAfterUpdate: Boolean

var sourceLine: Int

var systemFlags: Int

var table: String?

var tablePrefix: String?

var tableType: String?

var targetPath: String

var trackChanges: Boolean

var trackDownloads: Boolean

var uploadGroup: String?

Functions

open fun expand(vararg items: PropertyPath): ExpandablePath

Return an expandable path starting with this resource path.

open fun filter(test: QueryFilter): ExpandablePath

Return an expandable path starting with this resource path.

open fun getAnnotation(term: String): Annotation

Lookup an existing annotation by term name, or throw an exception if the annotation is not found.

See Also:: {@link com.sap.cloud.mobile.kotlin.odata.EntitySet#annotations EntitySet.annotations} and {@link com.sap.cloud.mobile.kotlin.odata.AnnotationMap#get(kotlin.String) AnnotationMap.get}, for looking up annotations that might not exist.

open fun getBinding(name: String): EntitySet

Lookup an existing navigation property binding by name.

See Also:: {@link com.sap.cloud.mobile.kotlin.odata.EntitySet#pathBindings EntitySet.pathBindings} and {@link com.sap.cloud.mobile.kotlin.odata.EntitySetMap#get(kotlin.String) EntitySetMap.get}, for looking up bindings that might not exist.

open fun path(child: Property): DataPath

Return a child path from an entity set. Cane be useful with queries using DataQuery.join(...).

open fun select(vararg items: PropertyPath): ExpandablePath

Return an expandable path starting with this resource path.

open override fun toString(): String

{@inheritDoc}