Package-level declarations
Types
Encapsulates an OData aggregate expression item.
A list of item type {@link com.sap.cloud.mobile.kotlin.odata.AggregateExpression}.
Represents the 'from' clause in an aggregate transformation.
A list of "aggregate from" transformations.
Represents the method of the aggregate transformation.
Encapsulates an OData aggregate transformation.
A list of aggregate transformations.
Abstract base class for top and bottom transformations.
Represents an OData annotation.
- See Also:
-
{@link com.sap.cloud.mobile.kotlin.odata.AnnotationTerm}.
For internal use only.
For internal use only.
Encapsulates an OData term definition.
- See Also:
-
{@link com.sap.cloud.mobile.kotlin.odata.Annotation}.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
DataValue subclass that wraps a {@link com.sap.cloud.mobile.kotlin.odata.BinaryValue#value BinaryValue.value} of type binary.
Marker interface for types that can be used as a binding parameter for a bound action/function invocation.
- See Also:
-
{@link com.sap.cloud.mobile.kotlin.odata.EntitySet}, {@link com.sap.cloud.mobile.kotlin.odata.EntityValue}.
For internal use only.
DataValue subclass that wraps a {@link com.sap.cloud.mobile.kotlin.odata.BooleanValue#value BooleanValue.value} of type boolean.
Represents the bottom* transformations.
Abstract base class for byte streams.
Listener for notification of request cancellation.
A list of item type {@link com.sap.cloud.mobile.kotlin.odata.CancellationListener}.
A token for requesting the cancellation of asynchronous requests.
Encapsulates an OData changed link.
- See Also:
-
ChangeSet.createLink,ChangeSet.updateLink,ChangeSet.deleteLink.
For internal use only.
For internal use only.
Encapsulates an OData change set. A change set is used to group a set of entity or link changes into a single unit of work, like an atomic database transaction.
- See Also:
-
{@link com.sap.cloud.mobile.kotlin.odata.DataService}, {@link com.sap.cloud.mobile.kotlin.odata.RequestBatch}.
Abstract base class for char streams, using UTF-16 code units.
Interface for providers that support client registration.
A data service provider that synchronizes data between a local SQL database on a mobile client device and a remote OData service.
Occasional {@link com.sap.cloud.mobile.kotlin.odata.CloudSyncProvider#download(com.sap.cloud.mobile.kotlin.odata.StringList, com.sap.cloud.mobile.kotlin.odata.SyncOptions) CloudSyncProvider.download} and {@link com.sap.cloud.mobile.kotlin.odata.CloudSyncProvider#upload(com.sap.cloud.mobile.kotlin.odata.StringList, com.sap.cloud.mobile.kotlin.odata.SyncOptions) CloudSyncProvider.upload} calls may be used to synchronize data changes when the mobile client device is online.
The local SQL database will subsequently be queried and updated via the associated {@link com.sap.cloud.mobile.kotlin.odata.SQLDatabaseProvider} when the mobile client device is offline.
The remote OData service can be cloud-based or on-premise, but will typically be accessed via a cloud-based intermediary which enables connectivity between the mobile client device and the remote OData service.
Connectivity between the mobile client device and the remote OData service can be achieved by the associated {@link com.sap.cloud.mobile.kotlin.odata.OnlineODataProvider} via
SAP Mobile Services
and/or SAP BTP Connectivity.
The OData service should be enabled for OData change tracking,
so that {@link com.sap.cloud.mobile.kotlin.odata.CloudSyncProvider#download(com.sap.cloud.mobile.kotlin.odata.StringList, com.sap.cloud.mobile.kotlin.odata.SyncOptions) CloudSyncProvider.download} calls can efficiently obtain only the changed data.
If the OData service does not support change tracking, then Mobile Back-End Tools
can be used to enable change tracking,
either by using a delta-enabled cache database,
or by using a delta-enabled existing database.
Mobile Back-end Tools can also be used to provide an OData service with a delta-enabled cache database, wrapping a non-OData backend system which is accessible
using HTTPS (for REST APIs or SOAP services), JDBC (for SQL databases), or SAP Java Connector (for ABAP systems).
The {@link com.sap.cloud.mobile.kotlin.odata.EntitySet#downloadWithoutDeltaLinks EntitySet.downloadWithoutDeltaLinks} property can be set to true to enable client-side change tracking, however this is only appropriate for application prototyping or
for production scenarios with a limited amount of data to be downloaded.
Client applications should wrap this provider with a {@link com.sap.cloud.mobile.kotlin.odata.DataService} (or {@link com.sap.cloud.mobile.kotlin.odata.OfflineDataService}) for convenient consumption, including the use of async methods and proxy classes.
- See Also:
-
{@link com.sap.cloud.mobile.kotlin.odata.CloudSyncProvider#open() CloudSyncProvider.open}, client-side download queries, server-side download queries, {@link com.sap.cloud.mobile.kotlin.odata.CloudSyncProvider#downloadWithoutDeltaLinks(com.sap.cloud.mobile.kotlin.odata.EntitySet...) CloudSyncProvider.downloadWithoutDeltaLinks}, {@link com.sap.cloud.mobile.kotlin.odata.CloudSyncProvider#downloadQueriesCanOverlap(com.sap.cloud.mobile.kotlin.odata.EntitySet...) CloudSyncProvider.downloadQueriesCanOverlap}, {@link com.sap.cloud.mobile.kotlin.odata.CloudSyncProvider#noDefaultEntityDownload(com.sap.cloud.mobile.kotlin.odata.EntitySet...) CloudSyncProvider.noDefaultEntityDownload}, {@link com.sap.cloud.mobile.kotlin.odata.CloudSyncProvider#noDefaultStreamDownload(com.sap.cloud.mobile.kotlin.odata.EntitySet...) CloudSyncProvider.noDefaultStreamDownload}.
Encapsulates the metadata of an OData complex type.
A list of item type {@link com.sap.cloud.mobile.kotlin.odata.ComplexType}.
A map from key type string to value type {@link com.sap.cloud.mobile.kotlin.odata.ComplexType}.
Encapsulates an OData complex value.
A list of item type {@link com.sap.cloud.mobile.kotlin.odata.ComplexValue}.
For internal use only.
A map from key type string to value type {@link com.sap.cloud.mobile.kotlin.odata.ComplexValue}.
A marker interface implemented by {@link com.sap.cloud.mobile.kotlin.odata.ComplexValue} and {@link com.sap.cloud.mobile.kotlin.odata.ComplexValueList}. Used for parameters that accept a single value or multiple values.
Represents the 'concat' transformation.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
Abstract base class for data exceptions.
Format constants for use with data protocols.
Exception thrown when data does not match the expected format.
For internal use only.
Encapsulates the metadata of an OData function or action.
Encapsulates the application of an OData method (function or action) to a list of parameters. This is used to represent calls to actions and functions defined within an entity model, as opposed to {@link com.sap.cloud.mobile.kotlin.odata.QueryFunction} which is used to represent calls to builtin functions.
For internal use only.
A map from key type string to value type {@link com.sap.cloud.mobile.kotlin.odata.DataMethod}.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
Exception thrown when a request fails due to a data network issue.
Used together with {@link com.sap.cloud.mobile.kotlin.odata.DataQuery} to represent a select, expand or sort item which is a single-part or multi-part path expression. For example, a path whose OData URL representation is "Address/City" might be used to access the "City" property in a complex-typed "Address" property. Also used to represent paths in OData CSDL.
Encapsulates an OData query request. A query can be defined by setting query properties, or by calling query functions which provide a fluent interface. Execution of a query may result in some query properties being changed (e.g. the addition of {@link com.sap.cloud.mobile.kotlin.odata.DataQuery#expandItems DataQuery.expandItems} or {@link com.sap.cloud.mobile.kotlin.odata.DataQuery#selectItems DataQuery.selectItems} that are required for correct execution). Thus for thread safety, a query should be used only by a single thread at a time. Preferably a new query should be created before each query execution.
- See Also:
-
DataService.executeQuery.
Exception thrown when a query cannot be parsed or evaluated.
Represents an OData data schema.
Exception thrown when a problem is detected with a data schema.
For internal use only.
For internal use only.
Encapsulates an OData data service.
- See Also:
-
{@link com.sap.cloud.mobile.kotlin.odata.DataQuery}.
Encapsulates an OData data service.
- See Also:
-
{@link com.sap.cloud.mobile.kotlin.odata.DataQuery}.
Exception thrown when a DataService request fails due to a data service issue.
A provider interface for data services, using OData conventions for metadata, queries and updates. Where applicable, client applications should use the {@link com.sap.cloud.mobile.kotlin.odata.DataService} wrapper to invoke provider functions.
Exception thrown when a DataService request fails due to a data storage issue.
For internal use only.
A provider interface for data services which can synchronize data between a local database and a backend system.
Represents a data type defined by XML Schema Part 2: Datatypes or OData. String, binary, boolean, numeric and calendar types use XML Schema nomenclature. Geography, geometry, complex and entity types use OData nomenclature.
- See Also:
-
{@link com.sap.cloud.mobile.kotlin.odata.DataValue}, {@link com.sap.cloud.mobile.kotlin.odata.SimpleType}, {@link com.sap.cloud.mobile.kotlin.odata.EnumType}, {@link com.sap.cloud.mobile.kotlin.odata.ComplexType}, {@link com.sap.cloud.mobile.kotlin.odata.EntityType}.
A list of item type {@link com.sap.cloud.mobile.kotlin.odata.DataType}.
A map from key type string to value type {@link com.sap.cloud.mobile.kotlin.odata.DataType}.
Abstract base class for wrapper classes that wrap basic data values as objects, as well as calendar values, geography values, geometry values, {@link com.sap.cloud.mobile.kotlin.odata.ComplexValue}, {@link com.sap.cloud.mobile.kotlin.odata.EntityValue} and {@link com.sap.cloud.mobile.kotlin.odata.ListBase}.
- See Also:
-
{@link com.sap.cloud.mobile.kotlin.odata.StringValue}, {@link com.sap.cloud.mobile.kotlin.odata.BinaryValue}, {@link com.sap.cloud.mobile.kotlin.odata.BooleanValue}, {@link com.sap.cloud.mobile.kotlin.odata.CharValue}, {@link com.sap.cloud.mobile.kotlin.odata.ByteValue}, {@link com.sap.cloud.mobile.kotlin.odata.ShortValue}, {@link com.sap.cloud.mobile.kotlin.odata.IntValue}, {@link com.sap.cloud.mobile.kotlin.odata.LongValue}, {@link com.sap.cloud.mobile.kotlin.odata.IntegerValue}, {@link com.sap.cloud.mobile.kotlin.odata.DecimalValue}, {@link com.sap.cloud.mobile.kotlin.odata.FloatValue}, {@link com.sap.cloud.mobile.kotlin.odata.DoubleValue}, {@link com.sap.cloud.mobile.kotlin.odata.UnsignedByte}, {@link com.sap.cloud.mobile.kotlin.odata.UnsignedShort}, {@link com.sap.cloud.mobile.kotlin.odata.EnumValue}, {@link com.sap.cloud.mobile.kotlin.odata.GuidValue}, {@link com.sap.cloud.mobile.kotlin.odata.LocalDate}, {@link com.sap.cloud.mobile.kotlin.odata.LocalTime}, {@link com.sap.cloud.mobile.kotlin.odata.LocalDateTime}, {@link com.sap.cloud.mobile.kotlin.odata.GlobalDateTime}, {@link com.sap.cloud.mobile.kotlin.odata.DayTimeDuration}, {@link com.sap.cloud.mobile.kotlin.odata.YearMonthDuration}, {@link com.sap.cloud.mobile.kotlin.odata.GeographyValue}, {@link com.sap.cloud.mobile.kotlin.odata.GeometryValue}.
A list of item type {@link com.sap.cloud.mobile.kotlin.odata.DataValue}.
For internal use only.
A map from key type string to value type {@link com.sap.cloud.mobile.kotlin.odata.DataValue}?.
Constant codes to represent OData versions.
Utility functions for date numbering.
Constants to represent days of the week (Monday = 1 to Sunday = 7, using ISO 8601 conventions).
- See Also:
-
{@link com.sap.cloud.mobile.kotlin.odata.LocalDate#dayOfWeek LocalDate.dayOfWeek}, {@link com.sap.cloud.mobile.kotlin.odata.LocalDateTime#dayOfWeek LocalDateTime.dayOfWeek}, {@link com.sap.cloud.mobile.kotlin.odata.GlobalDateTime#dayOfWeek GlobalDateTime.dayOfWeek}.
Represents the XML Schema dayTimeDuration type.
A list of item type {@link com.sap.cloud.mobile.kotlin.odata.DayTimeDuration}.
For internal use only.
DataValue subclass that wraps a {@link com.sap.cloud.mobile.kotlin.odata.DecimalValue#value DecimalValue.value} of type decimal.
A stream of delta items, each of which is either an {@link com.sap.cloud.mobile.kotlin.odata.EntityValue} or a {@link com.sap.cloud.mobile.kotlin.odata.ChangedLink}. While processing a stream, a delta link may be encountered, but it will not be immediately available to the caller. The {@link com.sap.cloud.mobile.kotlin.odata.DeltaStream#deltaLink DeltaStream.deltaLink} can be obtained only after the stream is closed.
Example
let deltaStream = ...;
while (deltaStream.next())
{
if (deltaStream.hasEntity())
{
let entity = deltaStream.getEntity();
// Process entity value.
}
else
{
let link = deltaStream.getLink();
// Process changed link.
}
}
deltaStream.close();
var deltaLink = deltaStream.deltaLink;
// Save delta link for later use.
For internal use only.
DataValue subclass that wraps a {@link com.sap.cloud.mobile.kotlin.odata.DoubleValue#value DoubleValue.value} of type double.
Represents a named group for offline download. Download groups are used for selecting a subset of data to be downloaded.
- See Also:
-
groupsparameter of {@link com.sap.cloud.mobile.kotlin.odata.OfflineDataService#download(com.sap.cloud.mobile.kotlin.odata.StringList?, com.sap.cloud.mobile.kotlin.odata.SyncOptions?) OfflineDataService.download}.
Download mode for entity downloads.
- See Also:
-
OfflineDataService.setDownloadMode.
Represents a numbered phase for offline download. Download phases are used to break downloads into phases which might have different characteristics.
- See Also:
-
{@link com.sap.cloud.mobile.kotlin.odata.OfflineDataService#download(com.sap.cloud.mobile.kotlin.odata.StringList?, com.sap.cloud.mobile.kotlin.odata.SyncOptions?) OfflineDataService.download}.
A query used to limit the downloading of entities with {@link com.sap.cloud.mobile.kotlin.odata.CloudSyncProvider}.
- See Also:
-
{@link com.sap.cloud.mobile.kotlin.odata.OfflineDataService#createDownloadQuery(kotlin.String, com.sap.cloud.mobile.kotlin.odata.DataQuery, kotlin.Boolean) OfflineDataService.createDownloadQuery}.
A list of item type {@link com.sap.cloud.mobile.kotlin.odata.DownloadQuery}.
Represents an OData entity container.
For internal use only.
For internal use only.
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.
A list of item type {@link com.sap.cloud.mobile.kotlin.odata.EntitySet}.
A map from key type string to value type {@link com.sap.cloud.mobile.kotlin.odata.EntitySet}.
For internal use only.
A stream of entity values.
- See Also:
-
DataService.entityStream, {@link com.sap.cloud.mobile.kotlin.odata.DeltaStream}.
Encapsulates the metadata of an OData entity type.
For internal use only.
For internal use only.
Encapsulates an OData entity value.
A list of item type {@link com.sap.cloud.mobile.kotlin.odata.EntityValue}.
For internal use only.
A map from key type string to value type {@link com.sap.cloud.mobile.kotlin.odata.EntityValue}.
A marker interface implemented by {@link com.sap.cloud.mobile.kotlin.odata.EntityValue} and {@link com.sap.cloud.mobile.kotlin.odata.EntityValueList}. Used for parameters that accept a single entity or multiple entities.
For internal use only.
A map from key type string to value type {@link com.sap.cloud.mobile.kotlin.odata.EnumType}.
A list of item type {@link com.sap.cloud.mobile.kotlin.odata.EnumValue}.
A map from key type string to value type {@link com.sap.cloud.mobile.kotlin.odata.EnumValue}.
Encapsulates an OData error response.
For internal use only.
Convenience class for the abbreviated creation of expand queries with nested select/expand/filter.
Encapsulates an OData expand item. An expand item indicates a property (or expression) that is used in the $expand system query option.
- See Also:
-
{@link com.sap.cloud.mobile.kotlin.odata.DataQuery#expandItems DataQuery.expandItems}, {@link com.sap.cloud.mobile.kotlin.odata.DataQuery#expand(com.sap.cloud.mobile.kotlin.odata.PropertyPath...) DataQuery.expand}.
For internal use only.
Represents the 'expand' transformation.
For internal use only.
For internal use only.
Represents the 'filter' transformation.
DataValue subclass that wraps a {@link com.sap.cloud.mobile.kotlin.odata.FloatValue#value FloatValue.value} of type float.
A collection of geography values.
A sequence of geography points which represents a joined string of lines.
A sequence of geography line strings.
A sequence of geography points.
A sequence of geography polygons.
A geography point.
A sequence of geography multi-points which represents a polygon. The first multi-point coordinate is the exterior ring, any others are interior rings.
Abstract base class for geography data values.
- See Also:
-
{@link com.sap.cloud.mobile.kotlin.odata.GeographyPoint}, {@link com.sap.cloud.mobile.kotlin.odata.GeographyMultiPoint}, {@link com.sap.cloud.mobile.kotlin.odata.GeographyLineString}, {@link com.sap.cloud.mobile.kotlin.odata.GeographyMultiLineString}, {@link com.sap.cloud.mobile.kotlin.odata.GeographyPolygon}, {@link com.sap.cloud.mobile.kotlin.odata.GeographyMultiPolygon}, {@link com.sap.cloud.mobile.kotlin.odata.GeographyCollection}.
A list of item type {@link com.sap.cloud.mobile.kotlin.odata.GeographyValue}.
A collection of geometry values.
A sequence of geometry points which represents a joined string of lines.
A sequence of geometry line strings.
A sequence of geometry points.
A sequence of geometry polygons.
A geometry point.
A sequence of geometry multi-points which represents a polygon.
Abstract base class for geometry data values.
- See Also:
-
{@link com.sap.cloud.mobile.kotlin.odata.GeometryPoint}, {@link com.sap.cloud.mobile.kotlin.odata.GeometryMultiPoint}, {@link com.sap.cloud.mobile.kotlin.odata.GeometryLineString}, {@link com.sap.cloud.mobile.kotlin.odata.GeometryMultiLineString}, {@link com.sap.cloud.mobile.kotlin.odata.GeometryPolygon}, {@link com.sap.cloud.mobile.kotlin.odata.GeometryMultiPolygon}, {@link com.sap.cloud.mobile.kotlin.odata.GeometryCollection}.
A list of item type {@link com.sap.cloud.mobile.kotlin.odata.GeometryValue}.
Abstract base class for geospatial (geography/geometry) data values.
- See Also:
-
{@link com.sap.cloud.mobile.kotlin.odata.GeographyValue}, {@link com.sap.cloud.mobile.kotlin.odata.GeometryValue}.
Represents the XML Schema dateTime type with zone offset.
A list of item type {@link com.sap.cloud.mobile.kotlin.odata.GlobalDateTime}.
Represents the 'groupby' transformation.
A list of item type {@link com.sap.cloud.mobile.kotlin.odata.GuidValue}.
For internal use only.
Represents the 'identity' transformation.
For internal use only.
DataValue subclass that wraps a {@link com.sap.cloud.mobile.kotlin.odata.IntegerValue#value IntegerValue.value} of type integer.
Object to discover server-only navigation properties between a source entity type, a target entity type and a join entity type. The source is the entity containing the navigation property which owns this JoinSetRelations instance. The target is the entity which is connected to the sorce entity with the navigation property. JoinSet is an entity between the source and the target. This exists only on the server side, and connects the source and the target entities.
Represents the 'join' transformation.
For internal use only.
A list of item type {@link com.sap.cloud.mobile.kotlin.odata.PointCoordinates}.
Exception thrown when a data value literal is invalid.
A list of item type {@link com.sap.cloud.mobile.kotlin.odata.LocalDate}.
Represents the XML Schema dateTime type without zone offset.
A list of item type {@link com.sap.cloud.mobile.kotlin.odata.LocalDateTime}.
A list of item type {@link com.sap.cloud.mobile.kotlin.odata.LocalTime}.
Listener for metadata change notifications.
A lock for ensuring thread-safe access to mutable service metadata.
See ReadWriteLock for notes regarding lock reentrancy for writers.
A data service provider that only provdes service metadata.
Constants to represent months of the year.
- See Also:
-
{@link com.sap.cloud.mobile.kotlin.odata.LocalDate#month LocalDate.month}, {@link com.sap.cloud.mobile.kotlin.odata.LocalDateTime#month LocalDateTime.month}, {@link com.sap.cloud.mobile.kotlin.odata.GlobalDateTime#month GlobalDateTime.month}.
A list of item type {@link com.sap.cloud.mobile.kotlin.odata.LineStringCoordinates}.
A list of item type {@link com.sap.cloud.mobile.kotlin.odata.PointCoordinates}.
A list of item type {@link com.sap.cloud.mobile.kotlin.odata.PolygonCoordinates}.
Represents an OData navigation property.
Options for interaction with a data network.
For internal use only.
A specialization of {@link com.sap.cloud.mobile.kotlin.odata.DataService} where the {@link com.sap.cloud.mobile.kotlin.odata.OfflineDataService#provider OfflineDataService.provider} is a {@link com.sap.cloud.mobile.kotlin.odata.DataSyncProvider}.
- See Also:
-
{@link com.sap.cloud.mobile.kotlin.odata.CloudSyncProvider},
OfflineODataProvider.
An specialization of {@link com.sap.cloud.mobile.kotlin.odata.DataService} where the {@link com.sap.cloud.mobile.kotlin.odata.OfflineDataServiceAsync#provider OfflineDataServiceAsync.provider} is a {@link com.sap.cloud.mobile.kotlin.odata.DataSyncProvider}, using the async/await style of asynchronous operations.
For internal use only.
A specialization of {@link com.sap.cloud.mobile.kotlin.odata.DataService} where the {@link com.sap.cloud.mobile.kotlin.odata.OnlineDataService#provider OnlineDataService.provider} is an {@link com.sap.cloud.mobile.kotlin.odata.OnlineODataProvider}.
An specialization of {@link com.sap.cloud.mobile.kotlin.odata.DataService} where the {@link com.sap.cloud.mobile.kotlin.odata.OnlineDataServiceAsync#provider OnlineDataServiceAsync.provider} is an {@link com.sap.cloud.mobile.kotlin.odata.OnlineODataProvider}, using the async/await style of asynchronous operations.
A data service provider for online OData.
Generalized operation progress information, e.g. for network download / upload operations.
Represents the 'orderby' transformation.
A list of item type {@link com.sap.cloud.mobile.kotlin.odata.Parameter}.
For internal use only.
Annotations that are associated with a CSDL target path that is a child of a CSDL model element.
For internal use only.
For internal use only.
For internal use only.
Represents a pending request from client to server, retained on the client during offline operation until it can be successfully uploaded to the server, or cancelled by the application.
A list of item type {@link com.sap.cloud.mobile.kotlin.odata.PendingRequest}.
Represents an N-dimensional point. Note that some coordinate reference systems will support only {@link com.sap.cloud.mobile.kotlin.odata.PointCoordinates#x PointCoordinates.x} and {@link com.sap.cloud.mobile.kotlin.odata.PointCoordinates#y PointCoordinates.y} dimensions.
A list of item type {@link com.sap.cloud.mobile.kotlin.odata.LineStringCoordinates}.
Listener for operation progress notifications.
Encapsulates the metadata of an OData structural or navigation property. Used for properties of complex and entity types.
A fixed-length mutable array of item type {@link com.sap.cloud.mobile.kotlin.odata.Property}.
A list of item type {@link com.sap.cloud.mobile.kotlin.odata.Property}.
For internal use only.
Abstract base class for {@link com.sap.cloud.mobile.kotlin.odata.Property} and {@link com.sap.cloud.mobile.kotlin.odata.DataPath}.
Values of type PropertyPath are typically used in query construction.
- See Also:
-
{@link com.sap.cloud.mobile.kotlin.odata.DataQuery#select(com.sap.cloud.mobile.kotlin.odata.PropertyPath...) DataQuery.select}, {@link com.sap.cloud.mobile.kotlin.odata.DataQuery#expand(com.sap.cloud.mobile.kotlin.odata.PropertyPath...) DataQuery.expand}, {@link com.sap.cloud.mobile.kotlin.odata.DataQuery#orderBy(com.sap.cloud.mobile.kotlin.odata.QueryValue, com.sap.cloud.mobile.kotlin.odata.SortOrder) DataQuery.orderBy}.
A list of item type {@link com.sap.cloud.mobile.kotlin.odata.PropertyPath}.
A map from key type string to value type {@link com.sap.cloud.mobile.kotlin.odata.PropertyPath}.
For internal use only.
For internal use only.
An alias reference for a data value.
For internal use only.
Evaluator for {@link com.sap.cloud.mobile.kotlin.odata.DataQuery} expressions.
Encapsulates the boolean value of an OData logical operator. Used to wrap the results of logical {@link com.sap.cloud.mobile.kotlin.odata.QueryOperator} in a type-safe manner.
- See Also:
-
{@link com.sap.cloud.mobile.kotlin.odata.DataQuery#queryFilter DataQuery.queryFilter}, {@link com.sap.cloud.mobile.kotlin.odata.DataQuery#filter(com.sap.cloud.mobile.kotlin.odata.QueryFilter) DataQuery.filter}.
For internal use only.
Represents a OData query function. Query functions are typically used within {@link com.sap.cloud.mobile.kotlin.odata.DataQuery#filter(com.sap.cloud.mobile.kotlin.odata.QueryFilter) DataQuery.filter}. {@link com.sap.cloud.mobile.kotlin.odata.QueryFunctionCall} can be constructed using static calls on {@link com.sap.cloud.mobile.kotlin.odata.QueryFunction} or, more conveniently, by chained calls on {@link com.sap.cloud.mobile.kotlin.odata.QueryValue}.//! @example example.NorthwindProxyClient.queryFunctionExample
Encapsulates the application of an OData query function to a list of arguments.
Constants for {@link com.sap.cloud.mobile.kotlin.odata.QueryFunction#code QueryFunction.code}.
For internal use only.
For internal use only.
For internal use only.
Represents a OData query operator. Query operators are typically used within {@link com.sap.cloud.mobile.kotlin.odata.DataQuery#filter(com.sap.cloud.mobile.kotlin.odata.QueryFilter) DataQuery.filter}. {@link com.sap.cloud.mobile.kotlin.odata.QueryOperatorCall} can be constructed using static calls on {@link com.sap.cloud.mobile.kotlin.odata.QueryOperator} or, more conveniently, by chained calls on {@link com.sap.cloud.mobile.kotlin.odata.QueryValue}.
Encapsulates the application of an OData query operator to a list of arguments.
Constants for {@link com.sap.cloud.mobile.kotlin.odata.QueryOperator#code QueryOperator.code}.
For internal use only.
For internal use only.
For internal use only.
Holds a data query and its result value. Allows conversion of the result to optional/required/list values for basic, complex and entity types.
Exception thrown when a query result cannot be converted to the expected type.
Base class for paths and properties as well as wrapped constant values and query function/operation calls. Intended to allow convenient cascaded application of query functions/operators in fluent query construction.
- See Also:
-
{@link com.sap.cloud.mobile.kotlin.odata.DataQuery}, {@link com.sap.cloud.mobile.kotlin.odata.DataPath}, {@link com.sap.cloud.mobile.kotlin.odata.Property}, {@link com.sap.cloud.mobile.kotlin.odata.QueryFunction}, {@link com.sap.cloud.mobile.kotlin.odata.QueryOperator}.
Encapsulates an OData batch request.
- See Also:
-
{@link com.sap.cloud.mobile.kotlin.odata.ChangeSet}, {@link com.sap.cloud.mobile.kotlin.odata.DataQuery},
DataService.processBatch.
Exception thrown when an asynchronous request is cancelled.
Available values for {@link com.sap.cloud.mobile.kotlin.odata.PendingRequest#method PendingRequest.method}.
For internal use only.
Options for processing of data requests. If request options are used for {@link com.sap.cloud.mobile.kotlin.odata.RequestOptions#repeatable(com.sap.cloud.mobile.kotlin.odata.GuidValue, com.sap.cloud.mobile.kotlin.odata.GlobalDateTime) RequestOptions.repeatable} requests, a new request options object should be used for each distinct request (or the repeatability properties should be reset before object re-use). The repeated execution of a failed request should re-use the original request options object without {@link com.sap.cloud.mobile.kotlin.odata.RequestOptions#repeatable(com.sap.cloud.mobile.kotlin.odata.GuidValue, com.sap.cloud.mobile.kotlin.odata.GlobalDateTime) RequestOptions.repeatable} being reset beforehand.
Available values for {@link com.sap.cloud.mobile.kotlin.odata.PendingRequest#status PendingRequest.status}.
For internal use only.
Holds the path to a data service resource.
Represents a parsed OData search expression.
- See Also:
-
{@link com.sap.cloud.mobile.kotlin.odata.SearchTerm}.
A list of item type {@link com.sap.cloud.mobile.kotlin.odata.SearchExpression}.
Options for {@link com.sap.cloud.mobile.kotlin.odata.SearchExpression#matches(com.sap.cloud.mobile.kotlin.odata.StringList) SearchExpression.matches}. Reserved for future use.
Represents an OData search term (word or phrase).
Encapsulates an OData select item. A select item indicates a property (or expression) that is used in the $select system query option.
- See Also:
-
{@link com.sap.cloud.mobile.kotlin.odata.DataQuery#selectItems DataQuery.selectItems}, {@link com.sap.cloud.mobile.kotlin.odata.DataQuery#select(com.sap.cloud.mobile.kotlin.odata.PropertyPath...) DataQuery.select}.
For internal use only.
Options for interaction with a data service.
DataValue subclass that wraps a {@link com.sap.cloud.mobile.kotlin.odata.ShortValue#value ShortValue.value} of type short.
For internal use only.
Represents a type definition for an underlying basic type.
For internal use only.
For internal use only.
Represents the 'skip' transformation.
Encapsulates an OData sort item. A sort item indicates a property (or expression) that is used in the $orderby system query option.
- See Also:
-
{@link com.sap.cloud.mobile.kotlin.odata.DataQuery#sortItems DataQuery.sortItems}, {@link com.sap.cloud.mobile.kotlin.odata.DataQuery#orderBy(com.sap.cloud.mobile.kotlin.odata.QueryValue, com.sap.cloud.mobile.kotlin.odata.SortOrder) DataQuery.orderBy}, {@link com.sap.cloud.mobile.kotlin.odata.DataQuery#thenBy(com.sap.cloud.mobile.kotlin.odata.QueryValue, com.sap.cloud.mobile.kotlin.odata.SortOrder) DataQuery.thenBy}.
For internal use only.
Sort order for data queries.
- See Also:
-
{@link com.sap.cloud.mobile.kotlin.odata.DataQuery#orderBy(com.sap.cloud.mobile.kotlin.odata.QueryValue, com.sap.cloud.mobile.kotlin.odata.SortOrder) DataQuery.orderBy}, {@link com.sap.cloud.mobile.kotlin.odata.SortItem#order SortItem.order}.
Exception thrown by SQL functions when an error occurs.
For internal use only.
An implementation of {@link com.sap.cloud.mobile.kotlin.odata.DataServiceProvider} using a SQL database. A remote OData service is not required in order to use this provider. The underlying database software is SQLite (SQLCipher).
For internal use only.
Options for offline storage of data from a {@link com.sap.cloud.mobile.kotlin.odata.DataService}.
Abstract base class for streams.
- See Also:
-
{@link com.sap.cloud.mobile.kotlin.odata.ByteStream}, {@link com.sap.cloud.mobile.kotlin.odata.CharStream}.
Represents a link to the value of a media entity resource or a stream-typed property.
- See Also:
-
{@link com.sap.cloud.mobile.kotlin.odata.EntityType#isMedia EntityType.isMedia}, {@link com.sap.cloud.mobile.kotlin.odata.Property#isStream Property.isStream}.
Encapsulates the metadata of an OData stream property.
For internal use only.
DataValue subclass that wraps a {@link com.sap.cloud.mobile.kotlin.odata.StringValue#value StringValue.value} of type string.
Represents an OData structural property.
Common base class for {@link com.sap.cloud.mobile.kotlin.odata.ComplexValue} and {@link com.sap.cloud.mobile.kotlin.odata.EntityValue}.
A fixed-length mutable array of item type {@link com.sap.cloud.mobile.kotlin.odata.DataValue}?.
Common base class for {@link com.sap.cloud.mobile.kotlin.odata.ComplexType} and {@link com.sap.cloud.mobile.kotlin.odata.EntityType}.
A list of item type {@link com.sap.cloud.mobile.kotlin.odata.StructureType}.
A map from key type string to value type {@link com.sap.cloud.mobile.kotlin.odata.StructureType}.
Encapsulates an OData SymbolicName as a DataValue.
- See Also:
-
SymbolicName in https://oasis-tcs.github.io/odata-vocabularies/vocabularies/Org.OData.Core.V1.xml
A list of item type {@link com.sap.cloud.mobile.kotlin.odata.SyncEvent}.
Request options for {@link com.sap.cloud.mobile.kotlin.odata.OfflineDataService#download(com.sap.cloud.mobile.kotlin.odata.StringList?, com.sap.cloud.mobile.kotlin.odata.SyncOptions?) OfflineDataService.download} and {@link com.sap.cloud.mobile.kotlin.odata.OfflineDataService#upload(com.sap.cloud.mobile.kotlin.odata.StringList?, com.sap.cloud.mobile.kotlin.odata.SyncOptions?) OfflineDataService.upload}.
Represents the top* transformations.
Encapsulates an OData transformation defined in OData Data Aggregation. A TransformValue indicates an expression that is used in the $apply system query option.
A list of transformations.
Encapsulates the metadata of custom OData type facets.
- See Also:
-
{@link com.sap.cloud.mobile.kotlin.odata.DataMethod}, {@link com.sap.cloud.mobile.kotlin.odata.Parameter}, {@link com.sap.cloud.mobile.kotlin.odata.Property}, {@link com.sap.cloud.mobile.kotlin.odata.SimpleType},
DataValue subclass that wraps a {@link com.sap.cloud.mobile.kotlin.odata.UnsignedByte#value UnsignedByte.value} of type unsignedByte.
For internal use only.
DataValue subclass that wraps a {@link com.sap.cloud.mobile.kotlin.odata.UnsignedShort#value UnsignedShort.value} of type unsignedShort.
For internal use only.
Update mode for entity updates.
- See Also:
-
{@link com.sap.cloud.mobile.kotlin.odata.RequestOptions#updateMode RequestOptions.updateMode}.
Exception thrown by {@link com.sap.cloud.mobile.kotlin.odata.DataSyncProvider#upload(com.sap.cloud.mobile.kotlin.odata.StringList, com.sap.cloud.mobile.kotlin.odata.SyncOptions) DataSyncProvider.upload} when one or more pending requests cannot be uploaded due to a backend failure. The {@link com.sap.cloud.mobile.kotlin.odata.UploadException#message UploadException.message} for this exception will not be localized. Please use the properties ({@link com.sap.cloud.mobile.kotlin.odata.UploadException#failureCount UploadException.failureCount}, {@link com.sap.cloud.mobile.kotlin.odata.UploadException#successCount UploadException.successCount}, {@link com.sap.cloud.mobile.kotlin.odata.UploadException#notSentCount UploadException.notSentCount}) for error handling and user notification.
- See Also:
-
{@link com.sap.cloud.mobile.kotlin.odata.OfflineDataService#getFailedRequests(com.sap.cloud.mobile.kotlin.odata.DataQuery?, com.sap.cloud.mobile.kotlin.odata.http.HttpHeaders?, com.sap.cloud.mobile.kotlin.odata.RequestOptions?) OfflineDataService.getFailedRequests}, to list the failed requests after an {@link com.sap.cloud.mobile.kotlin.odata.UploadException} has been thrown.
Represents the XML Schema yearMonthDuration type.
A list of item type {@link com.sap.cloud.mobile.kotlin.odata.YearMonthDuration}.