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

Class AssetPageIterator

Object

AssetPageIterator

All Implemented Interfaces:

PageIterator<Assets>

public class AssetPageIterator
extends Object
implements PageIterator<Assets>

AssetPageIterator is an iterator implementation, used to get Assets 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 AssetPageIterator	getInstance(AssetClient assetsClient) Returns an AssetPageIterator instance initialized with the assetsClient
static AssetPageIterator	getInstance(AssetClient assetsClient, Integer pageSize) Returns an AssetPageIterator instance initialized with the assetsClient
static AssetPageIterator	getInstance(AssetClient assetClient, Integer pageSize, Integer pageNumber) Returns an AssetPageIterator instance initialized with the assetsClient
Assets	getPage(int pageNumber) Returns the Assets at a requested page number
Assets	next() Returns the next page of Assets
Assets	previous() Returns the previous page of Assets

Methods inherited from class Object

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

Method Detail

getInstance

public static AssetPageIterator getInstance(AssetClient assetsClient)
                                     throws MindsphereClientException

Returns an AssetPageIterator instance initialized with the assetsClient

Parameters:

assetsClient - assetsClient that will be used to make API calls to fetch the assets

Returns:

instance of AssetPageIterator

Throws:

MindsphereClientException - thrown if an error occurs while creating an instance

getInstance

public static AssetPageIterator getInstance(AssetClient assetsClient,
                                            Integer pageSize)
                                     throws MindsphereClientException

Returns an AssetPageIterator instance initialized with the assetsClient

Parameters:

assetsClient - assetsClient that will be used to make API calls to fetch the assets

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

Returns:

instance of AssetPageIterator

Throws:

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

getInstance

public static AssetPageIterator getInstance(AssetClient assetClient,
                                            Integer pageSize,
                                            Integer pageNumber)
                                     throws MindsphereClientException

Returns an AssetPageIterator instance initialized with the assetsClient

Parameters:

assetClient - assetsClient that will be used to make API calls to fetch the assets

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 AssetPageIterator

Throws:

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

next

public Assets next()
            throws MindsphereException

Returns the next page of Assets

Specified by:

next in interface PageIterator<Assets>

Returns:

Assets

Throws:

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

previous

public Assets previous()
                throws MindsphereException

Returns the previous page of Assets

Specified by:

previous in interface PageIterator<Assets>

Returns:

Assets

Throws:

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

getPage

public Assets getPage(int pageNumber)
               throws MindsphereException

Returns the Assets at a requested page number

Specified by:

getPage in interface PageIterator<Assets>

Returns:

Assets

Throws:

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