curam.outcomeplanning.outcomeplan.facade.intf

Interface PlanReview

All Known Implementing Classes:

PlanReview, curam.outcomeplanning.outcomeplan.facade.impl.PlanReview, PlanReviewFactory

public interface PlanReview

Facade layer class for the management of reviews on an outcome plan.

Method Summary

Modifier and Type	Method and Description
void	addNarrativeNote(curam.outcomeplanning.outcomeplan.facade.struct.PlanReviewNoteDetails details) Updates the narrative note for the PlanReview with the given details.
void	addNote(curam.outcomeplanning.outcomeplan.facade.struct.PlanReviewNoteDetails details) Updates the note for the PlanReview with the given details.
void	cancelPlanReview(curam.outcomeplanning.outcomeplan.facade.struct.PlanReviewVersionedKey key) Logically deletes the given PlanReview.
void	completePlanReview(curam.outcomeplanning.outcomeplan.facade.struct.PlanReviewCompletionDetails details) Completes the given PlanReview with the given details.
curam.assessmentplanning.delivery.facade.struct.CreateAssessmentResult	createAssessment(curam.assessmentplanning.delivery.facade.struct.CreateAssessmentDetails details, curam.outcomeplanning.outcomeplan.entity.struct.PlanReviewKey key) Creates an assessment for the Plan Review based on the passed in details.
void	createPlanReview(curam.outcomeplanning.outcomeplan.facade.struct.PlanReviewCreateDetails details, curam.outcomeplanning.outcomeplan.entity.struct.OutcomePlanKey key) Creates a new PlanReview for the given OutcomePlan.
curam.outcomeplanning.outcomeplan.facade.struct.PlanReviewVersionedKey	getVersionNo(curam.outcomeplanning.outcomeplan.entity.struct.PlanReviewKey key) Reads the version number of the given PlanReview.
curam.assessmentplanning.delivery.facade.struct.AssessmentCaseListDetailsList	listAssessments(curam.outcomeplanning.outcomeplan.entity.struct.PlanReviewKey key) Returns a list of Assessments for the Plan Review.
curam.outcomeplanning.outcomeplan.facade.struct.PlanReviewListDetailsList	listPlanReviews(curam.outcomeplanning.outcomeplan.entity.struct.OutcomePlanKey key) Returns a list of all active PlanReview for the given OutcomePlan.
curam.outcomeplanning.outcomeplan.facade.struct.PlanReviewItemDetailsList	listReviewItems(curam.outcomeplanning.outcomeplan.facade.struct.PlanReviewRelatedItemKey key) Returns a list of all active PlanReviewItem for the given curam.outcomeplanning.outcomeplan.impl.Reviewable.
void	maintainReviewItem(curam.outcomeplanning.outcomeplan.facade.struct.PlanReviewMaintainItemDetails details) Creates a PlanReviewItem of type 'Maintained' with the given details.
curam.outcomeplanning.outcomeplan.facade.struct.PlanReviewCompletionDisplayDetails	readCompletionDisplayDetails(curam.outcomeplanning.outcomeplan.entity.struct.PlanReviewKey key) Reads the completion display details for the given PlanReview.
curam.outcomeplanning.outcomeplan.facade.struct.PlanReviewContextPanelDetails	readContextPanelDetails(curam.outcomeplanning.outcomeplan.entity.struct.PlanReviewKey key) Reads the context panel details for the given PlanReview.
curam.outcomeplanning.outcomeplan.facade.struct.PlanReviewHomePageDetails	readHomePageDetails(curam.outcomeplanning.outcomeplan.entity.struct.PlanReviewKey key) Reads the home page details for the given PlanReview.
curam.outcomeplanning.outcomeplan.facade.struct.PlanReviewListDropDownDetails	readListDropDownDetails(curam.outcomeplanning.outcomeplan.entity.struct.PlanReviewKey key) Reads the list drop down details for the given PlanReview.
curam.outcomeplanning.outcomeplan.facade.struct.PlanReviewCreateDetails	readPlanReviewCreateDetails(curam.outcomeplanning.outcomeplan.entity.struct.OutcomePlanKey key) Reads the display details for the creation of a new PlanReview on the given OutcomePlan.
curam.outcomeplanning.outcomeplan.facade.struct.PlanReviewEditDetails	readPlanReviewEditDetails(curam.outcomeplanning.outcomeplan.entity.struct.PlanReviewKey key) Reads the edit details for the given PlanReview.
curam.outcomeplanning.outcomeplan.facade.struct.PlanReviewItemUpdatesDetails	readPlanReviewItemUpdatesForActivities(curam.outcomeplanning.outcomeplan.entity.struct.PlanReviewKey key) Returns the lists of all items added, completed, maintained and pending review for all activities during the given PlanReview.
curam.outcomeplanning.outcomeplan.facade.struct.PlanReviewItemUpdatesDetails	readPlanReviewItemUpdatesForType(curam.outcomeplanning.outcomeplan.facade.struct.PlanReviewItemTypeKey key) Returns the lists of all items added, completed, maintained and pending review during the given PlanReview and review related item type.
curam.outcomeplanning.outcomeplan.facade.struct.NoteHistoryDetails	readPlanReviewNotes(curam.outcomeplanning.outcomeplan.entity.struct.PlanReviewKey key) Reads the notes entered for the given PlanReview.
curam.outcomeplanning.outcomeplan.facade.struct.PlanReviewMaintainItemDisplayDetails	readReviewMaintainItemDisplayDetails(curam.outcomeplanning.outcomeplan.facade.struct.PlanReviewRelatedItemKey key) Reads the maintain review item display details for the given curam.outcomeplanning.outcomeplan.impl.Reviewable.
curam.outcomeplanning.outcomeplan.facade.struct.PlanReviewUpdateCompletionDetails	readUpdateCompletionDetails(curam.outcomeplanning.outcomeplan.entity.struct.PlanReviewKey key) Reads the completion details of the given PlanReview so that they can be updated.
void	updateCompletionDetails(curam.outcomeplanning.outcomeplan.facade.struct.PlanReviewUpdateCompletionDetails details) Updates a completed PlanReview with the given details.
void	updateExpectedEndDate(curam.outcomeplanning.outcomeplan.entity.struct.PlanReviewKey key, curam.outcomeplanning.outcomeplan.facade.struct.ExpectedEndDateDetails details) Updates the expected end date for the PlanReview with the given details.
void	updatePlanReview(curam.outcomeplanning.outcomeplan.facade.struct.PlanReviewEditDetails details) Updates the given PlanReview with the given details.
curam.outcomeplanning.outcomeplan.facade.struct.ExpectedEndDateHistoryList	viewExpectedEndDateHistory(curam.outcomeplanning.outcomeplan.entity.struct.PlanReviewKey key) Returns the expected end date history for the given PlanReview.

