org.openmrs.api

Interface FormService

All Superinterfaces:

OpenmrsService

All Known Implementing Classes:

FormServiceImpl

public interface FormService
extends OpenmrsService

This service contains methods relating to Form, FormField, and Field. Methods relating to FieldType are in AdministrationService

Method Summary

Modifier and Type	Method and Description
void	checkIfFormsAreLocked() Checks if the forms are locked, and if they are throws an exception when saving or deleting a form
Form	duplicateForm(Form form) Duplicate this form and form_fields associated with this form
List<Field>	getAllFields() Fetches all Fields in the database, including retired ones
List<Field>	getAllFields(boolean includeRetired) Fetches all Fields in the database, possibly including retired ones
List<FieldType>	getAllFieldTypes() Get all field types in the database including the retired ones
List<FieldType>	getAllFieldTypes(boolean includeRetired) Get all field types in the database with or without retired ones
List<FormField>	getAllFormFields() Returns all FormFields in the database
List<Form>	getAllForms() Gets all Forms, including retired ones.
List<Form>	getAllForms(boolean includeRetired) Gets all forms, possibly including retired ones
Field	getField(Integer fieldId) Gets a Field by internal database id
FieldAnswer	getFieldAnswerByUuid(String uuid) Get FieldAnswer by its UUID
Field	getFieldByUuid(String uuid) Get Field by its UUID
List<Field>	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
List<Field>	getFields(String fuzzySearchPhrase) Find all Fields whose names are similar to or contain the given phrase.
List<Field>	getFieldsByConcept(Concept concept) Finds all Fields that point to the given concept, including retired ones.
FieldType	getFieldType(Integer fieldTypeId) Get fieldType by internal identifier
FieldType	getFieldTypeByName(String name) Get FieldType by its name
FieldType	getFieldTypeByUuid(String uuid) Get FieldType by its UUID
Form	getForm(Integer formId) Get form by internal form identifier
Form	getForm(String name) Get form by exact name match.
Form	getForm(String name, String version) Get form by exact name & version match.
Form	getFormByUuid(String uuid) Get Form by its UUID
Integer	getFormCount(String partialNameSearch, Boolean published, Collection<EncounterType> encounterTypes, Boolean retired, Collection<FormField> containingAnyFormField, Collection<FormField> containingAllFormFields, Collection<Field> fields) Same as getForms(String, Boolean, Collection, Boolean, Collection, Collection, Collection) except that it returns an integer that is the size of the list that would be returned
FormField	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.
FormField	getFormField(Integer formFieldId) Gets a FormField by internal database id
FormField	getFormFieldByUuid(String uuid) Get FormField by its UUID
FormResource	getFormResource(Form form, String name) Finds a FormResource based on a given Form and name
FormResource	getFormResource(Integer formResourceId) Finds a FormResource by its id
FormResource	getFormResourceByUuid(String uuid) Finds a FormResource by its uuid
Collection<FormResource>	getFormResourcesForForm(Form form) Finds all FormResources tied to a given form
List<Form>	getForms(String fuzzyName, boolean onlyLatestVersion) Gets all forms with name similar to the given name.
List<Form>	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>	getFormsContainingConcept(Concept concept) Returns all forms that contain the given concept as a field in their schema.
List<Form>	getPublishedForms() Returns all published forms (not including retired ones)
int	mergeDuplicateFields() Audit form, consolidate similar fields
void	purgeField(Field field) Completely removes a Field from the database.
void	purgeField(Field field, boolean cascade) Completely removes a Field from the database.
void	purgeFieldType(FieldType fieldType) Deletes the given field type from the database.
void	purgeForm(Form form) Completely remove a Form from the database.
void	purgeForm(Form form, boolean cascade) Completely remove a Form from the database.
void	purgeFormField(FormField formField) Completely removes the given FormField from the database.
void	purgeFormResource(FormResource formResource) Purges a form resource
Field	retireField(Field field) Retires field
void	retireForm(Form form, String reason) Retires the Form, leaving it in the database, but removing it from data entry screens
Field	saveField(Field field) Creates or updates the given Field
FieldType	saveFieldType(FieldType fieldType) Saves the given field type to the database
Form	saveForm(Form form) Create or update the given Form in the database
FormField	saveFormField(FormField formField) Creates or updates the given FormField
FormResource	saveFormResource(FormResource formResource) Saves or updates the given form resource
Field	unretireField(Field field) Unretires field
void	unretireForm(Form form) Unretires a Form that had previous been retired.

