org.schedulesdirect.api.json

Interface IJsonRequestFactory

All Known Implementing Classes:

JsonRequestFactory

public interface IJsonRequestFactory

Author:

Derek Battams <derek@battams.ca>

Method Summary

Methods

Modifier and Type	Method and Description
JsonRequest	get(JsonRequest.Action action, String resource) Construct a partial JsonRequest that CANNOT be executed; used as skeleton for a clone construction
JsonRequest	get(JsonRequest.Action action, String resource, String hash, String userAgent, String baseUrl) Construct a complete JsonRequest suitable for execution.
JsonRequest	get(JsonRequest.Action action, URL url) Construct a JSON request from a complete URL; the request is partial and cannot be immediately executed

Method Detail

get

JsonRequest get(JsonRequest.Action action,
              String resource,
              String hash,
              String userAgent,
              String baseUrl)

Construct a complete JsonRequest suitable for execution.

Parameters:

action - The action to execute

resource - The resource to execute against

hash - The user auth hash or null if not available/not required

userAgent - The user agent to pass to the server

baseUrl - The service base URL

Returns:

The constructed JsonRequest, ready to be executed

get

JsonRequest get(JsonRequest.Action action,
              String resource)

Construct a partial JsonRequest that CANNOT be executed; used as skeleton for a clone construction

Parameters:

action - The action to execute

resource - The resource to execute against

Returns:

The partial JsonRequest object; use this object as the basis for constructing a full one

get

JsonRequest get(JsonRequest.Action action,
              URL url)

Construct a JSON request from a complete URL; the request is partial and cannot be immediately executed

Parameters:

action - The action to execute

url - The URL to build the request from

Returns:

The partial JsonRequest; suitable for constructing a full, executable request