com.blockchyp.client.dto

Class BatchHistoryResponse

java.lang.Object

com.blockchyp.client.dto.BatchHistoryResponse

All Implemented Interfaces:

IAbstractAcknowledgement

public class BatchHistoryResponse
extends Object
implements IAbstractAcknowledgement

Models response to a batch history request.

Constructor Summary

Constructors

Constructor and Description
BatchHistoryResponse()

Method Summary

Modifier and Type	Method and Description
void	addBatche(BatchSummary value) Adds a merchant's batch history in descending order.
Collection<BatchSummary>	getBatches() Gets merchant's batch history in descending order.
Date	getEndDate() Gets end date if filtered by end date.
String	getError() Gets the error, if an error occurred.
int	getMaxResults() Gets max results from the original request echoed back.
String	getResponseDescription() Gets a narrative description of the transaction result.
Date	getStartDate() Gets start date if filtered by start date.
int	getStartIndex() Gets starting index from the original request echoed back.
int	getTotalResultCount() Gets total number of results accessible through paging.
boolean	isSuccess() Gets whether or not the request succeeded.
boolean	isTest() Gets that the response came from the test gateway.
void	setBatches(Collection<BatchSummary> value) Sets merchant's batch history in descending order.
void	setEndDate(Date value) Sets end date if filtered by end date.
void	setError(String value) Sets the error, if an error occurred.
void	setMaxResults(int value) Sets max results from the original request echoed back.
void	setResponseDescription(String value) Sets a narrative description of the transaction result.
void	setStartDate(Date value) Sets start date if filtered by start date.
void	setStartIndex(int value) Sets starting index from the original request echoed back.
void	setSuccess(boolean value) Sets whether or not the request succeeded.
void	setTest(boolean value) Sets that the response came from the test gateway.
void	setTotalResultCount(int value) Sets total number of results accessible through paging.

Methods inherited from class java.lang.Object

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

Constructor Detail

BatchHistoryResponse

public BatchHistoryResponse()

Method Detail

setSuccess

public void setSuccess(boolean value)

Sets whether or not the request succeeded.

Parameters:

value - whether or not the request succeeded.

isSuccess

public boolean isSuccess()

Gets whether or not the request succeeded.

Specified by:

isSuccess in interface IAbstractAcknowledgement

Returns:

whether or not the request succeeded.

setError

public void setError(String value)

Sets the error, if an error occurred.

Parameters:

value - the error, if an error occurred.

getError

public String getError()

Gets the error, if an error occurred.

Specified by:

getError in interface IAbstractAcknowledgement

Returns:

the error, if an error occurred.

setResponseDescription

public void setResponseDescription(String value)

Sets a narrative description of the transaction result.

Parameters:

value - a narrative description of the transaction result.

getResponseDescription

public String getResponseDescription()

Gets a narrative description of the transaction result.

Specified by:

getResponseDescription in interface IAbstractAcknowledgement

Returns:

a narrative description of the transaction result.

setTest

public void setTest(boolean value)

Sets that the response came from the test gateway.

Parameters:

value - that the response came from the test gateway.

isTest

public boolean isTest()

Gets that the response came from the test gateway.

Returns:

that the response came from the test gateway.

setStartDate

public void setStartDate(Date value)

Sets start date if filtered by start date.

Parameters:

value - start date if filtered by start date.

getStartDate

public Date getStartDate()

Gets start date if filtered by start date.

Returns:

start date if filtered by start date.

setEndDate

public void setEndDate(Date value)

Sets end date if filtered by end date.

Parameters:

value - end date if filtered by end date.

getEndDate

public Date getEndDate()

Gets end date if filtered by end date.

Returns:

end date if filtered by end date.

setBatches

public void setBatches(Collection<BatchSummary> value)

Sets merchant's batch history in descending order.

Parameters:

value - merchant's batch history in descending order.

getBatches

public Collection<BatchSummary> getBatches()

Gets merchant's batch history in descending order.

Returns:

merchant's batch history in descending order.

setMaxResults

public void setMaxResults(int value)

Sets max results from the original request echoed back.

Parameters:

value - max results from the original request echoed back.

getMaxResults

public int getMaxResults()

Gets max results from the original request echoed back.

Returns:

max results from the original request echoed back.

setStartIndex

public void setStartIndex(int value)

Sets starting index from the original request echoed back.

Parameters:

value - starting index from the original request echoed back.

getStartIndex

public int getStartIndex()

Gets starting index from the original request echoed back.

Returns:

starting index from the original request echoed back.

setTotalResultCount

public void setTotalResultCount(int value)

Sets total number of results accessible through paging.

Parameters:

value - total number of results accessible through paging.

getTotalResultCount

public int getTotalResultCount()

Gets total number of results accessible through paging.

Returns:

total number of results accessible through paging.

addBatche

public void addBatche(BatchSummary value)

Adds a merchant's batch history in descending order.

Parameters:

value - merchant's batch history in descending order.