org.openmrs.api

Interface ProgramWorkflowService

All Superinterfaces:

OpenmrsService

All Known Implementing Classes:

ProgramWorkflowServiceImpl

public interface ProgramWorkflowService
extends OpenmrsService

Contains methods pertaining to management of Programs, ProgramWorkflows, ProgramWorkflowStates, PatientPrograms, PatientStates, and ConceptStateConversions Use:

   Program program = new Program();
   program.set___(___);
   ...etc
   Context.getProgramWorkflowService().saveProgram(program);
 

Method Summary

Modifier and Type	Method and Description
List<ConceptStateConversion>	getAllConceptStateConversions() Returns all conceptStateConversions
List<ProgramAttributeType>	getAllProgramAttributeTypes()
List<Program>	getAllPrograms() Returns all programs, includes retired programs.
List<Program>	getAllPrograms(boolean includeRetired) Returns all programs
ConceptStateConversion	getConceptStateConversion(Integer conceptStateConversionId) 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) Get a concept state conversion by its uuid.
PatientProgram	getPatientProgram(Integer patientProgramId) 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> patients, String attributeName)
PatientProgramAttribute	getPatientProgramAttributeByUuid(String var1)
List<PatientProgram>	getPatientProgramByAttributeNameAndValue(String attributeName, String attributeValue)
PatientProgram	getPatientProgramByUuid(String uuid) Get a patient program by its 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) Get a program state by its uuid.
List<Concept>	getPossibleOutcomes(Integer programId) Get all possible outcome concepts for a program.
Program	getProgram(Integer programId) Returns a program given that programs primary key programId A null value is returned if no program exists with this programId.
ProgramAttributeType	getProgramAttributeType(Integer var1)
ProgramAttributeType	getProgramAttributeTypeByUuid(String var1)
Program	getProgramByName(String name) Returns a program given the program's exact name A null value is returned if there is no program with this name
Program	getProgramByUuid(String uuid) Get a program by its uuid.
List<Program>	getPrograms(String nameFragment) Returns programs that match the given string.
List<Program>	getProgramsByConcept(Concept concept) Returns a list of Programs that are using a particular concept.
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) Get ProgramWorkflowState by internal identifier.
ProgramWorkflowState	getStateByUuid(String uuid) Get a state by its uuid.
ProgramWorkflow	getWorkflow(Integer workflowId) Get ProgramWorkflow by internal identifier.
ProgramWorkflow	getWorkflowByUuid(String uuid) Get ProgramWorkflow by its UUID
void	purgeConceptStateConversion(ConceptStateConversion conceptStateConversion) Completely remove a conceptStateConversion from the database (not reversible) This method delegates to #purgeConceptStateConversion(conceptStateConversion, boolean) method
void	purgeConceptStateConversion(ConceptStateConversion conceptStateConversion, boolean cascade) Completely remove a conceptStateConversion from the database (not reversible)
void	purgePatientProgram(PatientProgram patientProgram) Completely remove a patientProgram from the database (not reversible) This method delegates to #purgePatientProgram(patientProgram, boolean) method
void	purgePatientProgram(PatientProgram patientProgram, boolean cascade) Completely remove a patientProgram from the database (not reversible)
void	purgeProgram(Program program) Completely remove a program from the database (not reversible) This method delegates to #purgeProgram(program, boolean) method
void	purgeProgram(Program program, boolean cascade) Completely remove a program from the database (not reversible)
void	purgeProgramAttributeType(ProgramAttributeType var1)
Program	retireProgram(Program program, String reason) Retires the given program
ConceptStateConversion	saveConceptStateConversion(ConceptStateConversion conceptStateConversion) 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) Save program to database (create if new or update if changed)
ProgramAttributeType	saveProgramAttributeType(ProgramAttributeType var1)
void	setProgramWorkflowDAO(ProgramWorkflowDAO dao) Setter for the ProgramWorkflow DataAccessObject (DAO).
Program	unretireProgram(Program program) Unretires the given program
PatientProgram	unvoidPatientProgram(PatientProgram patientProgram) Unvoids the given patientProgram
PatientProgram	voidPatientProgram(PatientProgram patientProgram, String reason) Voids the given patientProgram

Methods inherited from interface org.openmrs.api.OpenmrsService

onShutdown, onStartup

Method Detail

setProgramWorkflowDAO

void setProgramWorkflowDAO(ProgramWorkflowDAO dao)

Setter for the ProgramWorkflow DataAccessObject (DAO). The DAO is used for saving and retrieving from the database

Parameters:

dao - - The DAO for this service

saveProgram

@Authorized(value="Manage Programs")
Program saveProgram(Program program)
                                                  throws APIException

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

