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

Class AspectTypePageIterator

Object

AspectTypePageIterator

All Implemented Interfaces:

PageIterator<AspectTypes>

public class AspectTypePageIterator
extends Object
implements PageIterator<AspectTypes>

AspectTypePageIterator is an iterator implementation, used to get AspectTypes 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 AspectTypePageIterator	getInstance(AspectTypeClient aspectTypeClient) Returns an AspectTypePageIterator instance initialized with the aspectTypeClient
static AspectTypePageIterator	getInstance(AspectTypeClient aspectTypeClient, Integer pageSize) Returns an AspectTypePageIterator instance initialized with the aspectTypeClient
static AspectTypePageIterator	getInstance(AspectTypeClient aspectTypeClient, Integer pageSize, Integer pageNumber) Returns an AspectTypePageIterator instance initialized with the aspectTypeClient
AspectTypes	getPage(int pageNumber) Returns the Aspect Types at a requested page number
AspectTypes	next() Returns the next page of Aspect Types
AspectTypes	previous() Returns the previous page of Aspect Types

Methods inherited from class Object

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

Method Detail

getInstance

public static AspectTypePageIterator getInstance(AspectTypeClient aspectTypeClient)
                                          throws MindsphereClientException

Returns an AspectTypePageIterator instance initialized with the aspectTypeClient

Parameters:

aspectTypeClient - aspectTypeClient that will be used to make API calls to fetch the aspect types

Returns:

instance of AspectTypePageIterator

Throws:

MindsphereClientException - thrown if an error occurs while creating an instance

getInstance

public static AspectTypePageIterator getInstance(AspectTypeClient aspectTypeClient,
                                                 Integer pageSize)
                                          throws MindsphereClientException

Returns an AspectTypePageIterator instance initialized with the aspectTypeClient

Parameters:

aspectTypeClient - aspectTypeClient that will be used to make API calls to fetch the aspect types

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

Returns:

instance of AspectTypePageIterator

Throws:

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

getInstance

public static AspectTypePageIterator getInstance(AspectTypeClient aspectTypeClient,
                                                 Integer pageSize,
                                                 Integer pageNumber)
                                          throws MindsphereClientException

Returns an AspectTypePageIterator instance initialized with the aspectTypeClient

Parameters:

aspectTypeClient - aspectTypeClient that will be used to make API calls to fetch the aspect 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 AspectTypePageIterator

Throws:

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

next

public AspectTypes next()
                 throws MindsphereException

Returns the next page of Aspect Types

Specified by:

next in interface PageIterator<AspectTypes>

Returns:

AspectTypes

Throws:

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

previous

public AspectTypes previous()
                     throws MindsphereException

Returns the previous page of Aspect Types

Specified by:

previous in interface PageIterator<AspectTypes>

Returns:

AspectTypes

Throws:

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

getPage

public AspectTypes getPage(int pageNumber)
                    throws MindsphereException

Returns the Aspect Types at a requested page number

Specified by:

getPage in interface PageIterator<AspectTypes>

Returns:

AspectTypes

Throws:

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