Package com.ibm.fhir.search.context

Interface FHIRSearchContext

All Superinterfaces:

FHIRPagingContext

All Known Implementing Classes:

FHIRSearchContextImpl

public interface FHIRSearchContext
extends FHIRPagingContext

Interface for FHIR Search Context.

Method Summary

Modifier and Type	Method	Description
void	addElementsParameter(String elementToInclude)
void	addOutcomeIssue(OperationOutcome.Issue outcomeIssue)	Adds an issue the list of issues to be returned in the search outcome.
List<String>	getElementsParameters()	Get the list of element names requested to be included in the returned resources.
List<InclusionParameter>	getIncludeParameters()
List<OperationOutcome.Issue>	getOutcomeIssues()	Get the list of issues to be returned in the search outcome.
List<InclusionParameter>	getRevIncludeParameters()
List<QueryParameter>	getSearchParameters()
List<String>	getSearchResourceTypes()
List<SortParameter>	getSortParameters()
SummaryValueSet	getSummaryParameter()	Get the summary parameter.
TotalValueSet	getTotalParameter()	Get the total parameter.
boolean	hasElementsParameters()
boolean	hasIncludeParameters()
boolean	hasRevIncludeParameters()
boolean	hasSortParameters()
boolean	hasSummaryParameter()
boolean	hasTotalParameter()
void	setElementsParameters(List<String> elementsToInclude)	Set the list of element names requested to be included in the returned resources.
void	setSearchParameters(List<QueryParameter> searchParameters)
void	setSearchResourceTypes(List<String> searchResourceTypes)
void	setSortParameters(List<SortParameter> sortParameters)
void	setSummaryParameter(SummaryValueSet summary)	Set the value of the summary parameter.
void	setTotalParameter(TotalValueSet total)	Set the value of the total parameter.

Methods inherited from interface com.ibm.fhir.core.context.FHIRPagingContext

getLastPageNumber, getMatchCount, getPageNumber, getPageSize, getTotalCount, isLenient, setLastPageNumber, setLenient, setMatchCount, setPageNumber, setPageSize, setTotalCount

Method Detail

getSearchResourceTypes

List<String> getSearchResourceTypes()

setSearchResourceTypes

void setSearchResourceTypes(List<String> searchResourceTypes)

getSearchParameters

List<QueryParameter> getSearchParameters()

setSearchParameters

void setSearchParameters(List<QueryParameter> searchParameters)

getSortParameters

List<SortParameter> getSortParameters()

setSortParameters

void setSortParameters(List<SortParameter> sortParameters)

hasSortParameters

boolean hasSortParameters()

getIncludeParameters

List<InclusionParameter> getIncludeParameters()

hasIncludeParameters

boolean hasIncludeParameters()

getRevIncludeParameters

List<InclusionParameter> getRevIncludeParameters()

hasRevIncludeParameters

boolean hasRevIncludeParameters()

getElementsParameters

List<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(List<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(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

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