org.openmrs.api.impl

Class ProgramWorkflowServiceImpl

java.lang.Object

org.openmrs.api.impl.BaseOpenmrsService

org.openmrs.api.impl.ProgramWorkflowServiceImpl

All Implemented Interfaces:

OpenmrsService, ProgramWorkflowService

@Transactional
public class ProgramWorkflowServiceImpl
extends BaseOpenmrsService
implements ProgramWorkflowService

Default implementation of the ProgramWorkflow-related services class. This method should not be invoked by itself. Spring injection is used to inject this implementation into the ServiceContext. Which implementation is injected is determined by the spring application context file: /metadata/api/spring/applicationContext.xml

See Also:

ProgramWorkflowService

Field Summary

Fields

Modifier and Type	Field and Description
protected ProgramWorkflowDAO	dao

Constructor Summary

Constructors

Constructor and Description
ProgramWorkflowServiceImpl()

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 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) 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 uuid)
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 id) Returns a program given that programs primary key programId A null value is returned if no program exists with this programId.
Program	getProgram(String name)
ProgramAttributeType	getProgramAttributeType(Integer id)
ProgramAttributeType	getProgramAttributeTypeByUuid(String uuid)
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 type)
Program	retireProgram(Program program, String reason) Retires the given program
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) Save program to database (create if new or update if changed)
ProgramAttributeType	saveProgramAttributeType(ProgramAttributeType type)
void	setProgramWorkflowDAO(ProgramWorkflowDAO dao) Setter for the ProgramWorkflow DataAccessObject (DAO).
void	triggerStateConversion(Patient patient, Concept trigger, Date dateConverted)
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 class org.openmrs.api.impl.BaseOpenmrsService

onShutdown, onStartup

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.openmrs.api.OpenmrsService

onShutdown, onStartup

Field Detail

dao

protected ProgramWorkflowDAO dao

Constructor Detail

ProgramWorkflowServiceImpl

public ProgramWorkflowServiceImpl()

Method Detail

setProgramWorkflowDAO

public void setProgramWorkflowDAO(ProgramWorkflowDAO dao)

Description copied from interface: ProgramWorkflowService

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

Specified by:

setProgramWorkflowDAO in interface ProgramWorkflowService

Parameters:

dao - - The DAO for this service

See Also:

ProgramWorkflowService.setProgramWorkflowDAO(org.openmrs.api.db.ProgramWorkflowDAO)

saveProgram

public Program saveProgram(Program program)
                    throws APIException

Description copied from interface: ProgramWorkflowService

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

Specified by:

saveProgram in interface ProgramWorkflowService

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

See Also:

ProgramWorkflowService.saveProgram(org.openmrs.Program)

getProgram

@Transactional(readOnly=true)
public Program getProgram(Integer id)

Description copied from interface: ProgramWorkflowService

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

Specified by:

getProgram in interface ProgramWorkflowService

Parameters:

id - integer primary key of the program to find

Returns:

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

See Also:

ProgramWorkflowService.getProgram(java.lang.Integer)

getProgram

@Transactional(readOnly=true)
public Program getProgram(String name)

See Also:

org.openmrs.api.ProgramWorkflowService#getProgram(java.lang.String)

getProgramByName

@Transactional(readOnly=true)
public Program getProgramByName(String name)
                                                       throws APIException

Description copied from interface: ProgramWorkflowService

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

Specified by:

getProgramByName in interface ProgramWorkflowService

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

See Also:

org.openmrs.api.ProgramWorkflowService#getProgram(java.lang.String)

getAllPrograms

@Transactional(readOnly=true)
public List<Program> getAllPrograms()
                                                           throws APIException

Description copied from interface: ProgramWorkflowService

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

Specified by:

getAllPrograms in interface ProgramWorkflowService

Returns:

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

Throws:

APIException

See Also:

ProgramWorkflowService.getAllPrograms()

getAllPrograms

@Transactional(readOnly=true)
public List<Program> getAllPrograms(boolean includeRetired)
                                                           throws APIException

Description copied from interface: ProgramWorkflowService

Returns all programs

Specified by:

getAllPrograms in interface ProgramWorkflowService

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

See Also:

ProgramWorkflowService.getAllPrograms(boolean)

getPrograms

@Transactional(readOnly=true)
public List<Program> getPrograms(String nameFragment)
                                                        throws APIException

Description copied from interface: ProgramWorkflowService

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

Specified by:

getPrograms in interface ProgramWorkflowService

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

See Also:

ProgramWorkflowService.getPrograms(String)

purgeProgram

public void purgeProgram(Program program)
                  throws APIException

Description copied from interface: ProgramWorkflowService

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

Specified by:

purgeProgram in interface ProgramWorkflowService

Parameters:

