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

Class StructureVariablesPageIterator

Object

StructureVariablesPageIterator

All Implemented Interfaces:

PageIterator<VariableListResource>

public class StructureVariablesPageIterator
extends Object
implements PageIterator<VariableListResource>

StructureVariablesPageIterator is an iterator implementation, used to get VariableListResource available at next page, previous page and a specified page number

Field Summary

Fields inherited from interface PageIterator

DEFAULT_PAGE_NUMBER, DEFAULT_PAGE_SIZE

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	StructureVariablesPageIterator(StructureClient structureClient, String id, Integer pageNumber, Integer pageSize)

Method Summary

Modifier and Type	Method and Description
static StructureVariablesPageIterator	getInstance(StructureClient structureClient, String id) Returns an StructureVariablesPageIterator instance initialized with the structureClient
static StructureVariablesPageIterator	getInstance(StructureClient structureClient, String id, Integer pageSize) Returns an StructureVariablesPageIterator instance initialized with the structureClient
static StructureVariablesPageIterator	getInstance(StructureClient structureClient, String id, Integer pageSize, Integer pageNumber) Returns an StructureVariablesPageIterator instance initialized with the structureClient
VariableListResource	getPage(int pageNumber) Returns the Structure Variables at a requested page number
VariableListResource	next() Returns the next page of Structure Variables
VariableListResource	previous() Returns the previous page of Structure Variables

Methods inherited from class Object

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

Constructor Detail

StructureVariablesPageIterator

protected StructureVariablesPageIterator(StructureClient structureClient,
                                         String id,
                                         Integer pageNumber,
                                         Integer pageSize)
                                  throws MindsphereClientException

Throws:

MindsphereClientException

Method Detail

getInstance

public static StructureVariablesPageIterator getInstance(StructureClient structureClient,
                                                         String id,
                                                         Integer pageSize,
                                                         Integer pageNumber)
                                                  throws MindsphereClientException

Returns an StructureVariablesPageIterator instance initialized with the structureClient

Parameters:

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

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 StructureVariablesPageIterator

Throws:

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

getInstance

public static StructureVariablesPageIterator getInstance(StructureClient structureClient,
                                                         String id,
                                                         Integer pageSize)
                                                  throws MindsphereClientException

Returns an StructureVariablesPageIterator instance initialized with the structureClient

Parameters:

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

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

id - Unique identifier

Returns:

instance of StructureVariablesPageIterator

Throws:

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

getInstance

public static StructureVariablesPageIterator getInstance(StructureClient structureClient,
                                                         String id)
                                                  throws MindsphereClientException

Returns an StructureVariablesPageIterator instance initialized with the structureClient

Parameters:

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

id - Unique identifier

Returns:

instance of StructureVariablesPageIterator

Throws:

MindsphereClientException - thrown if an error occurs while creating an instance

next

public VariableListResource next()
                          throws MindsphereException

Returns the next page of Structure Variables

Specified by:

next in interface PageIterator<VariableListResource>

Returns:

VariableListResource

Throws:

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

previous

public VariableListResource previous()
                              throws MindsphereException

Returns the previous page of Structure Variables

Specified by:

previous in interface PageIterator<VariableListResource>

Returns:

VariableListResource

Throws:

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

getPage

public VariableListResource getPage(int pageNumber)
                             throws MindsphereException

Returns the Structure Variables at a requested page number

Specified by:

getPage in interface PageIterator<VariableListResource>

Returns:

VariableListResource

Throws:

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