Method Detail

readListDropDownDetails

curam.outcomeplanning.outcomeplan.facade.struct.PlanReviewListDropDownDetails readListDropDownDetails(curam.outcomeplanning.outcomeplan.entity.struct.PlanReviewKey key)
                                                                                               throws curam.util.exception.AppException,
                                                                                                      curam.util.exception.InformationalException

Reads the list drop down details for the given PlanReview. This method is intended to be used by users responsible for the management of outcome plans.

Parameters:

key - The plan review to read

Returns:

The details to be shown in the list drop down pane for the plan review

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

readHomePageDetails

curam.outcomeplanning.outcomeplan.facade.struct.PlanReviewHomePageDetails readHomePageDetails(curam.outcomeplanning.outcomeplan.entity.struct.PlanReviewKey key)
                                                                                       throws curam.util.exception.AppException,
                                                                                              curam.util.exception.InformationalException

Reads the home page details for the given PlanReview. This method is intended to be used by users responsible for the management of outcome plans.

Parameters:

key - The unique identifier of the plan review to read

Returns:

The home page details for the given plan review

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

readContextPanelDetails

curam.outcomeplanning.outcomeplan.facade.struct.PlanReviewContextPanelDetails readContextPanelDetails(curam.outcomeplanning.outcomeplan.entity.struct.PlanReviewKey key)
                                                                                               throws curam.util.exception.AppException,
                                                                                                      curam.util.exception.InformationalException

