Module com.genologics.ri
Package com.genologics.ri.container

Class Containers

java.lang.Object
com.genologics.ri.container.Containers
All Implemented Interfaces:
Batch<ContainerLink>, PaginatedBatch<ContainerLink>, Serializable, Iterable<ContainerLink>
public class Containers extends Object implements PaginatedBatch<ContainerLink>, Serializable
The representation for a list of container 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:

  • Field Details

    • containers

      protected List<ContainerLink> containers
      The list of container links.

    • previousPage

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

    • nextPage

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

  • Constructor Details

    • Containers

      public Containers()
      Default constructor.

  • Method Details

    • getContainers

      public List<ContainerLink> getContainers()
      Gets the list of container links. Creates a new list if one doesn't exist.
      Returns:
      The list of container links.

    • getList

      public List<ContainerLink> getList()
      Gets the list of container links as required by the PaginatedBatch interface.
      Specified by:
      getList in interface Batch<ContainerLink>
      Returns:
      The list of container links.

    • getSize

      public int getSize()
      Gets the number of container links.
      Specified by:
      getSize in interface Batch<ContainerLink>
      Returns:
      The number of links, or 0 if the list is null.

    • getPreviousPage

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