Package ca.uhn.fhir.rest.api.server

Interface IPreResourceShowDetails

All Superinterfaces:
Iterable<org.hl7.fhir.instance.model.api.IBaseResource>
All Known Implementing Classes:
SimplePreResourceShowDetails
public interface IPreResourceShowDetails extends Iterable<org.hl7.fhir.instance.model.api.IBaseResource>
This interface is a parameter type for the Pointcut.STORAGE_PRESHOW_RESOURCES hook.

  • Method Summary

    Modifier and Type
    Method
    Description
    List<org.hl7.fhir.instance.model.api.IBaseResource>
    getAllResources()
    Returns a List containing all resources that will be shown.
    org.hl7.fhir.instance.model.api.IBaseResource
    getResource(int theIndex)
     
    void
    markResourceAtIndexAsSubset(int theIndex)
    Indicates that data is being masked from within the resource at the given index.
    void
    setResource(int theIndex, org.hl7.fhir.instance.model.api.IBaseResource theResource)
    Replace the resource being returned at index
    int
    size()
     

    Methods inherited from interface java.lang.Iterable

    forEach, iterator, spliterator

  • Method Details

    • size

      int size()
      Returns:
      Returns the number of resources being shown

    • getResource

      org.hl7.fhir.instance.model.api.IBaseResource getResource(int theIndex)
      Returns:
      Returns the resource at the given index. If you wish to make modifications to any resources

    • setResource

      void setResource(int theIndex, org.hl7.fhir.instance.model.api.IBaseResource theResource)
      Replace the resource being returned at index
      Parameters:
      theIndex - The resource index
      theResource - The resource at index

    • markResourceAtIndexAsSubset

      void markResourceAtIndexAsSubset(int theIndex)
      Indicates that data is being masked from within the resource at the given index. This generally flags to the rest of the stack that the resource should include a SUBSET tag as an indication to consumers that some data has been removed.
      Parameters:
      theIndex - The resource index

    • getAllResources

      List<org.hl7.fhir.instance.model.api.IBaseResource> getAllResources()
      Returns a List containing all resources that will be shown. The returned list will have the same relative ordering as if the resources were retrieved using getResource(int), but any null entries will be filtered out.

      The returned List may not be modified. Use this method only if you are not looking to make changes.

      Since:
      6.6.0