Uses of Class
org.openmrs.Form

Packages that use Form

Package	Description
org.openmrs	These classes represent the core domain objects for the OpenMRS project.
org.openmrs.api	The primary OpenMRS API interfaces.
org.openmrs.api.db	OpenMRS database layer interfaces.
org.openmrs.api.db.hibernate	Resources for Hibernate ORM.
org.openmrs.api.impl
org.openmrs.module.web.extension
org.openmrs.reporting	Deprecated
org.openmrs.util	Shared utilities for OpenMRS classes
org.openmrs.web.controller
org.openmrs.web.dwr

Uses of Form in org.openmrs

Fields in org.openmrs declared as Form

Modifier and Type	Field and Description
protected Form	FormField.form

Methods in org.openmrs that return Form

Modifier and Type	Method and Description
Form	FormField.getForm()
Form	Encounter.getForm()

Methods in org.openmrs that return types with arguments of type Form

Modifier and Type	Method and Description
Set<Form>	Field.getForms() Deprecated. This method always returns null. Forms that a Field is on are managed through the FormField object

Methods in org.openmrs with parameters of type Form

Modifier and Type	Method and Description
void	FormField.setForm(Form form)
void	Encounter.setForm(Form form)

Method parameters in org.openmrs with type arguments of type Form

Modifier and Type	Method and Description
void	Field.setForms(Set<Form> forms) Deprecated. This method does nothing. Forms that a Field is on are managed through the FormField object

Uses of Form in org.openmrs.api

Methods in org.openmrs.api that return Form

Modifier and Type	Method and Description
Form	FormService.createForm(Form form) Deprecated. use FormService.saveForm(Form)
Form	FormService.duplicateForm(Form form) Duplicate this form and form_fields associated with this form
Form	FormService.getForm(Integer formId) Get form by internal form identifier
Form	FormService.getForm(String name) Get form by exact name match.
Form	FormService.getForm(String name, String version) Get form by exact name & version match.
Form	FormService.getFormByUuid(String uuid) Get Form by its UUID
Form	FormService.saveForm(Form form) Create or update the given Form in the database

Methods in org.openmrs.api that return types with arguments of type Form

Modifier and Type	Method and Description
List<Form>	FormService.findForms(String text, boolean includeUnpublished, boolean includeRetired) Deprecated. use FormService.getForms(String, Boolean, Collection, Boolean, Collection, Collection)
List<Form>	FormService.getAllForms() Gets all Forms, including retired ones.
List<Form>	FormService.getAllForms(boolean includeRetired) Gets all forms, possibly including retired ones
List<Form>	FormService.getForms() Deprecated. use FormService.getAllForms()
List<Form>	FormService.getForms(boolean publishedOnly) Deprecated. use FormService.getAllForms() or FormService.getPublishedForms()
List<Form>	FormService.getForms(boolean publishedOnly, boolean includeRetired) Deprecated. use FormService.getAllForms() or FormService.getPublishedForms() or FormService.getForms(String, Boolean, Collection, Boolean, Collection, Collection)
Set<Form>	FormService.getForms(Concept c) Deprecated. use FormService.getFormsContainingConcept(Concept)
List<Form>	FormService.getForms(String fuzzyName, boolean onlyLatestVersion) Gets all forms with name similar to the given name.
List<Form>	FormService.getForms(String partialNameSearch, Boolean published, Collection<EncounterType> encounterTypes, Boolean retired, Collection<FormField> containingAnyFormField, Collection<FormField> containingAllFormFields) Deprecated. use FormService.getForms(String, Boolean, Collection, Boolean, Collection, Collection, Collection)
List<Form>	FormService.getForms(String partialNameSearch, Boolean published, Collection<EncounterType> encounterTypes, Boolean retired, Collection<FormField> containingAnyFormField, Collection<FormField> containingAllFormFields, Collection<Field> fields) Gets all forms that match all the (nullable) criteria
List<Form>	FormService.getFormsContainingConcept(Concept concept) Returns all forms that contain the given concept as a field in their schema.
List<Form>	FormService.getPublishedForms() Returns all published forms (not including retired ones)

