FormDAO (OpenMRS 2.7.0-SNAPSHOT API)

All Known Implementing Classes:

HibernateFormDAO
```
public interface FormDAO
```
Database access functions for the Form, FormField, and Field objects

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`deleteField(Field field)` Deletes a field from the database.
`void`	`deleteFieldType(FieldType fieldType)` Delete the given field type from the database
`void`	`deleteForm(Form form)` Delete form from database.
`void`	`deleteFormField(FormField formField)` Deletes a FormField from the database.
`void`	`deleteFormResource(FormResource formResource)`
`Form`	`duplicateForm(Form form)` Creates new form from the given `Form`
`List<Field>`	`getAllFields(boolean includeRetired)` Returns all fields in the database, possibly including retired ones
`List<FieldType>`	`getAllFieldTypes(boolean includeRetired)` Get all field types
`List<FormField>`	`getAllFormFields()` Returns all FormFields in the database
`List<Form>`	`getAllForms(boolean includeRetired)` Returns all forms in the database, possibly including retired ones
`Field`	`getField(Integer fieldId)`
`FieldAnswer`	`getFieldAnswerByUuid(String uuid)`
`Field`	`getFieldByUuid(String 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 a broad range of (nullable) criteria
`List<Field>`	`getFields(String search)`
`FieldType`	`getFieldType(Integer fieldTypeId)` Get fieldType by internal identifier
`FieldType`	`getFieldTypeByName(String name)` Return fieldType associated with given name
`FieldType`	`getFieldTypeByUuid(String uuid)`
`Form`	`getForm(Integer formId)` Get form by internal form identifier
`Form`	`getForm(String name, String version)` Get form by exact name and version
`Form`	`getFormByUuid(String uuid)`
`Integer`	`getFormCount(String partialName, Boolean published, Collection<EncounterType> encounterTypes, Boolean retired, Collection<FormField> containingAnyFormField, Collection<FormField> containingAllFormFields, Collection<Field> fields)`
`FormField`	`getFormField(Form form, Concept concept, Collection<FormField> ignoreFormFields, boolean force)`
`FormField`	`getFormField(Integer formFieldId)`
`FormField`	`getFormFieldByUuid(String uuid)`
`List<FormField>`	`getFormFieldsByField(Field field)` Return a list of FormFields given a Field
`FormResource`	`getFormResource(Form form, String name)`
`FormResource`	`getFormResource(Integer formResourceId)`
`FormResource`	`getFormResourceByUuid(String uuid)`
`Collection<FormResource>`	`getFormResourcesForForm(Form form)`
`List<Form>`	`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>`	`getFormsByName(String name)` Gets all forms with the given name, sorted (alphabetically) by descending version
`List<Form>`	`getFormsContainingConcept(Concept concept)` Get all forms that contain the given `Concept` as one of their fields.
`Field`	`saveField(Field field)`
`FieldType`	`saveFieldType(FieldType fieldType)` Save the given field type to the database
`Form`	`saveForm(Form form)`
`FormField`	`saveFormField(FormField formField)`
`FormResource`	`saveFormResource(FormResource formResource)`

- Method Detail
  - saveForm
```
Form saveForm(Form form)
       throws DAOException
```
    Throws:
    
    DAOException
    
    See Also:
    
    FormService.saveForm(Form)
  - duplicateForm
```
Form duplicateForm(Form form)
            throws DAOException
```
    Creates new form from the given Form
    
    Parameters:
    
    form - Form to duplicate
    
    Returns:
    
    newly duplicated Form
    
    Throws:
    
    DAOException
  - getForm
```
Form getForm(Integer formId)
      throws DAOException
```
    Get form by internal form identifier
    
    Parameters:
    
    formId - Integer internal identifier for requested Form
    
    Returns:
    
    requested Form
    
    Throws:
    
    DAOException
  - getForm
```
Form getForm(String name,
             String version)
      throws DAOException
```
    Get form by exact name and version
    
    Parameters:
    
    name - the name of the form to get
    
    version - the version of the form to get
    
    Returns:
    
    the form with the exact name and version given
    
    Throws:
    
    DAOException
  - getFormsByName
```
List<Form> getFormsByName(String name)
                   throws DAOException
```
    Gets all forms with the given name, sorted (alphabetically) by descending version
    
    Parameters:
    
    name - String name of the forms to get
    
    Returns:
    
    All forms with the given name, sorted by (alphabetically) by descending version
    
    Throws:
    
    DAOException
  - deleteForm
```
void deleteForm(Form form)
         throws DAOException
```
    Delete form from database. This is included for troubleshooting and low-level system administration. Ideally, this method should never be called — Forms should be retired and not deleted altogether (since many foreign key constraints depend on forms, deleting a form would require deleting all traces, and any historical trail would be lost). This method only clears form roles and attempts to delete the form record. If the form has been included in any other parts of the database (through a foreign key), the attempt to delete the form will violate foreign key constraints and fail.
    
    Parameters:
    
    form - Form to delete
    
    Throws:
    
    DAOException
  - getAllFieldTypes
```
List<FieldType> getAllFieldTypes(boolean includeRetired)
                          throws DAOException
