org.openmrs.api.db

Interface ProgramWorkflowDAO

All Known Implementing Classes:

HibernateProgramWorkflowDAO

public interface ProgramWorkflowDAO

Program- and PatientProgram- and ConceptStateConversion-related database functions

Version:

1.0

Method Summary

Modifier and Type	Method and Description
void	deleteConceptStateConversion(ConceptStateConversion csc) Completely remove a conceptStateConversion from the database (not reversible)
void	deletePatientProgram(PatientProgram patientProgram) Completely remove a patientProgram from the database (not reversible) This method delegates to #purgePatientProgram(patientProgram, boolean) method
void	deleteProgram(Program program) Completely remove a program from the database (not reversible) This method delegates to #purgeProgram(program, boolean) method
List<Program>	findPrograms(String nameFragment) Returns programs that match the given string.
List<ConceptStateConversion>	getAllConceptStateConversions() Returns all conceptStateConversions
List<ProgramAttributeType>	getAllProgramAttributeTypes()
List<Program>	getAllPrograms(boolean includeRetired) Returns all programs
ConceptStateConversion	getConceptStateConversion(Integer id) Returns a conceptStateConversion given that conceptStateConversions primary key conceptStateConversionId A null value is returned if no conceptStateConversion exists with this conceptStateConversionId.
ConceptStateConversion	getConceptStateConversion(ProgramWorkflow workflow, Concept trigger) Retrieves the ConceptStateConversion that matches the passed ProgramWorkflow and Concept
ConceptStateConversion	getConceptStateConversionByUuid(String uuid)
PatientProgram	getPatientProgram(Integer id) Returns a PatientProgram given that PatientPrograms primary key patientProgramId A null value is returned if no PatientProgram exists with this patientProgramId.
Map<Object,Object>	getPatientProgramAttributeByAttributeName(List<Integer> patientIds, String attributeName)
PatientProgramAttribute	getPatientProgramAttributeByUuid(String var1)
List<PatientProgram>	getPatientProgramByAttributeNameAndValue(String attributeName, String attributeValue)
PatientProgram	getPatientProgramByUuid(String uuid)
List<PatientProgram>	getPatientPrograms(Cohort cohort, Collection<Program> programs)
List<PatientProgram>	getPatientPrograms(Patient patient, Program program, Date minEnrollmentDate, Date maxEnrollmentDate, Date minCompletionDate, Date maxCompletionDate, boolean includeVoided) Returns PatientPrograms that match the input parameters.
PatientState	getPatientStateByUuid(String uuid)
Program	getProgram(Integer programId) Retrieves a Program from the database by primary key programId
ProgramAttributeType	getProgramAttributeType(Integer var1)
ProgramAttributeType	getProgramAttributeTypeByUuid(String var1)
Program	getProgramByUuid(String uuid)
List<Program>	getProgramsByConcept(Concept concept) Returns a list of Programs that are using a particular concept.
List<Program>	getProgramsByName(String name, boolean includeRetired) Retrieves the Programs from the dB which have the given name.
List<ProgramWorkflow>	getProgramWorkflowsByConcept(Concept concept) Returns a list of ProgramWorkflows that are using a particular concept.
List<ProgramWorkflowState>	getProgramWorkflowStatesByConcept(Concept concept) Returns a list of ProgramWorkflowStates that are using a particular concept.
ProgramWorkflowState	getState(Integer stateId) Retrieves a ProgramWorkflowState from the database by its primary key.
ProgramWorkflowState	getStateByUuid(String uuid)
ProgramWorkflow	getWorkflow(Integer workflowId) Retrieves a ProgramWorkflow from the database by its primary key.
ProgramWorkflow	getWorkflowByUuid(String uuid)
void	purgeProgramAttributeType(ProgramAttributeType var1)
ConceptStateConversion	saveConceptStateConversion(ConceptStateConversion csc) Save ConceptStateConversion to database (create if new or update if changed)
PatientProgram	savePatientProgram(PatientProgram patientProgram) Save patientProgram to database (create if new or update if changed)
Program	saveProgram(Program program) Saves a Program to the database
ProgramAttributeType	saveProgramAttributeType(ProgramAttributeType var1)

Method Detail

saveProgram

Program saveProgram(Program program)
             throws DAOException

Saves a Program to the database

Parameters:

program - - The Program to save

Returns:

The saved Program

Throws:

DAOException