Parameters:

program - is the Program to be saved to the database

Returns:

The Program that was saved

Throws:

APIException - Should create program workflows Should save program successfully Should save workflows associated with program Should save states associated with program Should update detached program

getProgram

@Authorized(value="Get Programs")
Program getProgram(Integer programId)
                                              throws APIException

Returns a program given that programs primary key programId A null value is returned if no program exists with this programId.

Parameters:

programId - integer primary key of the program to find

Returns:

Program object that has program.programId = programId passed in.

Throws:

APIException - Should return program matching the given programId Should return null when programId does not exist

getProgramByName

@Authorized(value="Get Programs")
Program getProgramByName(String name)
                                                    throws APIException

Returns a program given the program's exact name A null value is returned if there is no program with this name

Parameters:

name - the exact name of the program to match on

Returns:

Program matching the name to Program.name

Throws:

APIException

ProgramNameDuplicatedException - when there are more than one program in the dB with the given name. Should return program when name matches Should return null when program does not exist with given name Should fail when two programs found with same name

getAllPrograms

@Authorized(value="Get Programs")
List<Program> getAllPrograms()
                                                        throws APIException

Returns all programs, includes retired programs. This method delegates to the #getAllPrograms(boolean) method

Returns:

List<Program> of all existing programs, including retired programs

Throws:

APIException

getAllPrograms

@Authorized(value="Get Programs")
List<Program> getAllPrograms(boolean includeRetired)
                                                        throws APIException

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:

APIException - Should return all programs including retired when includeRetired equals true Should return all programs excluding retired when includeRetired equals false

getPrograms

@Authorized(value="Get Programs")
List<Program> getPrograms(String nameFragment)
                                                     throws APIException

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:

APIException - Should return all programs with partial name match Should return all programs when exact name match Should return empty list when name does not match Should not return a null list Should return programs when nameFragment matches beginning of program name Should return programs when nameFragment matches ending of program name Should return programs when nameFragment matches middle of program name Should return programs when nameFragment matches entire program name Should return programs ordered by name Should return empty list when nameFragment does not match any

purgeProgram

@Authorized(value="Manage Programs")
void purgeProgram(Program program)
                                                throws APIException

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:

APIException - Should delete program successfully

purgeProgram

@Authorized(value="Manage Programs")
void purgeProgram(Program program,
                                                       boolean cascade)
                                                throws APIException

Completely remove a program from the database (not reversible)

Parameters:

cascade - true to delete related content

Throws:

APIException - Should delete program successfully Should not delete child associations when cascade equals false Should throw APIException when given cascade equals true Should purge program with patients enrolled

retireProgram

@Authorized(value="Manage Programs")
Program retireProgram(Program program,
                                                           String reason)
                                                    throws APIException

Retires the given program

Parameters:

program - Program to be retired

reason - String for retiring the program

Returns:

the Program which has been retired

Throws:

APIException - Should retire program successfully Should retire workflows associated with given program Should retire states associated with given program

unretireProgram

@Authorized(value="Manage Programs")
Program unretireProgram(Program program)
                                                      throws APIException

Unretires the given program

Parameters:

program - Program to be unretired

Returns:

the Program which has been unretired

Throws:

APIException - Should unretire program successfully Should unretire workflows associated with given program Should unretire states associated with given program

getProgramByUuid

Program getProgramByUuid(String uuid)

Get a program by its uuid. There should be only one of these in the database. If multiple are found, an error is thrown.

Parameters:

uuid - the universally unique identifier

Returns:

the program which matches the given uuid Should find object given valid uuid Should return null if no object found with given uuid Should return program with given uuid Should throw error when multiple programs with same uuid are found

getPatientStateByUuid

PatientState getPatientStateByUuid(String uuid)

Get a program state by its uuid. There should be only one of these in the database. If multiple are found, an error is thrown.

Parameters:

uuid - the universally unique identifier

Returns:

the program which matches the given uuid Should find object given valid uuid Should return null if no object found with given uuid Should return program state with the given uuid Should throw error when multiple program states with same uuid are found

savePatientProgram

@Authorized(value={"Add Patient Programs","Edit Patient Programs"})
PatientProgram savePatientProgram(PatientProgram patientProgram)
                                                                                               throws APIException

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:

APIException - Should update patient program Should save patient program successfully Should return patient program with assigned patient program id

getPatientProgram

@Authorized(value="Get Patient Programs")
PatientProgram getPatientProgram(Integer patientProgramId)
                                                                    throws APIException

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

Parameters:

patientProgramId - integer primary key of the PatientProgram to find

Returns:

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

Throws:

