org.odpi.openmetadata.adapters.repositoryservices.igc.clientlibrary.model.common

Class ReferenceList

java.lang.Object

org.odpi.openmetadata.adapters.repositoryservices.igc.clientlibrary.model.common.ObjectPrinter

org.odpi.openmetadata.adapters.repositoryservices.igc.clientlibrary.model.common.ReferenceList

public class ReferenceList
extends ObjectPrinter

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

Used in POJOs, this class can be defined as the type of any relationship attribute, eg.:
public ReferenceList assigned_assets;

Field Summary

Fields

Modifier and Type	Field and Description
protected ArrayList<Reference>	items The 'items' property of a ReferenceList gives the actual items that are part of this particular page.
protected Paging	paging The 'paging' property of a ReferenceList gives the aspects related to paging (eg.

Constructor Summary

Constructors

Constructor and Description
ReferenceList()

Method Summary

Modifier and Type	Method and Description
void	getAllPages(IGCRestClient igcrest) Retrieve all pages of relationships that this object represents.
ArrayList<Reference>	getItems()
void	getNextPage(IGCRestClient igcrest) Retrieve the next page of relationships that this object represents.
Paging	getPaging()
Boolean	hasMorePages() Returns true iff there are more (unretrieved) pages for the relationships that this object represents.
void	setItems(ArrayList<Reference> items)
void	setPaging(Paging paging)

Methods inherited from class org.odpi.openmetadata.adapters.repositoryservices.igc.clientlibrary.model.common.ObjectPrinter

getAllFields, 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 a ReferenceList gives the aspects related to paging (eg. number of items in the page, total number for the relationship, etc).

Will be a single Paging object.

items

protected ArrayList<Reference> items

The 'items' property of a ReferenceList gives the actual items that are part of this particular page.

Will be a ArrayList of Reference objects.

Constructor Detail

ReferenceList

public ReferenceList()

Method Detail

getPaging

public Paging getPaging()

See Also:

paging

setPaging

public void setPaging(Paging paging)

See Also:

paging

getItems

public ArrayList<Reference> getItems()

See Also:

items

setItems

public void setItems(ArrayList<Reference> items)

See Also:

items

hasMorePages

public Boolean hasMorePages()

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

Returns:

Boolean

getAllPages

public void getAllPages(IGCRestClient igcrest)

Retrieve all pages of relationships that this object represents.

Parameters:

igcrest - the IGCRestClient connection to use to retrieve the relationships

getNextPage

public void getNextPage(IGCRestClient igcrest)

Retrieve the next page of relationships that this object represents.

Parameters:

igcrest - the IGCRestClient connection to use to retrieve the relationships