BaseEntityCollectionRequest<T,T2,T3> Class

Type Parameters

T

the type of the object in the collection

T2

the response collection type

T3

the collection page type

public abstract class BaseEntityCollectionRequest<T,T2,T3>
extends BaseCollectionRequest<T,T2,T3>

A request against a collection

Constructor Summary

Constructor Description
BaseEntityCollectionRequest(String requestUrl, IBaseClient<?> client, List<? extends Option> options, Class<T2> responseCollectionClass, Class<T3> collectionPageClass, Class<? extends BaseCollectionRequestBuilder<T,? extends BaseRequestBuilder<T>,T2,T3,? extends BaseCollectionRequest<T,T2,T3>>> collectionRequestBuilderClass)

Create the collection request

Method Summary

Modifier and Type Method and Description
protected T2 post(BodyType serializedObject)

Posts this request

T3 get()

Gets the collection of items

java.util.concurrent.CompletableFuture<T3> getAsync()

Gets the collection of items

Methods inherited from BaseCollectionRequest

Methods inherited from java.lang.Object

java.lang.Object.clone java.lang.Object.equals java.lang.Object.finalize java.lang.Object.getClass java.lang.Object.hashCode java.lang.Object.notify java.lang.Object.notifyAll java.lang.Object.toString java.lang.Object.wait java.lang.Object.wait java.lang.Object.wait

Constructor Details

BaseEntityCollectionRequest

public BaseEntityCollectionRequest(String requestUrl, IBaseClient client, List options, Class responseCollectionClass, Class collectionPageClass, Class,T2,T3,? extends BaseCollectionRequest>> collectionRequestBuilderClass)

Create the collection request

Parameters:

requestUrl - the URL to make the request against
client - the client which can issue the request
options - the options for this request
responseCollectionClass - the class for the response collection
collectionPageClass - the class for the collection page
collectionRequestBuilderClass - the class for the collection request builder

Method Details

post

protected T2 post(BodyType serializedObject)

Posts this request

Parameters:

serializedObject - the object to serialize as the body

Returns:

the response object

Throws:

ClientException - an exception occurs if there was an error while the request was sent

get

public T3 get()

Gets the collection of items

Returns:

the collection page

Throws:

getAsync

public CompletableFuture getAsync()

Gets the collection of items

Returns:

a future with the result

Applies to