program - the Program to clean out of the database.

Throws:

APIException - Should delete program successfully

See Also:

ProgramWorkflowService.purgeProgram(org.openmrs.Program)

purgeProgram

public void purgeProgram(Program program,
                         boolean cascade)
                  throws APIException

Description copied from interface: ProgramWorkflowService

Completely remove a program from the database (not reversible)

Specified by:

purgeProgram in interface ProgramWorkflowService

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

See Also:

ProgramWorkflowService.purgeProgram(org.openmrs.Program, boolean)

retireProgram

public Program retireProgram(Program program,
                             String reason)
                      throws APIException

Description copied from interface: ProgramWorkflowService

Retires the given program

Specified by:

retireProgram in interface ProgramWorkflowService

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

See Also:

ProgramWorkflowService.retireProgram(org.openmrs.Program, java.lang.String)

unretireProgram

public Program unretireProgram(Program program)
                        throws APIException

Description copied from interface: ProgramWorkflowService

Unretires the given program

Specified by:

unretireProgram in interface ProgramWorkflowService

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

See Also:

ProgramWorkflowService.unretireProgram(org.openmrs.Program)

savePatientProgram

public PatientProgram savePatientProgram(PatientProgram patientProgram)
                                  throws APIException

Description copied from interface: ProgramWorkflowService

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

Specified by:

savePatientProgram in interface ProgramWorkflowService

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

See Also:

ProgramWorkflowService.savePatientProgram(org.openmrs.PatientProgram)

getPatientProgram

@Transactional(readOnly=true)
public PatientProgram getPatientProgram(Integer patientProgramId)

Description copied from interface: ProgramWorkflowService

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

Specified by:

getPatientProgram in interface ProgramWorkflowService

Parameters:

patientProgramId - integer primary key of the PatientProgram to find

Returns:

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

See Also:

ProgramWorkflowService.getPatientProgram(java.lang.Integer)

getPatientPrograms

@Transactional(readOnly=true)
public List<PatientProgram> getPatientPrograms(Patient patient,
                                                                             Program program,
                                                                             Date minEnrollmentDate,
                                                                             Date maxEnrollmentDate,
                                                                             Date minCompletionDate,
                                                                             Date maxCompletionDate,
                                                                             boolean includeVoided)
                                                                      throws APIException

Description copied from interface: ProgramWorkflowService

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

Specified by:

getPatientPrograms in interface ProgramWorkflowService

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

See Also:

ProgramWorkflowService.getPatientPrograms(Patient, Program, Date, Date, Date, Date, boolean)

getPatientPrograms

@Transactional(readOnly=true)
public List<PatientProgram> getPatientPrograms(Cohort cohort,
                                                                             Collection<Program> programs)

Specified by:

getPatientPrograms in interface ProgramWorkflowService

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

See Also:

ProgramWorkflowService.getPatientPrograms(Cohort, Collection)

purgePatientProgram

public void purgePatientProgram(PatientProgram patientProgram)
                         throws APIException

Description copied from interface: ProgramWorkflowService

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

Specified by:

purgePatientProgram in interface ProgramWorkflowService

Parameters:

patientProgram - the PatientProgram to clean out of the database.

Throws:

APIException - Should delete patient program from database without cascade

See Also:

ProgramWorkflowService.purgePatientProgram(org.openmrs.PatientProgram)

purgePatientProgram

public void purgePatientProgram(PatientProgram patientProgram,
                                boolean cascade)
                         throws APIException

Description copied from interface: ProgramWorkflowService

Completely remove a patientProgram from the database (not reversible)

Specified by:

purgePatientProgram in interface ProgramWorkflowService

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

See Also:

ProgramWorkflowService.purgePatientProgram(org.openmrs.PatientProgram, boolean)

voidPatientProgram

public PatientProgram voidPatientProgram(PatientProgram patientProgram,
                                         String reason)

Description copied from interface: ProgramWorkflowService

Voids the given patientProgram

Specified by:

voidPatientProgram in interface ProgramWorkflowService

Parameters:

patientProgram - patientProgram to be voided

reason - is the reason why the patientProgram is being voided

Returns:

the voided PatientProgram

See Also:

ProgramWorkflowService.voidPatientProgram(org.openmrs.PatientProgram, java.lang.String)

unvoidPatientProgram

public PatientProgram unvoidPatientProgram(PatientProgram patientProgram)

Description copied from interface: ProgramWorkflowService

Unvoids the given patientProgram

Specified by:

unvoidPatientProgram in interface ProgramWorkflowService

Parameters:

patientProgram - patientProgram to be un-voided

Returns:

the voided PatientProgram

See Also:

ProgramWorkflowService.voidPatientProgram(org.openmrs.PatientProgram, java.lang.String)

