com.siemens.mindsphere.sdk.assetmanagement.iterator.model

Class AssetTypePageIterator

Object

AssetTypePageIterator

All Implemented Interfaces:

PageIterator<AssetTypeListResource>

public class AssetTypePageIterator
extends Object
implements PageIterator<AssetTypeListResource>

AssetTypePageIterator is an iterator implementation, used to get AssetTypeListResource 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 AssetTypePageIterator	getInstance(AssettypeClient assetTypeClient) Returns an AssetTypePageIterator instance initialized with the assetTypeClient
static AssetTypePageIterator	getInstance(AssettypeClient assetTypeClient, Integer pageSize) Returns an AssetTypePageIterator instance initialized with the assetTypeClient
static AssetTypePageIterator	getInstance(AssettypeClient assetTypeClient, Integer pageSize, Integer pageNumber) Returns an AssetTypePageIterator instance initialized with the assetTypeClient
AssetTypeListResource	getPage(int pageNumber) Returns the Asset Types at a requested page number
AssetTypeListResource	next() Returns the next page of Asset Types
AssetTypeListResource	previous() Returns the previous page of Asset Types

Methods inherited from class Object

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

Method Detail

getInstance

public static AssetTypePageIterator getInstance(AssettypeClient assetTypeClient)
                                         throws MindsphereClientException

Returns an AssetTypePageIterator instance initialized with the assetTypeClient

Parameters:

assetTypeClient - assetTypeClient that will be used to make API calls to fetch the asset types

Returns:

instance of AssetTypePageIterator

Throws:

MindsphereClientException - thrown if an error occurs while creating an instance

getInstance

public static AssetTypePageIterator getInstance(AssettypeClient assetTypeClient,
                                                Integer pageSize)
                                         throws MindsphereClientException

Returns an AssetTypePageIterator instance initialized with the assetTypeClient

Parameters:

assetTypeClient - assetTypeClient that will be used to make API calls to fetch the asset types

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

Returns:

instance of AssetTypePageIterator

Throws:

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

getInstance

public static AssetTypePageIterator getInstance(AssettypeClient assetTypeClient,
                                                Integer pageSize,
                                                Integer pageNumber)
                                         throws MindsphereClientException

Returns an AssetTypePageIterator instance initialized with the assetTypeClient

Parameters:

assetTypeClient - assetTypeClient that will be used to make API calls to fetch the asset 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 AssetTypePageIterator

Throws:

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

next

public AssetTypeListResource next()
                           throws MindsphereException

Returns the next page of Asset Types

Specified by:

next in interface PageIterator<AssetTypeListResource>

Returns:

AssetTypeListResource

Throws:

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

previous

public AssetTypeListResource previous()
                               throws MindsphereException

Returns the previous page of Asset Types

Specified by:

previous in interface PageIterator<AssetTypeListResource>

Returns:

AssetTypeListResource

Throws:

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

getPage

public AssetTypeListResource getPage(int pageNumber)
                              throws MindsphereException

Returns the Asset Types at a requested page number

Specified by:

getPage in interface PageIterator<AssetTypeListResource>

Returns:

AssetTypeListResource

Throws:

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