Adding Web Service Sub Class Handler

In OpenMRS Core orders are represented by the following classes: Order, DrugOrder and TestOrder. Where Order is the parent class while the other two are child classes implementing specifics to drug and (lab) test orders.

Two possible design routes for a third-party module (such as REST Web Services) to expose resources for the child classes could be illustrated with the following sets of URLs:

  1. /api/order/drugorder and /api/order/testorder


  2. /api/order?t=drugorder  and /api/order?t=testorder

In the first case, each class will implement its own @Resource class. By implementing this method, a lot of the code is replicated as there is one parent who has most of the properties already. And changing in parent class ,we have to make changes to all the @Resource classes also. This would easier become complex after awhile.

In Second case, OpenMRS REST API provides a functionality for this using a single @Resource class for the parent and managing its child/other types using @SubClassHandler. Like in Order and DrugOrder case, this reduces a lot of work and complexity.

Sub Class Handler provides you the facility to add different child classes of single resource while handling all the complex work be