Methods in org.openmrs.api with parameters of type Form

Modifier and Type	Method and Description
Form	FormService.createForm(Form form) Deprecated. use FormService.saveForm(Form)
void	FormService.deleteForm(Form form) Deprecated. use FormService.purgeForm(Form)
Form	FormService.duplicateForm(Form form) Duplicate this form and form_fields associated with this form
FormField	FormService.getFormField(Form form, Concept concept) Finds the FormField defined for this form/concept combination Calls FormService.getFormField(Form, Concept, Collection, boolean) with an empty ignore list and with force set to false
FormField	FormService.getFormField(Form form, Concept concept, Collection<FormField> ignoreFormFields, boolean force) Finds the FormField defined for this form/concept combination while discounting any form field found in the ignoreFormFields collection This method was added when needing to relate observations to form fields during a display.
List<FormField>	FormService.getFormFields(Form form) Deprecated. use getFormFields()
Cohort	PatientSetService.getPatientsHavingEncounters(EncounterType encounterType, Location location, Form form, Date fromDate, Date toDate, Integer minCount, Integer maxCount) Searches for patients who have encounters as described by the arguments to this method
Cohort	PatientSetService.getPatientsHavingEncounters(List<EncounterType> encounterTypeList, Location location, Form form, Date fromDate, Date toDate, Integer minCount, Integer maxCount) Gets patients who have encounters as described by the parameters specified (all optional)
void	FormService.purgeForm(Form form) Completely remove a Form from the database.
void	FormService.purgeForm(Form form, boolean cascade) Completely remove a Form from the database.
void	FormService.retireForm(Form form, String reason) Retires the Form, leaving it in the database, but removing it from data entry screens
Form	FormService.saveForm(Form form) Create or update the given Form in the database
void	FormService.unretireForm(Form form) Unretires a Form that had previous been retired.
void	FormService.updateForm(Form form) Deprecated. use FormService.saveForm(Form)

Method parameters in org.openmrs.api with type arguments of type Form

Modifier and Type	Method and Description
List<Encounter>	EncounterService.getEncounters(Patient who, Location loc, Date fromDate, Date toDate, Collection<Form> enteredViaForms, Collection<EncounterType> encounterTypes, boolean includeVoided) Deprecated. replaced by EncounterService.getEncounters(Patient, Location, Date, Date, Collection, Collection, Collection, boolean)
List<Encounter>	EncounterService.getEncounters(Patient who, Location loc, Date fromDate, Date toDate, Collection<Form> enteredViaForms, Collection<EncounterType> encounterTypes, Collection<User> providers, boolean includeVoided) Get all encounters that match a variety of (nullable) criteria.
List<Encounter>	PatientSetService.getEncountersByForm(Cohort patients, List<Form> form) Gets a list of encounters associated with the given form, filtered by the given patient set.
List<Field>	FormService.getFields(Collection<Form> forms, Collection<FieldType> fieldTypes, Collection<Concept> concepts, Collection<String> tableNames, Collection<String> attributeNames, Boolean selectMultiple, Collection<FieldAnswer> containsAllAnswers, Collection<FieldAnswer> containsAnyAnswer, Boolean retired) Returns all Fields that match these (nullable) criteria

Uses of Form in org.openmrs.api.db

Methods in org.openmrs.api.db that return Form

Modifier and Type	Method and Description
Form	FormDAO.duplicateForm(Form form) Creates new form from the given Form
Form	FormDAO.getForm(Integer formId) Get form by internal form identifier
Form	FormDAO.getForm(String name, String version) Get form by exact name and version
Form	FormDAO.getFormByUuid(String uuid) Auto generated method comment
Form	FormDAO.saveForm(Form form)