APIException - Should return patient program with given patientProgramId Should get patient program with given identifier Should return null if program does not exist

getPatientPrograms

@Authorized(value="Get Patient Programs")
List<PatientProgram> getPatientPrograms(Patient patient,
                                                                                  Program program,
                                                                                  Date minEnrollmentDate,
                                                                                  Date maxEnrollmentDate,
                                                                                  Date minCompletionDate,
                                                                                  Date maxCompletionDate,
                                                                                  boolean includeVoided)
                                                                           throws APIException

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 - if true, will also include voided PatientPrograms

Returns:

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

Throws:

APIException - Should return patient programs for given patient Should return patient programs for given program Should return patient programs with dateEnrolled on or before minEnrollmentDate Should return patient programs with dateEnrolled on or after maxEnrollmentDate Should return patient programs with dateCompleted on or before minCompletionDate Should return patient programs with dateCompleted on or after maxCompletionDate Should return patient programs with dateCompleted Should return patient programs not yet completed Should return voided patient programs Should return all patient programs when all parameters are null Should return empty list when matches not found

purgePatientProgram

@Authorized(value="Purge Patient Programs")
void purgePatientProgram(PatientProgram patientProgram)
                                                              throws APIException

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:

APIException - Should delete patient program from database without cascade

purgePatientProgram

@Authorized(value="Purge Patient Programs")
void purgePatientProgram(PatientProgram patientProgram,
                                                                     boolean cascade)
                                                              throws APIException

Completely remove a patientProgram from the database (not reversible)

Parameters:

patientProgram - the PatientProgram to clean out of the database.

cascade - true to delete related content

Throws:

APIException - Should delete patient program from database Should cascade delete patient program states when cascade equals true Should not cascade delete patient program states when cascade equals false

voidPatientProgram

@Authorized(value="Delete Patient Programs")
PatientProgram voidPatientProgram(PatientProgram patientProgram,
                                                                               String reason)
                                                                        throws APIException

Voids the given patientProgram

Parameters:

patientProgram - patientProgram to be voided

reason - is the reason why the patientProgram is being voided

Returns:

the voided PatientProgram

Throws:

APIException - Should void patient program when reason is valid Should fail when reason is empty

unvoidPatientProgram

@Authorized(value="Delete Patient Programs")
PatientProgram unvoidPatientProgram(PatientProgram patientProgram)
                                                                          throws APIException

Unvoids the given patientProgram

Parameters:

patientProgram - patientProgram to be un-voided

Returns:

the voided PatientProgram

Throws:

APIException - Should void patient program when reason is valid

getPossibleOutcomes

@Authorized(value="Get Programs")
List<Concept> getPossibleOutcomes(Integer programId)

Get all possible outcome concepts for a program. Will return all concept answers Concept.getAnswers() if they exist, then all concept set members Concept.getSetMembers() if they exist, then empty List.

Parameters:

programId -

Returns:

outcome concepts or empty List if none exist

getWorkflow

ProgramWorkflow getWorkflow(Integer workflowId)

Get ProgramWorkflow by internal identifier.

Parameters:

workflowId - the primary key of the workflow to find, null not ok

Returns:

the program workflow matching given id or null if not found

Since:

2.2.0

getWorkflowByUuid

ProgramWorkflow getWorkflowByUuid(String uuid)

Get ProgramWorkflow by its UUID

Parameters:

uuid -

Returns:

program work flow or null Should find object given valid uuid Should return null if no object found with given uuid

saveConceptStateConversion

@Authorized(value={"Add Patient Programs","Edit Patient Programs"})
ConceptStateConversion saveConceptStateConversion(ConceptStateConversion conceptStateConversion)
                                                                                                               throws APIException

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

Parameters:

conceptStateConversion - - The ConceptStateConversion to save

Returns:

ConceptStateConversion - The saved ConceptStateConversion

Throws:

APIException - Should save state conversion

getConceptStateConversion

@Authorized(value="Get Programs")
ConceptStateConversion getConceptStateConversion(Integer conceptStateConversionId)
                                                                            throws APIException

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

Parameters:

conceptStateConversionId - integer primary key of the conceptStateConversion to find

Returns:

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

Throws:

APIException - Should return concept state conversion for given identifier

getAllConceptStateConversions

@Authorized(value="Get Programs")
List<ConceptStateConversion> getAllConceptStateConversions()
                                                                                      throws APIException

Returns all conceptStateConversions

Returns:

List<ConceptStateConversion> of all ConceptStateConversions that exist

Throws:

APIException - Should return all concept state conversions

purgeConceptStateConversion

@Authorized(value="Manage Programs")
void purgeConceptStateConversion(ConceptStateConversion conceptStateConversion)
                                                               throws APIException

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