getProgram

Program getProgram(Integer programId)
            throws DAOException

Retrieves a Program from the database by primary key programId

Parameters:

programId - - The primary key programId to use to retrieve a Program

Returns:

Program - The Program matching the passed programId

Throws:

DAOException

getAllPrograms

List<Program> getAllPrograms(boolean includeRetired)
                      throws DAOException

Returns all programs

Parameters:

includeRetired - whether or not to include retired programs

Returns:

List<Program> all existing programs, including retired based on the input parameter

Throws:

DAOException

findPrograms

List<Program> findPrograms(String nameFragment)
                    throws DAOException

Returns programs that match the given string. A null list will never be returned. An empty list will be returned if there are no programs matching this nameFragment

Parameters:

nameFragment - is the string used to search for programs

Returns:

List<Program> - list of Programs whose name matches the input parameter

Throws:

DAOException

deleteProgram

void deleteProgram(Program program)
            throws DAOException

Completely remove a program from the database (not reversible) This method delegates to #purgeProgram(program, boolean) method

Parameters:

program - the Program to clean out of the database.

Throws:

DAOException

savePatientProgram

PatientProgram savePatientProgram(PatientProgram patientProgram)
                           throws DAOException

Save patientProgram to database (create if new or update if changed)

Parameters:

patientProgram - is the PatientProgram to be saved to the database

Returns:

PatientProgram - the saved PatientProgram

Throws:

DAOException

getPatientProgram

PatientProgram getPatientProgram(Integer id)

Returns a PatientProgram given that PatientPrograms primary key patientProgramId A null value is returned if no PatientProgram exists with this patientProgramId.

Parameters:

id - integer primary key of the PatientProgram to find

Returns:

PatientProgram object that has patientProgram.patientProgramId = patientProgramId passed in.

Throws:

DAOException

getPatientPrograms

List<PatientProgram> getPatientPrograms(Cohort cohort,
                                        Collection<Program> programs)

getPatientPrograms

List<PatientProgram> getPatientPrograms(Patient patient,
                                        Program program,
                                        Date minEnrollmentDate,
                                        Date maxEnrollmentDate,
                                        Date minCompletionDate,
                                        Date maxCompletionDate,
                                        boolean includeVoided)
                                 throws DAOException

Returns PatientPrograms that match the input parameters. If an input parameter is set to null, the parameter will not be used. Calling this method will all null parameters will return all PatientPrograms in the database A null list will never be returned. An empty list will be returned if there are no programs matching the input criteria

Parameters:

patient - - if supplied all PatientPrograms returned will be for this Patient

program - - if supplied all PatientPrograms returned will be for this Program

minEnrollmentDate - - if supplied will limit PatientPrograms to those with enrollments on or after this Date

maxEnrollmentDate - - if supplied will limit PatientPrograms to those with enrollments on or before this Date

minCompletionDate - - if supplied will limit PatientPrograms to those completed on or after this Date OR not yet completed

maxCompletionDate - - if supplied will limit PatientPrograms to those completed on or before this Date

includeVoided - - boolean, if true will return voided PatientPrograms as well. If false, will not return voided PatientPrograms

Returns:

List<PatientProgram> of PatientPrograms that match the passed input parameters

Throws:

DAOException

deletePatientProgram

void deletePatientProgram(PatientProgram patientProgram)
                   throws DAOException

Completely remove a patientProgram from the database (not reversible) This method delegates to #purgePatientProgram(patientProgram, boolean) method

Parameters:

patientProgram - the PatientProgram to clean out of the database.

Throws:

DAOException

saveConceptStateConversion

ConceptStateConversion saveConceptStateConversion(ConceptStateConversion csc)
                                           throws DAOException

Save ConceptStateConversion to database (create if new or update if changed)

Parameters:

csc - The ConceptStateConversion to save

Returns:

The saved ConceptStateConversion

Throws:

DAOException

getAllConceptStateConversions

List<ConceptStateConversion> getAllConceptStateConversions()
                                                    throws DAOException

Returns all conceptStateConversions

Returns:

List<ConceptStateConversion> of all ConceptStateConversions that exist

Throws:

DAOException

getConceptStateConversion

ConceptStateConversion getConceptStateConversion(Integer id)

Returns a conceptStateConversion given that conceptStateConversions primary key conceptStateConversionId A null value is returned if no conceptStateConversion exists with this conceptStateConversionId.

