com.blockchyp.client.dto

Class TransactionHistoryResponse

java.lang.Object

com.blockchyp.client.dto.TransactionHistoryResponse

All Implemented Interfaces:

IAbstractAcknowledgement

public class TransactionHistoryResponse
extends Object
implements IAbstractAcknowledgement

Models response to a batch history request.

Constructor Summary

Constructors

Constructor and Description
TransactionHistoryResponse()

Method Summary

Modifier and Type	Method and Description
void	addTransaction(AuthorizationResponse value) Adds a matching transaction history.
String	getBatchId() Gets batch identifier if filtered by batch.
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.
String	getTerminalName() Gets terminal name if filtered by terminal.
int	getTotalResultCount() Gets total number of results accessible through paging.
Collection<AuthorizationResponse>	getTransactions() Gets matching transaction history.
boolean	isSuccess() Gets whether or not the request succeeded.
boolean	isTest() Gets that the response came from the test gateway.
void	setBatchId(String value) Sets batch identifier if filtered by batch.
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	setTerminalName(String value) Sets terminal name if filtered by terminal.
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.
void	setTransactions(Collection<AuthorizationResponse> value) Sets matching transaction history.

Methods inherited from class java.lang.Object

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

Constructor Detail

TransactionHistoryResponse

public TransactionHistoryResponse()

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.

setBatchId

public void setBatchId(String value)

Sets batch identifier if filtered by batch.

Parameters:

value - batch identifier if filtered by batch.

getBatchId

public String getBatchId()

Gets batch identifier if filtered by batch.

Returns:

batch identifier if filtered by batch.

setTerminalName

public void setTerminalName(String value)

Sets terminal name if filtered by terminal.

Parameters:

value - terminal name if filtered by terminal.

getTerminalName

public String getTerminalName()

Gets terminal name if filtered by terminal.

Returns:

terminal name if filtered by terminal.

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.

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. Defaults to the system max of 250.

getMaxResults

public int getMaxResults()

Gets max results from the original request echoed back.

Returns:

max results from the original request echoed back. Defaults to the system max of 250.

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.

setTransactions

public void setTransactions(Collection<AuthorizationResponse> value)

Sets matching transaction history.

Parameters:

value - matching transaction history.

getTransactions

public Collection<AuthorizationResponse> getTransactions()

Gets matching transaction history.

Returns:

matching transaction history.

addTransaction

public void addTransaction(AuthorizationResponse value)

Adds a matching transaction history.

Parameters:

value - matching transaction history.