com.cumulocity.sdk.client
Interface PagedCollectionResource<T extends BaseCollectionRepresentation>

All Superinterfaces:

GenericResource<T>

All Known Implementing Classes:

AlarmCollectionImpl, AuditRecordCollectionImpl, EmptyPagedCollectionResource, EventCollectionImpl, ExternalIDCollectionImpl, ManagedObjectCollectionImpl, ManagedObjectReferenceCollectionImpl, MeasurementCollectionImpl, OperationCollectionImpl, PagedCollectionResourceImpl

public interface PagedCollectionResource<T extends BaseCollectionRepresentation>
extends GenericResource<T>

Method Summary

T	get() The method returns the first page.
T	get(int pageSize) The method returns the first page.
T	getNextPage(BaseCollectionRepresentation collectionRepresentation) The method returns the next page from the collection.
T	getPage(BaseCollectionRepresentation collectionRepresentation, int pageNumber) The method returns the specified page number.
T	getPage(BaseCollectionRepresentation collectionRepresentation, int pageNumber, int pageSize) The method returns the specified page number.
T	getPreviousPage(BaseCollectionRepresentation collectionRepresentation) This method returns the previous page in the collection.

Method Detail

get

T get()
                                           throws SDKException

The method returns the first page.

Specified by:

get in interface GenericResource<T extends BaseCollectionRepresentation>

Throws:

SDKException

get

T get(int pageSize)
                                           throws SDKException

The method returns the first page.

Parameters:

pageSize - - page size

Returns:

BaseCollectionRepresentation type of BaseCollectionRepresentation.

Throws:

SDKException

getPage

T getPage(BaseCollectionRepresentation collectionRepresentation,
          int pageNumber)
                                               throws SDKException

The method returns the specified page number.

Parameters:

collectionRepresentation - It uses the BaseCollectionRepresentation.getSelf() URL to find the collection.

pageNumber - - page number

Returns:

BaseCollectionRepresentation type of BaseCollectionRepresentation.

Throws:

SDKException

getPage

T getPage(BaseCollectionRepresentation collectionRepresentation,
          int pageNumber,
          int pageSize)
                                               throws SDKException

The method returns the specified page number.

Parameters:

collectionRepresentation - It uses the BaseCollectionRepresentation.getSelf() URL to find the collection.

pageNumber - - page number

pageSize - - page size

Returns:

BaseCollectionRepresentation type of BaseCollectionRepresentation.

Throws:

SDKException

getNextPage

T getNextPage(BaseCollectionRepresentation collectionRepresentation)
                                                   throws SDKException

The method returns the next page from the collection.

Parameters:

collectionRepresentation - It uses the BaseCollectionRepresentation.getNext() URL to find the collection.

Returns:

collectionRepresentation type of BaseCollectionRepresentation.

Throws:

SDKException

getPreviousPage

T getPreviousPage(BaseCollectionRepresentation collectionRepresentation)
                                                       throws SDKException

This method returns the previous page in the collection.

Parameters:

collectionRepresentation - - It uses the BaseCollectionRepresentation.getPrevious() URL to find the collection.

Returns:

BaseCollectionRepresentation type of BaseCollectionRepresentation.

Throws:

SDKException