Parameters:

id - integer primary key of the conceptStateConversion to find

Returns:

ConceptStateConversion object that has conceptStateConversion.conceptStateConversionId = conceptStateConversionId passed in.

Throws:

DAOException

deleteConceptStateConversion

void deleteConceptStateConversion(ConceptStateConversion csc)

Completely remove a conceptStateConversion from the database (not reversible)

Parameters:

csc - the ConceptStateConversion to clean out of the database.

Throws:

DAOException

getConceptStateConversion

ConceptStateConversion getConceptStateConversion(ProgramWorkflow workflow,
                                                 Concept trigger)

Retrieves the ConceptStateConversion that matches the passed ProgramWorkflow and Concept

Parameters:

workflow - the ProgramWorkflow to check

trigger - the Concept to check

Returns:

ConceptStateConversion that matches the passed ProgramWorkflow and Concept

Throws:

DAOException

getConceptStateConversionByUuid

ConceptStateConversion getConceptStateConversionByUuid(String uuid)

Parameters:

uuid -

Returns:

concept state conversion or null

getPatientProgramByUuid

PatientProgram getPatientProgramByUuid(String uuid)

Parameters:

uuid -

Returns:

patient program or null

getProgramByUuid

Program getProgramByUuid(String uuid)

Parameters:

uuid -

Returns:

program or null

getProgramsByName

List<Program> getProgramsByName(String name,
                                boolean includeRetired)

Retrieves the Programs from the dB which have the given name.

Parameters:

name - the name of the Programs to retrieve.

includeRetired - whether to include retired programs or not Should return an empty list when there is no program in the dB with given name Should return only and exactly the programs with the given name

Returns:

all Programs with the given name.

getState

ProgramWorkflowState getState(Integer stateId)

Retrieves a ProgramWorkflowState from the database by its primary key.

Parameters:

stateId - the primary key used to retrieve program workflow state

Returns:

the program workflow state matching given id or null if not found

Since:

2.2.0

getStateByUuid

ProgramWorkflowState getStateByUuid(String uuid)

Parameters:

uuid -

Returns:

program workflow state or null

getPatientStateByUuid

PatientState getPatientStateByUuid(String uuid)

getWorkflow

ProgramWorkflow getWorkflow(Integer workflowId)

Retrieves a ProgramWorkflow from the database by its primary key.

Parameters:

workflowId - the primary key used to retrieve program workflow

Returns:

the program workflow matching given id or null if not found

Since:

2.2.0

getWorkflowByUuid

ProgramWorkflow getWorkflowByUuid(String uuid)

Parameters:

uuid -

Returns:

program workflow or null

getProgramsByConcept

List<Program> getProgramsByConcept(Concept concept)

Returns a list of Programs that are using a particular concept.

Parameters:

concept - - The Concept being used.

Returns:

- A List of Programs

getProgramWorkflowsByConcept

List<ProgramWorkflow> getProgramWorkflowsByConcept(Concept concept)

Returns a list of ProgramWorkflows that are using a particular concept.

Parameters:

concept - - The Concept being used.

Returns:

- A List of ProgramWorkflows

getProgramWorkflowStatesByConcept

List<ProgramWorkflowState> getProgramWorkflowStatesByConcept(Concept concept)

Returns a list of ProgramWorkflowStates that are using a particular concept.

Parameters:

concept - - The Concept being used.

Returns:

- A List of ProgramWorkflowStates

getAllProgramAttributeTypes

List<ProgramAttributeType> getAllProgramAttributeTypes()

getProgramAttributeType

ProgramAttributeType getProgramAttributeType(Integer var1)

getProgramAttributeTypeByUuid

ProgramAttributeType getProgramAttributeTypeByUuid(String var1)

saveProgramAttributeType

ProgramAttributeType saveProgramAttributeType(ProgramAttributeType var1)

getPatientProgramAttributeByUuid

PatientProgramAttribute getPatientProgramAttributeByUuid(String var1)

purgeProgramAttributeType

void purgeProgramAttributeType(ProgramAttributeType var1)

getPatientProgramByAttributeNameAndValue

List<PatientProgram> getPatientProgramByAttributeNameAndValue(String attributeName,
                                                              String attributeValue)

getPatientProgramAttributeByAttributeName

Map<Object,Object> getPatientProgramAttributeByAttributeName(List<Integer> patientIds,
                                                             String attributeName)