```
    Get all field types
    
    Parameters:
    
    includeRetired - boolean - include retired field types as well?
    
    Returns:
    
    List<FieldTypes> object with all FieldTypes, possibly including retired ones
    
    Throws:
    
    DAOException
  - getFieldType
```
FieldType getFieldType(Integer fieldTypeId)
                throws DAOException
```
    Get fieldType by internal identifier
    
    Parameters:
    
    fieldTypeId - Internal Integer identifier of FieldType
    
    Returns:
    
    The FieldType with specified internal identifier
    
    Throws:
    
    DAOException
  - getAllForms
```
List<Form> getAllForms(boolean includeRetired)
                throws DAOException
```
    Returns all forms in the database, possibly including retired ones
    
    Parameters:
    
    includeRetired - boolean - include retired forms?
    
    Returns:
    
    List<Form> object of all forms, possibly including retired ones
    
    Throws:
    
    DAOException
  - getAllFormFields
```
List<FormField> getAllFormFields()
                          throws DAOException
```
    Returns all FormFields in the database
    
    Returns:
    
    List<FormField> object of all FormFields in the database
    
    Throws:
    
    DAOException
  - getFormField
```
FormField getFormField(Form form,
                       Concept concept,
                       Collection<FormField> ignoreFormFields,
                       boolean force)
                throws DAOException
```
    Throws:
    
    DAOException
    
    See Also:
    
    FormService.getFormField(org.openmrs.Form, org.openmrs.Concept, java.util.Collection, boolean)
  - getFields
```
List<Field> getFields(String search)
               throws DAOException
```
    Parameters:
    
    search - String phrase to search for
    
    Returns:
    
    list of fields in the database matching search phrase
    
    Throws:
    
    DAOException
  - getAllFields
```
List<Field> getAllFields(boolean includeRetired)
                  throws DAOException
```
    Returns all fields in the database, possibly including retired ones
    
    Parameters:
    
    includeRetired - whether or not to return retired fields
    
    Returns:
    
    all fields in the database, possibly including retired ones
    
    Throws:
    
    DAOException
  - getField
```
Field getField(Integer fieldId)
        throws DAOException
```
    Throws:
    
    DAOException
    
    See Also:
    
    FormService.getField(Integer)
  - saveField
```
Field saveField(Field field)
         throws DAOException
```
    Throws:
    
    DAOException
    
    See Also:
    
    FormService.saveField(Field)
  - deleteField
```
void deleteField(Field field)
          throws DAOException
```
    Deletes a field from the database.
    This will fail if any other entities reference this field via a foreign key
    
    Parameters:
    
    field - the Field to delete
    
    Throws:
    
    DAOException
  - getFormField
```
FormField getFormField(Integer formFieldId)
                throws DAOException
```
    Throws:
    
    DAOException
    
    See Also:
    
    FormService.getFormField(Integer)
  - saveFormField
```
FormField saveFormField(FormField formField)
                 throws DAOException
```
    Throws:
    
    DAOException
    
    See Also:
    
    FormService.saveFormField(FormField)
  - deleteFormField
```
void deleteFormField(FormField formField)
              throws DAOException
```
    Deletes a FormField from the database. This will fail if any other entities reference this FormField via a foreign key
    
    Parameters:
    
    formField - the FormField to delete
    
    Throws:
    
    DAOException
  - getFields
```
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 DAOException
```
    Returns all fields that match a broad range of (nullable) criteria
    
    Parameters:
    
    forms - Collection of Form to which the requested Fields must belong
    
    fieldTypes - Collection of FieldType of which the requested fields must be
    
    concepts - Collection of Concepts which the fields must point to
    
    tableNames - Collection of TableNames which the fields must point to
    
    attributeNames - Collection of String attribute names which the fields must point to
    
    selectMultiple - Boolean value that matching fields must have for selectMultiple
    
    containsAllAnswers - Collection of FieldAnswers, all of which a matching field must contain (not yet implemented)
    
    containsAnyAnswer - Collection of FieldAnswers, any one of which a matching field must contain (not yet implemented)
    
    retired - Boolean retired status that fields must match
    
    Returns:
    
    All Fields that match the criteria
    
    Throws:
    
    DAOException
  - getFormsContainingConcept
```
List<Form> getFormsContainingConcept(Concept concept)
                              throws DAOException
```
    Get all forms that contain the given Concept as one of their fields. (Includes retired forms.)
    
    Parameters:
    
    concept - the Concept to search through form fields for
    
    Returns:
    
    forms that contain a form field referencing the given concept
    
    Throws:
    
    DAOException
  - getForms
```
List<Form> getForms(String partialName,
                    Boolean published,
                    Collection<EncounterType> encounterTypes,
                    Boolean retired,
                    Collection<FormField> containingAnyFormField,
                    Collection<FormField> containingAllFormFields,
                    Collection<Field> fields)
             throws DAOException
```
    Gets all forms that match all the criteria. Expects the list objects to be non-null
    
    Parameters:
    
    partialName - String of partial name of form to search on
    
    published - boolean - is the form published?
    
    encounterTypes - Collection of EncounterTypes that the form must represent
    
    retired - boolean - is the form retired?
    
    containingAnyFormField - Collection of FormFields, any one of which must be contained in the form
    
    containingAllFormFields - Collection of FormFields, all of which must be contained in the form
    
    fields - Collection of Fields that the form must contain
    
    Returns:
    
    All forms that match the criteria
    
    Throws:
    
    DAOException
    
    See Also:
    
    FormService.getForms(java.lang.String, java.lang.Boolean, java.util.Collection, java.lang.Boolean, java.util.Collection, java.util.Collection, java.util.Collection)
  - getFormCount
```
Integer getFormCount(String partialName,
                     Boolean published,
                     Collection<EncounterType> encounterTypes,
                     Boolean retired,
                     Collection<FormField> containingAnyFormField,
                     Collection<FormField> containingAllFormFields,
                     Collection<Field> fields)
              throws DAOException
```
    Throws:
    
    DAOException
    
    See Also:
    
    getForms(String, Boolean, Collection, Boolean, Collection, Collection, Collection)
  - deleteFieldType
```
void deleteFieldType(FieldType fieldType)
              throws DAOException
```
    Delete the given field type from the database
    
    Parameters:
    
    fieldType - FieldType to delete
    
    Throws:
    
    DAOException
  - getFieldByUuid
```
Field getFieldByUuid(String uuid)
```
    Parameters:
    
    uuid -
    
    Returns:
    
    field or null
  - getFieldAnswerByUuid
```
FieldAnswer getFieldAnswerByUuid(String uuid)
```
  - getFieldTypeByUuid
```
FieldType getFieldTypeByUuid(String uuid)
```
    Parameters:
    
    uuid -
    
    Returns:
    
    field type or null
  - getFieldTypeByName
```
FieldType getFieldTypeByName(String name)
```
    Return fieldType associated with given name
    
    Parameters:
    
    name - Name of the fileType to query
    
    Returns:
    
    fieldType object associate with given name
  - getFormByUuid
```
Form getFormByUuid(String uuid)
```
    Parameters:
    
    uuid -
    
    Returns:
    
    form or null
  - getFormFieldByUuid
```
FormField getFormFieldByUuid(String uuid)
```
    Parameters:
    
    uuid -
    
    Returns:
    
    form field or null
  - saveFieldType
```
FieldType saveFieldType(FieldType fieldType)
                 throws DAOException
```
    Save the given field type to the database
    
    Parameters:
    
    fieldType - FieldType to save to the database
    
    Returns:
    
    the newly saved field type
    
    Throws:
    
    DAOException
  - getFormFieldsByField
```
List<FormField> getFormFieldsByField(Field field)
```
    Return a list of FormFields given a Field
    
    Parameters:
    
    field -
    
    Returns:
    
    List of FormFields
  - getFormResource
```
FormResource getFormResource(Integer formResourceId)
```
    Since:
    
    1.9
    
    See Also:
    
    FormService.getFormResource(java.lang.Integer)
  - getFormResourceByUuid
```
FormResource getFormResourceByUuid(String uuid)
```
    Since:
    
    1.9
    
    See Also:
    
    FormService.getFormResourceByUuid(java.lang.String)
  - getFormResource
```
FormResource getFormResource(Form form,
                             String name)
```
    Since:
    
    1.9
    
    See Also:
    
    FormService.getFormResource(org.openmrs.Form, java.lang.String)
  - getFormResourcesForForm
```
Collection<FormResource> getFormResourcesForForm(Form form)
```
    Since:
    
    1.9
    
    See Also:
    
    FormService.getFormResourcesForForm(org.openmrs.Form)
  - saveFormResource
```
FormResource saveFormResource(FormResource formResource)
```
    Since:
    
    1.9
    
    See Also:
    
    FormService.saveFormResource(org.openmrs.FormResource)
  - deleteFormResource
```
void deleteFormResource(FormResource formResource)
```
    Since:
    
    1.9
    
    See Also:
    
    FormService.purgeFormResource(org.openmrs.FormResource)

Interface FormDAO

Method Summary

Method Detail

saveForm

duplicateForm

getForm

getForm

getFormsByName

deleteForm

getAllFieldTypes

getFieldType

getAllForms

getAllFormFields

getFormField

getFields

getAllFields

getField

saveField

deleteField

getFormField

saveFormField

deleteFormField

getFields

getFormsContainingConcept

getForms

getFormCount

deleteFieldType

getFieldByUuid

getFieldAnswerByUuid

getFieldTypeByUuid

getFieldTypeByName

getFormByUuid

getFormFieldByUuid

saveFieldType

getFormFieldsByField

getFormResource

getFormResourceByUuid

getFormResource

getFormResourcesForForm

saveFormResource

deleteFormResource