Parameters:

conceptStateConversion - the ConceptStateConversion to clean out of the database.

Throws:

APIException

purgeConceptStateConversion

@Authorized(value="Manage Programs")
void purgeConceptStateConversion(ConceptStateConversion conceptStateConversion,
                                                                      boolean cascade)
                                                               throws APIException

Completely remove a conceptStateConversion from the database (not reversible)

Parameters:

conceptStateConversion - the ConceptStateConversion to clean out of the database.

cascade - true to delete related content

Throws:

APIException - Should cascade delete given concept state conversion when given cascade is true Should not cascade delete given concept state conversion when given cascade is false

getConceptStateConversion

ConceptStateConversion getConceptStateConversion(ProgramWorkflow workflow,
                                                 Concept trigger)
                                          throws APIException

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:

APIException - Should return concept state conversion for given workflow and trigger

getState

ProgramWorkflowState getState(Integer stateId)

Get ProgramWorkflowState by internal identifier.

Parameters:

stateId - the primary key of the state to find, null not ok

Returns:

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

Since:

2.2.0

getStateByUuid

ProgramWorkflowState getStateByUuid(String uuid)

Get a state by its uuid. There should be only one of these in the database. If multiple are found, an error is thrown.

Parameters:

uuid - the universally unique identifier

Returns:

the program workflow state which matches the given uuid Should find object given valid uuid Should return null if no object found with given uuid Should return a state with the given uuid Should throw an error when multiple states with same uuid are found

getPatientProgramByUuid

PatientProgram getPatientProgramByUuid(String uuid)

Get a patient program by its uuid. There should be only one of these in the database. If multiple are found, an error is thrown.

Parameters:

uuid - the universally unique identifier

Returns:

the patient program which matches the given uuid Should find object given valid uuid Should return null if no object found with given uuid Should return a patient program with the given uuid Should throw an error when multiple patient programs with same uuid are found

getPatientPrograms

@Authorized(value="Get Patient Programs")
List<PatientProgram> getPatientPrograms(Cohort cohort,
                                                                                  Collection<Program> programs)

Parameters:

cohort -

programs -

Returns:

List<PatientProgram> for all Patients in the given Cohort that are in the given programs Should return patient programs with patients in given cohort and programs Should return patient programs with patients in given cohort Should return patient programs with programs in given programs Should return empty list when there is no match for given cohort and programs Should not return null when there is no match for given cohort and program Should not throw NullPointerException when given cohort and programs are null Should not fail when given cohort is empty Should not fail when given program is empty

getProgramsByConcept

@Authorized(value="Get Patient Programs")
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

@Authorized(value="Get Patient Programs")
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

@Authorized(value="Get Patient Programs")
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

getConceptStateConversionByUuid

ConceptStateConversion getConceptStateConversionByUuid(String uuid)

Get a concept state conversion by its uuid. There should be only one of these in the database. If multiple are found, an error is thrown.

Parameters:

uuid - the universally unique identifier

Returns:

the concept state conversion which matches the given uuid Should find object given valid uuid Should return null if no object found with given uuid Should return a program state with the given uuid Should throw an error when multiple program states with same uuid are found

getAllProgramAttributeTypes

@Transactional(readOnly=true)
 @Authorized(value="Get Patient Program Attribute Types")
List<ProgramAttributeType> getAllProgramAttributeTypes()

getProgramAttributeType

@Transactional(readOnly=true)
 @Authorized(value="Get Patient Program Attribute Types")
ProgramAttributeType getProgramAttributeType(Integer var1)

getProgramAttributeTypeByUuid

@Transactional(readOnly=true)
 @Authorized(value="Get Patient Program Attribute Types")
ProgramAttributeType getProgramAttributeTypeByUuid(String var1)

saveProgramAttributeType

@Authorized(value="Manage Patient Program Attribute Types")
ProgramAttributeType saveProgramAttributeType(ProgramAttributeType var1)

purgeProgramAttributeType

@Authorized(value="Purge Patient Program Attribute Types")
void purgeProgramAttributeType(ProgramAttributeType var1)

getPatientProgramAttributeByUuid

@Transactional(readOnly=true)
 @Authorized(value="Get Patient Programs")
PatientProgramAttribute getPatientProgramAttributeByUuid(String var1)

getPatientProgramAttributeByAttributeName

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

getPatientProgramByAttributeNameAndValue

@Transactional(readOnly=true)
 @Authorized(value="Get Patient Programs")
List<PatientProgram> getPatientProgramByAttributeNameAndValue(String attributeName,
                                                                                                                                       String attributeValue)