Methods inherited from interface org.openmrs.api.OpenmrsService

onShutdown, onStartup

Method Detail

saveForm

@Authorized(value="Manage Forms")
Form saveForm(Form form)
                                         throws APIException

Create or update the given Form in the database

Parameters:

form - the Form to save

Returns:

the Form that was saved

Throws:

APIException - Should save given form successfully Should update an existing form Should throw an error when trying to save an existing form while forms are locked Should throw an error when trying to save a new form while forms are locked

getForm

@Authorized(value="Get Forms")
Form getForm(Integer formId)
                                     throws APIException

Get form by internal form identifier

Parameters:

formId - internal identifier

Returns:

requested form

Throws:

APIException - Should return null if no form exists with given formId Should return the requested form

getForm

@Authorized(value="Get Forms")
Form getForm(String name)
                                     throws APIException

Get form by exact name match. If there are multiple forms with this name, then this returns the one with the highest version (sorted alphabetically)

Parameters:

name - exact name of the form to fetch

Returns:

requested form

Throws:

APIException - Should return null if no form has the exact form name

getFormByUuid

@Authorized(value="Get Forms")
Form getFormByUuid(String uuid)
                                           throws APIException

Get Form by its UUID

Parameters:

uuid -

Returns:

form or null Should find object given valid uuid Should return null if no object found with given uuid

Throws:

APIException

getForm

@Authorized(value="Get Forms")
Form getForm(String name,
                                            String version)
                                     throws APIException

Get form by exact name & version match. If version is null, then this method behaves like getForm(String)

Parameters:

name - exact name of the form to fetch

version - exact version of the form to fetch

Returns:

requested form

Throws:

APIException - Should get the specific version of the form with the given name

getAllForms

@Authorized(value="Get Forms")
List<Form> getAllForms()
                                               throws APIException

Gets all Forms, including retired ones.

Returns:

all Forms, including retired ones

Throws:

APIException - Should return all forms including retired

getAllForms

@Authorized(value="Get Forms")
List<Form> getAllForms(boolean includeRetired)
                                               throws APIException

Gets all forms, possibly including retired ones

Parameters:

includeRetired - whether or not to return retired forms

Returns:

all forms, possibly including retired ones

Throws:

APIException - Should return retired forms if includeRetired is true Should not return retired forms if includeRetired is false

getForms

@Authorized(value="Get Forms")
List<Form> getForms(String fuzzyName,
                                                   boolean onlyLatestVersion)

Gets all forms with name similar to the given name. (The precise fuzzy matching algorithm is not specified.)

Parameters:

fuzzyName - approximate name to match

onlyLatestVersion - whether or not to return only the latest version of each form (by name)

Returns:

forms with names similar to fuzzyName Should match forms with partial match on name Should only return one form per name if onlyLatestVersion is true

getForms

@Authorized(value="Get Forms")
List<Form> 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

Parameters:

partialNameSearch - partial search of name

published - whether the form is published

encounterTypes - whether the form has any of these encounter types

retired - whether the form is retired

containingAnyFormField - includes forms that contain any of the specified FormFields

containingAllFormFields - includes forms that contain all of the specified FormFields

fields - whether the form has any of these fields. If a field is used more than once on a form, that form is returning more than once in this list

Returns:

All forms that match the criteria Should get multiple of the same form by field Should return duplicate form when given fields included in form multiple times Should only return published forms when given published equals true Should return both published and unpublished when given published is null Should match to forms with fuzzy partialNameSearch Should return forms with encounterType in given encounterTypes Should return unretired forms when retired equals false Should return retired forms when retired equals true Should return all forms including retired and unretired when retired is null Should return forms containing all form fields in containingAllFormFields Should return forms that have any matching formFields in containingAnyFormField

getFormCount

@Authorized(value="Get Forms")
Integer getFormCount(String partialNameSearch,
                                                    Boolean published,
                                                    Collection<EncounterType> encounterTypes,
                                                    Boolean retired,
                                                    Collection<FormField> containingAnyFormField,
                                                    Collection<FormField> containingAllFormFields,
                                                    Collection<Field> fields)

Same as getForms(String, Boolean, Collection, Boolean, Collection, Collection, Collection) except that it returns an integer that is the size of the list that would be returned

See Also:

getForms(String, Boolean, Collection, Boolean, Collection, Collection, Collection)

getPublishedForms

@Authorized(value="Get Forms")
List<Form> getPublishedForms()
                                                     throws APIException

Returns all published forms (not including retired ones)

Returns:

all published non-retired forms

Throws:

APIException - Should only return published forms that are not retired

mergeDuplicateFields

@Authorized(value="Manage Forms")
int mergeDuplicateFields()
                                                    throws APIException

Audit form, consolidate similar fields

Throws:

APIException - Should should merge fields with similar attributes

duplicateForm

@Authorized(value="Manage Forms")
Form duplicateForm(Form form)
                                              throws APIException

Duplicate this form and form_fields associated with this form

Parameters:

form -

Returns:

New duplicated form

Throws:

APIException - Should clear changed details and update creation details Should give a new uuid to the duplicated form Should copy resources for old form to new form Should throw an error when trying to duplicate a form while forms are locked

retireForm

@Authorized(value="Manage Forms")
void retireForm(Form form,
                                                  String reason)
                                           throws APIException

Retires the Form, leaving it in the database, but removing it from data entry screens

Parameters:

form - the Form to retire

reason - the retiredReason to set

Throws:

APIException - Should set the retired bit before saving

unretireForm

@Authorized(value="Manage Forms")
void unretireForm(Form form)
                                             throws APIException

Unretires a Form that had previous been retired.

Parameters:

form - the Form to revive

Throws:

APIException - Should unset the retired bit before saving

purgeForm

@Authorized(value="Manage Forms")
void purgeForm(Form form)
                                          throws APIException

Completely remove a Form from the database. This is not reversible. It will fail if this form has already been used to create Encounters

Parameters:

form -

Throws:

APIException - Should delete given form successfully Should delete form resources for deleted form Should throw an error when trying to delete a form while forms are locked

purgeForm

@Authorized(value="Manage Forms")
void purgeForm(Form form,
                                                 boolean cascade)
                                          throws APIException

Completely remove a Form from the database. This is not reversible. !! WARNING: Calling this method with cascade=true can be very destructive !!

Parameters:

form -

cascade - whether or not to cascade delete all dependent objects (including encounters!)

Throws:

APIException - Should throw APIException if cascade is true

getAllFieldTypes

@Authorized(value="Get Field Types")
List<FieldType> getAllFieldTypes()
                                                               throws APIException

Get all field types in the database including the retired ones

Returns:

list of all field types

Throws:

APIException - Should also get retired field types

getAllFieldTypes

@Authorized(value="Get Field Types")
List<FieldType> getAllFieldTypes(boolean includeRetired)
                                                               throws APIException

Get all field types in the database with or without retired ones

Parameters:

includeRetired - true/false whether to include the retired field types

Returns:

list of all field types

Throws:

APIException - Should get all field types including retired when includeRetired equals true Should get all field types excluding retired when includeRetired equals false

getFieldType

@Authorized(value="Get Field Types")
FieldType getFieldType(Integer fieldTypeId)
                                                     throws APIException

Get fieldType by internal identifier

Parameters:

fieldTypeId - Integer id of FieldType to get

Returns:

fieldType with given internal identifier

Throws:

APIException - Should return null when no field type matching given id

getFieldTypeByUuid

FieldType getFieldTypeByUuid(String uuid)
                      throws APIException

Get FieldType by its UUID

Parameters:

uuid -

Returns:

field type or null Should find object given valid uuid Should return null if no object found with given uuid

Throws:

APIException

getFieldTypeByName

FieldType getFieldTypeByName(String name)
                      throws APIException

Get FieldType by its name

Parameters:

name -

Returns:

field type or null Should find object given valid name Should return null if no object found with given name

Throws:

APIException

Since:

1.11

getFormsContainingConcept

@Authorized(value="Get Forms")
List<Form> getFormsContainingConcept(Concept concept)
                                                             throws APIException

Returns all forms that contain the given concept as a field in their schema. (includes retired forms)

Parameters:

concept - the concept to search for in forms

Returns:

forms containing the specified concept in their schema

Throws:

APIException - Should get forms with field matching given concept Should get all forms for concept

getAllFormFields

@Authorized(value="Get Forms")
List<FormField> getAllFormFields()
                                                         throws APIException

Returns all FormFields in the database

Returns:

all FormFields in the database

Throws:

APIException - Should get all form fields including retired

getFields

@Authorized(value="Get Forms")
List<Field> getFields(String fuzzySearchPhrase)
                                              throws APIException

Find all Fields whose names are similar to or contain the given phrase. (The exact similarity algorithm is unspecified.) (includes retired fields)

