Module com.genologics.ri

Package com.genologics.ri.artifactgroup

Class ArtifactGroups

java.lang.Object

com.genologics.ri.artifactgroup.ArtifactGroups

All Implemented Interfaces:

Batch<ArtifactGroupLink>, PaginatedBatch<ArtifactGroupLink>, Serializable, Iterable<ArtifactGroupLink>

public class ArtifactGroups
extends Object
implements PaginatedBatch<ArtifactGroupLink>, Serializable

The representation of a list of artifactGroup 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<ArtifactGroupLink>	artifactGroups	The list of artifact group links.
protected Page	nextPage	Link to the next page of results.
protected Page	previousPage	Link to the previous page of results.

Constructor Summary

Constructors

Constructor	Description
ArtifactGroups()	Default constructor.

Method Summary

Modifier and Type	Method	Description
List<ArtifactGroupLink>	getArtifactGroups()	Gets the list of artifact groups.
List<ArtifactGroupLink>	getList()	Gets the list of artifact group links.
Page	getNextPage()	Gets the link to the next page.
Page	getPreviousPage()	Gets the link to the previous page.
int	getSize()	Gets the size of the artifact groups list.
void	setNextPage(Page value)	Sets the link to the next page.
void	setPreviousPage(Page value)	Sets the link to the previous page.

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

artifactGroups

protected List<ArtifactGroupLink> artifactGroups

The list of artifact group 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

ArtifactGroups

public ArtifactGroups()

Default constructor.

Method Details

getArtifactGroups

public List<ArtifactGroupLink> getArtifactGroups()

Gets the list of artifact groups.

Returns:

The list of artifact group links.

getList

public List<ArtifactGroupLink> getList()

Gets the list of artifact group links.

Specified by:

getList in interface Batch<ArtifactGroupLink>

Returns:

The list of artifact group links.

getSize

public int getSize()

Gets the size of the artifact groups list.

Specified by:

getSize in interface Batch<ArtifactGroupLink>

Returns:

The number of artifact groups.

getPreviousPage

public Page getPreviousPage()

Gets the link to the previous page.

Specified by:

getPreviousPage in interface PaginatedBatch<ArtifactGroupLink>

Returns:

The previous page link.

setPreviousPage

public void setPreviousPage(Page value)

Sets the link to the previous page.

Specified by:

setPreviousPage in interface PaginatedBatch<ArtifactGroupLink>

Parameters:

value - The previous page to set.

getNextPage

public Page getNextPage()

Gets the link to the next page.

Specified by:

getNextPage in interface PaginatedBatch<ArtifactGroupLink>

Returns:

The next page link.

setNextPage

public void setNextPage(Page value)

Sets the link to the next page.

Specified by:

setNextPage in interface PaginatedBatch<ArtifactGroupLink>

Parameters:

value - The next page to set.