Methods in org.openmrs.api.db that return types with arguments of type Form

Modifier and Type	Method and Description
List<Form>	FormDAO.getAllForms(boolean includeRetired) Returns all forms in the database, possibly including retired ones
List<Form>	FormDAO.getForms(String partialName, Boolean published, Collection<EncounterType> encounterTypes, Boolean retired, Collection<FormField> containingAnyFormField, Collection<FormField> containingAllFormFields, Collection<Field> fields) Gets all forms that match all the criteria.
List<Form>	FormDAO.getFormsByName(String name) Gets all forms with the given name, sorted (alphabetically) by descending version
List<Form>	FormDAO.getFormsContainingConcept(Concept concept) Get all forms that contain the given Concept as one of their fields.

Methods in org.openmrs.api.db with parameters of type Form

Modifier and Type	Method and Description
void	FormDAO.deleteForm(Form form) Delete form from database.
Form	FormDAO.duplicateForm(Form form) Creates new form from the given Form
FormField	FormDAO.getFormField(Form form, Concept concept, Collection<FormField> ignoreFormFields, boolean force)
Cohort	PatientSetDAO.getPatientsHavingEncounters(List<EncounterType> encounterTypeList, Location location, Form form, Date fromDate, Date toDate, Integer minCount, Integer maxCount)
Form	FormDAO.saveForm(Form form)

Method parameters in org.openmrs.api.db with type arguments of type Form

Modifier and Type	Method and Description
List<Encounter>	EncounterDAO.getEncounters(Patient patient, Location location, Date fromDate, Date toDate, Collection<Form> enteredViaForms, Collection<EncounterType> encounterTypes, Collection<User> providers, boolean includeVoided)
List<Encounter>	PatientSetDAO.getEncountersByForm(Cohort patients, List<Form> forms)
List<Field>	FormDAO.getFields(Collection<Form> forms, Collection<FieldType> fieldTypes, Collection<Concept> concepts, Collection<String> tableNames, Collection<String> attributeNames, Boolean selectMultiple, Collection<FieldAnswer> containsAllAnswers, Collection<FieldAnswer> containsAnyAnswer, Boolean retired) Returns all fields that match a broad range of (nullable) criteria

Uses of Form in org.openmrs.api.db.hibernate

Methods in org.openmrs.api.db.hibernate that return Form

Modifier and Type	Method and Description
Form	HibernateFormDAO.duplicateForm(Form form)
Form	HibernateFormDAO.getForm(Integer formId)
Form	HibernateFormDAO.getForm(String name, String version)
Form	HibernateFormDAO.getFormByUuid(String uuid)
Form	HibernateFormDAO.saveForm(Form form) Returns the form object originally passed in, which will have been persisted.

Methods in org.openmrs.api.db.hibernate that return types with arguments of type Form

Modifier and Type	Method and Description
List<Form>	HibernateFormDAO.getAllForms(boolean includeRetired)
List<Form>	HibernateFormDAO.getForms(String partialName, Boolean published, Collection<EncounterType> encounterTypes, Boolean retired, Collection<FormField> containingAnyFormField, Collection<FormField> containingAllFormFields, Collection<Field> fields)
List<Form>	HibernateFormDAO.getFormsByName(String name)
List<Form>	HibernateFormDAO.getFormsContainingConcept(Concept c)

Methods in org.openmrs.api.db.hibernate with parameters of type Form

Modifier and Type	Method and Description
void	HibernateFormDAO.deleteForm(Form form)
Form	HibernateFormDAO.duplicateForm(Form form)
FormField	HibernateFormDAO.getFormField(Form form, Concept concept, Collection<FormField> ignoreFormFields, boolean force)
List<FormField>	HibernateFormDAO.getFormFields(Form form)
Cohort	HibernatePatientSetDAO.getPatientsHavingEncounters(List<EncounterType> encounterTypeList, Location location, Form form, Date fromDate, Date toDate, Integer minCount, Integer maxCount) Returns the set of patients that have encounters, with several optional parameters: of type encounterType at a given location from filling out a specific form on or after fromDate on or before toDate patients with at least minCount of the given encounters patients with up to maxCount of the given encounters
Form	HibernateFormDAO.saveForm(Form form) Returns the form object originally passed in, which will have been persisted.

