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

Class StructureAspectsPageIterator

Object

StructureAspectsPageIterator

All Implemented Interfaces:

PageIterator<StructureResource>

public class StructureAspectsPageIterator
extends Object
implements PageIterator<StructureResource>

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 StructureAspectsPageIterator	getInstance(AssetStructureClient structureClient, String id) Returns an StructureAspectsPageIterator instance initialized with the structureClient
static StructureAspectsPageIterator	getInstance(AssetStructureClient structureClient, String id, Integer pageSize) Returns an StructureAspectsPageIterator instance initialized with the structureClient
static StructureAspectsPageIterator	getInstance(AssetStructureClient structureClient, String id, Integer pageSize, Integer pageNumber) Returns an StructureAspectsPageIterator instance initialized with the structureClient
StructureAspects	getPage(int pageNumber) Returns the Structure Aspects at a requested page number
StructureAspects	next() Returns the next page of Structure Aspects
StructureAspects	previous() Returns the previous page of Structure Aspects

Methods inherited from class Object

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

Method Detail

getInstance

public static StructureAspectsPageIterator getInstance(AssetStructureClient structureClient,
                                                       String id,
                                                       Integer pageSize,
                                                       Integer pageNumber)
                                                throws MindsphereClientException

Returns an StructureAspectsPageIterator instance initialized with the structureClient

Parameters:

structureClient - structureClient that will be used to make API calls to fetch the structure aspects

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

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

id - Unique identifier

Returns:

instance of StructureAspectsPageIterator

Throws:

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

getInstance

public static StructureAspectsPageIterator getInstance(AssetStructureClient structureClient,
                                                       String id,
                                                       Integer pageSize)
                                                throws MindsphereClientException

Returns an StructureAspectsPageIterator instance initialized with the structureClient

Parameters:

structureClient - structureClient that will be used to make API calls to fetch the structure aspects

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

id - Unique identifier

Returns:

instance of StructureAspectsPageIterator

Throws:

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

getInstance

public static StructureAspectsPageIterator getInstance(AssetStructureClient structureClient,
                                                       String id)
                                                throws MindsphereClientException

Returns an StructureAspectsPageIterator instance initialized with the structureClient

Parameters:

structureClient - structureClient that will be used to make API calls to fetch the structure aspects

id - Unique identifier

Returns:

instance of StructureAspectsPageIterator

Throws:

MindsphereClientException - thrown if an error occurs while creating an instance

next

public StructureAspects next()
                      throws MindsphereException

Returns the next page of Structure Aspects

Specified by:

next in interface PageIterator<StructureResource>

Returns:

StructureAspects

Throws:

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

previous

public StructureAspects previous()
                          throws MindsphereException

Returns the previous page of Structure Aspects

Specified by:

previous in interface PageIterator<StructureResource>

Returns:

StructureAspects

Throws:

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

getPage

public StructureAspects getPage(int pageNumber)
                         throws MindsphereException

Returns the Structure Aspects at a requested page number

Specified by:

getPage in interface PageIterator<StructureResource>

Returns:

StructureAspects

Throws:

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