Package com.sap.cloud.server.odata

Server OData API for Mobile Services.

See: Description

Interface Summary

Interface	Description
BindingPath	Marker interface for types that can be used as a binding parameter for a bound action/function invocation.
DataServiceProvider	A provider interface for data services.

Class Summary

Class	Description
AggregateExpression	Encapsulates an OData aggregate expression item.
AggregateExpressionList	A list of item type AggregateExpression.
AggregateFrom	Represents the 'from' clause in an aggregate transformation item.
AggregateFromList	A list of "aggregate from" transformation items.
AggregateMethod	Represents the method of the aggregate transformation item.
AggregateValue	Encapsulates an OData aggregate transformation item.
AggregateValueList	A list of aggregate transformation items.
AmountTransform	Abstract base class for top and bottom transformation items.
Annotation	Represents an OData annotation.
AnnotationEquality	Checks whether 2 Annotation instances are the same.
AnnotationList	A list of item type Annotation.
AnnotationMap	A map from key type string to value type Annotation.
AnnotationMap.Entry	A key/value pair for map entries.
AnnotationMap.EntryList	A list of item type AnnotationMap.Entry.
AnnotationTerm	Encapsulates an OData term definition.
AnnotationTermList	A list of item type AnnotationTerm.
AnnotationTermMap	A map from key type string to value type AnnotationTerm.
AnnotationTermMap.Entry	A key/value pair for map entries.
AnnotationTermMap.EntryList	A list of item type AnnotationTermMap.Entry.
AnyList	A list of item type object?.
AnyMap	A map from key type string to value type any.
AnyMap.Entry	A key/value pair for map entries.
AnyMap.EntryList	A list of item type AnyMap.Entry.
AnySet	A set of value type any.
ArrayFunction	For internal use only.
ArrayProperty	For internal use only.
BasicType	For internal use only.
BinaryList	A list of item type binary.
BinaryValue	DataValue subclass that wraps a BinaryValue.value of type binary.
BooleanList	A list of item type boolean.
BooleanValue	DataValue subclass that wraps a BooleanValue.value of type boolean.
BottomTransform	Represents the Bottom* transformation items.
ByteList	A list of item type byte.
ByteStream	Abstract base class for byte streams.
ByteValue	DataValue subclass that wraps a ByteValue.value of type byte.
CancellationListener	Listener for notification of request cancellation.
CancelToken	A token for requesting the cancellation of asynchronous requests.
ChangedLink	Encapsulates an OData changed link.
ChangedLinkList	A list of item type ChangedLink.
ChangeSet	Encapsulates an OData change set.
CharList	A list of item type char.
CharStream	Abstract base class for char streams, using UTF-16 code units.
CharValue	DataValue subclass that wraps a CharValue.value of type char.
ComplexType	Encapsulates the metadata of an OData complex type.
ComplexTypeList	A list of item type ComplexType.
ComplexTypeMap	A map from key type string to value type ComplexType.
ComplexTypeMap.Entry	A key/value pair for map entries.
ComplexTypeMap.EntryList	A list of item type ComplexTypeMap.Entry.
ComplexValue	Encapsulates an OData complex value.
ComplexValueList	A list of item type ComplexValue.
ComplexValueListWithNulls	For internal use only.
ComplexValueMap	A map from key type string to value type ComplexValue.
ComplexValueMap.Entry	A key/value pair for map entries.
ComplexValueMap.EntryList	A list of item type ComplexValueMap.Entry.
ConnectionPool	For internal use only.
ConvertDataValue	For internal use only.
CurrentBatch	For internal use only.
CustomPath	For internal use only.
CustomPathList	For internal use only.
DataBindingPattern	Encapsulates a regular expression that can be used for data binding.
DataComparer	For internal use only.
DataContext	For internal use by formatting and parsing functions.
DataEquality	For internal use only.
DataFormat	Format constants for use with data protocols.
DataInternal	For internal use only.
DataMethod	Encapsulates the metadata of an OData function or action.
DataMethodCall	Encapsulates the application of an OData method (function or action) to a list of parameters.
DataMethodList	A list of item type DataMethod.
DataMethodMap	A map from key type string to value type DataMethod.
DataMethodMap.Entry	A key/value pair for map entries.
DataMethodMap.EntryList	A list of item type DataMethodMap.Entry.
DataMethodMetrics	Runtime metrics for DataMethod.
DataMetric	Metric that counts or times the occurrences of a particular kind of event.
DataMetricList	A list of item type DataMetric.
DataMetricMap	A map from key type string to value type DataMetric.
DataMetricMap.Entry	A key/value pair for map entries.
DataMetricMap.EntryList	A list of item type DataMetricMap.Entry.
DataPath	Used together with DataQuery to represent a select, expand or sort item which is a single-part or multi-part path expression.
DataQuery	Encapsulates an OData query request.
DataSchema	Represents an OData data schema.
DataSchemaList	A list of item type DataSchema.
DataSchemaMap	A map from key type string to value type DataSchema.
DataSchemaMap.Entry	A key/value pair for map entries.
DataSchemaMap.EntryList	A list of item type DataSchemaMap.Entry.
DataService	Encapsulates an OData data service.
DataServlet	Abstract base class for server-side implementation of OData data services.
DataTransaction	Abstract base class for objects that manage transaction boundaries.
DataType	Represents a data type defined by XML Schema Part 2: Datatypes or OData.
DataTypeList	For internal use only.
DataTypeMap	For internal use only.
DataTypeMap.Entry	A key/value pair for map entries.
DataTypeMap.EntryList	A list of item type DataTypeMap.Entry.
DataValue	Abstract base class for wrapper classes that wrap basic data values as objects, as well as calendar values, geography values, geometry values, ComplexValue, EntityValue and ListBase.
DataValueList	A list of item type DataValue.
DataValueListWithNulls	A list of item type DataValue?.
DataValueMap	A map from key type string to value type DataValue?.
DataValueMap.Entry	A key/value pair for map entries.
DataValueMap.EntryList	A list of item type DataValueMap.Entry.
DataVersion	Constant codes to represent OData versions.
DayOfWeek	Constants to represent days of the week (Monday = 1 to Sunday = 7, using ISO 8601 conventions).
DayTimeDuration	Represents the XML Schema dayTimeDuration type.
DayTimeDurationList	A list of item type DayTimeDuration.
DecimalList	A list of item type decimal.
DecimalValue	DataValue subclass that wraps a DecimalValue.value of type decimal.
DefaultEntityHandler	Default handler for CRUD (create/read/update/delete) operations on entities.
DefaultEntityListener	Default implementation of EntityListener, for which all listener functions have no action.
DefaultMethodHandler	Default handler for OData actions and functions.
DeltaStream	A stream of delta items, each of which is either an EntityValue or a ChangedLink.
DeltaStreamWriter	A response stream writer for OData delta responses.
DoubleList	A list of item type double.
DoubleValue	DataValue subclass that wraps a DoubleValue.value of type double.
EntityContainer	Represents an OData entity container.
EntityContainerList	A list of item type EntityContainer.
EntityContainerMap	A map from key type string to value type EntityContainer.
EntityContainerMap.Entry	A key/value pair for map entries.
EntityContainerMap.EntryList	A list of item type EntityContainerMap.Entry.
EntityHandler	Handler interface for CRUD (create/read/update/delete) operations on entities.
EntityKey	Encapsulates an OData entity key.
EntityListener	Callback interface for CRUD (create/read/update/delete) operations on entities.
EntitySet	Encapsulates the metadata of an OData entity set.
EntitySet.Index	Metadata for an index on the containing entity set.
EntitySet.IndexList	A list of item type EntitySet.Index.
EntitySetList	A list of item type EntitySet.
EntitySetMap	A map from key type string to value type EntitySet.
EntitySetMap.Entry	A key/value pair for map entries.
EntitySetMap.EntryList	A list of item type EntitySetMap.Entry.
EntitySetMetrics	Runtime metrics for EntitySet.
EntityStream	A stream of entity values.
EntityType	Encapsulates the metadata of an OData entity type.
EntityTypeList	A list of item type EntityType.
EntityTypeMap	A map from key type string to value type EntityType.
EntityTypeMap.Entry	A key/value pair for map entries.
EntityTypeMap.EntryList	A list of item type EntityTypeMap.Entry.
EntityValue	Encapsulates an OData entity value.
EntityValueList	A list of item type EntityValue.
EntityValueListWithNulls	For internal use only.
EntityValueMap	A map from key type string to value type EntityValue.
EntityValueMap.Entry	A key/value pair for map entries.
EntityValueMap.EntryList	A list of item type EntityValueMap.Entry.
EnumType	Encapsulates the metadata of an OData enum type.
EnumTypeList	A list of item type EnumType.
EnumTypeMap	A map from key type string to value type EnumType.
EnumTypeMap.Entry	A key/value pair for map entries.
EnumTypeMap.EntryList	A list of item type EnumTypeMap.Entry.
EnumValue	Encapsulates an OData enum value.
EnumValueList	A list of item type EnumValue.
EnumValueMap	A map from key type string to value type EnumValue.
EnumValueMap.Entry	A key/value pair for map entries.
EnumValueMap.EntryList	A list of item type EnumValueMap.Entry.
ErrorResponse	Encapsulates an OData error response.
ErrorResponseList	A list of item type ErrorResponse.
ExpandItem	Encapsulates an OData expand item.
ExpandItemList	A list of item type ExpandItem.
ExpandTransform	Represents an expand transform item.
ExpectedItem	For internal use only.
FilterTransform	Represents a filter transform item.
FloatList	A list of item type float.
FloatValue	DataValue subclass that wraps a FloatValue.value of type float.
FromJSON	A data query subclass for queries that obtain a response from caller-supplied JSON text.
GeographyCollection	A collection of geography values.
GeographyLineString	A sequence of geography points which represents a joined string of lines.
GeographyMultiLineString	A sequence of geography line strings.
GeographyMultiPoint	A sequence of geography points.
GeographyMultiPolygon	A sequence of geography polygons.
GeographyPoint	A geography point.
GeographyPolygon	A sequence of geography multi-points which represents a polygon.
GeographyValue	Abstract base class for geography data values.
GeographyValueList	A list of item type GeographyValue.
GeometryCollection	A collection of geometry values.
GeometryLineString	A sequence of geometry points which represents a joined string of lines.
GeometryMultiLineString	A sequence of geometry line strings.
GeometryMultiPoint	A sequence of geometry points.
GeometryMultiPolygon	A sequence of geometry polygons.
GeometryPoint	A geometry point.
GeometryPolygon	A sequence of geometry multi-points which represents a polygon.
GeometryValue	Abstract base class for geometry data values.
GeometryValueList	A list of item type GeometryValue.
GeospatialValue	Abstract base class for geospatial (geography/geometry) data values.
GlobalDateTime	Represents the XML Schema dateTime type with zone offset.
GlobalDateTimeList	A list of item type GlobalDateTime.
GroupTransform	Represents a group transform item.
GuidValue	Encapsulates an OData GUID value.
GuidValueList	A list of item type GuidValue.
HttpDateTime	For internal use only.
InMemoryDatabase	A data service provider using in-memory storage.
IntegerList	A list of item type integer.
IntegerValue	DataValue subclass that wraps a IntegerValue.value of type integer.
IntList	A list of item type int.
IntValue	DataValue subclass that wraps a IntValue.value of type int.
JoinSetRelations	Object to discover server-only navigation properties between a source entity type, a target entity type and a join entity type.
JsonEntityProvider	For internal use only.
LineStringCoordinates	A list of item type PointCoordinates.
ListBase	Base class for strongly-typed lists.
LocalDate	Represents the XML Schema date type without zone offset.
LocalDateList	A list of item type LocalDate.
LocalDateTime	Represents the XML Schema dateTime type without zone offset.
LocalDateTimeList	A list of item type LocalDateTime.
LocalTime	Represents the XML Schema time type without zone offset.
LocalTimeList	A list of item type LocalTime.
LongList	A list of item type long.
LongValue	DataValue subclass that wraps a LongValue.value of type long.
MapBase	Base class for strongly-typed maps.
MetadataLock	A lock for ensuring thread-safe access to mutable service metadata.
MetadataOnlyProvider	A data service provider that only provdes service metadata.
MethodHandler	Handler interface for OData actions and functions.
MonthOfYear	Constants to represent months of the year.
MultiLineStringCoordinates	A list of item type LineStringCoordinates.
MultiPointCoordinates	A list of item type PointCoordinates.
MultiPolygonCoordinates	A list of item type PolygonCoordinates.
MustBeAuthenticated	Java servlet filter to validate that the client is authenticated.
NavigationProperty	Represents an OData navigation property.
NetworkOptions	Options for interaction with a data network.
ObjectList	A list of item type object.
ObjectMap	A map from key type string to value type object.
ObjectMap.Entry	A key/value pair for map entries.
ObjectMap.EntryList	A list of item type ObjectMap.Entry.
ObjectSet	A set of value type object.
ODataGet	For internal use only.
OfflineDataService	For internal use only.
OfflineODataProvider	For internal use only.
OnlineDataService	A specialization of DataService where the OnlineDataService.provider is an OnlineODataProvider.
OnlineODataProvider	A data service provider for online OData.
Parameter	Encapsulates an OData parameter.
ParameterList	A list of item type Parameter.
PathAnnotations	Annotations that are associated with a CSDL target path that is a child of a CSDL model element.
PathAnnotationsList	A list of item type PathAnnotations.
PathAnnotationsMap	A map from key type string to value type PathAnnotations.
PathAnnotationsMap.Entry	A key/value pair for map entries.
PathAnnotationsMap.EntryList	A list of item type PathAnnotationsMap.Entry.
PathResolver	For internal use only.
PendingRequest	For internal use only.
PendingRequestList	For internal use only.
PointCoordinates	Represents an N-dimensional point.
PolygonCoordinates	A list of item type LineStringCoordinates.
Property	Encapsulates the metadata of an OData structural or navigation property.
PropertyList	A list of item type Property.
PropertyMap	A map from key type string to value type Property.
PropertyMap.Entry	A key/value pair for map entries.
PropertyMap.EntryList	A list of item type PropertyMap.Entry.
PropertyPath	Abstract base class for Property and DataPath.
PropertyPathList	A list of item type PropertyPath.
ProviderInternal	For internal use only.
ProxyInternal	For internal use only.
QueryAlias	An alias reference for a data value.
QueryFilter	Encapsulates the boolean value of an OData logical operator.
QueryFormatter	Formatter for OData queries.
QueryFunction	Represents a OData query function.
QueryFunctionCall	Encapsulates the application of an OData query function to a list of arguments.
QueryFunctionCode	Constants for QueryFunction.code.
QueryFunctionList	For internal use only.
QueryFunctionMap	For internal use only.
QueryFunctionMap.Entry	A key/value pair for map entries.
QueryFunctionMap.EntryList	A list of item type QueryFunctionMap.Entry.
QueryInternal	For internal use only.
QueryOperator	Represents a OData query operator.
QueryOperatorCall	Encapsulates the application of an OData query operator to a list of arguments.
QueryOperatorCode	Constants for QueryOperator.code.
QueryOperatorList	For internal use only.
QueryOperatorMap	For internal use only.
QueryOperatorMap.Entry	A key/value pair for map entries.
QueryOperatorMap.EntryList	A list of item type QueryOperatorMap.Entry.
QueryParser	Parser for OData queries.
QueryResult	Holds a data query and its result value.
QueryType	A data type reference for use in a query.
QueryValue	Base class for paths and properties as well as wrapped constant values and query function/operation calls.
RequestBatch	Encapsulates an OData batch request.
RequestOptions	Options for processing of data requests.
SelectItem	Encapsulates an OData select item.
SelectItemList	A list of item type SelectItem.
ServerRuntime	Information about server runtime environment.
ServiceOptions	Options for interaction with a data service.
SetBase	Base class for strongly-typed sets.
ShortList	A list of item type short.
ShortValue	DataValue subclass that wraps a ShortValue.value of type short.
SimpleSQLParser	For internal use only.
SimpleType	Represents a type definition for an underlying basic type.
SimpleTypeList	A list of item type SimpleType.
SimpleTypeMap	A map from key type string to value type SimpleType.
SimpleTypeMap.Entry	A key/value pair for map entries.
SimpleTypeMap.EntryList	A list of item type SimpleTypeMap.Entry.
Single
SortItem	Encapsulates an OData sort item.
SortItemList	A list of item type SortItem.
SQLDatabaseInternal	For internal use only.
SQLDatabaseProvider	An implementation of DataServiceProvider using a SQL database.
SQLInternal	For internal use only.
StorageOptions	Options for offline storage of data from a DataService.
StreamBase	Abstract base class for streams.
StreamLink	Represents a link to the value of a media entity resource or a stream-typed property.
StreamProperty	Encapsulates the metadata of an OData stream property.
StringList	A list of item type string.
StringMap	A map from key type string to value type string.
StringMap.Entry	A key/value pair for map entries.
StringMap.EntryList	A list of item type StringMap.Entry.
StringSet	A set of value type string.
StringValue	DataValue subclass that wraps a StringValue.value of type string.
StructuralProperty	Represents an OData structural property.
StructureBase	The canonical path of this value relative to the service root URL.
StructureType	Common base class for ComplexType and EntityType.
StructureTypeList	A list of item type StructureType.
StructureTypeMap	A map from key type string to value type StructureType.
StructureTypeMap.Entry	A key/value pair for map entries.
StructureTypeMap.EntryList	A list of item type StructureTypeMap.Entry.
SystemKey	For internal use only.
SystemProcess	Functions for executing system processes.
ToJSON	A utility class for formatting OData values as JSON strings.
TopTransform	Represents the Top* transformation items.
TransformValue	Encapsulates an OData transformation item defined in OData Data Aggregation.
TransformValueList	A list of transformation items.
TypeFacets	Encapsulates the metadata of custom OData type facets.
UnsignedByte	DataValue subclass that wraps a UnsignedByte.value of type unsignedByte.
UnsignedByteList	A list of item type unsignedByte.
UnsignedShort	DataValue subclass that wraps a UnsignedShort.value of type unsignedShort.
UnsignedShortList	A list of item type unsignedShort.
YearMonthDuration	Represents the XML Schema yearMonthDuration type.
YearMonthDurationList	A list of item type YearMonthDuration.
ZZZ_EmptyMain

