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.hl7.handler
org.openmrs.parameter
org.openmrs.propertyeditor
org.openmrs.util	Shared utilities for OpenMRS classes

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	FormResource.getForm() gets the form
Form	FormField.getForm()
Form	Encounter.getForm()

Methods in org.openmrs with parameters of type Form

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

Uses of Form in org.openmrs.api

Methods in org.openmrs.api that return Form

Modifier and Type	Method and Description
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.getAllForms() Gets all Forms, including retired ones.
List<Form>	FormService.getAllForms(boolean includeRetired) Gets all forms, possibly including retired ones
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, 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.duplicateForm(Form form) Duplicate this form and form_fields associated with this form
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.
FormResource	FormService.getFormResource(Form form, String name) Finds a FormResource based on a given Form and name
Collection<FormResource>	FormService.getFormResourcesForForm(Form form) Finds all FormResources tied to a given form
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.

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, Collection<Provider> providers, Collection<VisitType> visitTypes, Collection<Visit> visits, boolean includeVoided) Deprecated. As of 2.0, replaced by EncounterService.getEncounters(EncounterSearchCriteria)
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)
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)
FormResource	FormDAO.getFormResource(Form form, String name)
Collection<FormResource>	FormDAO.getFormResourcesForForm(Form form)
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<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)
FormResource	HibernateFormDAO.getFormResource(Form form, String name)
Collection<FormResource>	HibernateFormDAO.getFormResourcesForForm(Form form)
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<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.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.getAllForms()
List<Form>	FormServiceImpl.getAllForms(boolean includeRetired)
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, 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.duplicateForm(Form form) Duplicate this form and form_fields associated with this form
FormField	FormServiceImpl.getFormField(Form form, Concept concept, Collection<FormField> ignoreFormFields, boolean force)
FormResource	FormServiceImpl.getFormResource(Form form, String name)
Collection<FormResource>	FormServiceImpl.getFormResourcesForForm(Form form)
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)

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, Collection<Provider> providers, Collection<VisitType> visitTypes, Collection<Visit> visits, boolean includeVoided) Deprecated. As of 2.0, replaced by EncounterServiceImpl.getEncounters(EncounterSearchCriteria)
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.hl7.handler

Methods in org.openmrs.hl7.handler that return Form

Modifier and Type	Method and Description
Form	ORUR01Handler.getForm(ca.uhn.hl7v2.model.v25.segment.MSH msh) needs to find a Form based on information in MSH-21. example: 16^AMRS.ELD.FORMID

Uses of Form in org.openmrs.parameter

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

Modifier and Type	Method and Description
Collection<Form>	EncounterSearchCriteria.getEnteredViaForms()

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

Modifier and Type	Method and Description
EncounterSearchCriteriaBuilder	EncounterSearchCriteriaBuilder.setEnteredViaForms(Collection<Form> enteredViaForms)

Constructor parameters in org.openmrs.parameter with type arguments of type Form

Constructor and Description
EncounterSearchCriteria(Patient patient, Location location, Date fromDate, Date toDate, Date dateChanged, Collection<Form> enteredViaForms, Collection<EncounterType> encounterTypes, Collection<Provider> providers, Collection<VisitType> visitTypes, Collection<Visit> visits, boolean includeVoided) Instead of calling this constructor directly, it is recommended to use EncounterSearchCriteriaBuilder.

Uses of Form in org.openmrs.propertyeditor

Methods in org.openmrs.propertyeditor that return Form

Modifier and Type	Method and Description
protected Form	FormEditor.getObjectById(Integer id)
protected Form	FormEditor.getObjectByUuid(String uuid)

Uses of Form in org.openmrs.util

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

Modifier and Type	Method and Description
static Map<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.