Interface CollectionBasedRequest

All Superinterfaces:

QueryParameterBasedRequest

All Known Implementing Classes:

GetCollectionDetailsRequest, GetCollectionImagesRequest, GetTranslationsRequest

public interface CollectionBasedRequest
extends QueryParameterBasedRequest

Interface for a request that is specific to a collection.

See Also:

• QueryParameterBasedRequest

Method Summary

Modifier and Type	Method	Description
int	getCollectionId()	Gets the collection identifier.
default void	validateCollectionId()	Determines if the collection identifier is valid.

Methods inherited from interface QueryParameterBasedRequest

populateQueryParameters

Modifier and Type	Method	Description
okhttp3.HttpUrl.Builder	populateQueryParameters(okhttp3.HttpUrl.Builder urlBuilder)	Helper method to populate query parameters of a HttpUrl.Builder.

Method Details

getCollectionId

int getCollectionId()

Gets the collection identifier.

Returns:

the collection identifier

validateCollectionId

default void validateCollectionId()

Determines if the collection identifier is valid.