org.domain.rhims.manager
Interface CaseManager

All Known Implementing Classes:
CaseManagerAction

public interface CaseManager

The CaseManager is the business/application logic that handles the CaseFiles between patients and clinicians in the system. It is responsible for registering creating new cases, retrieving a specific case given a patient and a clinician, and retrieving all the cases for a given patient. It is a component of the Application layer.

Author:
Mitch Williams

Method Summary
 java.lang.String createCase(long patientID, long clinicianID)
          This method creates a new CaseFile between the Patient and Clinician that have the respective supplied ID numbers.
 java.lang.String createCase(Patient patient, Clinician clinician)
          This method creates a new CaseFile between the supplied Patient and Clinician.
 CaseFile getCase(Patient patient, Clinician clinician)
          This method retrieves the CaseFile for the supplied Patient, Clinician combo.
 java.util.List<CaseFile> getCases(Patient patient)
          Retrieves all of the cases associated with Patient patient
 

Method Detail

createCase

java.lang.String createCase(Patient patient,
                            Clinician clinician)
This method creates a new CaseFile between the supplied Patient and Clinician.

Parameters:
patient - the Patient to use
clinician - the Clinician to use
Returns:
"success" if the case is created, "failure" if not.

createCase

java.lang.String createCase(long patientID,
                            long clinicianID)
This method creates a new CaseFile between the Patient and Clinician that have the respective supplied ID numbers.

Parameters:
patientID - the ID of the patient to use
clinicianID - the ID of the clinician to use
Returns:
"success" if the case is created, "failure" if not.

getCase

CaseFile getCase(Patient patient,
                 Clinician clinician)
This method retrieves the CaseFile for the supplied Patient, Clinician combo.

Parameters:
patient - the Patient to get the CaseFile for
clinician - the Clinician to get the CaseFile for
Returns:
the CaseFile if it is found, null otherwise

getCases

java.util.List<CaseFile> getCases(Patient patient)
Retrieves all of the cases associated with Patient patient

Parameters:
patient - Patient to get the cases for
Returns:
returns a list of CaseFiles as List