com.echopf

クラス ECHOQuery

java.lang.Object

com.echopf.ECHOQuery

public class ECHOQuery
extends java.lang.Object

The ECHOQuery contains basic query methods used by the SDK.

メソッドのサマリー

修飾子とタイプ	メソッドと説明
static JSONObject	deleteRequest(java.lang.String path) Sends a DELETE request
static <T extends ECHODataObject<T>> ECHOList<T>	doFind(boolean sync, java.lang.String listKey, java.lang.String resourceType, FindCallback<T> callback, java.lang.String instanceId, JSONObject fParams, ECHODataObjectFactory<T> factory) Does Find objects from the remote server.
static JSONObject	getRequest(java.lang.String path) Sends a GET request.
static JSONObject	getRequest(java.lang.String path, JSONObject query) Sends a GET request with optional request parameters.
static JSONObject	multipartPostRequest(java.lang.String path, JSONObject data) Sends a multipart POST request.
static JSONObject	multipartPutRequest(java.lang.String path, JSONObject data) Sends a multipart PUT request.
static JSONObject	postRequest(java.lang.String path, JSONObject data) Sends a POST request.
static JSONObject	putRequest(java.lang.String path, JSONObject data) Sends a PUT request.
static JSONObject	request(java.lang.String path, java.lang.String httpMethod) Sends a HTTP request.
static JSONObject	request(java.lang.String path, java.lang.String httpMethod, JSONObject data) Sends a HTTP request.
static JSONObject	request(java.lang.String path, java.lang.String httpMethod, JSONObject data, boolean multipart) Sends a HTTP request with optional request contents/parameters.
static java.io.InputStream	requestRaw(java.lang.String path, java.lang.String httpMethod, JSONObject data, boolean multipart) Sends a HTTP request with optional request contents/parameters.

クラスから継承されたメソッド java.lang.Object

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

メソッドの詳細

doFind

public static <T extends ECHODataObject<T>> ECHOList<T> doFind(boolean sync,
                                                               java.lang.String listKey,
                                                               java.lang.String resourceType,
                                                               FindCallback<T> callback,
                                                               java.lang.String instanceId,
                                                               JSONObject fParams,
                                                               ECHODataObjectFactory<T> factory)
                                                        throws ECHOException

Does Find objects from the remote server.

パラメータ:

sync - : if set TRUE, then the main (UI) thread is waited for complete the finding in a background thread. (a synchronous communication)

listKey - the key associated with the object list

clazz - the object class

callback - invoked after the finding is completed

instanceId - the reference ID of the finding target instance

resourceType - the type of this object

params - to control the output objects

例外:

ECHOException

getRequest

public static JSONObject getRequest(java.lang.String path)
                             throws ECHOException

Sends a GET request.

パラメータ:

path - a request url path

例外:

ECHOException

getRequest

public static JSONObject getRequest(java.lang.String path,
                                    JSONObject query)
                             throws ECHOException

Sends a GET request with optional request parameters.

パラメータ:

path - a request url path

query - optional request parameters

例外:

ECHOException

postRequest

public static JSONObject postRequest(java.lang.String path,
                                     JSONObject data)
                              throws ECHOException

Sends a POST request.

パラメータ:

path - a request url path

data - request contents

例外:

ECHOException

multipartPostRequest

public static JSONObject multipartPostRequest(java.lang.String path,
                                              JSONObject data)
                                       throws ECHOException

Sends a multipart POST request.

パラメータ:

path - a request url path

data - request contents

例外:

ECHOException

putRequest

public static JSONObject putRequest(java.lang.String path,
                                    JSONObject data)
                             throws ECHOException

Sends a PUT request.

パラメータ:

path - a request url path

data - request contents

例外:

ECHOException

multipartPutRequest

public static JSONObject multipartPutRequest(java.lang.String path,
                                             JSONObject data)
                                      throws ECHOException

Sends a multipart PUT request.

パラメータ:

path - a request url path

data - request contents

例外:

ECHOException

deleteRequest

public static JSONObject deleteRequest(java.lang.String path)
                                throws ECHOException

Sends a DELETE request

パラメータ:

path - a request url path

例外:

ECHOException

request

public static JSONObject request(java.lang.String path,
                                 java.lang.String httpMethod)
                          throws ECHOException

Sends a HTTP request.

パラメータ:

path - a request url path

httpMethod - a request method (GET/POST/PUT/DELETE)

例外:

ECHOException

request

public static JSONObject request(java.lang.String path,
                                 java.lang.String httpMethod,
                                 JSONObject data)
                          throws ECHOException

Sends a HTTP request.

パラメータ:

path - a request url path

httpMethod - a request method (GET/POST/PUT/DELETE)

data - request contents/parameters

例外:

ECHOException

request

public static JSONObject request(java.lang.String path,
                                 java.lang.String httpMethod,
                                 JSONObject data,
                                 boolean multipart)
                          throws ECHOException

Sends a HTTP request with optional request contents/parameters.

パラメータ:

path - a request url path

httpMethod - a request method (GET/POST/PUT/DELETE)

data - request contents/parameters

multipart - use multipart/form-data to encode the contents

例外:

ECHOException

requestRaw

public static java.io.InputStream requestRaw(java.lang.String path,
                                             java.lang.String httpMethod,
                                             JSONObject data,
                                             boolean multipart)
                                      throws ECHOException

Sends a HTTP request with optional request contents/parameters.

パラメータ:

path - a request url path

httpMethod - a request method (GET/POST/PUT/DELETE)

data - request contents/parameters

multipart - use multipart/form-data to encode the contents

例外:

ECHOException