getPossibleOutcomes

@Transactional(readOnly=true)
public List<Concept> getPossibleOutcomes(Integer programId)

Description copied from interface: ProgramWorkflowService

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.

Specified by:

getPossibleOutcomes in interface ProgramWorkflowService

Returns:

outcome concepts or empty List if none exist

See Also:

ProgramWorkflowService.getPossibleOutcomes(Integer)

saveConceptStateConversion

public ConceptStateConversion saveConceptStateConversion(ConceptStateConversion csc)
                                                  throws APIException

Description copied from interface: ProgramWorkflowService

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

Specified by:

saveConceptStateConversion in interface ProgramWorkflowService

Parameters:

csc - - The ConceptStateConversion to save

Returns:

ConceptStateConversion - The saved ConceptStateConversion

Throws:

APIException - Should save state conversion

See Also:

ProgramWorkflowService.saveConceptStateConversion(org.openmrs.ConceptStateConversion)

getConceptStateConversion

@Transactional(readOnly=true)
public ConceptStateConversion getConceptStateConversion(Integer id)

Description copied from interface: ProgramWorkflowService

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

Specified by:

getConceptStateConversion in interface ProgramWorkflowService

Parameters:

id - integer primary key of the conceptStateConversion to find

Returns:

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

See Also:

ProgramWorkflowService.getConceptStateConversion(java.lang.Integer)

getAllConceptStateConversions

@Transactional(readOnly=true)
public List<ConceptStateConversion> getAllConceptStateConversions()
                                                                                         throws APIException

Description copied from interface: ProgramWorkflowService

Returns all conceptStateConversions

Specified by:

getAllConceptStateConversions in interface ProgramWorkflowService

Returns:

List<ConceptStateConversion> of all ConceptStateConversions that exist

Throws:

APIException - Should return all concept state conversions

See Also:

ProgramWorkflowService.getAllConceptStateConversions()

purgeConceptStateConversion

public void purgeConceptStateConversion(ConceptStateConversion conceptStateConversion)
                                 throws APIException

Description copied from interface: ProgramWorkflowService

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

Specified by:

purgeConceptStateConversion in interface ProgramWorkflowService

Parameters:

conceptStateConversion - the ConceptStateConversion to clean out of the database.

Throws:

APIException

See Also:

ProgramWorkflowService.purgeConceptStateConversion(org.openmrs.ConceptStateConversion)

purgeConceptStateConversion

public void purgeConceptStateConversion(ConceptStateConversion conceptStateConversion,
                                        boolean cascade)
                                 throws APIException

Description copied from interface: ProgramWorkflowService

Completely remove a conceptStateConversion from the database (not reversible)

Specified by:

purgeConceptStateConversion in interface ProgramWorkflowService

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

See Also:

ProgramWorkflowService.purgeConceptStateConversion(org.openmrs.ConceptStateConversion, boolean)

triggerStateConversion

public void triggerStateConversion(Patient patient,
                                   Concept trigger,
                                   Date dateConverted)

See Also:

org.openmrs.api.ProgramWorkflowService#triggerStateConversion(org.openmrs.Patient, org.openmrs.Concept, java.util.Date)

getConceptStateConversion

@Transactional(readOnly=true)
public ConceptStateConversion getConceptStateConversion(ProgramWorkflow workflow,
                                                                                      Concept trigger)

Description copied from interface: ProgramWorkflowService

Retrieves the ConceptStateConversion that matches the passed ProgramWorkflow and Concept

Specified by:

getConceptStateConversion in interface ProgramWorkflowService

Parameters:

workflow - - the ProgramWorkflow to check

trigger - - the Concept to check

Returns:

ConceptStateConversion that matches the passed ProgramWorkflow and Concept

See Also:

ProgramWorkflowService.getConceptStateConversion(org.openmrs.ProgramWorkflow, org.openmrs.Concept)

getProgramsByConcept

@Transactional(readOnly=true)
public List<Program> getProgramsByConcept(Concept concept)

Description copied from interface: ProgramWorkflowService

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

Specified by:

getProgramsByConcept in interface ProgramWorkflowService

Parameters:

concept - - The Concept being used.

Returns:

- A List of Programs

See Also:

ProgramWorkflowService.getProgramsByConcept(org.openmrs.Concept)

getProgramWorkflowsByConcept

@Transactional(readOnly=true)
public List<ProgramWorkflow> getProgramWorkflowsByConcept(Concept concept)

Description copied from interface: ProgramWorkflowService

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

Specified by:

getProgramWorkflowsByConcept in interface ProgramWorkflowService

Parameters:

concept - - The Concept being used.

Returns:

- A List of ProgramWorkflows

See Also:

