Class GetMerchantsResponse

java.lang.Object
com.blockchyp.client.dto.GetMerchantsResponse
All Implemented Interfaces:
IAbstractAcknowledgement

public class GetMerchantsResponse extends Object implements IAbstractAcknowledgement
The results for a merchant list request.
  • Constructor Details

    • GetMerchantsResponse

      public GetMerchantsResponse()
  • 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.
    • setTest

      public void setTest(boolean value)
      Sets whether or not these results are for test or live merchants.
      Parameters:
      value - whether or not these results are for test or live merchants.
    • isTest

      public boolean isTest()
      Gets whether or not these results are for test or live merchants.
      Returns:
      whether or not these results are for test or live merchants.
    • setMaxResults

      public void setMaxResults(int value)
      Sets max to be returned in a single page.
      Parameters:
      value - max to be returned in a single page. Defaults to the system max of 250.
    • getMaxResults

      public int getMaxResults()
      Gets max to be returned in a single page.
      Returns:
      max to be returned in a single page. Defaults to the system max of 250.
    • setStartIndex

      public void setStartIndex(int value)
      Sets starting index for paged results.
      Parameters:
      value - starting index for paged results. Defaults to zero.
    • getStartIndex

      public int getStartIndex()
      Gets starting index for paged results.
      Returns:
      starting index for paged results. Defaults to zero.
    • setResultCount

      public void setResultCount(int value)
      Sets total number of results accessible through paging.
      Parameters:
      value - total number of results accessible through paging.
    • getResultCount

      public int getResultCount()
      Gets total number of results accessible through paging.
      Returns:
      total number of results accessible through paging.
    • setMerchants

      public void setMerchants(Collection<MerchantProfileResponse> value)
      Sets merchants in the current page of results.
      Parameters:
      value - merchants in the current page of results.
    • getMerchants

      public Collection<MerchantProfileResponse> getMerchants()
      Gets merchants in the current page of results.
      Returns:
      merchants in the current page of results.
    • addMerchant

      public void addMerchant(MerchantProfileResponse value)
      Adds a merchants in the current page of results.
      Parameters:
      value - merchants in the current page of results.