public interface OutcomePlanGoal
Modifier and Type | Method and Description |
---|---|
void |
addCompletionDetails(curam.outcomeplanning.outcomeplan.facade.struct.OutcomePlanGoalCompletionDetails completionDetails)
Adds/updates completion details for the
OutcomePlanGoal . |
void |
addNote(curam.outcomeplanning.outcomeplan.facade.struct.NoteDetails noteDetails)
Adds a note to the given
OutcomePlanGoal . |
void |
cancelOutcomePlanGoal(curam.outcomeplanning.outcomeplan.facade.struct.CancelOutcomePlanGoalKey cancelKey)
Cancels the
OutcomePlanGoal . |
void |
createForClient(curam.outcomeplanning.outcomeplan.facade.struct.CreateOutcomePlanGoalDetails key)
Creates an
OutcomePlanGoal
for a client on an OutcomePlan using the given
details. |
void |
createForOutcomePlan(curam.outcomeplanning.outcomeplan.facade.struct.CreateOutcomePlanGoalDetails key)
Creates an
OutcomePlanGoal
for an OutcomePlan using
the given details. |
curam.outcomeplanning.outcomeplan.facade.struct.OutcomePlanGoalDetailsList |
listOutcomePlanGoalsForOutcomePlan(curam.outcomeplanning.outcomeplan.entity.struct.OutcomePlanKey key)
Lists all
OutcomePlanGoal
that exist for both the clients on an OutcomePlan and for the Outcome
Plan itself. |
curam.outcomeplanning.outcomeplan.facade.struct.OutcomePlanGoalLinkDetailsList |
listPotentialGoalsForOutcomePlan(curam.outcomeplanning.outcomeplan.entity.struct.OutcomePlanKey key)
Returns a list of
OutcomePlanGoalAdmin that may be
added to the given OutcomePlan . |
curam.outcomeplanning.outcomeplan.facade.struct.OutcomePlanGoalCompletionDetails |
readCompletionDetails(curam.outcomeplanning.outcomeplan.entity.struct.OutcomePlanGoalKey key)
Returns the completion details for the
OutcomePlanGoal . |
curam.outcomeplanning.outcomeplan.facade.struct.OutcomePlanContextPanelDetails |
readContextPanelDetails(curam.outcomeplanning.outcomeplan.entity.struct.OutcomePlanGoalKey key)
Reads the context panel details for the given
OutcomePlanGoal . |
curam.outcomeplanning.outcomeplan.facade.struct.OutcomePlanGoalNoteDetails |
readNotes(curam.outcomeplanning.outcomeplan.entity.struct.OutcomePlanGoalKey key)
Returns the notes for the given
OutcomePlanGoal . |
curam.outcomeplanning.outcomeplan.facade.struct.ReadOutcomePlanGoalDetails |
readOutcomePlanGoalDetailsForClient(curam.outcomeplanning.outcomeplan.entity.struct.OutcomePlanGoalKey key)
Reads the details of an
OutcomePlanGoal for a client. |
curam.outcomeplanning.outcomeplan.facade.struct.ReadOutcomePlanGoalDetails |
readOutcomePlanGoalDetailsForOutcomePlan(curam.outcomeplanning.outcomeplan.entity.struct.OutcomePlanGoalKey key)
Reads the details of an
OutcomePlanGoal for an OutcomePlan . |
curam.outcomeplanning.outcomeplan.facade.struct.ReadOutcomePlanGoalDetails |
readOutcomePlanGoalDetailsForUpdate(curam.outcomeplanning.outcomeplan.entity.struct.OutcomePlanGoalKey key)
Reads the details of an
OutcomePlanGoal to be updatedThis
method is intended to be used by users responsible for the management of
Outcome Planning. |
curam.core.sl.infrastructure.entity.struct.VersionNo |
readVersionDetails(curam.outcomeplanning.outcomeplan.entity.struct.OutcomePlanGoalKey key)
Reads the version number of an
OutcomePlanGoal record. |
void |
updateExpectedEndDate(curam.outcomeplanning.outcomeplan.facade.struct.OutcomePlanGoalEndDateDetails expectedEndDateDetails)
Updates the expected end date on the
OutcomePlanGoal , creating a new
expected end date history for the Outcome Plan Goal. |
void |
updateReason(curam.outcomeplanning.outcomeplan.facade.struct.UpdateOutcomePlanGoalReasonDetails updateReasonDetails)
Updates the
OutcomePlanGoal
reason. |
curam.outcomeplanning.outcomeplan.facade.struct.ExpectedEndDateHistoryList |
viewExpectedEndDateHistory(curam.outcomeplanning.outcomeplan.entity.struct.OutcomePlanGoalKey key)
Returns a list of the expected end date changes for the specified
OutcomePlanGoal . |
void createForClient(curam.outcomeplanning.outcomeplan.facade.struct.CreateOutcomePlanGoalDetails key) throws curam.util.exception.AppException, curam.util.exception.InformationalException
OutcomePlanGoal
for a client on an OutcomePlan
using the given
details. This method is intended to be used by users responsible for the
management of Outcome Planning.key
- The details of the Outcome Plan Goal to be createdcuram.util.exception.AppException
curam.util.exception.InformationalException
void createForOutcomePlan(curam.outcomeplanning.outcomeplan.facade.struct.CreateOutcomePlanGoalDetails key) throws curam.util.exception.AppException, curam.util.exception.InformationalException
OutcomePlanGoal
for an OutcomePlan
using
the given details. This method is intended to be used by users responsible
for the management of Outcome Planning.key
- The details of the Outcome Plan Goal to be createdcuram.util.exception.AppException
curam.util.exception.InformationalException
curam.outcomeplanning.outcomeplan.facade.struct.OutcomePlanGoalDetailsList listOutcomePlanGoalsForOutcomePlan(curam.outcomeplanning.outcomeplan.entity.struct.OutcomePlanKey key) throws curam.util.exception.AppException, curam.util.exception.InformationalException
OutcomePlanGoal
that exist for both the clients on an OutcomePlan
and for the Outcome
Plan itself. This method is intended to be used by users responsible for
the management of Outcome Planning.key
- the unique identifier of the Outcome Plan the retrieved Outcome
Plan Goals are to be related tocuram.util.exception.AppException
curam.util.exception.InformationalException
curam.outcomeplanning.outcomeplan.facade.struct.ReadOutcomePlanGoalDetails readOutcomePlanGoalDetailsForClient(curam.outcomeplanning.outcomeplan.entity.struct.OutcomePlanGoalKey key) throws curam.util.exception.AppException, curam.util.exception.InformationalException
OutcomePlanGoal
for a client. This
method is intended to be used by users responsible for the management of
Outcome Planning.key
- The unique identifier of the Outcome Plan Goal whose details
are to be retrievedcuram.util.exception.AppException
curam.util.exception.InformationalException
curam.outcomeplanning.outcomeplan.facade.struct.ReadOutcomePlanGoalDetails readOutcomePlanGoalDetailsForOutcomePlan(curam.outcomeplanning.outcomeplan.entity.struct.OutcomePlanGoalKey key) throws curam.util.exception.AppException, curam.util.exception.InformationalException
OutcomePlanGoal
for an OutcomePlan
. This method is
intended to be used by users responsible for the management of Outcome
Planning.key
- The unique identifier of the Outcome Plan Goal whose details
are to be retrievedcuram.util.exception.AppException
curam.util.exception.InformationalException
void cancelOutcomePlanGoal(curam.outcomeplanning.outcomeplan.facade.struct.CancelOutcomePlanGoalKey cancelKey) throws curam.util.exception.AppException, curam.util.exception.InformationalException
OutcomePlanGoal
. This method is
intended to be used by users responsible for the management of Outcome
Planning.cancelKey
- The unique identifier of the Outcome Plan Goal to cancel
and its version numbercuram.util.exception.AppException
curam.util.exception.InformationalException
void addCompletionDetails(curam.outcomeplanning.outcomeplan.facade.struct.OutcomePlanGoalCompletionDetails completionDetails) throws curam.util.exception.AppException, curam.util.exception.InformationalException
OutcomePlanGoal
. This method is
intended to be used by users responsible for the management of Outcome
Planning.completionDetails
- Details regarding the completion of the Outcome
Plan Goalcuram.util.exception.AppException
curam.util.exception.InformationalException
curam.outcomeplanning.outcomeplan.facade.struct.OutcomePlanGoalCompletionDetails readCompletionDetails(curam.outcomeplanning.outcomeplan.entity.struct.OutcomePlanGoalKey key) throws curam.util.exception.AppException, curam.util.exception.InformationalException
OutcomePlanGoal
. This method is
intended to be used by users responsible for the management of Outcome
Planning.key
- The unique identifier of the Outcome Plan Goalcuram.util.exception.AppException
curam.util.exception.InformationalException
void addNote(curam.outcomeplanning.outcomeplan.facade.struct.NoteDetails noteDetails) throws curam.util.exception.AppException, curam.util.exception.InformationalException
OutcomePlanGoal
. This method is
intended to be used by users responsible for the management of Outcome
Planning.noteDetails
- Details of the note and the Outcome Plan Goal the note
is to be added tocuram.util.exception.AppException
curam.util.exception.InformationalException
void updateExpectedEndDate(curam.outcomeplanning.outcomeplan.facade.struct.OutcomePlanGoalEndDateDetails expectedEndDateDetails) throws curam.util.exception.AppException, curam.util.exception.InformationalException
OutcomePlanGoal
, creating a new
expected end date history for the Outcome Plan Goal. This method is
intended to be used by users responsible for the management of Outcome
Planning.expectedEndDateDetails
- The new expected end date, and the reason
for changecuram.util.exception.AppException
curam.util.exception.InformationalException
void updateReason(curam.outcomeplanning.outcomeplan.facade.struct.UpdateOutcomePlanGoalReasonDetails updateReasonDetails) throws curam.util.exception.AppException, curam.util.exception.InformationalException
OutcomePlanGoal
reason. This method is intended to be used by users responsible for the
management of Outcome Planning.updateReasonDetails
- The reason text to be updatedcuram.util.exception.AppException
curam.util.exception.InformationalException
curam.outcomeplanning.outcomeplan.facade.struct.ReadOutcomePlanGoalDetails readOutcomePlanGoalDetailsForUpdate(curam.outcomeplanning.outcomeplan.entity.struct.OutcomePlanGoalKey key) throws curam.util.exception.AppException, curam.util.exception.InformationalException
OutcomePlanGoal
to be updatedThis
method is intended to be used by users responsible for the management of
Outcome Planning.key
- The unique identifier of the Outcome Plan Goal whose details
are to be retrieved for updatingcuram.util.exception.AppException
curam.util.exception.InformationalException
curam.core.sl.infrastructure.entity.struct.VersionNo readVersionDetails(curam.outcomeplanning.outcomeplan.entity.struct.OutcomePlanGoalKey key) throws curam.util.exception.AppException, curam.util.exception.InformationalException
OutcomePlanGoal
record. This
method is intended to be used by users responsible for the management of
outcome plans.key
- The key of the outcome plan goal.curam.util.exception.AppException
curam.util.exception.InformationalException
curam.outcomeplanning.outcomeplan.facade.struct.OutcomePlanContextPanelDetails readContextPanelDetails(curam.outcomeplanning.outcomeplan.entity.struct.OutcomePlanGoalKey key) throws curam.util.exception.AppException, curam.util.exception.InformationalException
OutcomePlanGoal
. This method is
intended to be used by users responsible for the management of outcome
plans.key
- The unique identifier of the outcome plan goalcuram.util.exception.AppException
curam.util.exception.InformationalException
curam.outcomeplanning.outcomeplan.facade.struct.ExpectedEndDateHistoryList viewExpectedEndDateHistory(curam.outcomeplanning.outcomeplan.entity.struct.OutcomePlanGoalKey key) throws curam.util.exception.AppException, curam.util.exception.InformationalException
OutcomePlanGoal
. This method is
intended to be used by users responsible for the management of outcome
plans.key
- unique identifier of the outcome plan goalcuram.util.exception.AppException
curam.util.exception.InformationalException
curam.outcomeplanning.outcomeplan.facade.struct.OutcomePlanGoalNoteDetails readNotes(curam.outcomeplanning.outcomeplan.entity.struct.OutcomePlanGoalKey key) throws curam.util.exception.AppException, curam.util.exception.InformationalException
OutcomePlanGoal
. This method is
intended to be used by users responsible for the management of outcome
plans.curam.util.exception.AppException
curam.util.exception.InformationalException
curam.outcomeplanning.outcomeplan.facade.struct.OutcomePlanGoalLinkDetailsList listPotentialGoalsForOutcomePlan(curam.outcomeplanning.outcomeplan.entity.struct.OutcomePlanKey key) throws curam.util.exception.AppException, curam.util.exception.InformationalException
OutcomePlanGoalAdmin
that may be
added to the given OutcomePlan
. This method is
intended to be used by users responsible for the management of outcome
plans.key
- The unique identifier of the outcome plan the goal is to be
added tocuram.util.exception.AppException
curam.util.exception.InformationalException