Package com.ibm.fhir.persistence.context
Interface FHIRPersistenceContext
-
- All Known Implementing Classes:
FHIRPersistenceContextImpl
public interface FHIRPersistenceContext
This interface is used to provide request context-related information to the FHIR Server persistence layer.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description FHIRHistoryContext
getHistoryContext()
Returns the FHIRHistoryContext instance associated with the current request.java.lang.Integer
getIfNoneMatch()
Get the encoded ifNoneMatch value which is interpreted as follows:PayloadPersistenceResponse
getOffloadResponse()
Get the payload persistence responseFHIRPersistenceEvent
getPersistenceEvent()
Returns the FHIRPersistenceEvent instance for the current request.FHIRSearchContext
getSearchContext()
Returns the FHIRSearchContext instance associated with the current request.boolean
includeDeleted()
Indicates whether the persistence layer should include "deleted" resources in the operation response.
-
-
-
Method Detail
-
getPersistenceEvent
FHIRPersistenceEvent getPersistenceEvent()
Returns the FHIRPersistenceEvent instance for the current request. This contains information about the security context, HTTP headers, request URI information, etc.
-
getHistoryContext
FHIRHistoryContext getHistoryContext()
Returns the FHIRHistoryContext instance associated with the current request. This will be null if the current request is not a 'history' operation.
-
getSearchContext
FHIRSearchContext getSearchContext()
Returns the FHIRSearchContext instance associated with the current request. This will be null if the current request is not a 'search' operation.
-
includeDeleted
boolean includeDeleted()
Indicates whether the persistence layer should include "deleted" resources in the operation response.
-
getIfNoneMatch
java.lang.Integer getIfNoneMatch()
Get the encoded ifNoneMatch value which is interpreted as follows:null: create-on-update proceeds as normal 0: create-on-update returns 304 if resource exists, 201 if created
- Returns:
- the value from the If-None-Match header in the PUT request
-
getOffloadResponse
PayloadPersistenceResponse getOffloadResponse()
Get the payload persistence response- Returns:
-
-