public interface Progress
Modifier and Type | Method and Description |
---|---|
curam.progress.entity.struct.ProgressKey |
addProgress(curam.progress.facade.struct.UpdateProgressDetails progressDetails)
Updates progress information for the outcome plan goal.
|
void |
cancelProgress(curam.progress.facade.struct.ProgressCancelKey cancelKey)
Removes a Progress record in the system.
|
curam.progress.facade.struct.ProgressGraph |
chartProgress(curam.progress.facade.struct.ProgressRelatedDetailsKey key)
Builds the plot data for the the Progress Chart
|
void |
modifyProgress(curam.progress.facade.struct.ProgressDetails modifyDetails)
Modifies a Progress record in the system.
|
curam.progress.facade.struct.ProgressChartXmlDetails |
readProgressChartDetails(curam.progress.facade.struct.ProgressRelatedDetailsKey key)
Retrieves all the progress details related to the given related identifer
and type.
|
curam.progress.facade.struct.ProgressDetails |
readProgressDetails(curam.progress.entity.struct.ProgressKey key)
Reads the progress details for the given progress identifier.
|
curam.outcomeplanning.outcomeplan.facade.struct.ProgressAdminDetailsList |
readProgressLevelsAndCurrentProgressDetails(curam.progress.facade.struct.ProgressRelatedDetailsKey key)
Reads the possible progress values that may be applied to the progressable
object, and the current progress for the progressable object.
|
curam.progress.facade.struct.ProgressDetailsForModify |
viewProgressForModify(curam.progress.entity.struct.ProgressKey key)
View the details for a Progress record in the system.
|
curam.progress.facade.struct.ProgressHomePageDetails |
viewProgressOverview(curam.progress.facade.struct.ProgressRelatedDetailsKey key)
Gives an overview of the progress recorded against the outcome plan goal.
|
curam.outcomeplanning.outcomeplan.facade.struct.ProgressAdminDetailsList readProgressLevelsAndCurrentProgressDetails(curam.progress.facade.struct.ProgressRelatedDetailsKey key) throws curam.util.exception.AppException, curam.util.exception.InformationalException
key
- unique identifier and type of the object the progress is
related tocuram.util.exception.AppException
curam.util.exception.InformationalException
curam.progress.entity.struct.ProgressKey addProgress(curam.progress.facade.struct.UpdateProgressDetails progressDetails) throws curam.util.exception.AppException, curam.util.exception.InformationalException
progressDetails
- progress value and commentscuram.util.exception.AppException
curam.util.exception.InformationalException
curam.progress.facade.struct.ProgressHomePageDetails viewProgressOverview(curam.progress.facade.struct.ProgressRelatedDetailsKey key) throws curam.util.exception.AppException, curam.util.exception.InformationalException
key
- unique identifier of the outcome plan goalcuram.util.exception.AppException
curam.util.exception.InformationalException
curam.progress.facade.struct.ProgressChartXmlDetails readProgressChartDetails(curam.progress.facade.struct.ProgressRelatedDetailsKey key) throws curam.util.exception.AppException, curam.util.exception.InformationalException
key
- the related identifier and type to retrive the data fromcuram.util.exception.AppException
curam.util.exception.InformationalException
void modifyProgress(curam.progress.facade.struct.ProgressDetails modifyDetails) throws curam.util.exception.AppException, curam.util.exception.InformationalException
modifyDetails
- for a Progress, the progress value and notes can be
modified.curam.util.exception.AppException
curam.util.exception.InformationalException
void cancelProgress(curam.progress.facade.struct.ProgressCancelKey cancelKey) throws curam.util.exception.AppException, curam.util.exception.InformationalException
cancelKey
- unique identifier of the record to cancel and the version
number used for versioning control.curam.util.exception.AppException
curam.util.exception.InformationalException
curam.progress.facade.struct.ProgressDetailsForModify viewProgressForModify(curam.progress.entity.struct.ProgressKey key) throws curam.util.exception.AppException, curam.util.exception.InformationalException
key
- unique identifier for a Progress recordcuram.util.exception.AppException
curam.util.exception.InformationalException
curam.progress.facade.struct.ProgressDetails readProgressDetails(curam.progress.entity.struct.ProgressKey key) throws curam.util.exception.AppException, curam.util.exception.InformationalException
key
- unique identifier of the progress record the retrieved details
are in relation tocuram.util.exception.AppException
curam.util.exception.InformationalException
curam.progress.facade.struct.ProgressGraph chartProgress(curam.progress.facade.struct.ProgressRelatedDetailsKey key) throws curam.util.exception.AppException, curam.util.exception.InformationalException
key
- unique identifier of the outcome plan goalcuram.util.exception.AppException
curam.util.exception.InformationalException