Package ca.cdr.api.fhirgw.model

Class SearchRequest

java.lang.Object

ca.cdr.api.fhirgw.model.BaseRequest<SearchRequest>

ca.cdr.api.fhirgw.model.SearchRequest

All Implemented Interfaces:

IBaseRequest

public class SearchRequest
extends BaseRequest<SearchRequest>

This class represents a FHIR Gateway Search request

Constructor Summary

Constructors

Constructor	Description
SearchRequest()	Constructor
SearchRequest(SearchRequest theSearchRequest)	Copy constructor

Method Summary

Modifier and Type	Method	Description
void	addParameter(String theName, String theValue)	Add a new search parameter
Integer	getCount()
Set<Include>	getIncludes()
DateRangeParam	getLastUpdated()
Integer	getOffset()
String	getParameter(String theName)	Returns the first parameter value for a given parameter name (returns null if no parameters match the given name)
com.google.common.collect.Multimap<String,String>	getParameters()
List<String>	getParameters(String theName)	Returns a List of parameter values for the given name.
UriAndListParam	getProfile()
Set<Include>	getRevIncludes()
SearchStyleEnum	getSearchStyle()	Specifies the search form (GET vs POST) to use for this search.
SortSpec	getSort()
SearchTotalModeEnum	getTotalMode()
boolean	removeParameter(String theName, String theValue)	Remove the parameter with the given name and value, if found.
List<String>	removeParameters(String theName)	Remove all parameters with the given name
SearchRequest	setCount(Integer theCount)
SearchRequest	setIncludes(Set<Include> theIncludes)
SearchRequest	setLastUpdated(DateRangeParam theLastUpdated)
SearchRequest	setOffset(Integer theOffset)
SearchRequest	setParameters(Map<String,List<String>> theParameters)
SearchRequest	setProfile(UriAndListParam theProfile)
SearchRequest	setRevIncludes(Set<Include> theRevIncludes)
void	setSearchStyle(SearchStyleEnum theSearchStyle)	Specifies the search form (GET vs POST) to use for this search.
SearchRequest	setSort(SortSpec theSort)
SearchRequest	setTotalMode(SearchTotalModeEnum theTotalMode)

Methods inherited from class ca.cdr.api.fhirgw.model.BaseRequest

addAdditionalHeader, getAdditionalHeaders, getClientInterceptor, getResourceType, getServerCapabilityStatementValidationEnabled, getServletRequest, isSkip, setClientInterceptor, setResourceType, setServerCapabilityStatementValidationEnabled, setServletRequest, setSkip

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

SearchRequest

public SearchRequest()

Constructor

SearchRequest

public SearchRequest(SearchRequest theSearchRequest)

Copy constructor

Method Details

getSearchStyle

@Nullable
public SearchStyleEnum getSearchStyle()

Specifies the search form (GET vs POST) to use for this search. If set to null, the default will be used.

setSearchStyle

public void setSearchStyle(@Nullable
 SearchStyleEnum theSearchStyle)

Specifies the search form (GET vs POST) to use for this search. If set to null, the default will be used.

getParameters

public com.google.common.collect.Multimap<String,String> getParameters()

setParameters

public SearchRequest setParameters(Map<String,List<String>> theParameters)

removeParameters

public List<String> removeParameters(String theName)

Remove all parameters with the given name

Returns:

Returns any parameter values that were removed

removeParameter

public boolean removeParameter(String theName,
 String theValue)

Remove the parameter with the given name and value, if found. Any other parameters with the same name are kept.

Parameters:

theName - The parameter name

theValue - The parameter value

Returns:

Returns true if a parameter value was removed

getParameter

@Nullable
public String getParameter(String theName)

Returns the first parameter value for a given parameter name (returns null if no parameters match the given name)

Parameters:

theName - The parameter name

Returns:

The value, or null

getParameters

@Nonnull
public List<String> getParameters(String theName)

Returns a List of parameter values for the given name. Will not return null.

Parameters:

theName - The parameter name

Returns:

A List of values, or an empty List

getIncludes

public Set<Include> getIncludes()

setIncludes

public SearchRequest setIncludes(Set<Include> theIncludes)

getRevIncludes

public Set<Include> getRevIncludes()

setRevIncludes

public SearchRequest setRevIncludes(Set<Include> theRevIncludes)

getSort

public SortSpec getSort()

setSort

public SearchRequest setSort(SortSpec theSort)

getCount

public Integer getCount()

setCount

public SearchRequest setCount(Integer theCount)

getOffset

public Integer getOffset()

setOffset

public SearchRequest setOffset(Integer theOffset)

getLastUpdated

public DateRangeParam getLastUpdated()

setLastUpdated

public SearchRequest setLastUpdated(DateRangeParam theLastUpdated)

getProfile

public UriAndListParam getProfile()

setProfile

public SearchRequest setProfile(UriAndListParam theProfile)

getTotalMode

public SearchTotalModeEnum getTotalMode()

setTotalMode

public SearchRequest setTotalMode(SearchTotalModeEnum theTotalMode)

addParameter

public void addParameter(String theName,
 String theValue)

Add a new search parameter