Module com.genologics.ri
Package com.genologics.ri.queue

Class Queue

java.lang.Object
com.genologics.ri.queue.Queue
All Implemented Interfaces:
Batch<ArtifactLink>, PaginatedBatch<ArtifactLink>, Serializable, Iterable<ArtifactLink>
public class Queue extends Object implements PaginatedBatch<ArtifactLink>, 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:

  • Field Details

    • artifacts

      protected List<ArtifactLink> artifacts
      The list of artifacts in the queue.

    • previousPage

      protected Page previousPage
      The link to the previous page of results.

    • nextPage

      protected Page nextPage
      The link to the next page of results.

    • uri

      protected URI uri
      The URI of the queue.

    • protocolStepUri

      protected URI protocolStepUri
      The URI of the protocol step for this queue.

    • name

      protected String name
      The name of the queue.

  • Constructor Details

    • Queue

      public Queue()
      Default constructor.

    • Queue

      public Queue(URI uri)
      Constructor with URI.
      Parameters:
      uri - The URI of the queue.

    • Queue

      public Queue(URI uri, String name)
      Constructor with URI and name.
      Parameters:
      uri - The URI of the queue.
      name - The name of the queue.

  • Method Details

    • getPreviousPage

      public Page getPreviousPage()
      Gets the previous page of results.
      Specified by:
      getPreviousPage in interface PaginatedBatch<ArtifactLink>
      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<ArtifactLink>
      Parameters:
      previousPage - The previous page.

    • getNextPage

      public Page getNextPage()
      Gets the next page of results.
      Specified by:
      getNextPage in interface PaginatedBatch<ArtifactLink>
      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<ArtifactLink>
      Parameters:
      nextPage - The next page.

    • getUri

      public URI getUri()
      Gets the URI of the queue.
      Returns:
      The queue URI.

    • setUri

      public void setUri(URI uri)
      Sets the URI of the queue.
      Parameters:
      uri - The queue URI.

    • getProtocolStepUri

      public URI getProtocolStepUri()
      Gets the protocol step URI.
      Returns:
      The protocol step URI.

    • setProtocolStepUri

      public void setProtocolStepUri(URI protocolStepUri)
      Sets the protocol step URI.
      Parameters:
      protocolStepUri - The protocol step URI.

    • getName

      public String getName()
      Gets the name of the queue.
      Returns:
      The queue name.

    • setName

      public void setName(String name)
      Sets the name of the queue.
      Parameters:
      name - The queue name.

    • getArtifacts

      public List<ArtifactLink> getArtifacts()
      Gets the list of artifacts in the queue.
      Returns:
      The list of artifact links.

    • getList

      public List<ArtifactLink> getList()
      Gets the list of items in this batch.
      Specified by:
      getList in interface Batch<ArtifactLink>
      Returns:
      The list of items.

    • getSize

      public int getSize()
      Gets the number of items in this batch.
      Specified by:
      getSize in interface Batch<ArtifactLink>
      Returns:
      The size of the batch.