Enum Summary

Enum	Description
SortOrder	Sort order for data queries.
UpdateMode	Update mode for entity updates.

Exception Summary

Exception	Description
AccessDeniedException	Exception thrown when a DataService request fails due to access being denied.
DataException	Abstract base class for data exceptions.
DataFormatException	Exception thrown when data does not match the expected format.
DataNetworkException	Exception thrown when a request fails due to a data network issue.
DataQueryException	Exception thrown when a query cannot be parsed or evaluated.
DataSchemaException	Exception thrown when a problem is detected with a data schema.
DataSecurityException	Exception thrown when a DataService request fails due to a data security issue.
DataServiceException	Exception thrown when a DataService request fails due to a data service issue.
DataStorageException	Exception thrown when a DataService request fails due to a data storage issue.
DataStreamException	For internal use only.
DataTransactionException	Exception thrown when a DataTransaction encounters a failure.
QueryResultException	Exception thrown when a query result cannot be converted to the expected type.
RequestCancelledException	Exception thrown when an asynchronous request is cancelled.
RuntimeSQLException
SQLDatabaseException	Exception thrown by SQL functions when an error occurs.

Package com.sap.cloud.server.odata Description

Server OData API for Mobile Services. Key classes include:

• DataServlet — a base class for implementing OData services.
• DataService — a client API for accessing local SQL databases (when used with SQLDatabaseProvider) or remote OData services (when used with OnlineODataProvider).
• DataQuery — a fluent API for semi-type-safe construction of OData queries.