curam.cpm.facade.intf

Interface HomeStudyHomeVisit

All Known Implementing Classes:

HomeStudyHomeVisit, curam.cpm.facade.impl.HomeStudyHomeVisit, HomeStudyHomeVisitFactory

@AccessLevel(value=EXTERNAL)
public interface HomeStudyHomeVisit

This process class provides facade functionality for Home Study Home Visit evidence.

Method Summary

Modifier and Type	Method and Description
curam.cpm.facade.struct.HomeStudyHomeVisitKey	createHomeStudyHomeVisit(curam.cpm.facade.struct.CreateHomeStudyHomeVisitDetails details) This method creates a new Home Visit for a Home Study.
void	deleteHomeStudyHomeVisit(curam.cpm.facade.struct.CancelHomeStudyHomeVisitKey key) This method logically deletes this Home Study Home Visit (set it's status to 'canceled').
curam.cpm.facade.struct.UserNameDetails	getHomeStudyHomeVisitConductedByUser(curam.cpm.facade.struct.HomeStudyHomeVisitKey key) This method is intended to be used by users responsible for managing home studies to get the details of the user who conducted the home study home visit.
curam.cpm.facade.struct.HomeStudyHomeVisitKey	modifyHomeStudyHomeVisit(curam.cpm.facade.struct.HomeStudyHomeVisitDtls details) This method modifies the details of the Home Study Home Visit.
curam.cpm.facade.struct.HomeStudyHomeVisitDtls	viewHomeStudyHomeVisit(curam.cpm.facade.struct.HomeStudyHomeVisitKey key) This method returns the details of a Home Study Home Visit.

Method Detail

createHomeStudyHomeVisit

@AccessLevel(value=EXTERNAL)
curam.cpm.facade.struct.HomeStudyHomeVisitKey createHomeStudyHomeVisit(curam.cpm.facade.struct.CreateHomeStudyHomeVisitDetails details)
                                                                                             throws curam.util.exception.AppException,
                                                                                                    curam.util.exception.InformationalException

This method creates a new Home Visit for a Home Study.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

viewHomeStudyHomeVisit

@AccessLevel(value=EXTERNAL)
curam.cpm.facade.struct.HomeStudyHomeVisitDtls viewHomeStudyHomeVisit(curam.cpm.facade.struct.HomeStudyHomeVisitKey key)
                                                                                            throws curam.util.exception.AppException,
                                                                                                   curam.util.exception.InformationalException

This method returns the details of a Home Study Home Visit.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

modifyHomeStudyHomeVisit

@AccessLevel(value=EXTERNAL)
curam.cpm.facade.struct.HomeStudyHomeVisitKey modifyHomeStudyHomeVisit(curam.cpm.facade.struct.HomeStudyHomeVisitDtls details)
                                                                                             throws curam.util.exception.AppException,
                                                                                                    curam.util.exception.InformationalException

This method modifies the details of the Home Study Home Visit.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

deleteHomeStudyHomeVisit

@AccessLevel(value=EXTERNAL)
void deleteHomeStudyHomeVisit(curam.cpm.facade.struct.CancelHomeStudyHomeVisitKey key)
                                                    throws curam.util.exception.AppException,
                                                           curam.util.exception.InformationalException

This method logically deletes this Home Study Home Visit (set it's status to 'canceled'). The cancel operation uses optimistic locking.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

getHomeStudyHomeVisitConductedByUser

@AccessLevel(value=EXTERNAL)
curam.cpm.facade.struct.UserNameDetails getHomeStudyHomeVisitConductedByUser(curam.cpm.facade.struct.HomeStudyHomeVisitKey key)
                                                                                                   throws curam.util.exception.AppException,
                                                                                                          curam.util.exception.InformationalException

This method is intended to be used by users responsible for managing home studies to get the details of the user who conducted the home study home visit.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException