Order (OpenMRS 2.7.0-SNAPSHOT API)

java.lang.Object
- org.openmrs.BaseOpenmrsObject
- - org.openmrs.BaseOpenmrsData
  - - org.openmrs.BaseChangeableOpenmrsData
    - - org.openmrs.BaseCustomizableData<OrderAttribute>
      - org.openmrs.Order

All Implemented Interfaces:

Serializable, Auditable, Changeable, Creatable, Customizable<OrderAttribute>, FormRecordable, OpenmrsData, OpenmrsObject, Voidable

Direct Known Subclasses:

DrugOrder, ServiceOrder
```
public class Order
extends BaseCustomizableData<OrderAttribute>
implements FormRecordable
```
Encapsulates information about the clinical action of a provider requesting something for a patient e.g requesting a test to be performed, prescribing a medication, requesting the patient to enroll on a specific diet etc. There is the notion of effective dates, these are used to determine the span of an order's schedule i.e its effective start and stop dates therefore dates should be interpreted as follows: The effective start of the schedule is the scheduledDate if urgency is set to ON_SCHEDULED_DATE otherwise it is the dateActivated; the effective end date is dateStopped, if it is null then it is the autoExpireDate. For DrugOrders, if the autoExpireDate is not specified then it will be calculated and set by the API based on the duration and frequency, note that frequency is only used in case duration is specified as a recurring interval e.g. 3 times.

Version:

1.0

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`Order.Action`
`static class`	`Order.FulfillerStatus` Valid values for the status of an order that is received from a filler
`static class`	`Order.Urgency`

Field Summary

Fields
Modifier and Type Field and Description

static long serialVersionUID
- Fields inherited from class org.openmrs.BaseOpenmrsData
  creator

Fields
Modifier and Type	Field and Description
`static long`	`serialVersionUID`

Constructor Summary

Constructors
Constructor and Description

Order()
default constructor

Order(Integer orderId)
constructor with id

Constructors
Constructor and Description
`Order()` default constructor
`Order(Integer orderId)` constructor with id

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Order`	`cloneForDiscontinuing()` Creates a discontinuation order for this order, sets the previousOrder and action fields, note that the discontinuation order needs to be saved for the discontinuation to take effect
`Order`	`cloneForRevision()` Creates an order for revision from this order, sets the previousOrder and action field.
`protected Order`	`cloneForRevisionHelper(Order target)` The purpose of this method is to allow subclasses of Order to delegate a portion of their cloneForRevision() method back to the superclass, in case the base class implementation changes.
`Order`	`copy()` Performs a shallow copy of this Order.
`protected Order`	`copyHelper(Order target)` The purpose of this method is to allow subclasses of Order to delegate a portion of their copy() method back to the superclass, in case the base class implementation changes.
`String`	`getAccessionNumber()`
`Order.Action`	`getAction()` Gets the action
`Date`	`getAutoExpireDate()`
`CareSetting`	`getCareSetting()` Gets the careSetting
`String`	`getCommentToFulfiller()`
`Concept`	`getConcept()`
`Date`	`getDateActivated()`
`Date`	`getDateStopped()`
`Date`	`getEffectiveStartDate()` A convenience method to return start of the schedule for order.
`Date`	`getEffectiveStopDate()` A convenience method to return end of the schedule for order.
`Encounter`	`getEncounter()`
`String`	`getFormFieldNamespace()` Gets the namespace for the form field that was used to capture the obs details in the form
`String`	`getFormFieldPath()` Gets the path for the form field that was used to capture the obs details in the form
`String`	`getFormNamespaceAndPath()`
`String`	`getFulfillerComment()` Returns the comment received from the fulfiller regarding this order.
`Order.FulfillerStatus`	`getFulfillerStatus()` Returns the current status that was received from a fulfiller for this order.
`Integer`	`getId()`
`String`	`getInstructions()`
`Provider`	`getOrderer()`
`OrderGroup`	`getOrderGroup()`
`Integer`	`getOrderId()`
`String`	`getOrderNumber()`
`Concept`	`getOrderReason()`
`String`	`getOrderReasonNonCoded()`
`OrderType`	`getOrderType()` Get the `OrderType`
`Patient`	`getPatient()`
`Order`	`getPreviousOrder()` Gets the previous related order.
`Date`	`getScheduledDate()`
`Double`	`getSortWeight()` Gets the sortWeight for an order if it is ordered as an OrderGroup.
`Order.Urgency`	`getUrgency()`
`boolean`	`hasSameOrderableAs(Order otherOrder)` Checks whether orderable of this order is same as other order
`boolean`	`isActivated()` Convenience method to determine if the order is activated as of the current date
`boolean`	`isActivated(Date checkDate)` Convenience method to determine if the order is activated as of the specified date
`boolean`	`isActive()` Convenience method to determine if the order was active as of the current date
`boolean`	`isActive(Date aCheckDate)` Convenience method to determine if the order is active as of the specified date
`boolean`	`isDiscontinued(Date aCheckDate)` Convenience method to determine if the order is discontinued as of the specified date
`boolean`	`isDiscontinuedRightNow()`
`boolean`	`isExpired()` Convenience method to determine if the order is expired as of the specified date
`boolean`	`isExpired(Date aCheckDate)` Convenience method to determine if order was expired at a given time
`boolean`	`isStarted()` Convenience method to determine if order is started as of the current date
`boolean`	`isStarted(Date aCheckDate)` Convenience method to determine if the order is started as of the specified date, returns true only if the order has been activated.
`boolean`	`isType(OrderType orderType)` Checks whether this order's orderType matches or is a sub type of the specified one
`void`	`setAccessionNumber(String accessionNumber)`
`void`	`setAction(Order.Action action)` Sets the ation
`void`	`setAutoExpireDate(Date autoExpireDate)`
`void`	`setCareSetting(CareSetting careSetting)` Sets the careSetting
`void`	`setCommentToFulfiller(String commentToFulfiller)`
`void`	`setConcept(Concept concept)`
`void`	`setDateActivated(Date dateActivated)`
`void`	`setEncounter(Encounter encounter)`
`void`	`setFormField(String namespace, String formFieldPath)` Sets the namespace and path of the form field that was used to capture the obs details in the form.
`void`	`setFormNamespaceAndPath(String formNamespaceAndPath)` Sets the form namespace and path
`void`	`setFulfillerComment(String fulfillerComment)` Sets the comment received from the fulfiller for this order.
`void`	`setFulfillerStatus(Order.FulfillerStatus fulfillerStatus)` Sets the status of this order according to the value that was received from a fulfiller.
`void`	`setId(Integer id)`
`void`	`setInstructions(String instructions)`
`void`	`setOrderer(Provider orderer)`
`void`	`setOrderGroup(OrderGroup orderGroup)` Sets the OrderGroup for that order.
`void`	`setOrderId(Integer orderId)`
`void`	`setOrderReason(Concept orderReason)`
`void`	`setOrderReasonNonCoded(String orderReasonNonCoded)`
`void`	`setOrderType(OrderType orderType)` Set the `OrderType`
`void`	`setPatient(Patient patient)`
`void`	`setPreviousOrder(Order previousOrder)` Sets the previous order.
`void`	`setScheduledDate(Date scheduledDate)`
`void`	`setSortWeight(Double sortWeight)` Sets the sortWeight for an order if it is ordered as an OrderGroup.
`void`	`setUrgency(Order.Urgency urgency)`
`String`	`toString()` Returns a string equal to the value of: ClassName{hashCode=..., uuid=...}

Methods inherited from class org.openmrs.BaseCustomizableData
addAttribute, getActiveAttributes, getActiveAttributes, getAttributes, setAttribute, setAttributes

Methods inherited from class org.openmrs.BaseOpenmrsData
getChangedBy, getCreator, getDateChanged, getDateCreated, getDateVoided, getVoided, getVoidedBy, getVoidReason, isVoided, setChangedBy, setCreator, setDateChanged, setDateCreated, setDateVoided, setVoided, setVoidedBy, setVoidReason

Methods inherited from class org.openmrs.BaseOpenmrsObject
equals, getUuid, hashCode, setUuid

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.openmrs.OpenmrsObject
getUuid, setUuid

- Field Detail
  - serialVersionUID
```
public static final long serialVersionUID
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - Order
```
public Order()
```
    default constructor
  - Order
```
public Order(Integer orderId)
```
    constructor with id
- Method Detail
  - copy
```
public Order copy()
```
    Performs a shallow copy of this Order. Does NOT copy orderId.
    
    Returns:
    
    a shallow copy of this Order Should copy all fields
  - copyHelper
```
protected Order copyHelper(Order target)
```
    The purpose of this method is to allow subclasses of Order to delegate a portion of their copy() method back to the superclass, in case the base class implementation changes.
    
    Parameters:
    
    target - an Order that will have the state of this copied into it
    
    Returns:
    
    Returns the Order that was passed in, with state copied into it
  - getAutoExpireDate
```
public Date getAutoExpireDate()
```
    Returns:
    
    Returns the autoExpireDate.
  - setAutoExpireDate
```
public void setAutoExpireDate(Date autoExpireDate)
```
    Parameters:
    
    autoExpireDate - The autoExpireDate to set.
  - getConcept
```
public Concept getConcept()
```
    Returns:
    
    Returns the concept.
  - setConcept
```
public void setConcept(Concept concept)
```
    Parameters:
    
    concept - The concept to set.
  - getScheduledDate
```
public Date getScheduledDate()
```
    Returns:
    
    the scheduledDate
    
    Since:
    
    1.10
  - setScheduledDate
```
public void setScheduledDate(Date scheduledDate)
```
    Parameters:
    
    scheduledDate - the date to set
    
    Since:
    
    1.10
  - getDateStopped
```
public Date getDateStopped()
```
    Returns:
    
    Returns the dateStopped.
    
    Since:
    
    1.10
  - getOrderReason
```
public Concept getOrderReason()
```
    Returns:
    
    Returns the orderReason.
  - setOrderReason
```
public void setOrderReason(Concept orderReason)
```
    Parameters:
    
    orderReason - The orderReason to set.
  - getEncounter
```
public Encounter getEncounter()
```
    Returns:
    
    Returns the encounter.
  - setEncounter
```
public void setEncounter(Encounter encounter)
```
    Parameters:
    
    encounter - The encounter to set.
  - getInstructions
```
public String getInstructions()
```
    Returns:
    
    Returns the instructions.
  - setInstructions
```
public void setInstructions(String instructions)
```
    Parameters:
    
    instructions - The instructions to set.
  - getAccessionNumber
```
public String getAccessionNumber()
```
    Returns:
    
    Returns the accessionNumber.
  - setAccessionNumber
```
public void setAccessionNumber(String accessionNumber)
```
    Parameters:
    
    accessionNumber - The accessionNumber to set.
  - getOrderer
```
public Provider getOrderer()
```
    Returns:
    
    Returns the orderer.
  - setOrderer
```
public void setOrderer(Provider orderer)
```
    Parameters:
    
    orderer - The orderer to set.
  - getOrderId
```
public Integer getOrderId()
```
    Returns:
    
    Returns the orderId.
  - setOrderId
```
public void setOrderId(Integer orderId)
```
    Parameters:
    
    orderId - The orderId to set.
  - getDateActivated
```
public Date getDateActivated()
```
    Returns:
    
    Returns the dateActivated.
  - setDateActivated
```
public void setDateActivated(Date dateActivated)
```
    Parameters:
    
    dateActivated - The dateActivated to set.
  - getOrderReasonNonCoded
```
public String getOrderReasonNonCoded()
```
    Returns:
    
    Returns the orderReasonNonCoded.
  - setOrderReasonNonCoded
```
public void setOrderReasonNonCoded(String orderReasonNonCoded)
```
    Parameters:
    
    orderReasonNonCoded - The orderReasonNonCoded to set.
  - getCommentToFulfiller
```
public String getCommentToFulfiller()
```
    Returns:
    
    the commentToFulfiller
    
    Since:
    
    1.10
  - setCommentToFulfiller
```
public void setCommentToFulfiller(String commentToFulfiller)
```
    Parameters:
    
    commentToFulfiller - The commentToFulfiller to set
    
    Since:
    
    1.10
  - isActivated
```
public boolean isActivated()
```
    Convenience method to determine if the order is activated as of the current date
    
    Returns:
    
    boolean indicating whether the order was activated before or on the current date
    
    Since:
    
    2.0
    
    See Also:
    
    isActivated(java.util.Date)
  - isActivated
```
public boolean isActivated(Date checkDate)
```
    Convenience method to determine if the order is activated as of the specified date
    
    Parameters:
    
    checkDate - - the date on which to check order. if null, will use current date
    
    Returns:
    
    boolean indicating whether the order was activated before or on the check date
    
    Since:
    
    2.0 Should return true if an order was activated on the check date Should return true if an order was activated before the check date Should return false if dateActivated is null Should return false for an order activated after the check date
  - isActive
```
public boolean isActive()
```
    Convenience method to determine if the order was active as of the current date
    
    Returns:
    
    boolean indicating whether the order was active on the check date
    
    Since:
    
    1.10.1
  - isActive
```
public boolean isActive(Date aCheckDate)
```
    Convenience method to determine if the order is active as of the specified date
    
    Parameters:
    
    aCheckDate - - the date on which to check order. if null, will use current date
    
    Returns:
    
    boolean indicating whether the order was active on the check date
    
    Since:
    
    1.10.1 Should return true if an order expired on the check date Should return true if an order was discontinued on the check date Should return true if an order was activated on the check date Should return true if an order was activated on the check date but scheduled for the future Should return false for a voided order Should return false for a discontinued order Should return false for an expired order Should return false for an order activated after the check date Should return false for a discontinuation order
  - isStarted
```
public boolean isStarted()
```
    Convenience method to determine if order is started as of the current date
    
    Returns:
    
    boolean indicating whether the order is started as of the current date
    
    Since:
    
    1.10.1
    
    See Also:
    
    isStarted(java.util.Date)
  - isStarted
```
public boolean isStarted(Date aCheckDate)
```
    Convenience method to determine if the order is started as of the specified date, returns true only if the order has been activated. In case of scheduled orders, the scheduledDate becomes the effective start date that gets used to determined if it is started.
    
    Parameters:
    
    aCheckDate - - the date on which to check order. if null, will use current date
    
    Returns:
    
    boolean indicating whether the order is started as of the check date
    
    Since:
    
    1.10.1 Should return false for a voided order Should return false if dateActivated is null Should return false if the order is not yet activated as of the check date Should return false if the order was scheduled to start after the check date Should return true if the order was scheduled to start on the check date Should return true if the order was scheduled to start before the check date Should return true if the order is started and not scheduled
  - isDiscontinued
```
public boolean isDiscontinued(Date aCheckDate)
```
    Convenience method to determine if the order is discontinued as of the specified date
    
    Parameters:
    
    aCheckDate - - the date on which to check order. if null, will use current date
    
    Returns:
    
    boolean indicating whether the order was discontinued on the input date Should return false for a voided order Should return false if date stopped and auto expire date are both null Should return false if auto expire date is null and date stopped is equal to check date Should return false if auto expire date is null and date stopped is after check date Should return false if dateActivated is after check date Should return true if auto expire date is null and date stopped is before check date Should fail if date stopped is after auto expire date Should return true if check date is after date stopped but before auto expire date Should return true if check date is after both date stopped auto expire date Should return true if the order is scheduled for the future and activated on check date but the check date is after date stopped
  - isExpired
```
public boolean isExpired()
```
    Convenience method to determine if the order is expired as of the specified date
    
    Returns:
    
    boolean indicating whether the order is expired at the current time
    
    Since:
    
    1.10.1
  - isExpired
```
public boolean isExpired(Date aCheckDate)
```
    Convenience method to determine if order was expired at a given time
    
    Parameters:
    
    aCheckDate - - the date on which to check order. if null, will use current date
    
    Returns:
    
    boolean indicating whether the order was expired on the input date Should return false for a voided order Should return false if date stopped and auto expire date are both null Should return false if date stopped is null and auto expire date is equal to check date Should return false if date stopped is null and auto expire date is after check date Should return false if check date is after both date stopped auto expire date Should return false if dateActivated is after check date Should return false if check date is after date stopped but before auto expire date Should fail if date stopped is after auto expire date Should return true if date stopped is null and auto expire date is before check date
    
    Since:
    
    1.10.1
  - isDiscontinuedRightNow
```
public boolean isDiscontinuedRightNow()
```
  - getPatient
```
public Patient getPatient()
```
  - setPatient
```
public void setPatient(Patient patient)
```
  - getId
```
public Integer getId()
```
    Specified by:
    
    getId in interface OpenmrsObject
    
    Returns:
    
    id - The unique Identifier for the object
  - toString
```
public String toString()
```
    Description copied from class: BaseOpenmrsObject
    
    Returns a string equal to the value of:
    ClassName{hashCode=..., uuid=...}
    
    If the uuid field is null, it returns:
    ClassName{hashCode=...}
    Should include hashCode if uuid is null Should include uuid if not null
    
    Overrides:
    
    toString in class BaseOpenmrsObject
    
    See Also:
    
    Object.toString()
  - setId
```
public void setId(Integer id)
```
    Specified by:
    
    setId in interface OpenmrsObject
    
    Parameters:
    
    id - - The unique Identifier for the object
    
    Since:
    
    1.5
    
    See Also:
    
    OpenmrsObject.setId(java.lang.Integer)
  - getUrgency
```
public Order.Urgency getUrgency()
```
    Returns:
    
    the urgency
    
    Since:
    
    1.9.2
  - setUrgency
```
public void setUrgency(Order.Urgency urgency)
```
    Parameters:
    
    urgency - the urgency to set
    
    Since:
    
    1.9.2
  - getOrderNumber
```
public String getOrderNumber()
```
    Returns:
    
    the orderNumber
    
    Since:
    
    1.10
  - getPreviousOrder
```
public Order getPreviousOrder()
```
    Gets the previous related order.
    
    Returns:
    
    the previous order.
    
    Since:
    
    1.10
  - setPreviousOrder
```
public void setPreviousOrder(Order previousOrder)
```
    Sets the previous order.
    
    Parameters:
    
    previousOrder - the previous order to set.
    
    Since:
    
    1.10
  - getAction
```
public Order.Action getAction()
```
    Gets the action
    
    Returns:
    
    the action
    
    Since:
    
    1.10
  - setAction
```
public void setAction(Order.Action action)
```
    Sets the ation
    
    Parameters:
    
    action - the action to set
    
    Since:
    
    1.10
  - getCareSetting
```
public CareSetting getCareSetting()
```
    Gets the careSetting
    
    Returns:
    
    the action
    
    Since:
    
    1.10
  - setCareSetting
```
public void setCareSetting(CareSetting careSetting)
```
    Sets the careSetting
    
    Parameters:
    
    careSetting - the action to set
    
    Since:
    
    1.10
  - getOrderType
```
public OrderType getOrderType()
```
    Get the OrderType
    
    Returns:
    
    the OrderType
  - setOrderType
```
public void setOrderType(OrderType orderType)
```
    Set the OrderType
    
    Parameters:
    
    orderType - the OrderType
  - cloneForDiscontinuing
```
public Order cloneForDiscontinuing()
```
    Creates a discontinuation order for this order, sets the previousOrder and action fields, note that the discontinuation order needs to be saved for the discontinuation to take effect
    
    Returns:
    
    the newly created order
    
    Since:
    
    1.10 Should set all the relevant fields
  - cloneForRevision
```
public Order cloneForRevision()
```
    Creates an order for revision from this order, sets the previousOrder and action field.
    
    Returns:
    
    the newly created order
    
    Since:
    
    1.10 Should set all the relevant fields Should set the relevant fields for a DC order
  - cloneForRevisionHelper
```
protected Order cloneForRevisionHelper(Order target)
```
    The purpose of this method is to allow subclasses of Order to delegate a portion of their cloneForRevision() method back to the superclass, in case the base class implementation changes.
    
    Parameters:
    
    target - an Order that will have the state of this copied into it
    
    Returns:
    
    Returns the Order that was passed in, with state copied into it
  - isType
```
public boolean isType(OrderType orderType)
```
    Checks whether this order's orderType matches or is a sub type of the specified one
    
    Parameters:
    
    orderType - the orderType to match on
    
    Returns:
    
    true if the type of the order matches or is a sub type of the other order Should true if it is the same or is a subtype Should false if it neither the same nor a subtype
    
    Since:
    
    1.10
  - hasSameOrderableAs
```
public boolean hasSameOrderableAs(Order otherOrder)
```
    Checks whether orderable of this order is same as other order
    
    Parameters:
    
    otherOrder - the other order to match on
    
    Returns:
    
    true if the concept of the orders match Should return false if the concept of the orders do not match Should return false if other order is null Should return true if the orders have the same concept
    
    Since:
    
    1.10
    
    See Also:
    
    for overridden behaviour
  - getEffectiveStartDate
```
public Date getEffectiveStartDate()
```
    A convenience method to return start of the schedule for order.
    
    Since:
    
    1.10 Should return scheduledDate if Urgency is Scheduled Should return dateActivated if Urgency is not Scheduled
  - getEffectiveStopDate
```
public Date getEffectiveStopDate()
```
    A convenience method to return end of the schedule for order.
    
    Since:
    
    1.10 Should return dateStopped if dateStopped is not null Should return autoExpireDate if dateStopped is null
  - getOrderGroup
```
public OrderGroup getOrderGroup()
```
    Since:
    
    1.12 OrderGroup
  - setOrderGroup
```
public void setOrderGroup(OrderGroup orderGroup)
```
    Sets the OrderGroup for that order. If the order is ordered independently, it does not set an orderGroup for it. If the order is ordered as an orderGroup, then sets a link to the OrderGroup for that particular order.
    
    Parameters:
    
    orderGroup -
    
    Since:
    
    1.12
  - getSortWeight
```
public Double getSortWeight()
```
    Gets the sortWeight for an order if it is ordered as an OrderGroup.
    
    Returns:
    
    the sortWeight
    
    Since:
    
    1.12
  - setSortWeight
```
public void setSortWeight(Double sortWeight)
```
    Sets the sortWeight for an order if it is ordered as an OrderGroup. sortWeight is used internally by the API to manage the sequencing of orders when grouped. This value may be changed by the API as needed for that purpose. Instead of setting this internal value directly please use OrderGroup.addOrder(Order, Integer).
    
    Parameters:
    
    sortWeight -
    
    Since:
    
    1.12
    
    See Also:
    
    OrderGroup.addOrder(Order, Integer)
  - getFulfillerStatus
```
public Order.FulfillerStatus getFulfillerStatus()
```
    Returns the current status that was received from a fulfiller for this order. It can either be RECEIVED, IN_PROGRESS, EXCEPTION or COMPLETED.
    
    Returns:
    
    the status that was received from a fulfiller
    
    Since:
    
    2.2.0
  - setFulfillerStatus
```
public void setFulfillerStatus(Order.FulfillerStatus fulfillerStatus)
```
    Sets the status of this order according to the value that was received from a fulfiller.
    
    Parameters:
    
    fulfillerStatus - the status that was received from a fulfiller.
    
    Since:
    
    2.2.0
  - getFulfillerComment
```
public String getFulfillerComment()
```
    Returns the comment received from the fulfiller regarding this order.
    
    Returns:
    
    the comment of the fulfiller
    
    Since:
    
    2.2.0
  - setFulfillerComment
```
public void setFulfillerComment(String fulfillerComment)
```
    Sets the comment received from the fulfiller for this order.
    
    Parameters:
    
    fulfillerComment - the comment received from the fulfiller
    
    Since:
    
    2.2.0
  - getFormNamespaceAndPath
```
public String getFormNamespaceAndPath()
```
    Returns:
    
    Returns the formNamespaceAndPath.
    
    Since:
    
    2.5.0
  - setFormNamespaceAndPath
```
public void setFormNamespaceAndPath(String formNamespaceAndPath)
```
    Sets the form namespace and path
    
    Parameters:
    
    formNamespaceAndPath - the form namespace and path to set
    
    Since:
    
    2.5.0
  - getFormFieldNamespace
```
public String getFormFieldNamespace()
```
    Description copied from interface: FormRecordable
    
    Gets the namespace for the form field that was used to capture the obs details in the form
    
    Specified by:
    
    getFormFieldNamespace in interface FormRecordable
    
    Returns:
    
    the namespace
  - getFormFieldPath
```
public String getFormFieldPath()
```
    Description copied from interface: FormRecordable
    
    Gets the path for the form field that was used to capture the obs details in the form
    
    Specified by:
    
    getFormFieldPath in interface FormRecordable
    
    Returns:
    
    the the form field path
  - setFormField
```
public void setFormField(String namespace,
                         String formFieldPath)
```
    Description copied from interface: FormRecordable
    
    Sets the namespace and path of the form field that was used to capture the obs details in the form.
    Note: Namespace and formFieldPath together must not exceed 254 characters in length, form applications can subtract the length of their namespace from 254 to determine the maximum length they can use for a form field path.
    
    Specified by:
    
    setFormField in interface FormRecordable
    
    Parameters:
    
    namespace - the namespace of the form field
    
    formFieldPath - the path of the form field

Class Order

Nested Class Summary

Field Summary

Fields inherited from class org.openmrs.BaseOpenmrsData

Constructor Summary

Method Summary

Methods inherited from class org.openmrs.BaseCustomizableData

Methods inherited from class org.openmrs.BaseOpenmrsData

Methods inherited from class org.openmrs.BaseOpenmrsObject

Methods inherited from class java.lang.Object

Methods inherited from interface org.openmrs.OpenmrsObject

Field Detail

serialVersionUID

Constructor Detail

Order

Order

Method Detail

copy

copyHelper

getAutoExpireDate

setAutoExpireDate

getConcept

setConcept

getScheduledDate

setScheduledDate

getDateStopped

getOrderReason

setOrderReason

getEncounter

setEncounter

getInstructions

setInstructions

getAccessionNumber

setAccessionNumber

getOrderer

setOrderer

getOrderId

setOrderId

getDateActivated

setDateActivated

getOrderReasonNonCoded

setOrderReasonNonCoded

getCommentToFulfiller

setCommentToFulfiller

isActivated

isActivated

isActive

isActive

isStarted

isStarted

isDiscontinued

isExpired

isExpired

isDiscontinuedRightNow

getPatient

setPatient

getId

toString

setId

getUrgency

setUrgency

getOrderNumber

getPreviousOrder

setPreviousOrder

getAction

setAction

getCareSetting

setCareSetting

getOrderType

setOrderType

cloneForDiscontinuing

cloneForRevision

cloneForRevisionHelper

isType

hasSameOrderableAs

getEffectiveStartDate

getEffectiveStopDate

getOrderGroup

setOrderGroup

getSortWeight