com.blockchyp.client.dto

Class BatchDetailsResponse

java.lang.Object

com.blockchyp.client.dto.BatchDetailsResponse

All Implemented Interfaces:

IAbstractAcknowledgement

public class BatchDetailsResponse
extends Object
implements IAbstractAcknowledgement

Models a response for details about a single batch.

Constructor Summary

Constructors

Constructor and Description
BatchDetailsResponse()

Method Summary

Modifier and Type	Method and Description
void	addVolumeByTerminal(TerminalVolume value) Adds a merchant's batch history in descending order.
String	getBatchId() Gets batch identifier.
String	getCapturedAmount() Gets the new captured amount.
Date	getCloseDate() Gets date and time the batch was closed.
String	getDestinationAccountId() Gets merchant deposit account into which proceeds should be deposited.
String	getEntryMethod() Gets entry method for the batch, if any.
String	getError() Gets the error, if an error occurred.
String	getExpectedDeposit() Gets the expected volume for this batch, usually captured volume less gift card volume.
String	getGiftCardsSold() Gets the total volume of gift cards sold.
String	getGiftCardVolume() Gets the total volume of gift cards transactions.
Date	getOpenDate() Gets date and time of the first transaction for this batch.
String	getOpenPreauths() Gets preauths from this batch still open.
String	getResponseDescription() Gets a narrative description of the transaction result.
String	getTotalVolume() Gets the total volume from this batch.
int	getTransactionCount() Gets the total number of transactions in this batch.
Collection<TerminalVolume>	getVolumeByTerminal() Gets merchant's batch history in descending order.
boolean	isOpen() Gets flag indicating whether or not the batch is open.
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.
void	setCapturedAmount(String value) Sets the new captured amount.
void	setCloseDate(Date value) Sets date and time the batch was closed.
void	setDestinationAccountId(String value) Sets merchant deposit account into which proceeds should be deposited.
void	setEntryMethod(String value) Sets entry method for the batch, if any.
void	setError(String value) Sets the error, if an error occurred.
void	setExpectedDeposit(String value) Sets the expected volume for this batch, usually captured volume less gift card volume.
void	setGiftCardsSold(String value) Sets the total volume of gift cards sold.
void	setGiftCardVolume(String value) Sets the total volume of gift cards transactions.
void	setOpen(boolean value) Sets flag indicating whether or not the batch is open.
void	setOpenDate(Date value) Sets date and time of the first transaction for this batch.
void	setOpenPreauths(String value) Sets preauths from this batch still open.
void	setResponseDescription(String value) Sets a narrative description of the transaction result.
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	setTotalVolume(String value) Sets the total volume from this batch.
void	setTransactionCount(int value) Sets the total number of transactions in this batch.
void	setVolumeByTerminal(Collection<TerminalVolume> value) Sets merchant's batch history in descending order.

Methods inherited from class java.lang.Object

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

Constructor Detail

BatchDetailsResponse

public BatchDetailsResponse()

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.

Parameters:

value - batch identifier.

getBatchId

public String getBatchId()

Gets batch identifier.

Returns:

batch identifier.

setEntryMethod

public void setEntryMethod(String value)

Sets entry method for the batch, if any.

Parameters:

value - entry method for the batch, if any.

getEntryMethod

public String getEntryMethod()

Gets entry method for the batch, if any.

Returns:

entry method for the batch, if any.

setDestinationAccountId

public void setDestinationAccountId(String value)

Sets merchant deposit account into which proceeds should be deposited.

Parameters:

value - merchant deposit account into which proceeds should be deposited.

getDestinationAccountId

public String getDestinationAccountId()

Gets merchant deposit account into which proceeds should be deposited.

Returns:

merchant deposit account into which proceeds should be deposited.

setCapturedAmount

public void setCapturedAmount(String value)

Sets the new captured amount.

Parameters:

value - the new captured amount.

getCapturedAmount

public String getCapturedAmount()

Gets the new captured amount.

Returns:

the new captured amount.

setOpenPreauths

public void setOpenPreauths(String value)

Sets preauths from this batch still open.

Parameters:

value - preauths from this batch still open.

getOpenPreauths

public String getOpenPreauths()

Gets preauths from this batch still open.

Returns:

preauths from this batch still open.

setTotalVolume

public void setTotalVolume(String value)

Sets the total volume from this batch.

Parameters:

value - the total volume from this batch.

getTotalVolume

public String getTotalVolume()

Gets the total volume from this batch.

Returns:

the total volume from this batch.

setTransactionCount

public void setTransactionCount(int value)

Sets the total number of transactions in this batch.

Parameters:

value - the total number of transactions in this batch.

getTransactionCount

public int getTransactionCount()

Gets the total number of transactions in this batch.

Returns:

the total number of transactions in this batch.

setGiftCardsSold

public void setGiftCardsSold(String value)

Sets the total volume of gift cards sold.

Parameters:

value - the total volume of gift cards sold.

getGiftCardsSold

public String getGiftCardsSold()

Gets the total volume of gift cards sold.

Returns:

the total volume of gift cards sold.

setGiftCardVolume

public void setGiftCardVolume(String value)

Sets the total volume of gift cards transactions.

Parameters:

value - the total volume of gift cards transactions.

getGiftCardVolume

public String getGiftCardVolume()

Gets the total volume of gift cards transactions.

Returns:

the total volume of gift cards transactions.

setExpectedDeposit

public void setExpectedDeposit(String value)

Sets the expected volume for this batch, usually captured volume less gift card volume.

Parameters:

value - the expected volume for this batch, usually captured volume less gift card volume.

getExpectedDeposit

public String getExpectedDeposit()

Gets the expected volume for this batch, usually captured volume less gift card volume.

Returns:

the expected volume for this batch, usually captured volume less gift card volume.

setOpen

public void setOpen(boolean value)

Sets flag indicating whether or not the batch is open.

Parameters:

value - flag indicating whether or not the batch is open.

isOpen

public boolean isOpen()

Gets flag indicating whether or not the batch is open.

Returns:

flag indicating whether or not the batch is open.

setOpenDate

public void setOpenDate(Date value)

Sets date and time of the first transaction for this batch.

Parameters:

value - date and time of the first transaction for this batch.

getOpenDate

public Date getOpenDate()

Gets date and time of the first transaction for this batch.

Returns:

date and time of the first transaction for this batch.

setCloseDate

public void setCloseDate(Date value)

Sets date and time the batch was closed.

Parameters:

value - date and time the batch was closed.

getCloseDate

public Date getCloseDate()

Gets date and time the batch was closed.

Returns:

date and time the batch was closed.

setVolumeByTerminal

public void setVolumeByTerminal(Collection<TerminalVolume> value)

Sets merchant's batch history in descending order.

Parameters:

value - merchant's batch history in descending order.

getVolumeByTerminal

public Collection<TerminalVolume> getVolumeByTerminal()

Gets merchant's batch history in descending order.

Returns:

merchant's batch history in descending order.

addVolumeByTerminal

public void addVolumeByTerminal(TerminalVolume value)

Adds a merchant's batch history in descending order.

Parameters:

value - merchant's batch history in descending order.