Package com.blockchyp.client.dto

Class LocateResponse

java.lang.Object
com.blockchyp.client.dto.LocateResponse
All Implemented Interfaces:
IAbstractAcknowledgement, ICoreResponse
public class LocateResponse extends Object implements IAbstractAcknowledgement, ICoreResponse
The response to a locate request.

  • Constructor Details

    • LocateResponse

      public LocateResponse()

  • Method Details

    • 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.

    • setTransactionId

      public void setTransactionId(String value)
      Sets the ID assigned to the transaction.
      Parameters:
      value - the ID assigned to the transaction.

    • getTransactionId

      public String getTransactionId()
      Gets the ID assigned to the transaction.
      Specified by:
      getTransactionId in interface ICoreResponse
      Returns:
      the ID assigned to the transaction.

    • setBatchId

      public void setBatchId(String value)
      Sets the ID assigned to the batch.
      Parameters:
      value - the ID assigned to the batch.

    • getBatchId

      public String getBatchId()
      Gets the ID assigned to the batch.
      Specified by:
      getBatchId in interface ICoreResponse
      Returns:
      the ID assigned to the batch.

    • setTransactionRef

      public void setTransactionRef(String value)
      Sets the transaction reference string assigned to the transaction request.
      Parameters:
      value - the transaction reference string assigned to the transaction request. If no transaction ref was assiged on the request, then the gateway will randomly generate one.

    • getTransactionRef

      public String getTransactionRef()
      Gets the transaction reference string assigned to the transaction request.
      Specified by:
      getTransactionRef in interface ICoreResponse
      Returns:
      the transaction reference string assigned to the transaction request. If no transaction ref was assiged on the request, then the gateway will randomly generate one.

    • setTransactionType

      public void setTransactionType(String value)
      Sets the type of transaction.
      Parameters:
      value - the type of transaction.

    • getTransactionType

      public String getTransactionType()
      Gets the type of transaction.
      Specified by:
      getTransactionType in interface ICoreResponse
      Returns:
      the type of transaction.

    • setTimestamp

      public void setTimestamp(String value)
      Sets the timestamp of the transaction.
      Parameters:
      value - the timestamp of the transaction.

    • getTimestamp

      public String getTimestamp()
      Gets the timestamp of the transaction.
      Specified by:
      getTimestamp in interface ICoreResponse
      Returns:
      the timestamp of the transaction.

    • setTickBlock

      public void setTickBlock(String value)
      Sets the hash of the last tick block.
      Parameters:
      value - the hash of the last tick block.

    • getTickBlock

      public String getTickBlock()
      Gets the hash of the last tick block.
      Specified by:
      getTickBlock in interface ICoreResponse
      Returns:
      the hash of the last tick block.

    • setTest

      public void setTest(boolean value)
      Sets that the transaction was processed on the test gateway.
      Parameters:
      value - that the transaction was processed on the test gateway.

    • isTest

      public boolean isTest()
      Gets that the transaction was processed on the test gateway.
      Specified by:
      isTest in interface ICoreResponse
      Returns:
      that the transaction was processed on the test gateway.

    • setDestinationAccount

      public void setDestinationAccount(String value)
      Sets the settlement account for merchants with split settlements.
      Parameters:
      value - the settlement account for merchants with split settlements.

    • getDestinationAccount

      public String getDestinationAccount()
      Gets the settlement account for merchants with split settlements.
      Specified by:
      getDestinationAccount in interface ICoreResponse
      Returns:
      the settlement account for merchants with split settlements.

    • setSig

      public void setSig(String value)
      Sets the ECC signature of the response.
      Parameters:
      value - the ECC signature of the response. Can be used to ensure that it was signed by the terminal and detect man-in-the middle attacks.

    • getSig

      public String getSig()
      Gets the ECC signature of the response.
      Specified by:
      getSig in interface ICoreResponse
      Returns:
      the ECC signature of the response. Can be used to ensure that it was signed by the terminal and detect man-in-the middle attacks.

    • setTerminalName

      public void setTerminalName(String value)
      Sets the name assigned to the terminal at activation.
      Parameters:
      value - the name assigned to the terminal at activation.

    • getTerminalName

      public String getTerminalName()
      Gets the name assigned to the terminal at activation.
      Returns:
      the name assigned to the terminal at activation.

    • setIpAddress

      public void setIpAddress(String value)
      Sets the local IP address of the terminal.
      Parameters:
      value - the local IP address of the terminal.

    • getIpAddress

      public String getIpAddress()
      Gets the local IP address of the terminal.
      Returns:
      the local IP address of the terminal.

    • setCloudRelay

      public void setCloudRelay(boolean value)
      Sets whether or not the terminal is running in cloud relay mode.
      Parameters:
      value - whether or not the terminal is running in cloud relay mode.

    • isCloudRelay

      public boolean isCloudRelay()
      Gets whether or not the terminal is running in cloud relay mode.
      Returns:
      whether or not the terminal is running in cloud relay mode.

    • setPublicKey

      public void setPublicKey(String value)
      Sets the terminal's public key.
      Parameters:
      value - the terminal's public key.

    • getPublicKey

      public String getPublicKey()
      Gets the terminal's public key.
      Returns:
      the terminal's public key.