Module org.cruk.clarity.api

Package com.genologics.ri.queue

Class Queue

java.lang.Object

com.genologics.ri.queue.Queue

All Implemented Interfaces:

Batch<ArtifactLink>, Linkable<Queue>, Locatable, PaginatedBatch<ArtifactLink>, Serializable, Iterable<ArtifactLink>

public class Queue
extends Object
implements PaginatedBatch<ArtifactLink>, Linkable<Queue>, Serializable

The representation of a queue.

It represents and is used to list all of the elements contained within a queue. A queue is a representation of samples that are ready to run through a Protocol Step.

Each artifact listed in the queue will contain elements to show when it was queued and its container location.

Since:

2.19

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected List<ArtifactLink>	artifacts
protected String	name
protected Page	nextPage
protected Page	previousPage
protected URI	protocolStepUri
protected URI	uri

Constructor Summary

Constructors

Constructor	Description
Queue()
Queue(URI uri)
Queue(URI uri, String name)

Method Summary

Modifier and Type	Method	Description
List<ArtifactLink>	getArtifacts()
List<ArtifactLink>	getList()
String	getName()
Page	getNextPage()
Page	getPreviousPage()
URI	getProtocolStepUri()
int	getSize()
URI	getUri()	Get the URI of this object.
Iterator<ArtifactLink>	iterator()
void	setName(String name)
void	setNextPage(Page nextPage)
void	setPreviousPage(Page previousPage)
void	setProtocolStepUri(URI protocolStepUri)
void	setUri(URI uri)	Set the URI of this object.

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Details

artifacts

protected List<ArtifactLink> artifacts

previousPage

protected Page previousPage

nextPage

protected Page nextPage

uri

protected URI uri

protocolStepUri

protected URI protocolStepUri

name

protected String name

Constructor Details

Queue

public Queue()

Queue

public Queue(URI uri)

Queue

public Queue(URI uri,
 String name)

Method Details

getPreviousPage

public Page getPreviousPage()

Specified by:

getPreviousPage in interface PaginatedBatch<ArtifactLink>

setPreviousPage

public void setPreviousPage(Page previousPage)

Specified by:

setPreviousPage in interface PaginatedBatch<ArtifactLink>

getNextPage

public Page getNextPage()

Specified by:

getNextPage in interface PaginatedBatch<ArtifactLink>

setNextPage

public void setNextPage(Page nextPage)

Specified by:

setNextPage in interface PaginatedBatch<ArtifactLink>

getUri

public URI getUri()

Description copied from interface: Locatable

Get the URI of this object.

Specified by:

getUri in interface Locatable

Returns:

The URI.

setUri

public void setUri(URI uri)

Description copied from interface: Locatable

Set the URI of this object.

Specified by:

setUri in interface Locatable

Parameters:

uri - The new URI.

getProtocolStepUri

public URI getProtocolStepUri()

setProtocolStepUri

public void setProtocolStepUri(URI protocolStepUri)

getName

public String getName()

setName

public void setName(String name)

getArtifacts

public List<ArtifactLink> getArtifacts()

getList

public List<ArtifactLink> getList()

Specified by:

getList in interface Batch<ArtifactLink>

getSize

public int getSize()

Specified by:

getSize in interface Batch<ArtifactLink>

iterator

public Iterator<ArtifactLink> iterator()

Specified by:

iterator in interface Iterable<ArtifactLink>