Module com.genologics.ri

Package com.genologics.ri.artifact

Class Artifacts

java.lang.Object

com.genologics.ri.artifact.Artifacts

All Implemented Interfaces:

Batch<ArtifactLink>, PaginatedBatch<ArtifactLink>, Serializable, Iterable<ArtifactLink>

public class Artifacts
extends Object
implements PaginatedBatch<ArtifactLink>, Serializable

The representation of a list of artifact 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<ArtifactLink>	artifacts	The list of artifact links.
protected Page	nextPage	The next page of results.
protected Page	previousPage	The previous page of results.

Constructor Summary

Constructors

Constructor	Description
Artifacts()	Constructor.

Method Summary

Modifier and Type	Method	Description
List<ArtifactLink>	getArtifacts()	Gets the list of artifact links.
List<ArtifactLink>	getList()	Gets the list of artifact links.
Page	getNextPage()	Gets the next page of results.
Page	getPreviousPage()	Gets the previous page of results.
int	getSize()	Gets the size of the artifact list.
void	setNextPage(Page value)	Sets the next page of results.
void	setPreviousPage(Page value)	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

artifacts

protected List<ArtifactLink> artifacts

The list of artifact links.

previousPage

protected Page previousPage

The previous page of results.

nextPage

protected Page nextPage

The next page of results.

Constructor Details

Artifacts

public Artifacts()

Constructor.

Method Details

getArtifacts

public List<ArtifactLink> getArtifacts()

Gets the list of artifact links.

Returns:

The list of artifact links.

getList

public List<ArtifactLink> getList()

Gets the list of artifact links.

Specified by:

getList in interface Batch<ArtifactLink>

Returns:

The list of artifact links.

getSize

public int getSize()

Gets the size of the artifact list.

Specified by:

getSize in interface Batch<ArtifactLink>

Returns:

The number of artifacts.

getPreviousPage

public Page getPreviousPage()

Gets the previous page of results.

Specified by:

getPreviousPage in interface PaginatedBatch<ArtifactLink>

Returns:

The previous page.

setPreviousPage

public void setPreviousPage(Page value)

Sets the previous page of results.

Specified by:

setPreviousPage in interface PaginatedBatch<ArtifactLink>

Parameters:

value - The previous page.

getNextPage

public Page getNextPage()

Gets the next page of results.

Specified by:

getNextPage in interface PaginatedBatch<ArtifactLink>

Returns:

The next page.

setNextPage

public void setNextPage(Page value)

Sets the next page of results.

Specified by:

setNextPage in interface PaginatedBatch<ArtifactLink>

Parameters:

value - The next page.