Parameters:

fuzzySearchPhrase -

Returns:

Fields with names similar to or containing the given phrase

Throws:

APIException - Should get fields with name matching fuzzySearchPhrase at beginning Should get fields with name matching fuzzySearchPhrase at middle Should get fields with name matching fuzzySearchPhrase at end Should return fields in alphabetical order by name

getFieldsByConcept

@Authorized(value="Get Forms")
List<Field> getFieldsByConcept(Concept concept)
                                                       throws APIException

Finds all Fields that point to the given concept, including retired ones.

Parameters:

concept - the concept to search for in the Field table

Returns:

fields that point to the given concept

Throws:

APIException - Should get fields with concept matching given concept

getAllFields

@Authorized(value="Get Forms")
List<Field> getAllFields()
                                                 throws APIException

Fetches all Fields in the database, including retired ones

Returns:

all Fields

Throws:

APIException - Should get all fields including retired

getAllFields

@Authorized(value="Get Forms")
List<Field> getAllFields(boolean includeRetired)
                                                 throws APIException

Fetches all Fields in the database, possibly including retired ones

Parameters:

includeRetired - whether or not to include retired Fields

Returns:

all Fields

Throws:

APIException - Should get all fields including retired when includeRetired is true Should get all fields excluding retired when includeRetired is false

getFields

@Authorized(value="Get Forms")
List<Field> 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)
                                              throws APIException

Returns all Fields that match these (nullable) criteria

Parameters:

forms - on any of these Forms

fieldTypes - having any of these FieldTypes

concepts - for any of these Concepts

tableNames - for any of these table names

attributeNames - for any of these attribute names

selectMultiple - whether to return only select-multi fields

containsAllAnswers - fields with all the following answers

containsAnyAnswer - fields with any of the following answers

retired - only retired/unretired fields

Returns:

all Fields matching the given criteria

Throws:

APIException - Should get fields with form in given forms Should get fields with type in given fieldTypes Should get fields with concept in given concepts Should get fields with tableName in given tableNames Should get fields with attributeName in given attributeNames Should get fields with selectMultiple equals true when given selectMultiple equals true

getField

@Authorized(value="Get Forms")
Field getField(Integer fieldId)
                                       throws APIException

Gets a Field by internal database id

Parameters:

fieldId - the id of the Field to fetch

Returns:

the Field with the given id

Throws:

APIException - Should return null if no field exists with given fieldId

getFieldByUuid

Field getFieldByUuid(String uuid)
              throws APIException

Get Field by its UUID

Parameters:

uuid -

Returns:

field or null Should find object given valid uuid Should return null if no object found with given uuid

Throws:

APIException

getFieldAnswerByUuid

FieldAnswer getFieldAnswerByUuid(String uuid)
                          throws APIException

Get FieldAnswer by its UUID

Parameters:

uuid -

Returns:

field answer or null Should find object given valid uuid Should return null if no object found with given uuid

Throws:

APIException

saveField

@Authorized(value="Manage Forms")
Field saveField(Field field)
                                           throws APIException

Creates or updates the given Field

Parameters:

field - the Field to save

Returns:

the Field that was saved

Throws:

APIException - Should save given field successfully Should update an existing field

purgeField

@Authorized(value="Manage Forms")
void purgeField(Field field)
                                           throws APIException

Completely removes a Field from the database. Not reversible.

Parameters:

field - the Field to purge

Throws:

APIException - Should delete given field successfully

purgeField

@Authorized(value="Manage Forms")
void purgeField(Field field,
                                                  boolean cascade)
                                           throws APIException

Completely removes a Field from the database. Not reversible. !! WARNING: calling this with cascade=true can be very destructive !!

Parameters:

field - the Field to purge

cascade - whether to cascade delete all FormFields pointing to this field

Throws:

APIException - Should throw APIException if cascade is true

getFormField

@Authorized(value="Get Forms")
FormField getFormField(Integer formFieldId)
                                               throws APIException

Gets a FormField by internal database id

Parameters:

formFieldId - the internal id to search on

Returns:

the FormField with the given id

Throws:

APIException - Should return null if no formField exists with given id

getFormFieldByUuid

FormField getFormFieldByUuid(String uuid)
                      throws APIException

Get FormField by its UUID

Parameters:

uuid -

Returns:

form field or null Should find object given valid uuid Should return null if no object found with given uuid

Throws:

APIException

getFormField