ProgramWorkflowService.getProgramWorkflowsByConcept(org.openmrs.Concept)

getProgramWorkflowStatesByConcept

@Transactional(readOnly=true)
public List<ProgramWorkflowState> getProgramWorkflowStatesByConcept(Concept concept)

Description copied from interface: ProgramWorkflowService

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

Specified by:

getProgramWorkflowStatesByConcept in interface ProgramWorkflowService

Parameters:

concept - - The Concept being used.

Returns:

- A List of ProgramWorkflowStates

See Also:

ProgramWorkflowService.getProgramWorkflowStatesByConcept(org.openmrs.Concept)

getConceptStateConversionByUuid

@Transactional(readOnly=true)
public ConceptStateConversion getConceptStateConversionByUuid(String uuid)

Description copied from interface: ProgramWorkflowService

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.

Specified by:

getConceptStateConversionByUuid in interface ProgramWorkflowService

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

See Also:

ProgramWorkflowService.getConceptStateConversionByUuid(java.lang.String)

getPatientProgramByUuid

@Transactional(readOnly=true)
public PatientProgram getPatientProgramByUuid(String uuid)

Description copied from interface: ProgramWorkflowService

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.

Specified by:

getPatientProgramByUuid in interface ProgramWorkflowService

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

See Also:

ProgramWorkflowService.getPatientProgramByUuid(java.lang.String)

getProgramByUuid

@Transactional(readOnly=true)
public Program getProgramByUuid(String uuid)

Description copied from interface: ProgramWorkflowService

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

Specified by:

getProgramByUuid in interface ProgramWorkflowService

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

See Also:

ProgramWorkflowService.getProgramByUuid(java.lang.String)

getState

@Transactional(readOnly=true)
public ProgramWorkflowState getState(Integer stateId)

Description copied from interface: ProgramWorkflowService

Get ProgramWorkflowState by internal identifier.

Specified by:

getState in interface ProgramWorkflowService

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

See Also:

ProgramWorkflowService.getWorkflow(Integer)

getStateByUuid

@Transactional(readOnly=true)
public ProgramWorkflowState getStateByUuid(String uuid)

Description copied from interface: ProgramWorkflowService

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

Specified by:

getStateByUuid in interface ProgramWorkflowService

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

See Also:

ProgramWorkflowService.getStateByUuid(java.lang.String)

getPatientStateByUuid

@Transactional(readOnly=true)
public PatientState getPatientStateByUuid(String uuid)

Description copied from interface: ProgramWorkflowService

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.

Specified by:

getPatientStateByUuid in interface ProgramWorkflowService

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

getWorkflow

@Transactional(readOnly=true)
public ProgramWorkflow getWorkflow(Integer workflowId)

Description copied from interface: ProgramWorkflowService

Get ProgramWorkflow by internal identifier.

Specified by:

getWorkflow in interface ProgramWorkflowService

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

See Also:

ProgramWorkflowService.getWorkflow(Integer)

getWorkflowByUuid

@Transactional(readOnly=true)
public ProgramWorkflow getWorkflowByUuid(String uuid)

Description copied from interface: ProgramWorkflowService

Get ProgramWorkflow by its UUID

Specified by:

getWorkflowByUuid in interface ProgramWorkflowService

Returns:

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

See Also:

ProgramWorkflowService.getWorkflowByUuid(java.lang.String)

getAllProgramAttributeTypes

public List<ProgramAttributeType> getAllProgramAttributeTypes()

Specified by:

getAllProgramAttributeTypes in interface ProgramWorkflowService

getProgramAttributeType

public ProgramAttributeType getProgramAttributeType(Integer id)

Specified by:

getProgramAttributeType in interface ProgramWorkflowService

getProgramAttributeTypeByUuid

public ProgramAttributeType getProgramAttributeTypeByUuid(String uuid)

Specified by:

getProgramAttributeTypeByUuid in interface ProgramWorkflowService

saveProgramAttributeType

public ProgramAttributeType saveProgramAttributeType(ProgramAttributeType type)

Specified by:

saveProgramAttributeType in interface ProgramWorkflowService

purgeProgramAttributeType

public void purgeProgramAttributeType(ProgramAttributeType type)

Specified by:

purgeProgramAttributeType in interface ProgramWorkflowService

getPatientProgramAttributeByUuid

public PatientProgramAttribute getPatientProgramAttributeByUuid(String uuid)

Specified by:

getPatientProgramAttributeByUuid in interface ProgramWorkflowService

getPatientProgramAttributeByAttributeName

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

Specified by:

getPatientProgramAttributeByAttributeName in interface ProgramWorkflowService

getPatientProgramByAttributeNameAndValue

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

Specified by:

getPatientProgramByAttributeNameAndValue in interface ProgramWorkflowService