Module com.genologics.ri
Package com.genologics.ri.file

Class ClarityFiles

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

    • files

      protected List<FileLink> files
      The list of file links.

    • previousPage

      protected Page previousPage
      A link to the previous page of results, if available.

    • nextPage

      protected Page nextPage
      A link to the next page of results, if available.

  • Constructor Details

    • ClarityFiles

      public ClarityFiles()
      Creates a new, empty ClarityFiles instance.

  • Method Details

    • getFiles

      public List<FileLink> getFiles()
      Gets the list of file links. If the list is null, it will be initialized to an empty list.
      Returns:
      The list of file links.

    • getList

      public List<FileLink> getList()
      Gets the list of file links. This method is required by the PaginatedBatch interface.
      Specified by:
      getList in interface Batch<FileLink>
      Returns:
      The list of file links.

    • getSize

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

    • getPreviousPage

      public Page getPreviousPage()
      Gets the link to the previous page of results.
      Specified by:
      getPreviousPage in interface PaginatedBatch<FileLink>
      Returns:
      The previous page link, or null if there is no previous page.

    • setPreviousPage

      public void setPreviousPage(Page previousPage)
      Sets the link to the previous page of results.
      Specified by:
      setPreviousPage in interface PaginatedBatch<FileLink>
      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<FileLink>
      Returns:
      The next page link, or null if there is no next page.

    • setNextPage

      public void setNextPage(Page nextPage)
      Sets the link to the next page of results.
      Specified by:
      setNextPage in interface PaginatedBatch<FileLink>
      Parameters:
      nextPage - The next page link.