Reads the context panel details for the given PlanReview. This method is intended to be used by users responsible for the management of outcome plans.

Parameters:

key - The unique identifier of the plan review to read

Returns:

The context panel details for the given plan review

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

listPlanReviews

curam.outcomeplanning.outcomeplan.facade.struct.PlanReviewListDetailsList listPlanReviews(curam.outcomeplanning.outcomeplan.entity.struct.OutcomePlanKey key)
                                                                                   throws curam.util.exception.AppException,
                                                                                          curam.util.exception.InformationalException

Returns a list of all active PlanReview for the given OutcomePlan. This method is intended to be used by users responsible for the management of outcome plans.

Parameters:

key - The unique identifier of the outcome plan to search by

Returns:

The list of all active reviews for the given outcome plan.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

createPlanReview

void createPlanReview(curam.outcomeplanning.outcomeplan.facade.struct.PlanReviewCreateDetails details,
                      curam.outcomeplanning.outcomeplan.entity.struct.OutcomePlanKey key)
               throws curam.util.exception.AppException,
                      curam.util.exception.InformationalException

Creates a new PlanReview for the given OutcomePlan. This method is intended to be used by users responsible for the management of outcome plans.

Parameters:

details - The details of the plan review to be created

key - The unique identifier of the outcome plan under review

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

readPlanReviewEditDetails

curam.outcomeplanning.outcomeplan.facade.struct.PlanReviewEditDetails readPlanReviewEditDetails(curam.outcomeplanning.outcomeplan.entity.struct.PlanReviewKey key)
                                                                                         throws curam.util.exception.AppException,
                                                                                                curam.util.exception.InformationalException

Reads the edit details for the given PlanReview. This method is intended to be used by users responsible for the management of outcome plans.

Returns:

details The details of the plan review to be updated

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

updatePlanReview

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

Updates the given PlanReview with the given details. This method is intended to be used by users responsible for the management of outcome plans.

Parameters:

details - The details of the plan review to be updated

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

getVersionNo

curam.outcomeplanning.outcomeplan.facade.struct.PlanReviewVersionedKey getVersionNo(curam.outcomeplanning.outcomeplan.entity.struct.PlanReviewKey key)
                                                                             throws curam.util.exception.AppException,
                                                                                    curam.util.exception.InformationalException

Reads the version number of the given PlanReview. This method is intended to be used by users responsible for the management of outcome plans.

Parameters:

key - The unique identifier of the plan review to read

Returns:

The version number of the given plan review

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

viewExpectedEndDateHistory

curam.outcomeplanning.outcomeplan.facade.struct.ExpectedEndDateHistoryList viewExpectedEndDateHistory(curam.outcomeplanning.outcomeplan.entity.struct.PlanReviewKey key)
                                                                                               throws curam.util.exception.AppException,
                                                                                                      curam.util.exception.InformationalException

Returns the expected end date history for the given PlanReview. This method is intended to be used by users responsible for the management of outcome plans.

Parameters:

key - The unique identifier of the plan review to read

Returns:

The expected end date history for the given plan review

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

cancelPlanReview

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

Logically deletes the given PlanReview. This method is intended to be used by users responsible for the management of outcome plans.

Parameters:

key - The unique identifier of the plan review to be logically deleted

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

addNarrativeNote

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

Updates the narrative note for the PlanReview with the given details. This method is intended to be used by users responsible for the management of outcome plans.

Parameters:

details - The details of the note to be added to the narrative for the given plan review

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

addNote

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

Updates the note for the PlanReview with the given details. This method is intended to be used by users responsible for the management of outcome plans.

Parameters:

details - The details of the note to be added for the given plan review

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

