com.fire.sdk.model.request

Class BatchListRequest

java.lang.Object

com.fire.sdk.model.request.BatchListRequest

All Implemented Interfaces:

Request<BatchListRequest,BatchListResponse>

public class BatchListRequest
extends Object
implements Request<BatchListRequest,BatchListResponse>

Constructor Summary

Constructors

Constructor and Description
BatchListRequest()

Method Summary

Modifier and Type	Method and Description
Batch.BatchStatus[]	getBatchStatuses()
Batch.BatchType[]	getBatchTypes()
Object	getBody()
String	getEndpoint()
int	getLimit()
HttpUtils.HttpMethod	getMethod()
int	getOffset()
Class<BatchListResponse>	getResponseClass()
BatchListRequest	setBatchStatuses(Batch.BatchStatus[] batchStatuses) Set the statuses of batches you want returned.
BatchListRequest	setBatchTypes(Batch.BatchType[] batchTypes) Set the types of batches you want returned.
BatchListRequest	setLimit(int limit)
BatchListRequest	setOffset(int offset)

Methods inherited from class java.lang.Object

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

Constructor Detail

BatchListRequest

public BatchListRequest()

Method Detail

getEndpoint

public String getEndpoint()

Specified by:

getEndpoint in interface Request<BatchListRequest,BatchListResponse>

getBatchStatuses

public Batch.BatchStatus[] getBatchStatuses()

setBatchStatuses

public BatchListRequest setBatchStatuses(Batch.BatchStatus[] batchStatuses)

Set the statuses of batches you want returned. The following batch types exist:

• OPEN
• PENDING_APPROVAL
• PENDING_PARENT_BATCH_APPROVAL - the bank transfer batch is waiting for a batch of payees to be approved.
• COMPLETE
• CANCELLED
• REJECTED

Parameters:

batchStatuses - a String[] array containing the batch statuses to return.

Returns:

the batch list request object for chaining

getBatchTypes

public Batch.BatchType[] getBatchTypes()

setBatchTypes

public BatchListRequest setBatchTypes(Batch.BatchType[] batchTypes)

Set the types of batches you want returned. The following batch types exist:

• INTERNAL_TRANSFER
• BANK_TRANSFER
• NEW_PAYEE

Parameters:

batchTypes - a String[] array containing the batch types to return.

Returns:

the batch list request object for chaining

getLimit

public int getLimit()

setLimit

public BatchListRequest setLimit(int limit)

getOffset

public int getOffset()

setOffset

public BatchListRequest setOffset(int offset)

getMethod

public HttpUtils.HttpMethod getMethod()

Specified by:

getMethod in interface Request<BatchListRequest,BatchListResponse>

getResponseClass

public Class<BatchListResponse> getResponseClass()

Specified by:

getResponseClass in interface Request<BatchListRequest,BatchListResponse>

getBody

public Object getBody()

Specified by:

getBody in interface Request<BatchListRequest,BatchListResponse>