public interface OutcomePlanExpectedOutcome
Modifier and Type | Method and Description |
---|---|
void |
addClients(curam.outcomeplanning.outcomeplan.facade.struct.ExpectedOutcomeClientDetails clientDetails,
curam.outcomeplanning.outcomeplan.entity.struct.OutcomePlanExpectedOutcomeKey key)
Adds client(s) to the
OutcomePlanExpectedOutcome . |
void |
addExpectedOutcomeCompletionDetails(curam.outcomeplanning.outcomeplan.facade.struct.ExpectedOutcomeCompletionDetails completionDetails)
Adds/updates completion details for the
OutcomePlanExpectedOutcome . |
void |
addExpectedOutcomeNote(curam.outcomeplanning.outcomeplan.facade.struct.NoteDetails noteDetails)
Adds a note to the
OutcomePlanExpectedOutcome . |
void |
addFactors(curam.outcomeplanning.outcomeplan.facade.struct.OutcomePlanFactorLinks factorDetails,
curam.outcomeplanning.outcomeplan.entity.struct.OutcomePlanExpectedOutcomeKey key)
Adds factor(s) to the
OutcomePlanExpectedOutcome , with a
specified reason. |
void |
cancelExpectedOutcome(curam.outcomeplanning.outcomeplan.facade.struct.OutcomePlanExpectedOutcomeKey cancelKey)
Cancels the
OutcomePlanExpectedOutcome . |
void |
editExpectedOutcome(curam.outcomeplanning.outcomeplan.facade.struct.ExpectedOutcomeEditDetails editDetails)
Updates the
OutcomePlanExpectedOutcome , the
name can be modified if it is a user defined expected outcome, the reason
can also be modified. |
curam.outcomeplanning.outcomeplan.facade.struct.CompleteExpectedOutcomeDetails |
getCompleteExpectedOutcomeDetails(curam.outcomeplanning.outcomeplan.entity.struct.OutcomePlanExpectedOutcomeKey key)
Returns the version number of, and any informationals relating to, the
specified
OutcomePlanExpectedOutcome . |
curam.outcomeplanning.outcomeplan.facade.struct.VersionNoKey |
getVersionNo(curam.outcomeplanning.outcomeplan.entity.struct.OutcomePlanExpectedOutcomeKey key)
Returns the version number of the specified
OutcomePlanExpectedOutcome . |
curam.outcomeplanning.outcomeplan.facade.struct.FactorDeliveryLinkDetailsList |
listActiveExpectedOutcomeFactors(curam.outcomeplanning.outcomeplan.entity.struct.OutcomePlanExpectedOutcomeKey key)
List the factors which are currently added to the
OutcomePlanExpectedOutcome . |
curam.outcomeplanning.outcomeplan.facade.struct.ListCaseClientsNameAndAgeResult |
listClients(curam.outcomeplanning.outcomeplan.entity.struct.OutcomePlanExpectedOutcomeKey key)
Lists the clients currently associated to this
OutcomePlanExpectedOutcome . |
curam.outcomeplanning.outcomeplan.facade.struct.OutcomePlanActivityDetailsList |
listCurrentActivities(curam.outcomeplanning.outcomeplan.entity.struct.OutcomePlanExpectedOutcomeKey key)
Lists the current activities associated with the factors which are
currently linked to this
OutcomePlanExpectedOutcome . |
curam.outcomeplanning.outcomeplan.facade.struct.OutcomePlanExpectedOutcomeList |
listExpectedOutcomesForOutcomePlan(curam.outcomeplanning.outcomeplan.entity.struct.OutcomePlanKey key)
Returns a list of
OutcomePlanExpectedOutcome for the
given OutcomePlan .This
method is intended to be used by users responsible for the management of
outcome plans. |
curam.outcomeplanning.outcomeplan.facade.struct.ListCaseClientsNameAndAgeResult |
listPotentialClientsToAdd(curam.outcomeplanning.outcomeplan.entity.struct.OutcomePlanExpectedOutcomeKey key)
Lists the clients on the outcome plan which have not already been added to
this
OutcomePlanExpectedOutcome . |
curam.outcomeplanning.outcomeplan.facade.struct.FactorDeliverySummaryDetailsList |
listPotentialFactorsToAdd(curam.outcomeplanning.outcomeplan.entity.struct.OutcomePlanExpectedOutcomeKey key)
Lists the factors on the outcome plan which have not already been added to
this
OutcomePlanExpectedOutcome . |
curam.outcomeplanning.outcomeplan.facade.struct.OutcomePlanRecommendedActivityDetailsList |
listRecommendedActivities(curam.outcomeplanning.outcomeplan.facade.struct.OutcomePlanExpectedOutcomeKey key)
Lists all activity recommendations that exist for the
OutcomePlan on which the given
expected outcome lives. |
curam.outcomeplanning.outcomeplan.facade.struct.ExpectedOutcomeCompletionDetails |
readCompletionDetails(curam.outcomeplanning.outcomeplan.entity.struct.OutcomePlanExpectedOutcomeKey key)
Returns the completion details for the
OutcomePlanExpectedOutcome . |
curam.outcomeplanning.outcomeplan.facade.struct.OutcomePlanContextPanelDetails |
readContextPanelDetails(curam.outcomeplanning.outcomeplan.entity.struct.OutcomePlanExpectedOutcomeKey key)
Reads the context panel details for the given
OutcomePlanExpectedOutcome . |
curam.outcomeplanning.outcomeplan.facade.struct.ExpectedOutcomeReadForEditDetails |
readExpectedOutcomeForEdit(curam.outcomeplanning.outcomeplan.facade.struct.OutcomePlanExpectedOutcomeKey key)
Reads the details of the
OutcomePlanExpectedOutcome
required for the modification. |
curam.outcomeplanning.outcomeplan.facade.struct.LatestNoteDetails |
readLatestNote(curam.outcomeplanning.outcomeplan.entity.struct.OutcomePlanExpectedOutcomeKey key)
Reads the latest note for the specified expected outcome
|
curam.outcomeplanning.outcomeplan.facade.struct.OutcomePlanExpectedOutcomeNoteDetails |
readNotes(curam.outcomeplanning.outcomeplan.entity.struct.OutcomePlanExpectedOutcomeKey key)
Returns the notes for the given
OutcomePlanExpectedOutcome . |
curam.outcomeplanning.outcomeplan.facade.struct.OutcomePlanObjectiveWorkspaceDetails |
readWorkspaceObjectiveDetails(curam.outcomeplanning.outcomeplan.entity.struct.OutcomePlanExpectedOutcomeKey key)
Reads the details of the expected outcome to be displayed in the workspace
|
void |
removeClients(curam.outcomeplanning.outcomeplan.facade.struct.ExpectedOutcomeClientDetails clientDetails,
curam.outcomeplanning.outcomeplan.entity.struct.OutcomePlanExpectedOutcomeKey key)
Removes client(s) from the
OutcomePlanExpectedOutcome . |
void |
removeFactors(curam.outcomeplanning.outcomeplan.facade.struct.OutcomePlanFactorLinks factorDetails,
curam.outcomeplanning.outcomeplan.entity.struct.OutcomePlanExpectedOutcomeKey key)
Removes factor(s) from the
OutcomePlanExpectedOutcome , with a
specified reason.This method is intended to be used by users responsible
for the management of outcome plans. |
curam.outcomeplanning.outcomeplan.facade.struct.ExpectedOutcomeSelectList |
searchForExpectedOutcomes(curam.outcomeplanning.outcomeplan.facade.struct.ExpectedOutcomeSearchDetails details)
Searches expectedoutcome for records that mach the search criteria.
|
void |
updateExpectedEndDate(curam.outcomeplanning.outcomeplan.facade.struct.ExpectedOutcomeEndDateDetails expectedEndDateDetails)
Updates the expected end date on the
OutcomePlanExpectedOutcome ,
creating a new expected outcome history. |
curam.outcomeplanning.outcomeplan.facade.struct.ExpectedEndDateHistoryList |
viewExpectedEndDateHistory(curam.outcomeplanning.outcomeplan.entity.struct.OutcomePlanExpectedOutcomeKey key)
Returns a list of the expected end date changes for the specified
OutcomePlanExpectedOutcome . |
curam.outcomeplanning.outcomeplan.facade.struct.FactorDeliveryLinkDetails |
viewExpectedOutcomeFactorDetails(curam.outcomeplanning.outcomeplan.entity.struct.FactorDeliveryLinkKey key)
List the factors which have been added/removed from this
OutcomePlanExpectedOutcome . |
curam.outcomeplanning.outcomeplan.facade.struct.FactorDeliveryLinkDetailsList |
viewExpectedOutcomeFactors(curam.outcomeplanning.outcomeplan.entity.struct.OutcomePlanExpectedOutcomeKey key)
Lists the factors that have been added and removed to the
OutcomePlanExpectedOutcome . |
curam.outcomeplanning.outcomeplan.facade.struct.OutcomePlanExpectedOutcomeHomePageDetails |
viewExpectedOutcomeHome(curam.outcomeplanning.outcomeplan.entity.struct.OutcomePlanExpectedOutcomeKey key)
Reads the home page details for an
OutcomePlanExpectedOutcome . |
curam.outcomeplanning.outcomeplan.facade.struct.OutcomePlanExpectedOutcomeList listExpectedOutcomesForOutcomePlan(curam.outcomeplanning.outcomeplan.entity.struct.OutcomePlanKey key) throws curam.util.exception.AppException, curam.util.exception.InformationalException
OutcomePlanExpectedOutcome
for 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 plancuram.util.exception.AppException
curam.util.exception.InformationalException
curam.outcomeplanning.outcomeplan.facade.struct.OutcomePlanExpectedOutcomeHomePageDetails viewExpectedOutcomeHome(curam.outcomeplanning.outcomeplan.entity.struct.OutcomePlanExpectedOutcomeKey key) throws curam.util.exception.AppException, curam.util.exception.InformationalException
OutcomePlanExpectedOutcome
. This
method is intended to be used by users responsible for the management of
outcome plans.key
- the unique identifier of the outcome plan expected outcomecuram.util.exception.AppException
curam.util.exception.InformationalException
void addExpectedOutcomeNote(curam.outcomeplanning.outcomeplan.facade.struct.NoteDetails noteDetails) throws curam.util.exception.AppException, curam.util.exception.InformationalException
OutcomePlanExpectedOutcome
. This
method is intended to be used by users responsible for the management of
outcome plans.noteDetails
- details of the note and the expected outcome to add tocuram.util.exception.AppException
curam.util.exception.InformationalException
void addExpectedOutcomeCompletionDetails(curam.outcomeplanning.outcomeplan.facade.struct.ExpectedOutcomeCompletionDetails completionDetails) throws curam.util.exception.AppException, curam.util.exception.InformationalException
OutcomePlanExpectedOutcome
. This
method is intended to be used by users responsible for the management of
outcome plans.completionDetails
- details regarding the completion of the expected
outcomecuram.util.exception.AppException
curam.util.exception.InformationalException
void editExpectedOutcome(curam.outcomeplanning.outcomeplan.facade.struct.ExpectedOutcomeEditDetails editDetails) throws curam.util.exception.AppException, curam.util.exception.InformationalException
OutcomePlanExpectedOutcome
, the
name can be modified if it is a user defined expected outcome, the reason
can also be modified. This method is intended to be used by users
responsible for the management of outcome plans.editDetails
- optionally a new name, reason textcuram.util.exception.AppException
curam.util.exception.InformationalException
void updateExpectedEndDate(curam.outcomeplanning.outcomeplan.facade.struct.ExpectedOutcomeEndDateDetails expectedEndDateDetails) throws curam.util.exception.AppException, curam.util.exception.InformationalException
OutcomePlanExpectedOutcome
,
creating a new expected outcome history. This method is intended to be
used by users responsible for the management of outcome plans.expectedEndDateDetails
- new expected end date and reason for changecuram.util.exception.AppException
curam.util.exception.InformationalException
curam.outcomeplanning.outcomeplan.facade.struct.ExpectedEndDateHistoryList viewExpectedEndDateHistory(curam.outcomeplanning.outcomeplan.entity.struct.OutcomePlanExpectedOutcomeKey key) throws curam.util.exception.AppException, curam.util.exception.InformationalException
OutcomePlanExpectedOutcome
. This
method is intended to be used by users responsible for the management of
outcome plans.key
- unique identifier of the outcome plan expected outcomecuram.util.exception.AppException
curam.util.exception.InformationalException
curam.outcomeplanning.outcomeplan.facade.struct.ExpectedOutcomeCompletionDetails readCompletionDetails(curam.outcomeplanning.outcomeplan.entity.struct.OutcomePlanExpectedOutcomeKey key) throws curam.util.exception.AppException, curam.util.exception.InformationalException
OutcomePlanExpectedOutcome
. This
method is intended to be used by users responsible for the management of
outcome plans.key
- unique identifier of the expedcted outcomecuram.util.exception.AppException
curam.util.exception.InformationalException
curam.outcomeplanning.outcomeplan.facade.struct.ExpectedOutcomeReadForEditDetails readExpectedOutcomeForEdit(curam.outcomeplanning.outcomeplan.facade.struct.OutcomePlanExpectedOutcomeKey key) throws curam.util.exception.AppException, curam.util.exception.InformationalException
OutcomePlanExpectedOutcome
required for the modification. This method is intended to be used by users
responsible for the management of outcome plans.key
- unique identifier of the outcome plan expected outcomecuram.util.exception.AppException
curam.util.exception.InformationalException
void addFactors(curam.outcomeplanning.outcomeplan.facade.struct.OutcomePlanFactorLinks factorDetails, curam.outcomeplanning.outcomeplan.entity.struct.OutcomePlanExpectedOutcomeKey key) throws curam.util.exception.AppException, curam.util.exception.InformationalException
OutcomePlanExpectedOutcome
, with a
specified reason. This method is intended to be used by users responsible
for the management of outcome plans.factorDetails
- tab delimited list of factors and a reason for adding
themkey
- unique identifier of the expected outcome to add the factors tocuram.util.exception.AppException
curam.util.exception.InformationalException
void removeFactors(curam.outcomeplanning.outcomeplan.facade.struct.OutcomePlanFactorLinks factorDetails, curam.outcomeplanning.outcomeplan.entity.struct.OutcomePlanExpectedOutcomeKey key) throws curam.util.exception.AppException, curam.util.exception.InformationalException
OutcomePlanExpectedOutcome
, with a
specified reason.This method is intended to be used by users responsible
for the management of outcome plans.factorDetails
- Tab delimited list of factors and a reason for
removing themkey
- unique identifier of the expected outcome to remove the
factor(s) fromcuram.util.exception.AppException
curam.util.exception.InformationalException
curam.outcomeplanning.outcomeplan.facade.struct.FactorDeliverySummaryDetailsList listPotentialFactorsToAdd(curam.outcomeplanning.outcomeplan.entity.struct.OutcomePlanExpectedOutcomeKey key) throws curam.util.exception.AppException, curam.util.exception.InformationalException
OutcomePlanExpectedOutcome
. This
method is intended to be used by users responsible for the management of
outcome plans.key
- unique identifier of the outcome plan and expected outcomecuram.util.exception.AppException
curam.util.exception.InformationalException
curam.outcomeplanning.outcomeplan.facade.struct.FactorDeliveryLinkDetailsList viewExpectedOutcomeFactors(curam.outcomeplanning.outcomeplan.entity.struct.OutcomePlanExpectedOutcomeKey key) throws curam.util.exception.AppException, curam.util.exception.InformationalException
OutcomePlanExpectedOutcome
. This
method is intended to be used by users responsible for the management of
outcome plans.key
- unique identifier of the outcome plan expected outcomecuram.util.exception.AppException
curam.util.exception.InformationalException
void cancelExpectedOutcome(curam.outcomeplanning.outcomeplan.facade.struct.OutcomePlanExpectedOutcomeKey cancelKey) throws curam.util.exception.AppException, curam.util.exception.InformationalException
OutcomePlanExpectedOutcome
. This
method is intended to be used by users responsible for the management of
outcome plans.key
- unique identifier of the outcome plan expected outcome to
cancel and its version numbercuram.util.exception.AppException
curam.util.exception.InformationalException
curam.outcomeplanning.outcomeplan.facade.struct.FactorDeliveryLinkDetailsList listActiveExpectedOutcomeFactors(curam.outcomeplanning.outcomeplan.entity.struct.OutcomePlanExpectedOutcomeKey key) throws curam.util.exception.AppException, curam.util.exception.InformationalException
OutcomePlanExpectedOutcome
. This
method is intended to be used by users responsible for the management of
outcome plans.key
- unique identifier of the outcome plan expected outcomecuram.util.exception.AppException
curam.util.exception.InformationalException
curam.outcomeplanning.outcomeplan.facade.struct.FactorDeliveryLinkDetails viewExpectedOutcomeFactorDetails(curam.outcomeplanning.outcomeplan.entity.struct.FactorDeliveryLinkKey key) throws curam.util.exception.AppException, curam.util.exception.InformationalException
OutcomePlanExpectedOutcome
. This
method is intended to be used by users responsible for the management of
outcome plans.key
- The unique identifier of the factor linkcuram.util.exception.AppException
curam.util.exception.InformationalException
curam.outcomeplanning.outcomeplan.facade.struct.VersionNoKey getVersionNo(curam.outcomeplanning.outcomeplan.entity.struct.OutcomePlanExpectedOutcomeKey key) throws curam.util.exception.AppException, curam.util.exception.InformationalException
OutcomePlanExpectedOutcome
. This
method is intended to be used by users responsible for the management of
outcome plans.the
- unique identifier of the expected outcome recordcuram.util.exception.AppException
curam.util.exception.InformationalException
curam.outcomeplanning.outcomeplan.facade.struct.OutcomePlanActivityDetailsList listCurrentActivities(curam.outcomeplanning.outcomeplan.entity.struct.OutcomePlanExpectedOutcomeKey key) throws curam.util.exception.AppException, curam.util.exception.InformationalException
OutcomePlanExpectedOutcome
. This
method is intended to be used by users responsible for the management of
outcome plans.key
- unique identifier of the outcome plan expected outcomecuram.util.exception.AppException
curam.util.exception.InformationalException
curam.outcomeplanning.outcomeplan.facade.struct.OutcomePlanContextPanelDetails readContextPanelDetails(curam.outcomeplanning.outcomeplan.entity.struct.OutcomePlanExpectedOutcomeKey key) throws curam.util.exception.AppException, curam.util.exception.InformationalException
OutcomePlanExpectedOutcome
. This
method is intended to be used by users responsible for the management of
outcome plans.key
- The unique identifier of the outcome plan expected outcomecuram.util.exception.AppException
curam.util.exception.InformationalException
void addClients(curam.outcomeplanning.outcomeplan.facade.struct.ExpectedOutcomeClientDetails clientDetails, curam.outcomeplanning.outcomeplan.entity.struct.OutcomePlanExpectedOutcomeKey key) throws curam.util.exception.AppException, curam.util.exception.InformationalException
OutcomePlanExpectedOutcome
. This
method is intended to be used by users responsible for the management of
outcome plans.clientDetails
- tab delimited list of the client(s) to be addedunique
- identifier of the expected outcome to add the client(s) tocuram.util.exception.AppException
curam.util.exception.InformationalException
void removeClients(curam.outcomeplanning.outcomeplan.facade.struct.ExpectedOutcomeClientDetails clientDetails, curam.outcomeplanning.outcomeplan.entity.struct.OutcomePlanExpectedOutcomeKey key) throws curam.util.exception.AppException, curam.util.exception.InformationalException
OutcomePlanExpectedOutcome
. This
method is intended to be used by users responsible for the management of
outcome plans.clientDetails
- Tab delimited list of the clients to be removedkey
- unique identifier of the expected outcome to remove the
client(s) fromcuram.util.exception.AppException
curam.util.exception.InformationalException
curam.outcomeplanning.outcomeplan.facade.struct.ListCaseClientsNameAndAgeResult listPotentialClientsToAdd(curam.outcomeplanning.outcomeplan.entity.struct.OutcomePlanExpectedOutcomeKey key) throws curam.util.exception.AppException, curam.util.exception.InformationalException
OutcomePlanExpectedOutcome
. This
method is intended to be used by users responsible for the management of
outcome plans.key
- unique identifier of the outcome plan expected outcomecuram.util.exception.AppException
curam.util.exception.InformationalException
curam.outcomeplanning.outcomeplan.facade.struct.ListCaseClientsNameAndAgeResult listClients(curam.outcomeplanning.outcomeplan.entity.struct.OutcomePlanExpectedOutcomeKey key) throws curam.util.exception.AppException, curam.util.exception.InformationalException
OutcomePlanExpectedOutcome
. This
method is intended to be used by users responsible for the management of
outcome plans.key
- unique identifier of the outcome plan expected outcomecuram.util.exception.AppException
curam.util.exception.InformationalException
curam.outcomeplanning.outcomeplan.facade.struct.OutcomePlanExpectedOutcomeNoteDetails readNotes(curam.outcomeplanning.outcomeplan.entity.struct.OutcomePlanExpectedOutcomeKey key) throws curam.util.exception.AppException, curam.util.exception.InformationalException
OutcomePlanExpectedOutcome
. 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.OutcomePlanObjectiveWorkspaceDetails readWorkspaceObjectiveDetails(curam.outcomeplanning.outcomeplan.entity.struct.OutcomePlanExpectedOutcomeKey key) throws curam.util.exception.AppException, curam.util.exception.InformationalException
key
- unique identifier of the outcome plan and expected outcomecuram.util.exception.AppException
curam.util.exception.InformationalException
curam.outcomeplanning.outcomeplan.facade.struct.LatestNoteDetails readLatestNote(curam.outcomeplanning.outcomeplan.entity.struct.OutcomePlanExpectedOutcomeKey key) throws curam.util.exception.AppException, curam.util.exception.InformationalException
key
- unique identifier of the outcome plan and expected outcomecuram.util.exception.AppException
curam.util.exception.InformationalException
curam.outcomeplanning.outcomeplan.facade.struct.ExpectedOutcomeSelectList searchForExpectedOutcomes(curam.outcomeplanning.outcomeplan.facade.struct.ExpectedOutcomeSearchDetails details) throws curam.util.exception.AppException, curam.util.exception.InformationalException
curam.util.exception.AppException
curam.util.exception.InformationalException
curam.outcomeplanning.outcomeplan.facade.struct.OutcomePlanRecommendedActivityDetailsList listRecommendedActivities(curam.outcomeplanning.outcomeplan.facade.struct.OutcomePlanExpectedOutcomeKey key) throws curam.util.exception.AppException, curam.util.exception.InformationalException
OutcomePlan
on which the given
expected outcome lives.key
- The unique identifer of the outcome plan expected outcomecuram.util.exception.AppException
curam.util.exception.InformationalException
curam.outcomeplanning.outcomeplan.facade.struct.CompleteExpectedOutcomeDetails getCompleteExpectedOutcomeDetails(curam.outcomeplanning.outcomeplan.entity.struct.OutcomePlanExpectedOutcomeKey key) throws curam.util.exception.AppException, curam.util.exception.InformationalException
OutcomePlanExpectedOutcome
. This
method is intended to be used by users responsible for the management of
outcome plans.the
- expected outcome details for completion.curam.util.exception.AppException
curam.util.exception.InformationalException