Method parameters in org.openmrs.api.db.hibernate with type arguments of type Form

Modifier and Type	Method and Description
List<Encounter>	HibernateEncounterDAO.getEncounters(Patient patient, Location location, Date fromDate, Date toDate, Collection<Form> enteredViaForms, Collection<EncounterType> encounterTypes, Collection<User> providers, boolean includeVoided)
List<Encounter>	HibernatePatientSetDAO.getEncountersByForm(Cohort patients, List<Form> forms) Gets a list of encounters associated with the given form, filtered by the given patient set.
List<Field>	HibernateFormDAO.getFields(Collection<Form> forms, Collection<FieldType> fieldTypes, Collection<Concept> concepts, Collection<String> tableNames, Collection<String> attributeNames, Boolean selectMultiple, Collection<FieldAnswer> containsAllAnswers, Collection<FieldAnswer> containsAnyAnswer, Boolean retired)

Uses of Form in org.openmrs.api.impl

Methods in org.openmrs.api.impl that return Form

Modifier and Type	Method and Description
Form	FormServiceImpl.createForm(Form form) Deprecated.
Form	FormServiceImpl.duplicateForm(Form form) Duplicate this form and form_fields associated with this form
Form	FormServiceImpl.getForm(Integer formId)
Form	FormServiceImpl.getForm(String name)
Form	FormServiceImpl.getForm(String name, String version)
Form	FormServiceImpl.getFormByUuid(String uuid)
Form	FormServiceImpl.saveForm(Form form)

Methods in org.openmrs.api.impl that return types with arguments of type Form

Modifier and Type	Method and Description
List<Form>	FormServiceImpl.findForms(String text, boolean includeUnpublished, boolean includeRetired) Deprecated.
List<Form>	FormServiceImpl.getAllForms()
List<Form>	FormServiceImpl.getAllForms(boolean includeRetired)
List<Form>	FormServiceImpl.getForms() Deprecated.
List<Form>	FormServiceImpl.getForms(boolean publishedOnly) Deprecated.
List<Form>	FormServiceImpl.getForms(boolean publishedOnly, boolean includeRetired) Deprecated.
Set<Form>	FormServiceImpl.getForms(Concept c) Deprecated.
List<Form>	FormServiceImpl.getForms(String fuzzyName, boolean onlyLatestVersion)
List<Form>	FormServiceImpl.getForms(String partialName, Boolean published, Collection<EncounterType> encounterTypes, Boolean retired, Collection<FormField> containingAnyFormField, Collection<FormField> containingAllFormFields) Deprecated. see FormServiceImpl.getForms(String, Boolean, Collection, Boolean, Collection, Collection, Collection)
List<Form>	FormServiceImpl.getForms(String partialName, Boolean published, Collection<EncounterType> encounterTypes, Boolean retired, Collection<FormField> containingAnyFormField, Collection<FormField> containingAllFormFields, Collection<Field> fields)
List<Form>	FormServiceImpl.getFormsContainingConcept(Concept concept)
List<Form>	FormServiceImpl.getPublishedForms()

Methods in org.openmrs.api.impl with parameters of type Form