readCompletionDisplayDetails

curam.outcomeplanning.outcomeplan.facade.struct.PlanReviewCompletionDisplayDetails readCompletionDisplayDetails(curam.outcomeplanning.outcomeplan.entity.struct.PlanReviewKey key)
                                                                                                         throws curam.util.exception.AppException,
                                                                                                                curam.util.exception.InformationalException

Reads the completion display details for the given PlanReview. If an OutcomePlanGoal exists for the OutcomePlan under review progress is displayed. This method is intended to be used by users responsible for the management of outcome plans.

Parameters:

key - The unique identifier of the plan review to read

Returns:

The completion display details for the given plan review

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

completePlanReview

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

Completes the given PlanReview with the given details. If progress is specified this is recorded against the OutcomePlanGoal for the OutcomePlan under review. This method is intended to be used by users responsible for the management of outcome plans.

Parameters:

details - The completion details for the plan review

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

updateExpectedEndDate

void updateExpectedEndDate(curam.outcomeplanning.outcomeplan.entity.struct.PlanReviewKey key,
                           curam.outcomeplanning.outcomeplan.facade.struct.ExpectedEndDateDetails details)
                    throws curam.util.exception.AppException,
                           curam.util.exception.InformationalException

Updates the expected end date for the PlanReview with the given details. This method is intended to be used by users responsible for the management of outcome plans.

Parameters:

key - The unique identifier of the plan review to update

details - The new expected end date and reason for update

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

readPlanReviewItemUpdatesForType

curam.outcomeplanning.outcomeplan.facade.struct.PlanReviewItemUpdatesDetails readPlanReviewItemUpdatesForType(curam.outcomeplanning.outcomeplan.facade.struct.PlanReviewItemTypeKey key)
                                                                                                       throws curam.util.exception.AppException,
                                                                                                              curam.util.exception.InformationalException

Returns the lists of all items added, completed, maintained and pending review during the given PlanReview and review related item type. This method is intended to be used by users responsible for the management of outcome plans.

Parameters:

key - The unique identifier of the plan review and type of related item to search by

Returns:

The lists of all items added, completed, maintained and pending review for the given plan review and type

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

readReviewMaintainItemDisplayDetails

curam.outcomeplanning.outcomeplan.facade.struct.PlanReviewMaintainItemDisplayDetails readReviewMaintainItemDisplayDetails(curam.outcomeplanning.outcomeplan.facade.struct.PlanReviewRelatedItemKey key)
                                                                                                                   throws curam.util.exception.AppException,
                                                                                                                          curam.util.exception.InformationalException

Reads the maintain review item display details for the given curam.outcomeplanning.outcomeplan.impl.Reviewable. This method is intended to be used by users responsible for the management of outcome plans.

Parameters:

key - The unique identifier and type of the item under review

Returns:

The maintain review item display details for the given item under review

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

maintainReviewItem

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

Creates a PlanReviewItem of type 'Maintained' with the given details. If progress is specified this is recorded against the item under review. This method is intended to be used by users responsible for the management of outcome plans.

Parameters:

details - The details of the review item to be maintained

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

listReviewItems

curam.outcomeplanning.outcomeplan.facade.struct.PlanReviewItemDetailsList listReviewItems(curam.outcomeplanning.outcomeplan.facade.struct.PlanReviewRelatedItemKey key)
                                                                                   throws curam.util.exception.AppException,
                                                                                          curam.util.exception.InformationalException

Returns a list of all active PlanReviewItem for the given curam.outcomeplanning.outcomeplan.impl.Reviewable. This method is intended to be used by users responsible for the management of outcome plans.

Parameters:

key - The unique identifier and type of the reviewable item to search by

Returns:

The list of all active review items for the given item.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

readPlanReviewItemUpdatesForActivities

curam.outcomeplanning.outcomeplan.facade.struct.PlanReviewItemUpdatesDetails readPlanReviewItemUpdatesForActivities(curam.outcomeplanning.outcomeplan.entity.struct.PlanReviewKey key)
                                                                                                             throws curam.util.exception.AppException,
                                                                                                                    curam.util.exception.InformationalException