@Authorized(value="Get Forms")
FormField getFormField(Form form,
                                                      Concept concept,
                                                      Collection<FormField> ignoreFormFields,
                                                      boolean force)
                                               throws APIException

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. The use case would be that you know a Concept for a obs, which was defined on a form (via a formField). You can relate the formFields to Concepts easily enough, but if a Form reuses a Concept in two separate FormFields you don't want to only associate that first formField with that concept. So, keep a running list of formFields you've seen and pass them back in here to rule them out.

Parameters:

form - Form that this concept was found on

concept - Concept (question) on this form that is being requested

ignoreFormFields - FormFields to ignore (aka already seen formfields)

force - if true and there are zero matches because all formFields were ignored (because of ignoreFormFields) than the first result is returned

Returns:

Formfield for this concept on this form

Throws:

APIException - Should get form fields by form and concept Should not fail with null ignoreFormFields argument Should simply return null for nonexistent concepts Should simply return null for nonexistent forms Should ignore formFields passed to ignoreFormFields

saveFormField

@Authorized(value="Manage Forms")
FormField saveFormField(FormField formField)
                                                   throws APIException

Creates or updates the given FormField

Parameters:

formField - the FormField to save

Returns:

the formField that was just saved

Throws:

APIException - Should propagate save to the Field property on the given FormField Should save given formField successfully Should inject form fields from serializable complex obs handlers

purgeFormField

@Authorized(value="Manage Forms")
void purgeFormField(FormField formField)
                                               throws APIException

Completely removes the given FormField from the database. This is not reversible

Parameters:

formField - the FormField to purge

Throws:

APIException - Should delete the given form field successfully

retireField

@Authorized(value="Manage Forms")
Field retireField(Field field)
                                             throws APIException

Retires field

Parameters:

field - the Field to retire

Returns:

the Field that was retired

Throws:

APIException - Should set the retired bit before saving

unretireField

@Authorized(value="Manage Forms")
Field unretireField(Field field)
                                               throws APIException

Unretires field

Parameters:

field - the Field to unretire

Returns:

the Field that was unretired

Throws:

APIException - Should unset the retired bit before saving

saveFieldType

@Authorized(value="Manage Field Types")
FieldType saveFieldType(FieldType fieldType)
                                                         throws APIException

Saves the given field type to the database

Parameters:

fieldType - the field type to save

Returns:

the saved field type

Throws:

APIException - Should create new field type Should update existing field type

purgeFieldType

@Authorized(value="Purge Field Types")
void purgeFieldType(FieldType fieldType)
                                                    throws APIException

Deletes the given field type from the database. This should not be done. It is preferred to just retired this field type with #retireFieldType(FieldType)

Parameters:

fieldType - the field type to purge

Throws:

APIException - Should delete the given field type successfully

getFormResource

FormResource getFormResource(Integer formResourceId)
                      throws APIException

Finds a FormResource by its id

Parameters:

formResourceId - the id of the resource Should find a saved FormResource Should return null if no FormResource found

Throws:

APIException

Since:

1.9

getFormResourceByUuid

FormResource getFormResourceByUuid(String uuid)
                            throws APIException

Finds a FormResource by its uuid

Parameters:

uuid - the uuid of the resource

Throws:

APIException

Since:

1.9

getFormResource

FormResource getFormResource(Form form,
                             String name)
                      throws APIException

Finds a FormResource based on a given Form and name

Parameters:

form - the Form that the resource belongs to

name - the name of the resource

Throws:

APIException

Since:

1.9

getFormResourcesForForm

Collection<FormResource> getFormResourcesForForm(Form form)
                                          throws APIException

Finds all FormResources tied to a given form

Parameters:

form -

Returns:

the resources attached to the form

Throws:

APIException

Since:

1.9

saveFormResource

FormResource saveFormResource(FormResource formResource)
                       throws APIException

Saves or updates the given form resource

Parameters:

formResource - the resource to be saved Should persist a FormResource Should overwrite an existing resource with same name Should be able to save an XSLT

Throws:

APIException

Since:

1.9

purgeFormResource

void purgeFormResource(FormResource formResource)
                throws APIException

Purges a form resource

Parameters:

formResource - the resource to be purged Should delete a form resource

Throws:

APIException

Since:

1.9

checkIfFormsAreLocked

void checkIfFormsAreLocked()
                    throws FormsLockedException

Checks if the forms are locked, and if they are throws an exception when saving or deleting a form

Throws:

FormsLockedException