IPartnerServiceClient Interface

public interface IPartnerServiceClient

Method Summary

Modifier and Type Method and Description
abstract U <T,U>patch(IPartner rootPartnerOperations, TypeReference<U> responseType, String relativeUri, T content)

Executes a PATCH operation against the partner service.

abstract U <T,U>post(IPartner rootPartnerOperations, TypeReference<U> responseType, String relativeUri, T content)

Executes a POST operation against the partner service.

abstract U <T,U>post(IPartner rootPartnerOperations, TypeReference<U> responseType, String relativeUri, T content, Collection<KeyValuePair<String,String>> parameters)

Executes a POST operation against the partner service.

abstract U <T,U>put(IPartner rootPartnerOperations, TypeReference<U> responseType, String relativeUri, T content)

Executes a PUT operation against the partner service.

abstract void <T>delete(IPartner rootPartnerOperations, TypeReference<T> responseType, String relativeUri)

Executes a DELETE operation against the partner service.

abstract T <T>get(IPartner rootPartnerOperations, TypeReference<T> responseType, Link link)

Executes a GET operation against the partner service.

abstract T <T>get(IPartner rootPartnerOperations, TypeReference<T> responseType, String relativeUri)

Executes a GET operation against the partner service.

abstract T <T>get(IPartner rootPartnerOperations, TypeReference<T> responseType, String relativeUri, Collection<KeyValuePair<String,String>> parameters)

Executes a GET operation against the partner service.

abstract T <T>get(IPartner rootPartnerOperations, TypeReference<T> responseType, String relativeUri, Map<String,String> headers, Collection<KeyValuePair<String,String>> parameters)

Executes a GET operation against the partner service.

abstract T <T>head(IPartner rootPartnerOperations, TypeReference<T> responseType, String relativeUri)

Executes a HEAD operation against the partner service.

abstract java.io.InputStream getFileContents(IPartner rootPartnerOperations, String relativeUri, String acceptType)

Executes a file content request against the partner service.

Method Details

<T,U>patch

public abstract U patch(IPartner rootPartnerOperations, TypeReference responseType, String relativeUri, T content)

Executes a PATCH operation against the partner service.

Parameters:

rootPartnerOperations - An instance of the partner operations.
responseType - The type of object to be returned.
relativeUri - The relative address of the request.
content - The content for the body of the request.

Returns:

The response from the PATCH operation.

<T,U>post

public abstract U post(IPartner rootPartnerOperations, TypeReference responseType, String relativeUri, T content)

Executes a POST operation against the partner service.

Parameters:

rootPartnerOperations - An instance of the partner operations.
responseType - The type of object to be returned.
relativeUri - The relative address fo the request.
content - The content for the body of the request.

Returns:

The response from the POST operation.

<T,U>post

public abstract U post(IPartner rootPartnerOperations, TypeReference responseType, String relativeUri, T content, Collection> parameters)

Executes a POST operation against the partner service.

Parameters:

rootPartnerOperations - An instance of the partner operations.
responseType - The type of object to be returned.
relativeUri - The relative address fo the request.
content - The content for the body of the request.
parameters - Parameters to be added to the request.

Returns:

The response from the POST operation.

<T,U>put

public abstract U put(IPartner rootPartnerOperations, TypeReference responseType, String relativeUri, T content)

Executes a PUT operation against the partner service.

Parameters:

rootPartnerOperations - An instance of the partner operations.
responseType - The type of object to be returned.
relativeUri - The relative address fo the request.
content - The content for the body of the request.

Returns:

The response from the PUT operation.

<T>delete

public abstract void delete(IPartner rootPartnerOperations, TypeReference responseType, String relativeUri)

Executes a DELETE operation against the partner service.

Parameters:

rootPartnerOperations - An instance of the partner operations.
responseType - The type of object to be returned.
relativeUri - The relative address fo the request.

<T>get

public abstract T get(IPartner rootPartnerOperations, TypeReference responseType, Link link)

Executes a GET operation against the partner service.

Parameters:

rootPartnerOperations - An instance of the partner operations.
responseType - The type of object to be returned.
link - A link object that represents the action for accessing the resource.

Returns:

The response from the GET operation.

<T>get

public abstract T get(IPartner rootPartnerOperations, TypeReference responseType, String relativeUri)

Executes a GET operation against the partner service.

Parameters:

rootPartnerOperations - An instance of the partner operations.
responseType - The type of object to be returned.
relativeUri - The relative address of the request.

Returns:

The response from the GET operation.

<T>get

public abstract T get(IPartner rootPartnerOperations, TypeReference responseType, String relativeUri, Collection> parameters)

Executes a GET operation against the partner service.

Parameters:

rootPartnerOperations - An instance of the partner operations.
responseType - The type of object to be returned.
relativeUri - The relative address of the request.
parameters - Parameters to be added to the request.

Returns:

The response from the GET operation.

<T>get

public abstract T get(IPartner rootPartnerOperations, TypeReference responseType, String relativeUri, Map headers, Collection> parameters)

Executes a GET operation against the partner service.

Parameters:

rootPartnerOperations - An instance of the partner operations.
responseType - The type of object to be returned.
relativeUri - The relative address of the request.
headers - Headers to be added to the request.
parameters - Parameters to be added to the request.

Returns:

The response from the GET operation.

<T>head

public abstract T head(IPartner rootPartnerOperations, TypeReference responseType, String relativeUri)

Executes a HEAD operation against the partner service.

Parameters:

rootPartnerOperations - An instance of the partner operations.
responseType - The type of object to be returned.
relativeUri - The relative address of the request.

Returns:

The response from the HEAD operation.

getFileContents

public abstract InputStream getFileContents(IPartner rootPartnerOperations, String relativeUri, String acceptType)

Executes a file content request against the partner service.

Parameters:

rootPartnerOperations - An instance of the partner operations.
relativeUri - The relative address of the request.
acceptType - The value for the accept type header.

Returns:

The response from the file content request.

Applies to