Returns the lists of all items added, completed, maintained and pending review for all activities during the given PlanReview. This is a convenience method which groups all types of{ @link curam.outcomeplanning.outcomeplan.impl.OutcomePlanActivity} that extend curam.outcomeplanning.outcomeplan.impl.Reviewable rather than have a separate method to read each type. This method is intended to be used by users responsible for the management of outcome plans.

Parameters:

key - The unique identifier of the plan review

Returns:

The lists of all activities added, completed, maintained and pending review for the given plan review

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

readPlanReviewCreateDetails

curam.outcomeplanning.outcomeplan.facade.struct.PlanReviewCreateDetails readPlanReviewCreateDetails(curam.outcomeplanning.outcomeplan.entity.struct.OutcomePlanKey key)
                                                                                             throws curam.util.exception.AppException,
                                                                                                    curam.util.exception.InformationalException

Reads the display details for the creation of a new PlanReview on the given OutcomePlan. This method is intended to be used by users responsible for the management of outcome plans.

Parameters:

key - The unique identifier of the outcome plan under review

Returns:

details The default details of the plan review to be created

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

readPlanReviewNotes

curam.outcomeplanning.outcomeplan.facade.struct.NoteHistoryDetails readPlanReviewNotes(curam.outcomeplanning.outcomeplan.entity.struct.PlanReviewKey key)
                                                                                throws curam.util.exception.AppException,
                                                                                       curam.util.exception.InformationalException

Reads the notes entered for the given PlanReview. This method is intended to be used by users responsible for the management of outcome plans.

Parameters:

key - The unique identifier of the plan review to read

Returns:

The notes entered for the given plan review

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

readUpdateCompletionDetails

curam.outcomeplanning.outcomeplan.facade.struct.PlanReviewUpdateCompletionDetails readUpdateCompletionDetails(curam.outcomeplanning.outcomeplan.entity.struct.PlanReviewKey key)
                                                                                                       throws curam.util.exception.AppException,
                                                                                                              curam.util.exception.InformationalException

Reads the completion details of the given PlanReview so that they can be updated. This method is intended to be used by users responsible for the management of outcome plans.

Parameters:

key - The unique identifier of the plan review to read

Returns:

The completion details of the given plan review

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

updateCompletionDetails

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

Updates a completed PlanReview with the given details. This method is intended to be used by users responsible for the management of outcome plans.

Parameters:

details - The completion details of the plan review to be updated

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

listAssessments

curam.assessmentplanning.delivery.facade.struct.AssessmentCaseListDetailsList listAssessments(curam.outcomeplanning.outcomeplan.entity.struct.PlanReviewKey key)
                                                                                       throws curam.util.exception.AppException,
                                                                                              curam.util.exception.InformationalException

Returns a list of Assessments for the Plan Review. This list is filtered based on the executionLocation on the AssessmentDefinition This method is intended to be used by users responsible for the management of outcome plans.

Parameters:

key - The ID of the case to search by

Returns:

A list of Assessment for the given case

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Since:

6.0 SP2

createAssessment

curam.assessmentplanning.delivery.facade.struct.CreateAssessmentResult createAssessment(curam.assessmentplanning.delivery.facade.struct.CreateAssessmentDetails details,
                                                                                        curam.outcomeplanning.outcomeplan.entity.struct.PlanReviewKey key)
                                                                                 throws curam.util.exception.AppException,
                                                                                        curam.util.exception.InformationalException

Creates an assessment for the Plan Review based on the passed in details. Depending on the selected assessment either an assessment case or assessment delivery is created. If a assessment delivery is selected the client and start date must be entered. If a assessment case is selected client and start date details must not be entered.

Parameters:

details - The details for creating the Assessment.

key - The unique identifier of the Plan Review.

Returns:

The caseID and type of the new Assessment.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Since:

6.0 SP2