Module com.genologics.ri

Package com.genologics.ri.researcher

Class Researchers

java.lang.Object

com.genologics.ri.researcher.Researchers

All Implemented Interfaces:

Batch<ResearcherLink>, PaginatedBatch<ResearcherLink>, Serializable, Iterable<ResearcherLink>

public class Researchers
extends Object
implements PaginatedBatch<ResearcherLink>, Serializable

The representation of a list of researcher 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 Page	nextPage	Link to the next page of results.
protected Page	previousPage	Link to the previous page of results.
protected List<ResearcherLink>	researchers	The list of researcher links.

Constructor Summary

Constructors

Constructor	Description
Researchers()	Default constructor.

Method Summary

Modifier and Type	Method	Description
List<ResearcherLink>	getList()	Gets the list of researcher links.
Page	getNextPage()	Gets the link to the next page of results.
Page	getPreviousPage()	Gets the link to the previous page of results.
List<ResearcherLink>	getResearchers()	Gets the list of researcher links.
int	getSize()	Gets the size of the researcher list.
void	setNextPage(Page nextPage)	Sets the link to the next page of results.
void	setPreviousPage(Page previousPage)	Sets the link to 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

researchers

protected List<ResearcherLink> researchers

The list of researcher links.

previousPage

protected Page previousPage

Link to the previous page of results.

nextPage

protected Page nextPage

Link to the next page of results.

Constructor Details

Researchers

public Researchers()

Default constructor.

Method Details

getResearchers

public List<ResearcherLink> getResearchers()

Gets the list of researcher links.

Returns:

The list of researcher links.

getList

public List<ResearcherLink> getList()

Gets the list of researcher links.

Specified by:

getList in interface Batch<ResearcherLink>

Returns:

The list of researcher links.

getSize

public int getSize()

Gets the size of the researcher list.

Specified by:

getSize in interface Batch<ResearcherLink>

Returns:

The number of researchers in the list.

getPreviousPage

public Page getPreviousPage()

Gets the link to the previous page of results.

Specified by:

getPreviousPage in interface PaginatedBatch<ResearcherLink>

Returns:

The previous page link.

setPreviousPage

public void setPreviousPage(Page previousPage)

Sets the link to the previous page of results.

Specified by:

setPreviousPage in interface PaginatedBatch<ResearcherLink>

Parameters:

previousPage - The previous page link.

getNextPage

public Page getNextPage()

Gets the link to the next page of results.

Specified by:

getNextPage in interface PaginatedBatch<ResearcherLink>

Returns:

The next page link.

setNextPage

public void setNextPage(Page nextPage)

Sets the link to the next page of results.

Specified by:

setNextPage in interface PaginatedBatch<ResearcherLink>

Parameters:

nextPage - The next page link.