Package jp.gopay.sdk.builders

Interface Paginator<T extends SimpleModel,E,C extends BaseId>

Type Parameters:

T - The model of the response.

E - The type of request returned by methods that respond with a paginated list. Allows concatenation.

C - The class of the cursor used for pagination, which must extend the BaseId class.

All Known Implementing Classes:

AbstractApplicationTokenBuilders.AbstractListApplicationTokenRequestBuilder, AbstractBankAccountsBuilders.AbstractListAllBankAccountsRequestBuilder, AbstractCancelsBuilders.AbstractListAllCancelsRequestBuilder, AbstractChargesBuilders.AbstractListChargesRequestBuilder, AbstractLedgersBuilders.AbstractListLedgersRequestBuilder, AbstractMerchantsBuilders.AbstractGetTransactionHistoryRequestBuilder, AbstractRefundBuilders.AbstractListRefundsRequestBuilder, AbstractStoreBuilders.AbstractListStoresRequestBuilder, AbstractSubscriptionBuilders.AbstractListChargesForPaymentRequestBuilder, AbstractSubscriptionBuilders.AbstractListScheduledPaymentsRequestBuilder, AbstractSubscriptionBuilders.AbstractListSubscriptionChargesRequestBuilder, AbstractSubscriptionBuilders.AbstractListSubscriptionsMerchantRequestBuilder, AbstractSubscriptionBuilders.AbstractListSubscriptionsRequestBuilder, AbstractTransactionTokensBuilders.AbstractListTransactionTokensMerchantRequestBuilder, AbstractTransactionTokensBuilders.AbstractListTransactionTokensRequestBuilder, AbstractTransferBuilders.AbstractListTransferRequestBuilder, AbstractWebhookBuilders.AbstractListWebhookMerchantRequestBuilder, AbstractWebhookBuilders.AbstractListWebhookRequestBuilder, ApplicationTokenBuilders.ListApplicationTokenRequestBuilder, BankAccountsBuilders.ListAllBankAccountsRequestBuilder, CancelsBuilders.ListAllCancelsRequestBuilder, ChargesBuilders.ListChargesRequestBuilder, LedgersBuilders.ListLedgersRequestBuilder, MerchantsBuilders.GetTransactionHistoryRequestBuilder, RefundBuilders.ListRefundsRequestBuilder, RetrofitRequestBuilderPaginated, StoreBuilders.ListStoresRequestBuilder, SubscriptionBuilders.ListChargesForPaymentRequestBuilder, SubscriptionBuilders.ListScheduledPaymentsRequestBuilder, SubscriptionBuilders.ListSubscriptionChargesRequestBuilder, SubscriptionBuilders.ListSubscriptionsMerchantRequestBuilder, SubscriptionBuilders.ListSubscriptionsRequestBuilder, TransactionTokensBuilders.ListTransactionTokensMerchantRequestBuilder, TransactionTokensBuilders.ListTransactionTokensRequestBuilder, TransferBuilders.ListTransferRequestBuilder, WebhookBuilders.ListWebhookMerchantRequestBuilder, WebhookBuilders.ListWebhookRequestBuilder

public interface Paginator<T extends SimpleModel,E,C extends BaseId>

The paginator interface provides the methods for passing pagination parameters to requests.

See Also:

PaginatedList, BaseId

Method Summary

Modifier and Type	Method	Description
E	setCursor(C cursor)	Sets the cursor.
E	setCursorDirection(CursorDirection cursorDirection)	Sets the direction of the cursor.
E	setLimit(Integer limit)	Sets the maximum number of responses to be returned by the API.

Method Detail

setLimit

E setLimit(Integer limit)

Sets the maximum number of responses to be returned by the API.

Parameters:

limit - is an integer value that represents the maximum number of items returned by the API

Returns:

a request object

setCursorDirection

E setCursorDirection(CursorDirection cursorDirection)

Sets the direction of the cursor.

Parameters:

cursorDirection - is a member of the CursorDirection enum

Returns:

a request object

See Also:

CursorDirection

setCursor

E setCursor(C cursor)

Sets the cursor.

Parameters:

cursor - is the cursor used by the API to return a list of items following the other pagination parameters. The cursor usually equals the value of the ID of some item for which a list is being queried.

Returns:

a request object.

See Also:

BaseId