com.siemens.mindsphere.sdk.iot.event.iterator.model

Class EventTypesPageIterator

Object

EventTypesPageIterator

All Implemented Interfaces:

PageIterator<EventTypes>

public class EventTypesPageIterator
extends Object
implements PageIterator<EventTypes>

EventTypesPageIterator is an iterator implementation, used to get EventTypes available at next page, previous page and a specified page number

Field Summary

Fields inherited from interface PageIterator

DEFAULT_PAGE_NUMBER, DEFAULT_PAGE_SIZE

Method Summary

Modifier and Type	Method and Description
static EventTypesPageIterator	getInstance(EventTypeClient eventTypeClient) Returns an EventTypesPageIterator instance initialized with the eventTypeClient
static EventTypesPageIterator	getInstance(EventTypeClient eventTypeClient, Integer pageSize) Returns an EventTypesPageIterator instance initialized with the eventTypeClient
static EventTypesPageIterator	getInstance(EventTypeClient eventTypeClient, Integer pageSize, Integer pageNumber) Returns an EventTypesPageIterator instance initialized with the eventTypeClient
EventTypes	getPage(int pageNumber) Returns the Events at a requested page number
EventTypes	next() Returns the next page of EventTypes
EventTypes	previous() Returns the previous page of EventTypes

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getInstance

public static EventTypesPageIterator getInstance(EventTypeClient eventTypeClient)
                                          throws MindsphereClientException

Returns an EventTypesPageIterator instance initialized with the eventTypeClient

Parameters:

eventTypeClient - eventTypeClient that will be used to make API calls to fetch the event types

Returns:

instance of EventTypesPageIterator

Throws:

MindsphereClientException - thrown if an error occurs while creating an instance

getInstance

public static EventTypesPageIterator getInstance(EventTypeClient eventTypeClient,
                                                 Integer pageSize)
                                          throws MindsphereClientException

Returns an EventTypesPageIterator instance initialized with the eventTypeClient

Parameters:

eventTypeClient - eventTypeClient that will be used to make API calls to fetch the event types

pageSize - number of records that should be available in each page. Default is 2000

Returns:

instance of EventTypesPageIterator

Throws:

MindsphereClientException - thrown if an error occurs while creating an instance with invalid page size

getInstance

public static EventTypesPageIterator getInstance(EventTypeClient eventTypeClient,
                                                 Integer pageSize,
                                                 Integer pageNumber)
                                          throws MindsphereClientException

Returns an EventTypesPageIterator instance initialized with the eventTypeClient

Parameters:

eventTypeClient - eventTypeClient that will be used to make API calls to fetch the event types

pageSize - number of records that should be available in each page. Default is 2000

pageNumber - Page number to be fetched. Default is -1

Returns:

instance of EventTypesPageIterator

Throws:

MindsphereClientException - thrown if an error occurs while creating an instance with invalid page size

next

public EventTypes next()
                throws MindsphereException

Returns the next page of EventTypes

Specified by:

next in interface PageIterator<EventTypes>

Returns:

EventTypes instance of EventTypes

Throws:

MindsphereException - thrown if an error occurs while attempting to invoke the API

previous

public EventTypes previous()
                    throws MindsphereException

Returns the previous page of EventTypes

Specified by:

previous in interface PageIterator<EventTypes>

Returns:

EventTypes instance of EventTypes

Throws:

MindsphereException - thrown if an error occurs while attempting to invoke the API

getPage

public EventTypes getPage(int pageNumber)
                   throws MindsphereException

Returns the Events at a requested page number

Specified by:

getPage in interface PageIterator<EventTypes>

Returns:

EventTypes instance of EventTypes

Throws:

MindsphereException - thrown if an error occurs while attempting to invoke the API