MlmRule (OpenMRS 1.8.5-SNAPSHOT API)

All Superinterfaces:

Rule
```
public interface MlmRule
extends Rule
```
A medical logic module (MLM) is an independent unit in a health knowledge base that combines the knowledge required and the definition of the way it should be applied for a single health decision (from: wikipedia). Currently the way to create an MlmRule is using Arden syntax and then transform them to Rule object using the ArdenService.

Since:

1.8

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`String`	`getAction()` Returns the action that should be taken when the logic evaluates to true
`Integer`	`getAgeMax()`
`String`	`getAgeMaxUnits()`
`Integer`	`getAgeMin()`
`String`	`getAgeMinUnits()`
`String`	`getAuthor()` Returns the name of the person that authored this rule
`String`	`getCitations()` Returns citations that can be used as reference for this rule
`String`	`getData()` Returns the portion of the rule logic that pulls the data to run the rule
`String`	`getDate()` Returns the date this rule was created
`String`	`getExplanation()` Returns an explanation of why this rule is needed
`String`	`getInstitution()` Returns the institution that authored this rule
`String`	`getKeywords()` Returns keywords that can be used to classify the rule
`String`	`getLinks()` Returns urls that can be used as reference for this rule
`String`	`getLogic()` Returns the logic that is applied to the data to decide what action should be taken
`Integer`	`getPriority()` Returns the priority value of the rule.
`String`	`getPurpose()` Returns the purpose of this rule
`String`	`getSpecialist()` Returns the name of the specialist this rule applies to
`String`	`getTitle()` Returns a descriptive title for the rule.
`String`	`getType()` Returns the type of the rule.
`Double`	`getVersion()` Returns the version of the rule.

Methods inherited from interface org.openmrs.logic.Rule
eval, getDefaultDatatype, getDependencies, getParameterList, getTTL

- Method Detail
  - getPriority
```
Integer getPriority()
```
    Returns the priority value of the rule. This value determines in what order the rules get evaluated.
    
    Returns:
    
    Integer priority value
  - getTitle
```
String getTitle()
```
    Returns a descriptive title for the rule.
    
    Returns:
    
    String title for the rule
  - getVersion
```
Double getVersion()
```
    Returns the version of the rule.
    
    Returns:
    
    Double version of the rule
  - getInstitution
```
String getInstitution()
```
    Returns the institution that authored this rule
    
    Returns:
    
    String institution that authored this rule
  - getAuthor
```
String getAuthor()
```
    Returns the name of the person that authored this rule
    
    Returns:
    
    String name of the person that authored this rule
  - getSpecialist
```
String getSpecialist()
```
    Returns the name of the specialist this rule applies to
    
    Returns:
    
    String name of the specialist this rule applies to
  - getDate
```
String getDate()
```
    Returns the date this rule was created
    
    Returns:
    
    String date this rule was created
  - getPurpose
```
String getPurpose()
```
    Returns the purpose of this rule
    
    Returns:
    
    String purpose of this rule
  - getExplanation
```
String getExplanation()
```
    Returns an explanation of why this rule is needed
    
    Returns:
    
    String explanation of why this rule is needed
  - getKeywords
```
String getKeywords()
```
    Returns keywords that can be used to classify the rule
    
    Returns:
    
    String keywords that can be used to classify the rule
  - getCitations
```
String getCitations()
```
    Returns citations that can be used as reference for this rule
    
    Returns:
    
    String citations that can be used as reference for this rule
  - getLinks
```
String getLinks()
```
    Returns urls that can be used as reference for this rule
    
    Returns:
    
    String urls that can be used as reference for this rule
  - getData
```
String getData()
```
    Returns the portion of the rule logic that pulls the data to run the rule
    
    Returns:
    
    String portion of the rule logic that pulls the data to run the rule
  - getLogic
```
String getLogic()
```
    Returns the logic that is applied to the data to decide what action should be taken
    
    Returns:
    
    String the logic that is applied to the data to decide what action should be taken
  - getAction
```
String getAction()
```
    Returns the action that should be taken when the logic evaluates to true
    
    Returns:
    
    String action that should be taken when the logic evaluates to true
  - getType
```
String getType()
```
    Returns the type of the rule. This type is used along with the priority to evaluate prioritized rule sets
    
    Returns:
    
    String type of the rule
  - getAgeMin
```
Integer getAgeMin()
```
  - getAgeMax
```
Integer getAgeMax()
```
  - getAgeMinUnits
```
String getAgeMinUnits()
```
  - getAgeMaxUnits
```
String getAgeMaxUnits()
```

Interface MlmRule

Method Summary

Methods inherited from interface org.openmrs.logic.Rule

Method Detail

getPriority

getTitle

getVersion

getInstitution

getAuthor

getSpecialist

getDate

getPurpose

getExplanation

getKeywords

getCitations

getLinks

getData

getLogic

getAction

getType

getAgeMin

getAgeMax

getAgeMinUnits

getAgeMaxUnits