Modifier and Type	Method and Description
Form	FormServiceImpl.createForm(Form form) Deprecated.
void	FormServiceImpl.deleteForm(Form form) Deprecated.
Form	FormServiceImpl.duplicateForm(Form form) Duplicate this form and form_fields associated with this form
FormField	FormServiceImpl.getFormField(Form form, Concept concept) Deprecated.
FormField	FormServiceImpl.getFormField(Form form, Concept concept, Collection<FormField> ignoreFormFields, boolean force)
List<FormField>	FormServiceImpl.getFormFields(Form form) Deprecated.
Cohort	PatientSetServiceImpl.getPatientsHavingEncounters(EncounterType encounterType, Location location, Form form, Date fromDate, Date toDate, Integer minCount, Integer maxCount)
Cohort	PatientSetServiceImpl.getPatientsHavingEncounters(List<EncounterType> encounterTypeList, Location location, Form form, Date fromDate, Date toDate, Integer minCount, Integer maxCount)
void	FormServiceImpl.purgeForm(Form form)
void	FormServiceImpl.purgeForm(Form form, boolean cascade)
void	FormServiceImpl.retireForm(Form form, String reason)
Form	FormServiceImpl.saveForm(Form form)
void	FormServiceImpl.unretireForm(Form form)
void	FormServiceImpl.updateForm(Form form) Deprecated.

Method parameters in org.openmrs.api.impl with type arguments of type Form

Modifier and Type	Method and Description
List<Encounter>	EncounterServiceImpl.getEncounters(Patient who, Location loc, Date fromDate, Date toDate, Collection<Form> enteredViaForms, Collection<EncounterType> encounterTypes, boolean includeVoided) Deprecated. replaced by EncounterServiceImpl.getEncounters(Patient, Location, Date, Date, Collection, Collection, Collection, boolean)
List<Encounter>	EncounterServiceImpl.getEncounters(Patient who, Location loc, Date fromDate, Date toDate, Collection<Form> enteredViaForms, Collection<EncounterType> encounterTypes, Collection<User> providers, boolean includeVoided)
List<Encounter>	PatientSetServiceImpl.getEncountersByForm(Cohort patients, List<Form> forms) Gets a list of encounters associated with the given form, filtered by the given patient set.
List<Field>	FormServiceImpl.getFields(Collection<Form> forms, Collection<FieldType> fieldTypes, Collection<Concept> concepts, Collection<String> tableNames, Collection<String> attributeNames, Boolean selectMultiple, Collection<FieldAnswer> containsAllAnswers, Collection<FieldAnswer> containsAnyAnswer, Boolean retired)

Uses of Form in org.openmrs.module.web.extension

Methods in org.openmrs.module.web.extension that return types with arguments of type Form

Modifier and Type	Method and Description
Set<Form>	FormEntryHandler.getFormsModuleCanEdit() If your module wants to override the Edit link for encounters, override this method.
List<Form>	FormEntryHandler.getFormsModuleCanEnter(FormEntryContext formEntryContext) If your module allows filling out forms, override this method.
Set<Form>	FormEntryHandler.getFormsModuleCanView() If your module wants to override the View link for encounters, override this method.

Uses of Form in org.openmrs.reporting

Methods in org.openmrs.reporting that return Form

Modifier and Type	Method and Description
Form	EncounterPatientFilter.getForm() Deprecated.

Methods in org.openmrs.reporting with parameters of type Form

Modifier and Type	Method and Description
void	EncounterPatientFilter.setForm(Form form) Deprecated.

Uses of Form in org.openmrs.util

Methods in org.openmrs.util with parameters of type Form

Modifier and Type	Method and Description
static TreeMap<Integer,TreeSet<FormField>>	FormUtil.getFormStructure(Form form) Returns a sorted and structured map of FormFields for the given OpenMRS form.
static String	FormUtil.getFormUriWithoutExtension(Form form) Get a string somewhat unique to this form.

Uses of Form in org.openmrs.web.controller

Methods in org.openmrs.web.controller that return types with arguments of type Form

Modifier and Type	Method and Description
List<Form>	ConceptFormController.ConceptFormBackingObject.getFormsInUse() Get the forms that this concept is declared to be used in

Uses of Form in org.openmrs.web.dwr

Constructors in org.openmrs.web.dwr with parameters of type Form

Constructor and Description
FormListItem(Form form)