org.odpi.egeria.connectors.ibm.igc.clientlibrary.model.common

Class ItemList<T extends Reference>

java.lang.Object

org.odpi.egeria.connectors.ibm.igc.clientlibrary.model.common.ObjectPrinter

org.odpi.egeria.connectors.ibm.igc.clientlibrary.model.common.ItemList<T>

public class ItemList<T extends Reference>
extends ObjectPrinter

Provides a standard class for any relationship in IGC, by including 'paging' details and 'items' array.

Field Summary

Fields

Modifier and Type	Field and Description
protected List<T>	items The 'items' property of an ItemList gives the actual items that are part of this particular page.
protected Paging	paging The 'paging' property of an ItemList gives the paging details of this particular page.

Constructor Summary

Constructors

Constructor and Description
ItemList()

Method Summary

Modifier and Type	Method and Description
List<T>	getItems() Retrieve the items within this list (from the pages that are retrieved).
Paging	getPaging() Retrieve the paging characteristics of this list.
boolean	hasMorePages() Returns true iff there are more (unretrieved) pages for the relationships that this object represents.
void	setAllPages(List<T> allPages) Set all of the pages as retrieved using the list of items provided
void	setItems(List<T> items) Set the items within this list (for the pages that are retrieved).
void	setPaging(Paging paging) Set the paging characteristics of this list.

Methods inherited from class org.odpi.egeria.connectors.ibm.igc.clientlibrary.model.common.ObjectPrinter

toString

Methods inherited from class java.lang.Object

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

Field Detail

paging

protected Paging paging

The 'paging' property of an ItemList gives the paging details of this particular page.

items

protected List<T extends Reference> items

The 'items' property of an ItemList gives the actual items that are part of this particular page.

Will be a ArrayList of Reference objects.

Constructor Detail

ItemList

public ItemList()

Method Detail

getPaging

public Paging getPaging()

Retrieve the paging characteristics of this list.

Returns:

Paging

See Also:

paging

setPaging

public void setPaging(Paging paging)

Set the paging characteristics of this list.

Parameters:

paging - characteristics of this list

See Also:

paging

getItems

public List<T> getItems()

Retrieve the items within this list (from the pages that are retrieved).

Returns:

List<T>

See Also:

items

setItems

public void setItems(List<T> items)

Set the items within this list (for the pages that are retrieved).

Parameters:

items - within this list

See Also:

items

hasMorePages

public boolean hasMorePages()

Returns true iff there are more (unretrieved) pages for the relationships that this object represents.

Returns:

Boolean

setAllPages

public void setAllPages(List<T> allPages)

Set all of the pages as retrieved using the list of items provided

Parameters:

allPages - list of items that have results from all pages