ServiceOptions (SAP Cloud Platform - Server OData API for Mobile Services)

java.lang.Object
- com.sap.cloud.server.odata.ServiceOptions

public class ServiceOptions
extends java.lang.Object

Options for interaction with a data service.

Constructor Summary

Constructors
Constructor and Description

ServiceOptions()

Constructors
Constructor and Description
`ServiceOptions()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.lang.String`	`getAvoidInPaths()` Return (nullable) Characters that must be avoided in the path component of URLs (e.g.
`boolean`	`getBatchDownloads()` Return if the backend supports download for offline operation, should it be done with batch requests? True by default.
`boolean`	`getBatchUploads()` Return if the backend supports upload for offline operation, should it be done with batch requests? True by default.
`boolean`	`getCacheMetadata()` Return should loaded service metadata be cached in a local file? If `ServiceOptions.metadataFile` is non-null, then the cache file name will be `ServiceOptions.metadataFile` with ".cache" appended.
`boolean`	`getCheckQueries()` Return check data queries before sending them to the server.
`boolean`	`getCheckResults()` Return check query results after receiving them from the server.
`boolean`	`getCheckVersion()` Return check version header in OData responses.
`java.lang.String`	`getClientInstanceID()` Return (nullable) Globally unique client identifier for the client, used to provide a default value for the "Client-Instance-ID" HTTP header.
`boolean`	`getCreateReturnsContent()` Return do createEntity calls return resulting entity state in response payload? Defaults to `true`.
`CsdlFetcher`	`getCsdlFetcher()` Return (nullable) CSDL fetcher which can resolve CSDL references when loading metadata.
`int`	`getCsdlOptions()` Return CSDL options for parsing.
`boolean`	`getDatabaseOnly()` Return is this service only to be used with a local database? By default, a service can be used both online (remote service) and offline (local database).
`int`	`getDataFormat()` Return format to be used for data interchange (ATOM or JSON).
`int`	`getDataVersion()` Return version to be used for data interchange.
`boolean`	`getDeleteWithEntityTag()` Return if the backend system returns an ETag header when querying for an entity (or an "etag" annotation when querying for multiple entities), should deletes of the entity send the ETag value with an If-Match header? Defaults to `true`.
`boolean`	`getFixMissingEmptyLists()` Return if set to true and the server returns no value for a collection-typed property of an entity then parser will return an empty collection and validation will not fail.
`boolean`	`getFixMissingNullValues()` Return if set to true and the server returns no value for a non collection-typed property of an entity then parser will return a null value and validation will not fail.
`XmlElementList`	`getIncludeElements()` Return extra child elements for parsing main CSDL schema.
`DataSchemaList`	`getIncludeSchemas()` Return pre-parsed CSDL schemas, which may be referenced by the service metadata.
`int`	`getLoadIfCreateStatus()` Return defaults to `204` (HTTP No Content), forcing an implicit `loadEntity` call to be issued before `createEntity` returns, if the create response status from the server is >= `204`.
`int`	`getLoadIfUpdateStatus()` Return defaults to `204` (HTTP No Content), forcing an implicit `loadEntity` call to be issued before `updateEntity` returns, if the update response status from the server is >= `204`.
`boolean`	`getLogErrors()` Return should data service error messages be logged? Defaults to `true`.
`boolean`	`getLogWarnings()` Return should data service warning messages be logged? Defaults to `true`.
`java.lang.String`	`getMetadataFile()` Return (nullable) Name of local file containing OData CSDL service metadata for the data service.
`java.lang.String`	`getMetadataText()` Return (nullable) Text of the service metadata, provider by the caller so it does not need to be loaded.
`java.lang.String`	`getMetadataURL()` Return (nullable) Alternate location of OData CSDL service metadata.
`java.lang.String`	`getPingAccept()` Return response type accepted by `DataService.pingServer`.
`java.lang.String`	`getPingMethod()` Return HTTP method used by `DataService.pingServer`.
`java.lang.String`	`getPingResource()` Return resource path used by `DataService.pingServer`.
`GuidValue`	`getRepeatabilityClientID()` Return (nullable) Optional client ID for repeatable requests.
`java.lang.String`	`getRequiresToken()` Return (nullable) Does the service require a security token for change requests? Defaults to "X-CSRF-Token".
`boolean`	`getRequiresType()` Return does the service always require type metadata in client-sent complex/entity values.
`boolean`	`getSupportsAlias()` Return does the service support parameter aliases? True by default.
`boolean`	`getSupportsBatch()` Return does the service support OData batch requests? True by default.
`boolean`	`getSupportsBind()` Return does the service support bind operations.
`boolean`	`getSupportsDelta()` Return does the service support server-side change tracking (e.g.
`boolean`	`getSupportsNext()` Return does the service support the following of next-links using the $skiptoken system query option.
`boolean`	`getSupportsPatch()` Return does the service support OData PATCH requests (or MERGE for OData versions < 3.0).
`boolean`	`getSupportsUnbind()` Return does the service support unbind operations (unbind navigation property from an existing entity in delete)? True by default.
`boolean`	`getUpdateReturnsContent()` Return do updateEntity calls return resulting entity state in response payload? Defaults to `true`.
`boolean`	`getUpdateWithEntityTag()` Return if the backend system returns an ETag header when querying for an entity (or an "etag" annotation when querying for multiple entities), should updates of the entity send the ETag value with an If-Match header? Defaults to `true`.
`void`	`setAvoidInPaths(java.lang.String value)` Set characters that must be avoided in the path component of URLs (e.g.
`void`	`setBatchDownloads(boolean value)` Set if the backend supports download for offline operation, should it be done with batch requests? True by default.
`void`	`setBatchUploads(boolean value)` Set if the backend supports upload for offline operation, should it be done with batch requests? True by default.
`void`	`setCacheMetadata(boolean value)` Set should loaded service metadata be cached in a local file? If `ServiceOptions.metadataFile` is non-null, then the cache file name will be `ServiceOptions.metadataFile` with ".cache" appended.
`void`	`setCheckQueries(boolean value)` Set check data queries before sending them to the server.
`void`	`setCheckResults(boolean value)` Set check query results after receiving them from the server.
`void`	`setCheckVersion(boolean value)` Set check version header in OData responses.
`void`	`setClientInstanceID(java.lang.String value)` Set globally unique client identifier for the client, used to provide a default value for the "Client-Instance-ID" HTTP header.
`void`	`setCreateReturnsContent(boolean value)` Set do createEntity calls return resulting entity state in response payload? Defaults to `true`.
`void`	`setCsdlFetcher(CsdlFetcher value)` Set CSDL fetcher which can resolve CSDL references when loading metadata.
`void`	`setCsdlOptions(int value)` Set CSDL options for parsing.
`void`	`setDatabaseOnly(boolean value)` Set is this service only to be used with a local database? By default, a service can be used both online (remote service) and offline (local database).
`void`	`setDataFormat(int value)` Set format to be used for data interchange (ATOM or JSON).
`void`	`setDataVersion(int value)` Set version to be used for data interchange.
`void`	`setDeleteWithEntityTag(boolean value)` Set if the backend system returns an ETag header when querying for an entity (or an "etag" annotation when querying for multiple entities), should deletes of the entity send the ETag value with an If-Match header? Defaults to `true`.
`void`	`setFixMissingEmptyLists(boolean value)` Set if set to true and the server returns no value for a collection-typed property of an entity then parser will return an empty collection and validation will not fail.
`void`	`setFixMissingNullValues(boolean value)` Set if set to true and the server returns no value for a non collection-typed property of an entity then parser will return a null value and validation will not fail.
`void`	`setIncludeElements(XmlElementList value)` Set extra child elements for parsing main CSDL schema.
`void`	`setIncludeSchemas(DataSchemaList value)` Set pre-parsed CSDL schemas, which may be referenced by the service metadata.
`void`	`setLoadIfCreateStatus(int value)` Set defaults to `204` (HTTP No Content), forcing an implicit `loadEntity` call to be issued before `createEntity` returns, if the create response status from the server is >= `204`.
`void`	`setLoadIfUpdateStatus(int value)` Set defaults to `204` (HTTP No Content), forcing an implicit `loadEntity` call to be issued before `updateEntity` returns, if the update response status from the server is >= `204`.
`void`	`setLogErrors(boolean value)` Set should data service error messages be logged? Defaults to `true`.
`void`	`setLogWarnings(boolean value)` Set should data service warning messages be logged? Defaults to `true`.
`void`	`setMetadataFile(java.lang.String value)` Set name of local file containing OData CSDL service metadata for the data service.
`void`	`setMetadataText(java.lang.String value)` Set text of the service metadata, provider by the caller so it does not need to be loaded.
`void`	`setMetadataURL(java.lang.String value)` Set alternate location of OData CSDL service metadata.
`void`	`setPingAccept(java.lang.String value)` Set response type accepted by `DataService.pingServer`.
`void`	`setPingMethod(java.lang.String value)` Set HTTP method used by `DataService.pingServer`.
`void`	`setPingResource(java.lang.String value)` Set resource path used by `DataService.pingServer`.
`void`	`setRepeatabilityClientID(GuidValue value)` Set optional client ID for repeatable requests.
`void`	`setRequiresToken(java.lang.String value)` Set does the service require a security token for change requests? Defaults to "X-CSRF-Token".
`void`	`setRequiresType(boolean value)` Set does the service always require type metadata in client-sent complex/entity values.
`void`	`setSupportsAlias(boolean value)` Set does the service support parameter aliases? True by default.
`void`	`setSupportsBatch(boolean value)` Set does the service support OData batch requests? True by default.
`void`	`setSupportsBind(boolean value)` Set does the service support bind operations.
`void`	`setSupportsDelta(boolean value)` Set does the service support server-side change tracking (e.g.
`void`	`setSupportsNext(boolean value)` Set does the service support the following of next-links using the $skiptoken system query option.
`void`	`setSupportsPatch(boolean value)` Set does the service support OData PATCH requests (or MERGE for OData versions < 3.0).
`void`	`setSupportsUnbind(boolean value)` Set does the service support unbind operations (unbind navigation property from an existing entity in delete)? True by default.
`void`	`setUpdateReturnsContent(boolean value)` Set do updateEntity calls return resulting entity state in response payload? Defaults to `true`.
`void`	`setUpdateWithEntityTag(boolean value)` Set if the backend system returns an ETag header when querying for an entity (or an "etag" annotation when querying for multiple entities), should updates of the entity send the ETag value with an If-Match header? Defaults to `true`.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - ServiceOptions
```
public ServiceOptions()
```
- Method Detail
  - getAvoidInPaths
```
public java.lang.String getAvoidInPaths()
```
    Return (nullable) Characters that must be avoided in the path component of URLs (e.g. in OData key predicates or function parameters), even when percent-encoded. This mey be the case with certain client or server environments which limit the characters permitted in paths (usually due to security concerns). When this option is set, other options (e.g. ServiceOptions.supportsAlias, ServiceOptions.supportsBatch) may be required to enable such characters to be passed in another way.
    
    See Also:
    
    https://tools.ietf.org/html/rfc3986#section-7.3.
    
    Returns:
    
    (nullable) Characters that must be avoided in the path component of URLs (e.g. in OData key predicates or function parameters), even when percent-encoded.
  - getBatchDownloads
```
public boolean getBatchDownloads()
```
    Return if the backend supports download for offline operation, should it be done with batch requests? True by default.
    
    See Also:
    
    DataService.processBatch
    
    Returns:
    
    If the backend supports download for offline operation, should it be done with batch requests?
  - getBatchUploads
```
public boolean getBatchUploads()
```
    Return if the backend supports upload for offline operation, should it be done with batch requests? True by default.
    
    See Also:
    
    DataService.processBatch
    
    Returns:
    
    If the backend supports upload for offline operation, should it be done with batch requests?
  - getCacheMetadata
```
public boolean getCacheMetadata()
```
    Return should loaded service metadata be cached in a local file? If ServiceOptions.metadataFile is non-null, then the cache file name will be ServiceOptions.metadataFile with ".cache" appended. If ServiceOptions.metadataFile is null, then the cache file name will be the service name with ".csdl.cache" appended.
    
    See Also:
    
    DataService.loadMetadata.
    
    Returns:
    
    Should loaded service metadata be cached in a local file?
  - getCheckQueries
```
public boolean getCheckQueries()
```
    Return check data queries before sending them to the server. Defaults to true.
    
    See Also:
    
    DataQuery.check.
    
    Returns:
    
    Check data queries before sending them to the server. Defaults to `true`.
  - getCheckResults
```
public boolean getCheckResults()
```
    Return check query results after receiving them from the server. Defaults to true.
    
    See Also:
    
    QueryResult.check.
    
    Returns:
    
    Check query results after receiving them from the server. Defaults to `true`.
  - getCheckVersion
```
public boolean getCheckVersion()
```
    Return check version header in OData responses. Defaults to true.
    
    Returns:
    
    Check version header in OData responses. Defaults to true.
  - getClientInstanceID
```
public java.lang.String getClientInstanceID()
```
    Return (nullable) Globally unique client identifier for the client, used to provide a default value for the "Client-Instance-ID" HTTP header.
    
    See Also:
    
    Universally unique identifier.
    
    Returns:
    
    (nullable) Globally unique client identifier for the client, used to provide a default value for the "Client-Instance-ID" HTTP header.
  - getCreateReturnsContent
```
public boolean getCreateReturnsContent()
```
    Return do createEntity calls return resulting entity state in response payload? Defaults to true.
    
    Returns:
    
    Do createEntity calls return resulting entity state in response payload? Defaults to true.
  - getCsdlFetcher
```
public CsdlFetcher getCsdlFetcher()
```
    Return (nullable) CSDL fetcher which can resolve CSDL references when loading metadata. This overrides a data service's default mechanism to load metadata over HTTP.
    
    Returns:
    
    (nullable) CSDL fetcher which can resolve CSDL references when loading metadata.
  - getCsdlOptions
```
public int getCsdlOptions()
```
    Return CSDL options for parsing.
    
    See Also:
    
    CsdlOption.
    
    Returns:
    
    CSDL options for parsing.
  - getDataFormat
```
public int getDataFormat()
```
    Return format to be used for data interchange (ATOM or JSON). Defaults to JSON.
    
    See Also:
    
    DataFormat.
    
    Returns:
    
    Format to be used for data interchange (ATOM or JSON). Defaults to JSON.
  - getDataVersion
```
public int getDataVersion()
```
    Return version to be used for data interchange. If non-zero, this overrides any version specified in the service metadata.
    
    See Also:
    
    DataVersion.
    
    Returns:
    
    Version to be used for data interchange. If non-zero, this overrides any version specified in the service metadata.
  - getDatabaseOnly
```
public boolean getDatabaseOnly()
```
    Return is this service only to be used with a local database? By default, a service can be used both online (remote service) and offline (local database).
    
    Returns:
    
    Is this service only to be used with a local database?
  - getDeleteWithEntityTag
```
public boolean getDeleteWithEntityTag()
```
    Return if the backend system returns an ETag header when querying for an entity (or an "etag" annotation when querying for multiple entities), should deletes of the entity send the ETag value with an If-Match header? Defaults to true.
    
    Returns:
    
    If the backend system returns an ETag header when querying for an entity (or an "etag" annotation when querying for multiple entities), should deletes of the entity send the ETag value with an If-Match header? Defaults to true.
  - getFixMissingEmptyLists
```
public boolean getFixMissingEmptyLists()
```
    Return if set to true and the server returns no value for a collection-typed property of an entity then parser will return an empty collection and validation will not fail. Note: this property is only considered if checkResults is set to true and the property to be queried is selected or expanded in the query. False by default.
    
    Returns:
    
    If set to true and the server returns no value for a collection-typed property of an entity then parser will return an empty collection and validation will not fail.
  - getFixMissingNullValues
```
public boolean getFixMissingNullValues()
```
    Return if set to true and the server returns no value for a non collection-typed property of an entity then parser will return a null value and validation will not fail. Note: this property is only considered if checkResults is set to true and the property to be queried is selected or expanded in the query. False by default.
    
    Returns:
    
    If set to true and the server returns no value for a non collection-typed property of an entity then parser will return a null value and validation will not fail.
  - getIncludeElements
```
public XmlElementList getIncludeElements()
```
    Return extra child elements for parsing main CSDL schema.
    
    Returns:
    
    Extra child elements for parsing main CSDL schema.
  - getIncludeSchemas
```
public DataSchemaList getIncludeSchemas()
```
    Return pre-parsed CSDL schemas, which may be referenced by the service metadata.
    
    Returns:
    
    Pre-parsed CSDL schemas, which may be referenced by the service metadata.
  - getLoadIfCreateStatus
```
public int getLoadIfCreateStatus()
```
    Return defaults to 204 (HTTP No Content), forcing an implicit loadEntity call to be issued before createEntity returns, if the create response status from the server is >= 204. If this property has a value of 200 (HTTP OK) then an implicit loadEntity call will always be issued before createEntity returns, to retrieve the post-create entity state. If this property has a value of 0 then an implicit loadEntity call will never be issued.
    
    Returns:
    
    Defaults to 204 (HTTP No Content), forcing an implicit loadEntity call to be issued before createEntity returns, if the create response status from the server is >= 204.
  - getLoadIfUpdateStatus
```
public int getLoadIfUpdateStatus()
```
    Return defaults to 204 (HTTP No Content), forcing an implicit loadEntity call to be issued before updateEntity returns, if the update response status from the server is >= 204. If this property has a value of 200 (HTTP OK) then an implicit loadEntity call will always be issued before updateEntity returns, to retrieve the post-update entity state. If this property has a value of 0 then an implicit loadEntity call will never be issued.
    
    Returns:
    
    Defaults to 204 (HTTP No Content), forcing an implicit loadEntity call to be issued before updateEntity returns, if the update response status from the server is >= 204.
  - getLogErrors
```
public boolean getLogErrors()
```
    Return should data service error messages be logged? Defaults to true.
    
    Returns:
    
    Should data service error messages be logged? Defaults to true.
  - getLogWarnings
```
public boolean getLogWarnings()
```
    Return should data service warning messages be logged? Defaults to true.
    
    Returns:
    
    Should data service warning messages be logged? Defaults to true.
  - getMetadataFile
```
public java.lang.String getMetadataFile()
```
    Return (nullable) Name of local file containing OData CSDL service metadata for the data service. If this is null, then metadata will be fetched from the remote service.
    
    See Also:
    
    ServiceOptions.cacheMetadata, ServiceOptions.metadataText.
    
    Returns:
    
    (nullable) Name of local file containing OData CSDL service metadata for the data service.
  - getMetadataText
```
public java.lang.String getMetadataText()
```
    Return (nullable) Text of the service metadata, provider by the caller so it does not need to be loaded.
    
    See Also:
    
    ServiceOptions.cacheMetadata, ServiceOptions.metadataFile.
    
    Returns:
    
    (nullable) Text of the service metadata, provider by the caller so it does not need to be loaded.
  - getMetadataURL
```
public java.lang.String getMetadataURL()
```
    Return (nullable) Alternate location of OData CSDL service metadata. Can be an absolute URL, or a relative URL (relative to the service root URL). Use this if the preferred service metadata document appears at a URL other than that formed by appending "$metadata" to the service root URL.
    
    Returns:
    
    (nullable) Alternate location of OData CSDL service metadata.
  - getPingAccept
```
public java.lang.String getPingAccept()
```
    Return response type accepted by DataService.pingServer. Defaults to "application/json,application/xml,application/atomsvc+xml".
    
    Returns:
    
    Response type accepted by DataService.pingServer. Defaults to "application/json,application/xml,application/atomsvc+xml".
  - getPingMethod
```
public java.lang.String getPingMethod()
```
    Return HTTP method used by DataService.pingServer. Defaults to "HEAD".
    
    Returns:
    
    HTTP method used by DataService.pingServer. Defaults to "HEAD".
  - getPingResource
```
public java.lang.String getPingResource()
```
    Return resource path used by DataService.pingServer. Defaults to "/" (the service document).
    
    Returns:
    
    Resource path used by DataService.pingServer. Defaults to "/" (the service document).
  - getRepeatabilityClientID
```
public GuidValue getRepeatabilityClientID()
```
    Return (nullable) Optional client ID for repeatable requests.
    
    Returns:
    
    (nullable) Optional client ID for repeatable requests.
  - getRequiresToken
```
public java.lang.String getRequiresToken()
```
    Return (nullable) Does the service require a security token for change requests? Defaults to "X-CSRF-Token". A token is obtained, implicitly if needed, by a call to DataService.pingServer.
    
    Returns:
    
    (nullable) Does the service require a security token for change requests? Defaults to "X-CSRF-Token".
  - getRequiresType
```
public boolean getRequiresType()
```
    Return does the service always require type metadata in client-sent complex/entity values. False by default.
    
    Returns:
    
    Does the service always require type metadata in client-sent complex/entity values.
  - getSupportsAlias
```
public boolean getSupportsAlias()
```
    Return does the service support parameter aliases? True by default.
    
    Returns:
    
    Does the service support parameter aliases?
  - getSupportsBatch
```
public boolean getSupportsBatch()
```
    Return does the service support OData batch requests? True by default.
    
    See Also:
    
    DataService.processBatch
    
    Returns:
    
    Does the service support OData batch requests?
  - getSupportsBind
```
public boolean getSupportsBind()
```
    Return does the service support bind operations. True by default.
    
    See Also:
    
    EntityValue.bindEntity.
    
    Returns:
    
    Does the service support bind operations.
  - getSupportsDelta
```
public boolean getSupportsDelta()
```
    Return does the service support server-side change tracking (e.g. with delta links)? True by default.
    
    Returns:
    
    Does the service support server-side change tracking (e.g. with delta links)?
  - getSupportsNext
```
public boolean getSupportsNext()
```
    Return does the service support the following of next-links using the $skiptoken system query option. True by default.
    
    Returns:
    
    Does the service support the following of next-links using the $skiptoken system query option.
  - getSupportsPatch
```
public boolean getSupportsPatch()
```
    Return does the service support OData PATCH requests (or MERGE for OData versions < 3.0). True by default.
    
    Returns:
    
    Does the service support OData PATCH requests (or MERGE for OData versions < 3.0).
  - getSupportsUnbind
```
public boolean getSupportsUnbind()
```
    Return does the service support unbind operations (unbind navigation property from an existing entity in delete)? True by default.
    
    See Also:
    
    EntityValue.unbindEntity.
    
    Returns:
    
    Does the service support unbind operations (unbind navigation property from an existing entity in delete)?
  - getUpdateReturnsContent
```
public boolean getUpdateReturnsContent()
```
    Return do updateEntity calls return resulting entity state in response payload? Defaults to true.
    
    Returns:
    
    Do updateEntity calls return resulting entity state in response payload? Defaults to true.
  - getUpdateWithEntityTag
```
public boolean getUpdateWithEntityTag()
```
    Return if the backend system returns an ETag header when querying for an entity (or an "etag" annotation when querying for multiple entities), should updates of the entity send the ETag value with an If-Match header? Defaults to true.
    
    Returns:
    
    If the backend system returns an ETag header when querying for an entity (or an "etag" annotation when querying for multiple entities), should updates of the entity send the ETag value with an If-Match header? Defaults to true.
  - setAvoidInPaths
```
public void setAvoidInPaths(java.lang.String value)
```
    Set characters that must be avoided in the path component of URLs (e.g. in OData key predicates or function parameters), even when percent-encoded. This mey be the case with certain client or server environments which limit the characters permitted in paths (usually due to security concerns). When this option is set, other options (e.g. ServiceOptions.supportsAlias, ServiceOptions.supportsBatch) may be required to enable such characters to be passed in another way.
    
    See Also:
    
    https://tools.ietf.org/html/rfc3986#section-7.3.
    
    Parameters:
    
    value - Characters that must be avoided in the path component of URLs (e.g. in OData key predicates or function parameters), even when percent-encoded.
  - setBatchDownloads
```
public void setBatchDownloads(boolean value)
```
    Set if the backend supports download for offline operation, should it be done with batch requests? True by default.
    
    See Also:
    
    DataService.processBatch
    
    Parameters:
    
    value - If the backend supports download for offline operation, should it be done with batch requests?
  - setBatchUploads
```
public void setBatchUploads(boolean value)
```
    Set if the backend supports upload for offline operation, should it be done with batch requests? True by default.
    
    See Also:
    
    DataService.processBatch
    
    Parameters:
    
    value - If the backend supports upload for offline operation, should it be done with batch requests?
  - setCacheMetadata
```
public void setCacheMetadata(boolean value)
```
    Set should loaded service metadata be cached in a local file? If ServiceOptions.metadataFile is non-null, then the cache file name will be ServiceOptions.metadataFile with ".cache" appended. If ServiceOptions.metadataFile is null, then the cache file name will be the service name with ".csdl.cache" appended.
    
    See Also:
    
    DataService.loadMetadata.
    
    Parameters:
    
    value - Should loaded service metadata be cached in a local file?
  - setCheckQueries
```
public void setCheckQueries(boolean value)
```
    Set check data queries before sending them to the server. Defaults to true.
    
    See Also:
    
    DataQuery.check.
    
    Parameters:
    
    value - Check data queries before sending them to the server. Defaults to `true`.
  - setCheckResults
```
public void setCheckResults(boolean value)
```
    Set check query results after receiving them from the server. Defaults to true.
    
    See Also:
    
    QueryResult.check.
    
    Parameters:
    
    value - Check query results after receiving them from the server. Defaults to `true`.
  - setCheckVersion
```
public void setCheckVersion(boolean value)
```
    Set check version header in OData responses. Defaults to true.
    
    Parameters:
    
    value - Check version header in OData responses. Defaults to true.
  - setClientInstanceID
```
public void setClientInstanceID(java.lang.String value)
```
    Set globally unique client identifier for the client, used to provide a default value for the "Client-Instance-ID" HTTP header.
    
    See Also:
    
    Universally unique identifier.
    
    Parameters:
    
    value - Globally unique client identifier for the client, used to provide a default value for the "Client-Instance-ID" HTTP header.
  - setCreateReturnsContent
```
public void setCreateReturnsContent(boolean value)
```
    Set do createEntity calls return resulting entity state in response payload? Defaults to true.
    
    Parameters:
    
    value - Do createEntity calls return resulting entity state in response payload? Defaults to true.
  - setCsdlFetcher
```
public void setCsdlFetcher(CsdlFetcher value)
```
    Set CSDL fetcher which can resolve CSDL references when loading metadata. This overrides a data service's default mechanism to load metadata over HTTP.
    
    Parameters:
    
    value - CSDL fetcher which can resolve CSDL references when loading metadata.
  - setCsdlOptions
```
public void setCsdlOptions(int value)
```
    Set CSDL options for parsing.
    
    See Also:
    
    CsdlOption.
    
    Parameters:
    
    value - CSDL options for parsing.
  - setDataFormat
```
public void setDataFormat(int value)
```
    Set format to be used for data interchange (ATOM or JSON). Defaults to JSON.
    
    See Also:
    
    DataFormat.
    
    Parameters:
    
    value - Format to be used for data interchange (ATOM or JSON). Defaults to JSON.
  - setDataVersion
```
public void setDataVersion(int value)
```
    Set version to be used for data interchange. If non-zero, this overrides any version specified in the service metadata.
    
    See Also:
    
    DataVersion.
    
    Parameters:
    
    value - Version to be used for data interchange. If non-zero, this overrides any version specified in the service metadata.
  - setDatabaseOnly
```
public void setDatabaseOnly(boolean value)
```
    Set is this service only to be used with a local database? By default, a service can be used both online (remote service) and offline (local database).
    
    Parameters:
    
    value - Is this service only to be used with a local database?
  - setDeleteWithEntityTag
```
public void setDeleteWithEntityTag(boolean value)
```
    Set if the backend system returns an ETag header when querying for an entity (or an "etag" annotation when querying for multiple entities), should deletes of the entity send the ETag value with an If-Match header? Defaults to true.
    
    Parameters:
    
    value - If the backend system returns an ETag header when querying for an entity (or an "etag" annotation when querying for multiple entities), should deletes of the entity send the ETag value with an If-Match header? Defaults to true.
  - setFixMissingEmptyLists
```
public void setFixMissingEmptyLists(boolean value)
```
    Set if set to true and the server returns no value for a collection-typed property of an entity then parser will return an empty collection and validation will not fail. Note: this property is only considered if checkResults is set to true and the property to be queried is selected or expanded in the query. False by default.
    
    Parameters:
    
    value - If set to true and the server returns no value for a collection-typed property of an entity then parser will return an empty collection and validation will not fail.
  - setFixMissingNullValues
```
public void setFixMissingNullValues(boolean value)
```
    Set if set to true and the server returns no value for a non collection-typed property of an entity then parser will return a null value and validation will not fail. Note: this property is only considered if checkResults is set to true and the property to be queried is selected or expanded in the query. False by default.
    
    Parameters:
    
    value - If set to true and the server returns no value for a non collection-typed property of an entity then parser will return a null value and validation will not fail.
  - setIncludeElements
```
public void setIncludeElements(XmlElementList value)
```
    Set extra child elements for parsing main CSDL schema.
    
    Parameters:
    
    value - Extra child elements for parsing main CSDL schema.
  - setIncludeSchemas
```
public void setIncludeSchemas(DataSchemaList value)
```
    Set pre-parsed CSDL schemas, which may be referenced by the service metadata.
    
    Parameters:
    
    value - Pre-parsed CSDL schemas, which may be referenced by the service metadata.
  - setLoadIfCreateStatus
```
public void setLoadIfCreateStatus(int value)
```
    Set defaults to 204 (HTTP No Content), forcing an implicit loadEntity call to be issued before createEntity returns, if the create response status from the server is >= 204. If this property has a value of 200 (HTTP OK) then an implicit loadEntity call will always be issued before createEntity returns, to retrieve the post-create entity state. If this property has a value of 0 then an implicit loadEntity call will never be issued.
    
    Parameters:
    
    value - Defaults to 204 (HTTP No Content), forcing an implicit loadEntity call to be issued before createEntity returns, if the create response status from the server is >= 204.
  - setLoadIfUpdateStatus
```
public void setLoadIfUpdateStatus(int value)
```
    Set defaults to 204 (HTTP No Content), forcing an implicit loadEntity call to be issued before updateEntity returns, if the update response status from the server is >= 204. If this property has a value of 200 (HTTP OK) then an implicit loadEntity call will always be issued before updateEntity returns, to retrieve the post-update entity state. If this property has a value of 0 then an implicit loadEntity call will never be issued.
    
    Parameters:
    
    value - Defaults to 204 (HTTP No Content), forcing an implicit loadEntity call to be issued before updateEntity returns, if the update response status from the server is >= 204.
  - setLogErrors
```
public void setLogErrors(boolean value)
```
    Set should data service error messages be logged? Defaults to true.
    
    Parameters:
    
    value - Should data service error messages be logged? Defaults to true.
  - setLogWarnings
```
public void setLogWarnings(boolean value)
```
    Set should data service warning messages be logged? Defaults to true.
    
    Parameters:
    
    value - Should data service warning messages be logged? Defaults to true.
  - setMetadataFile
```
public void setMetadataFile(java.lang.String value)
```
    Set name of local file containing OData CSDL service metadata for the data service. If this is null, then metadata will be fetched from the remote service.
    
    See Also:
    
    ServiceOptions.cacheMetadata, ServiceOptions.metadataText.
    
    Parameters:
    
    value - Name of local file containing OData CSDL service metadata for the data service.
  - setMetadataText
```
public void setMetadataText(java.lang.String value)
```
    Set text of the service metadata, provider by the caller so it does not need to be loaded.
    
    See Also:
    
    ServiceOptions.cacheMetadata, ServiceOptions.metadataFile.
    
    Parameters:
    
    value - Text of the service metadata, provider by the caller so it does not need to be loaded.
  - setMetadataURL
```
public void setMetadataURL(java.lang.String value)
```
    Set alternate location of OData CSDL service metadata. Can be an absolute URL, or a relative URL (relative to the service root URL). Use this if the preferred service metadata document appears at a URL other than that formed by appending "$metadata" to the service root URL.
    
    Parameters:
    
    value - Alternate location of OData CSDL service metadata.
  - setPingAccept
```
public void setPingAccept(java.lang.String value)
```
    Set response type accepted by DataService.pingServer. Defaults to "application/json,application/xml,application/atomsvc+xml".
    
    Parameters:
    
    value - Response type accepted by DataService.pingServer. Defaults to "application/json,application/xml,application/atomsvc+xml".
  - setPingMethod
```
public void setPingMethod(java.lang.String value)
```
    Set HTTP method used by DataService.pingServer. Defaults to "HEAD".
    
    Parameters:
    
    value - HTTP method used by DataService.pingServer. Defaults to "HEAD".
  - setPingResource
```
public void setPingResource(java.lang.String value)
```
    Set resource path used by DataService.pingServer. Defaults to "/" (the service document).
    
    Parameters:
    
    value - Resource path used by DataService.pingServer. Defaults to "/" (the service document).
  - setRepeatabilityClientID
```
public void setRepeatabilityClientID(GuidValue value)
```
    Set optional client ID for repeatable requests.
    
    Parameters:
    
    value - Optional client ID for repeatable requests.
  - setRequiresToken
```
public void setRequiresToken(java.lang.String value)
```
    Set does the service require a security token for change requests? Defaults to "X-CSRF-Token". A token is obtained, implicitly if needed, by a call to DataService.pingServer.
    
    Parameters:
    
    value - Does the service require a security token for change requests? Defaults to "X-CSRF-Token".
  - setRequiresType
```
public void setRequiresType(boolean value)
```
    Set does the service always require type metadata in client-sent complex/entity values. False by default.
    
    Parameters:
    
    value - Does the service always require type metadata in client-sent complex/entity values.
  - setSupportsAlias
```
public void setSupportsAlias(boolean value)
```
    Set does the service support parameter aliases? True by default.
    
    Parameters:
    
    value - Does the service support parameter aliases?
  - setSupportsBatch
```
public void setSupportsBatch(boolean value)
```
    Set does the service support OData batch requests? True by default.
    
    See Also:
    
    DataService.processBatch
    
    Parameters:
    
    value - Does the service support OData batch requests?
  - setSupportsBind
```
public void setSupportsBind(boolean value)
```
    Set does the service support bind operations. True by default.
    
    See Also:
    
    EntityValue.bindEntity.
    
    Parameters:
    
    value - Does the service support bind operations.
  - setSupportsDelta
```
public void setSupportsDelta(boolean value)
```
    Set does the service support server-side change tracking (e.g. with delta links)? True by default.
    
    Parameters:
    
    value - Does the service support server-side change tracking (e.g. with delta links)?
  - setSupportsNext
```
public void setSupportsNext(boolean value)
```
    Set does the service support the following of next-links using the $skiptoken system query option. True by default.
    
    Parameters:
    
    value - Does the service support the following of next-links using the $skiptoken system query option.
  - setSupportsPatch
```
public void setSupportsPatch(boolean value)
```
    Set does the service support OData PATCH requests (or MERGE for OData versions < 3.0). True by default.
    
    Parameters:
    
    value - Does the service support OData PATCH requests (or MERGE for OData versions < 3.0).
  - setSupportsUnbind
```
public void setSupportsUnbind(boolean value)
```
    Set does the service support unbind operations (unbind navigation property from an existing entity in delete)? True by default.
    
    See Also:
    
    EntityValue.unbindEntity.
    
    Parameters:
    
    value - Does the service support unbind operations (unbind navigation property from an existing entity in delete)?
  - setUpdateReturnsContent
```
public void setUpdateReturnsContent(boolean value)
```
    Set do updateEntity calls return resulting entity state in response payload? Defaults to true.
    
    Parameters:
    
    value - Do updateEntity calls return resulting entity state in response payload? Defaults to true.
  - setUpdateWithEntityTag
```
public void setUpdateWithEntityTag(boolean value)
```
    Set if the backend system returns an ETag header when querying for an entity (or an "etag" annotation when querying for multiple entities), should updates of the entity send the ETag value with an If-Match header? Defaults to true.
    
    Parameters:
    
    value - If the backend system returns an ETag header when querying for an entity (or an "etag" annotation when querying for multiple entities), should updates of the entity send the ETag value with an If-Match header? Defaults to true.

Class ServiceOptions

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ServiceOptions

Method Detail

getAvoidInPaths

getBatchDownloads

getBatchUploads

getCacheMetadata

getCheckQueries

getCheckResults

getCheckVersion

getClientInstanceID

getCreateReturnsContent

getCsdlFetcher

getCsdlOptions

getDataFormat

getDataVersion

getDatabaseOnly

getDeleteWithEntityTag

getFixMissingEmptyLists

getFixMissingNullValues

getIncludeElements

getIncludeSchemas

getLoadIfCreateStatus

getLoadIfUpdateStatus

getLogErrors

getLogWarnings

getMetadataFile

getMetadataText

getMetadataURL

getPingAccept

getPingMethod

getPingResource

getRepeatabilityClientID

getRequiresToken

getRequiresType

getSupportsAlias

getSupportsBatch

getSupportsBind

getSupportsDelta

getSupportsNext

getSupportsPatch

getSupportsUnbind

getUpdateReturnsContent

getUpdateWithEntityTag

setAvoidInPaths

setBatchDownloads

setBatchUploads

setCacheMetadata

setCheckQueries

setCheckResults

setCheckVersion

setClientInstanceID

setCreateReturnsContent

setCsdlFetcher

setCsdlOptions

setDataFormat

setDataVersion

setDatabaseOnly

setDeleteWithEntityTag

setFixMissingEmptyLists

setFixMissingNullValues

setIncludeElements

setIncludeSchemas

setLoadIfCreateStatus

setLoadIfUpdateStatus

setLogErrors

setLogWarnings

setMetadataFile

setMetadataText

setMetadataURL

setPingAccept

setPingMethod

setPingResource

setRepeatabilityClientID

setRequiresToken

setRequiresType