Package com.blockchyp.client.dto
Class GetMerchantsResponse
java.lang.Object
com.blockchyp.client.dto.GetMerchantsResponse
- All Implemented Interfaces:
IAbstractAcknowledgement
The results for a merchant list request.
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoidAdds a merchants in the current page of results.getError()Gets the error, if an error occurred.intGets max to be returned in a single page.Gets merchants in the current page of results.Gets a narrative description of the transaction result.intGets total number of results accessible through paging.intGets starting index for paged results.booleanGets whether or not the request succeeded.booleanisTest()Gets whether or not these results are for test or live merchants.voidSets the error, if an error occurred.voidsetMaxResults(int value) Sets max to be returned in a single page.voidSets merchants in the current page of results.voidsetResponseDescription(String value) Sets a narrative description of the transaction result.voidsetResultCount(int value) Sets total number of results accessible through paging.voidsetStartIndex(int value) Sets starting index for paged results.voidsetSuccess(boolean value) Sets whether or not the request succeeded.voidsetTest(boolean value) Sets whether or not these results are for test or live merchants.
-
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:
isSuccessin interfaceIAbstractAcknowledgement- Returns:
- whether or not the request succeeded.
-
setError
Sets the error, if an error occurred.- Parameters:
value- the error, if an error occurred.
-
getError
Gets the error, if an error occurred.- Specified by:
getErrorin interfaceIAbstractAcknowledgement- Returns:
- the error, if an error occurred.
-
setResponseDescription
Sets a narrative description of the transaction result.- Parameters:
value- a narrative description of the transaction result.
-
getResponseDescription
Gets a narrative description of the transaction result.- Specified by:
getResponseDescriptionin interfaceIAbstractAcknowledgement- 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
Sets merchants in the current page of results.- Parameters:
value- merchants in the current page of results.
-
getMerchants
Gets merchants in the current page of results.- Returns:
- merchants in the current page of results.
-
addMerchant
Adds a merchants in the current page of results.- Parameters:
value- merchants in the current page of results.
-