Package com.ibm.fhir.search.context

Interface FHIRSearchContext

    • Method Detail

      • isIncludeResourceData

        boolean isIncludeResourceData()
        Should the search result include the actual resource in the response
        Returns:

      • setIncludeResourceData

        void setIncludeResourceData​(boolean flag)
        Set the includeResourceData flag
        Parameters:
        flag -

      • getSearchResourceTypes

        java.util.List<java.lang.String> getSearchResourceTypes()

      • setSearchResourceTypes

        void setSearchResourceTypes​(java.util.List<java.lang.String> searchResourceTypes)

      • getSearchParameters

        java.util.List<QueryParameter> getSearchParameters()

      • setSearchParameters

        void setSearchParameters​(java.util.List<QueryParameter> searchParameters)

      • getSortParameters

        java.util.List<SortParameter> getSortParameters()

      • setSortParameters

        void setSortParameters​(java.util.List<SortParameter> sortParameters)

      • hasSortParameters

        boolean hasSortParameters()

      • hasIncludeParameters

        boolean hasIncludeParameters()

      • hasRevIncludeParameters

        boolean hasRevIncludeParameters()

      • getElementsParameters

        java.util.List<java.lang.String> getElementsParameters()
        Get the list of element names requested to be included in the returned resources.
        Returns:
        a list of strings or null to indicate that there is currently no elements filter associated with the search

      • setElementsParameters

        void setElementsParameters​(java.util.List<java.lang.String> elementsToInclude)
        Set the list of element names requested to be included in the returned resources. An empty list of strings will indicate that only mandatory elements should be included in the search result. Null is used to represent "no filter".

      • hasElementsParameters

        boolean hasElementsParameters()
        Returns:
        true when the elements parameter is not null

      • addElementsParameter

        void addElementsParameter​(java.lang.String elementToInclude)
        Parameters:
        elementToInclude -

      • hasSummaryParameter

        boolean hasSummaryParameter()
        Returns:
        true when the summary parameter is not null

      • getSummaryParameter

        SummaryValueSet getSummaryParameter()
        Get the summary parameter.
        Returns:
        the value of the summary parameter

      • setSummaryParameter

        void setSummaryParameter​(SummaryValueSet summary)
        Set the value of the summary parameter.
        Parameters:
        summary - the value

      • hasTotalParameter

        boolean hasTotalParameter()
        Returns:
        true when the total parameter is not null

      • getTotalParameter

        TotalValueSet getTotalParameter()
        Get the total parameter.
        Returns:
        the value of the total parameter

      • setTotalParameter

        void setTotalParameter​(TotalValueSet total)
        Set the value of the total parameter.
        Parameters:
        total - the value

      • getOutcomeIssues

        java.util.List<OperationOutcome.Issue> getOutcomeIssues()
        Get the list of issues to be returned in the search outcome.
        Returns:
        a list of issues to be returned in the search outcome

      • addOutcomeIssue

        void addOutcomeIssue​(OperationOutcome.Issue outcomeIssue)
        Adds an issue the list of issues to be returned in the search outcome.
        Parameters:
        outcomeIssue - the issue