com.siemens.mindsphere.sdk.eventmanagement.iterator.model

Class EventsPageIterator

Object

EventsPageIterator

All Implemented Interfaces:

PageIterator<Events>

public class EventsPageIterator
extends Object
implements PageIterator<Events>

EventsPageIterator is an iterator implementation, used to get Events 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 EventsPageIterator	getInstance(EventsClient eventClient) Returns an EventsPageIterator instance initialized with the eventClient
static EventsPageIterator	getInstance(EventsClient eventClient, Integer pageSize) Returns an EventsPageIterator instance initialized with the eventClient
static EventsPageIterator	getInstance(EventsClient eventClient, Integer pageSize, Integer pageNumber) Returns an EventsPageIterator instance initialized with the eventClient
static EventsPageIterator	getInstance(EventsClient eventClient, Integer pageSize, Integer pageNumber, String filter) Returns an EventsPageIterator instance initialized with the eventClient
Events	getPage(int pageNumber) Returns the Events at a requested page number
Events	next() Returns the next page of Events
Events	previous() Returns the previous page of Events

Methods inherited from class Object

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

Method Detail

getInstance

public static EventsPageIterator getInstance(EventsClient eventClient)
                                      throws MindsphereClientException

Returns an EventsPageIterator instance initialized with the eventClient

Parameters:

eventClient - eventClient that will be used to make API calls to fetch the events

Returns:

instance of EventsPageIterator

Throws:

MindsphereClientException - thrown if an error occurs while creating an instance

getInstance

public static EventsPageIterator getInstance(EventsClient eventClient,
                                             Integer pageSize)
                                      throws MindsphereClientException

Returns an EventsPageIterator instance initialized with the eventClient

Parameters:

eventClient - eventClient that will be used to make API calls to fetch the events

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

Returns:

instance of EventsPageIterator

Throws:

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

getInstance

public static EventsPageIterator getInstance(EventsClient eventClient,
                                             Integer pageSize,
                                             Integer pageNumber)
                                      throws MindsphereClientException

Returns an EventsPageIterator instance initialized with the eventClient

Parameters:

eventClient - eventClient that will be used to make API calls to fetch the events

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 EventsPageIterator

Throws:

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

getInstance

public static EventsPageIterator getInstance(EventsClient eventClient,
                                             Integer pageSize,
                                             Integer pageNumber,
                                             String filter)
                                      throws MindsphereClientException

Returns an EventsPageIterator instance initialized with the eventClient

Parameters:

eventClient - eventClient that will be used to make API calls to fetch the events

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

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

filter - filter

Returns:

instance of EventsPageIterator

Throws:

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

next

public Events next()
            throws MindsphereException

Returns the next page of Events

Specified by:

next in interface PageIterator<Events>

Returns:

Events instance of Events

Throws:

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

previous

public Events previous()
                throws MindsphereException

Returns the previous page of Events

Specified by:

previous in interface PageIterator<Events>

Returns:

Events instance of Events

Throws:

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

getPage

public Events getPage(int pageNumber)
               throws MindsphereException

Returns the Events at a requested page number

Specified by:

getPage in interface PageIterator<Events>

Returns:

Events instance of Events

Throws:

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