curam.outcomeplanning.outcomeplan.facade.intf

Interface ActivityAdminEvidenceLink

All Known Implementing Classes:

ActivityAdminEvidenceLink, curam.outcomeplanning.outcomeplan.facade.impl.ActivityAdminEvidenceLink, ActivityAdminEvidenceLinkFactory

public interface ActivityAdminEvidenceLink

Method Summary

Modifier and Type	Method and Description
void	addEvidence(curam.outcomeplanning.outcomeplan.facade.struct.ActivityAdminAddEvidenceDetails details) Creates a ActivityAdminEvidenceLink with the given details.
void	editEvidence(curam.outcomeplanning.outcomeplan.facade.struct.EditActivityAdminEvidenceKey key) Edits the activity admin evidence link.
curam.outcomeplanning.outcomeplan.facade.struct.ActivityAdminEvidenceTypeList	listEvidence(curam.outcomeplanning.outcomeplan.facade.struct.ActivityAdminIDAndTypeKey key) Returns a list of all enabled Evidence Types associated for the given outcome plan activity.
curam.outcomeplanning.outcomeplan.facade.struct.ActivityAdminEvidenceTypeList	listEvidenceByLocation(curam.outcomeplanning.outcomeplan.facade.struct.ActivityAdminIDTypeAndLocationKey key) Returns a list by location of all enabled Evidence Types associated for the given outcome plan activity.
curam.outcomeplanning.outcomeplan.facade.struct.LocationList	listLocations() Returns a filtered list of all enabled Evidence Storage locations.
curam.outcomeplanning.outcomeplan.facade.struct.ActivityAdminEvidenceTypeList	listPotentialEvidence(curam.outcomeplanning.outcomeplan.facade.struct.ActivityAdminIDAndTypeKey key) Returns a list of enabled Evidence Types in the system not already associated to the specified administration outcome plan activity.
curam.outcomeplanning.outcomeplan.facade.struct.ActivityAdminEvidenceType	readEvidence(curam.outcomeplanning.outcomeplan.facade.struct.ReadActivityAdminEvidenceKey key) Reads the activity admin evidence link.
void	removeEvidence(curam.outcomeplanning.outcomeplan.facade.struct.RemoveActivityAdminEvidenceKey key) Removes the association between an administration outcome plan activity and an evidence type.

Method Detail

addEvidence

void addEvidence(curam.outcomeplanning.outcomeplan.facade.struct.ActivityAdminAddEvidenceDetails details)
          throws curam.util.exception.AppException,
                 curam.util.exception.InformationalException

Creates a ActivityAdminEvidenceLink with the given details. This method is intended to be used by users responsible for administrating adding evidnce to an aciton on an outcome plan.

Parameters:

details - The details of the action to be created

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

listPotentialEvidence

curam.outcomeplanning.outcomeplan.facade.struct.ActivityAdminEvidenceTypeList listPotentialEvidence(curam.outcomeplanning.outcomeplan.facade.struct.ActivityAdminIDAndTypeKey key)
                                                                                             throws curam.util.exception.AppException,
                                                                                                    curam.util.exception.InformationalException

Returns a list of enabled Evidence Types in the system not already associated to the specified administration outcome plan activity. This method is intended to be used by users responsible for the administration of outcome plans.

Parameters:

key - the unique identifier and type of the outcome plan activty

Returns:

A list of enabled Evidence Types that can be associated to the outcome plan activity.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

listEvidence

curam.outcomeplanning.outcomeplan.facade.struct.ActivityAdminEvidenceTypeList listEvidence(curam.outcomeplanning.outcomeplan.facade.struct.ActivityAdminIDAndTypeKey key)
                                                                                    throws curam.util.exception.AppException,
                                                                                           curam.util.exception.InformationalException

Returns a list of all enabled Evidence Types associated for the given outcome plan activity. This method is intended to be used by users responsible for the administration of outcome plans.

Parameters:

key - The unique identifier and type of the administration outcome plan activity to search with

Returns:

A list of all active Evidence Types configured for the administration outcome plan activity record

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

removeEvidence

void removeEvidence(curam.outcomeplanning.outcomeplan.facade.struct.RemoveActivityAdminEvidenceKey key)
             throws curam.util.exception.AppException,
                    curam.util.exception.InformationalException

Removes the association between an administration outcome plan activity and an evidence type. This method is intended to be used by users responsible for the administration of outcome plans.

Parameters:

key - The details of the evidence type the administratiion outcome plan activity is to remove its association to

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

listEvidenceByLocation

curam.outcomeplanning.outcomeplan.facade.struct.ActivityAdminEvidenceTypeList listEvidenceByLocation(curam.outcomeplanning.outcomeplan.facade.struct.ActivityAdminIDTypeAndLocationKey key)
                                                                                              throws curam.util.exception.AppException,
                                                                                                     curam.util.exception.InformationalException

Returns a list by location of all enabled Evidence Types associated for the given outcome plan activity. This method is intended to be used by users responsible for the administration of outcome plans.

Parameters:

key - The unique identifier, type and location of the administration outcome plan activity to search with

Returns:

A list of all active Evidence Types configured for the administration outcome plan activity record

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

editEvidence

void editEvidence(curam.outcomeplanning.outcomeplan.facade.struct.EditActivityAdminEvidenceKey key)
           throws curam.util.exception.AppException,
                  curam.util.exception.InformationalException

Edits the activity admin evidence link. This method is intended to be used by users responsible for the administration of outcome plans.

Parameters:

key - The details of the evidence type the administration outcome plan activity is to modify.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

readEvidence

curam.outcomeplanning.outcomeplan.facade.struct.ActivityAdminEvidenceType readEvidence(curam.outcomeplanning.outcomeplan.facade.struct.ReadActivityAdminEvidenceKey key)
                                                                                throws curam.util.exception.AppException,
                                                                                       curam.util.exception.InformationalException

Reads the activity admin evidence link. This method is intended to be used by users responsible for the administration of outcome plans.

Parameters:

key - The details of the evidence type to be read.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

listLocations

curam.outcomeplanning.outcomeplan.facade.struct.LocationList listLocations()
                                                                    throws curam.util.exception.AppException,
                                                                           curam.util.exception.InformationalException

Returns a filtered list of all enabled Evidence Storage locations. This method is intended to be used by users responsible for the administration of outcome plans.

Returns:

A filtered list of all enabled Evidence Storage locations, if the participant data case is disabled then the Person code will not be returned.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException