org.openmrs.module.web.extension

Class FormEntryHandler

java.lang.Object

org.openmrs.module.Extension

org.openmrs.module.web.extension.FormEntryHandler

public abstract class FormEntryHandler
extends Extension

 This class allows modules that provide form entry capabilities (like formentry, htmlformentry, and xforms) to appear in the
 same place in the UI when the user indicates they want to enter a form, and wants to pick which form.
 
 To be able to enter forms, your module should provide a subclass that overrides the #getFormList(FormEntryContext)),
 and getFormEntryUrl() methods.
 
 If your module wants to be able to take over the view or edit links in the list of existing encounters, then your subclass
 should override the getViewFormUrl() and getFormsModuleCanView() methods (for viewing) and/or
 the getEditFormUrl() and getFormsModuleCanEdit() methods (for editing).
 
 [WARNING: Do not be surprised if this class changes substantially in OpenMRS 1.6.]
 

Nested Class Summary

Nested classes/interfaces inherited from class org.openmrs.module.Extension

Extension.MEDIA_TYPE

Field Summary

Fields inherited from class org.openmrs.module.Extension

extensionIdSeparator

Constructor Summary

Constructors

Constructor and Description
FormEntryHandler()

Method Summary

Modifier and Type	Method and Description
String	getEditFormUrl() If your module wants to override the Edit link for encounters, override this method.
String	getFormEntryUrl() If your module allows filling out forms, override this method.
Set<Form>	getFormsModuleCanEdit() If your module wants to override the Edit link for encounters, override this method.
List<Form>	getFormsModuleCanEnter(FormEntryContext formEntryContext) If your module allows filling out forms, override this method.
Set<Form>	getFormsModuleCanView() If your module wants to override the View link for encounters, override this method.
Extension.MEDIA_TYPE	getMediaType() Sets the content type of this extension.
String	getRequiredPrivilege() If you want your module to require any privileges before the user can enter forms with this particular module (besides "Form Entry" which is automatically required by the framework) then return it here.
String	getViewFormUrl() If your module wants to override the View link for encounters, override this method.

Methods inherited from class org.openmrs.module.Extension

getExtensionId, getModuleId, getOverrideContent, getParameterMap, getPointId, initialize, setModuleId, setParameterMap, setPointId, toExtensionId, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

FormEntryHandler

public FormEntryHandler()

Method Detail

getMediaType

public Extension.MEDIA_TYPE getMediaType()

Description copied from class: Extension

Sets the content type of this extension. If null is returned this extension should work across all medium types

Specified by:

getMediaType in class Extension

Returns:

type of the medium that this extension works for

See Also:

Extension.getMediaType()

getRequiredPrivilege

public String getRequiredPrivilege()

If you want your module to require any privileges before the user can enter forms with this particular module (besides "Form Entry" which is automatically required by the framework) then return it here.

Returns:

privilege to require

getFormsModuleCanEnter

public List<Form> getFormsModuleCanEnter(FormEntryContext formEntryContext)

If your module allows filling out forms, override this method.

Parameters:

formEntryContext - details about the state of the user interface where the user is choosing to enter a form from

Returns:

the list of forms provided by this module.

getFormEntryUrl

public String getFormEntryUrl()

If your module allows filling out forms, override this method.

Returns:

the url to go to enter a form. (The framework will take care of adding ?personId=xyz&patientId=xyz&formId=abc to it.)

getViewFormUrl

public String getViewFormUrl()

If your module wants to override the View link for encounters, override this method.

Returns:

the url to go to to view a form. (The framework will take care of adding ?encounterId=xyz

getFormsModuleCanView

public Set<Form> getFormsModuleCanView()

If your module wants to override the View link for encounters, override this method.

Returns:

the forms for which this module should override the View link

getEditFormUrl

public String getEditFormUrl()

If your module wants to override the Edit link for encounters, override this method.

Returns:

the url to go to to edit a form. (The framework will take care of adding ?encounterId=xyz

getFormsModuleCanEdit

public Set<Form> getFormsModuleCanEdit()

If your module wants to override the Edit link for encounters, override this method.

Returns:

the forms for which this module should override the Edit link