org.openmrs.logic

Interface LogicContext

public interface LogicContext

Method Summary

Modifier and Type	Method and Description
Result	eval(Integer patientId, LogicCriteria criteria, Map<String,Object> parameters) Evaluate a rule with criteria and parameters for a single patient
Result	eval(Integer patientId, String token) Evaluate a rule for a single patient
Result	eval(Integer patientId, String token, Map<String,Object> parameters) Evaluate a rule with parameters for a single patient
Object	getGlobalParameter(String id) Fetches a global parameter value by name
Collection<String>	getGlobalParameters()
Date	getIndexDate()
LogicDataSource	getLogicDataSource(String name) Fetches a logic data source by name
Patient	getPatient(Integer patientId) Gets the patient object for the given patient id (this patient must be in the cohort of this context)
Result	read(Integer patientId, LogicCriteria criteria) Reads a key with criteria from a logic data source
Result	read(Integer patientId, LogicDataSource dataSource, LogicCriteria criteria) Reads a key with criteria from a logic data source
Result	read(Integer patientId, LogicDataSource dataSource, String key) Reads a key from a logic data source
Result	read(Integer patientId, String key) Reads a key from a logic data source
Object	setGlobalParameter(String id, Object value) Assigns a value to a global parameters within this logic context
void	setIndexDate(Date indexDate) Changes the index date for this logic context
Date	today()

Method Detail

getPatient

Patient getPatient(Integer patientId)

Gets the patient object for the given patient id (this patient must be in the cohort of this context)

Parameters:

patientId -

Returns:

patient object

eval

Result eval(Integer patientId,
            String token)
     throws LogicException

Evaluate a rule for a single patient

Parameters:

patientId -

token -

Returns:

Result of the evaluation

Throws:

LogicException

See Also:

LogicService.eval(Integer, String)

eval

Result eval(Integer patientId,
            String token,
            Map<String,Object> parameters)
     throws LogicException

Evaluate a rule with parameters for a single patient

Parameters:

patientId -

token -

parameters -

Returns:

Result of the evaluation

Throws:

LogicException

See Also:

LogicService.eval(Integer, String, Map)

eval

Result eval(Integer patientId,
            LogicCriteria criteria,
            Map<String,Object> parameters)
     throws LogicException

Evaluate a rule with criteria and parameters for a single patient

Parameters:

patientId -

criteria -

parameters -

Returns:

A Result object with the result of the evaluation

Throws:

LogicException

See Also:

LogicService.eval(Integer, LogicCriteria, Map)

getLogicDataSource

LogicDataSource getLogicDataSource(String name)

Fetches a logic data source by name

Parameters:

name -

Returns:

the requested LogicDataSource

read

Result read(Integer patientId,
            LogicDataSource dataSource,
            String key)
     throws LogicException

Reads a key from a logic data source

Parameters:

patientId -

dataSource -

key -

Returns:

Result of the read operation

Throws:

LogicException

read

Result read(Integer patientId,
            String key)
     throws LogicException

Reads a key from a logic data source

Parameters:

patientId -

key -

Returns:

Result of the read operation

Throws:

LogicException

read

Result read(Integer patientId,
            LogicCriteria criteria)
     throws LogicException

Reads a key with criteria from a logic data source

Parameters:

patientId -

criteria -

Returns:

Result of the read

Throws:

LogicException

read

Result read(Integer patientId,
            LogicDataSource dataSource,
            LogicCriteria criteria)
     throws LogicException

Reads a key with criteria from a logic data source

Parameters:

patientId -

dataSource -

criteria -

Returns:

Result of the read

Throws:

LogicException

setIndexDate

void setIndexDate(Date indexDate)

Changes the index date for this logic context

Parameters:

indexDate - the new Date value for "today" to be used by rules within this logic context

getIndexDate

Date getIndexDate()

Returns:

the value of "today" within this logic context

today

Date today()

Returns:

the index date for the logic context (effective value of "today")

See Also:

getIndexDate()

setGlobalParameter

Object setGlobalParameter(String id,
                          Object value)

Assigns a value to a global parameters within this logic context

Parameters:

id -

value -

Returns:

the value of the parameter that was set

getGlobalParameter

Object getGlobalParameter(String id)

Fetches a global parameter value by name

Parameters:

id -

Returns:

The requested Global parameter Object

getGlobalParameters

Collection<String> getGlobalParameters()

Returns:

all global parameters defined within this logic context