oracle.cloud.mobile.sync.mobileEndpoint

Class FetchFileBuilder

java.lang.Object

oracle.cloud.mobile.sync.mobileEndpoint.FetchFileBuilder

public class FetchFileBuilder
extends java.lang.Object

Class that exposes fluent APIs for fetching a MobileFile from an API endpoint.

Method Summary

Modifier and Type	Method and Description
void	execute(MobileEndpointCallback callback) Executes the fetch against OMCe and returns the results.
FetchFileBuilder	fromService() When invoked causes the MobileFile to be refreshed from the service.
java.lang.String	getId() Returns the ID of the current MobileFile in the API endpoint.
SyncPolicy	getPolicy() Returns the syncPolicy which the current FetchFileBuilder is using to fetch objects.
boolean	isFromService() Returns true if the current FetchFileBuilder will fetch from the service.
FetchFileBuilder	withHeader(java.lang.String name, java.lang.String value) Specifies the HTTP header.
FetchFileBuilder	withPolicy(SyncPolicy policy) Specifies a SyncPolicy to use.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

withHeader

public FetchFileBuilder withHeader(java.lang.String name,
                                   java.lang.String value)

Specifies the HTTP header.

Parameters:

name - The name of the HTTP Header

value - The value of the HTTP Header

Returns:

The Fetch Object

fromService

public FetchFileBuilder fromService()

When invoked causes the MobileFile to be refreshed from the service.

Returns:

The FetchFileBuilder object

isFromService

public boolean isFromService()

Returns true if the current FetchFileBuilder will fetch from the service.

Returns:

getPolicy

public SyncPolicy getPolicy()

Returns the syncPolicy which the current FetchFileBuilder is using to fetch objects.

Returns:

A SyncPolicy object

withPolicy

public FetchFileBuilder withPolicy(SyncPolicy policy)

Specifies a SyncPolicy to use.

Parameters:

policy - The SyncPolicy to use

Returns:

The FetchFileBuilder object

getId

public java.lang.String getId()

Returns the ID of the current MobileFile in the API endpoint.

Returns:

ID of the MobileFile

execute

public void execute(MobileEndpointCallback callback)
             throws java.lang.Exception

Executes the fetch against OMCe and returns the results.

Parameters:

callback - Callback that gives the result

Throws:

java.lang.Exception - when callback is null