Module com.genologics.ri

Package com.genologics.ri.instrument

Class Instruments

java.lang.Object

com.genologics.ri.instrument.Instruments

All Implemented Interfaces:

Batch<InstrumentLink>, PaginatedBatch<InstrumentLink>, Serializable, Iterable<InstrumentLink>

public class Instruments
extends Object
implements PaginatedBatch<InstrumentLink>, Serializable

The representation of a list of instrument links.

The system enforces a maximum number of elements when generating the list of links. When the size of the request result set is larger than the system maximum, the list represents a paged view of the overall results, and the previous-page and next-page elements provide URIs linking to the previous or next page of links in the overall results.

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected List<InstrumentLink>	instruments	The list of instrument links.
protected Page	nextPage	The next page reference.
protected Page	previousPage	The previous page reference.

Constructor Summary

Constructors

Constructor	Description
Instruments()	Default constructor.

Method Summary

Modifier and Type	Method	Description
List<InstrumentLink>	getInstruments()	Get the list of instrument links.
List<InstrumentLink>	getList()	Gets the list of items in this batch.
Page	getNextPage()	Gets the next page of results.
Page	getPreviousPage()	Gets the previous page of results.
int	getSize()	Gets the number of items in this batch.
void	setNextPage(Page nextPage)	Sets the next page of results.
void	setPreviousPage(Page previousPage)	Sets the previous page of results.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.genologics.ri.Batch

isEmpty, iterator

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Details

instruments

protected List<InstrumentLink> instruments

The list of instrument links.

previousPage

protected Page previousPage

The previous page reference.

nextPage

protected Page nextPage

The next page reference.

Constructor Details

Instruments

public Instruments()

Default constructor.

Method Details

getInstruments

public List<InstrumentLink> getInstruments()

Get the list of instrument links.

Returns:

The list of instrument links.

getList

public List<InstrumentLink> getList()

Gets the list of items in this batch.

Specified by:

getList in interface Batch<InstrumentLink>

Returns:

The list of items.

getSize

public int getSize()

Gets the number of items in this batch.

Specified by:

getSize in interface Batch<InstrumentLink>

Returns:

The size of the batch.

getPreviousPage

public Page getPreviousPage()

Gets the previous page of results.

Specified by:

getPreviousPage in interface PaginatedBatch<InstrumentLink>

Returns:

The previous page, or null if there is no previous page.

setPreviousPage

public void setPreviousPage(Page previousPage)

Sets the previous page of results.

Specified by:

setPreviousPage in interface PaginatedBatch<InstrumentLink>

Parameters:

previousPage - The previous page.

getNextPage

public Page getNextPage()

Gets the next page of results.

Specified by:

getNextPage in interface PaginatedBatch<InstrumentLink>

Returns:

The next page, or null if there is no next page.

setNextPage

public void setNextPage(Page nextPage)

Sets the next page of results.

Specified by:

setNextPage in interface PaginatedBatch<InstrumentLink>

Parameters:

nextPage - The next page.