curam.outcomeplanning.outcomeplan.facade.intf

Interface OutcomePlanAction

All Known Implementing Classes:

OutcomePlanAction, curam.outcomeplanning.outcomeplan.facade.impl.OutcomePlanAction, OutcomePlanActionFactory

public interface OutcomePlanAction

Facade layer class for the management of Actions on an Outcome Plan. An OutcomePlanAction is a type of activity that can be added to an Outcome Plan to address client needs

Method Summary

Modifier and Type	Method and Description
void	addClientsToAction(curam.outcomeplanning.outcomeplan.facade.struct.OutcomePlanActionClientDetails details) Adds the given list of clients to the OutcomePlanAction.
void	addNote(curam.outcomeplanning.outcomeplan.facade.struct.NoteDetails details) Adds the given note to the OutcomePlanAction.
void	cancelAction(curam.outcomeplanning.outcomeplan.facade.struct.OutcomePlanActionVersionedKey key) Cancels an OutcomePlanAction.
void	completeAction(curam.outcomeplanning.outcomeplan.facade.struct.CompleteOutcomePlanActionDetails details) Completes the OutcomePlanAction with the given details.
void	createAttachment(curam.attachmentlink.struct.AttachmentLinkDetails details) Creates an attachment for the OutcomePlanAction.
curam.outcomeplanning.outcomeplan.facade.struct.OutcomePlanActionSummaryDetailsList	listActionsForOutcomePlan(curam.outcomeplanning.outcomeplan.entity.struct.OutcomePlanKey key) Returns a list of actions for the given OutcomePlan.
curam.outcomeplanning.outcomeplan.facade.struct.OPListAttachmentLinkDetails	listAttachments(curam.outcomeplanning.outcomeplan.entity.struct.OutcomePlanActionKey key) Returns a list of AttachmentLink for the given OutcomePlanAction.
curam.outcomeplanning.outcomeplan.facade.struct.FactorDeliverySummaryDetailsList	listFactorsForAction(curam.outcomeplanning.outcomeplan.entity.struct.OutcomePlanActionKey key) Returns the list of factors linked to the given OutcomePlanAction.
curam.outcomeplanning.outcomeplan.facade.struct.CaseClientSummaryDetailsList	listPotentialClientsForAction(curam.outcomeplanning.outcomeplan.entity.struct.OutcomePlanActionKey key) Returns the list of clients that may be added to the OutcomePlanAction.
curam.outcomeplanning.outcomeplan.facade.struct.OutcomePlanActionCompletionDisplayDetails	readActionCompletionDisplayDetails(curam.outcomeplanning.outcomeplan.entity.struct.OutcomePlanActionKey key) Reads the display details for the OutcomePlanAction complete page.
curam.outcomeplanning.outcomeplan.facade.struct.OutcomePlanActionDisplayDetailsForEdit	readActionEditDisplayDetails(curam.outcomeplanning.outcomeplan.entity.struct.OutcomePlanActionKey key) Deprecated. Since Curam 6.1 replaced by readActionUpdateDisplayDetails. The new operation supports the new page configuration. Reads the display details for the OutcomePlanAction edit page. This method is intended to be used by users responsible for the management of outcome plans.
curam.outcomeplanning.outcomeplan.facade.struct.OutcomePlanActionHomePageDetails	readActionHomePageDetails(curam.outcomeplanning.outcomeplan.entity.struct.OutcomePlanActionKey key) Returns the OutcomePlanAction home page details.
curam.outcomeplanning.outcomeplan.facade.struct.OutcomePlanActionNoteDetails	readActionNotes(curam.outcomeplanning.outcomeplan.entity.struct.OutcomePlanActionKey key) Returns the notes for the given OutcomePlanAction.
curam.outcomeplanning.outcomeplan.facade.struct.OutcomePlanActionDisplayDetailsForUpdate	readActionUpdateDisplayDetails(curam.outcomeplanning.outcomeplan.entity.struct.OutcomePlanActionKey key) Reads the display details for the OutcomePlanAction edit page.
curam.outcomeplanning.outcomeplan.facade.struct.OutcomePlanContextPanelDetails	readContextPanelDetails(curam.outcomeplanning.outcomeplan.entity.struct.OutcomePlanActionKey key) Reads the context panel details for the given OutcomePlanAction.
curam.outcomeplanning.outcomeplan.facade.struct.LatestNoteDetails	readLatestNote(curam.outcomeplanning.outcomeplan.entity.struct.OutcomePlanActionKey key) Returns the latest note for this OutcomePlanAction
curam.outcomeplanning.outcomeplan.facade.struct.OutcomePlanActionVersionedKey	readVersionNumber(curam.outcomeplanning.outcomeplan.entity.struct.OutcomePlanActionKey key) Reads the version number for the given OutcomePlanAction.
void	removeClientFromAction(curam.outcomeplanning.outcomeplan.entity.struct.OutcomePlanActionKey outcomePlanActionKey, curam.core.sl.entity.struct.CaseParticipantRoleKey caseParticipantRoleKey) Removes the given client from the OutcomePlanAction.
void	updateAction(curam.outcomeplanning.outcomeplan.facade.struct.OutcomePlanActionUpdateDetails details) Updates an OutcomePlanAction with the given details.
void	updateActionDetails(curam.outcomeplanning.outcomeplan.facade.struct.OutcomePlanActionEditDetails details) Deprecated. Since Curam 6.1 replaced by updateAction. The new operation supports the addition of mandatory fields and the additional responsibility types. Updates an OutcomePlanAction with the given details. This should only be used where the status is not 'Completed'. This method is intended to be used by users responsible for the management of outcome plans.
void	updateActionReason(curam.outcomeplanning.outcomeplan.facade.struct.OutcomePlanActionEditReasonDetails details) Edits the reason text for an action.
void	updateCompletedAction(curam.outcomeplanning.outcomeplan.facade.struct.CompleteOutcomePlanActionDetails details) Updates a 'Completed' OutcomePlanAction with the given details.

Method Detail

listActionsForOutcomePlan

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

Returns a list of actions 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

Returns:

The list of actions for the given outcome plan

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

readActionHomePageDetails

curam.outcomeplanning.outcomeplan.facade.struct.OutcomePlanActionHomePageDetails readActionHomePageDetails(curam.outcomeplanning.outcomeplan.entity.struct.OutcomePlanActionKey key)
                                                                                                    throws curam.util.exception.AppException,
                                                                                                           curam.util.exception.InformationalException

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

Returns:

The action home page details

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

updateActionDetails

@Deprecated
void updateActionDetails(curam.outcomeplanning.outcomeplan.facade.struct.OutcomePlanActionEditDetails details)
                              throws curam.util.exception.AppException,
                                     curam.util.exception.InformationalException

Deprecated. Since Curam 6.1 replaced by updateAction. The new operation supports the addition of mandatory fields and the additional responsibility types. Updates an OutcomePlanAction with the given details. This should only be used where the status is not 'Completed'. This method is intended to be used by users responsible for the management of outcome plans.

Parameters:

The - details of the action to be updated

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

completeAction

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

Completes the OutcomePlanAction 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 action to be completed

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

cancelAction

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

Cancels an OutcomePlanAction. This method is intended to be used by users responsible for the management of outcome plans.

Parameters:

key - The details of the action to be cancelled

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

readActionCompletionDisplayDetails

curam.outcomeplanning.outcomeplan.facade.struct.OutcomePlanActionCompletionDisplayDetails readActionCompletionDisplayDetails(curam.outcomeplanning.outcomeplan.entity.struct.OutcomePlanActionKey key)
                                                                                                                      throws curam.util.exception.AppException,
                                                                                                                             curam.util.exception.InformationalException

Reads the display details for the OutcomePlanAction complete page. This method is intended to be used by users responsible for the management of outcome plans.

Parameters:

key - The details of the action to read

Returns:

The display details for the action complete page

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

readActionEditDisplayDetails

@Deprecated
curam.outcomeplanning.outcomeplan.facade.struct.OutcomePlanActionDisplayDetailsForEdit readActionEditDisplayDetails(curam.outcomeplanning.outcomeplan.entity.struct.OutcomePlanActionKey key)
                                                                                                                         throws curam.util.exception.AppException,
                                                                                                                                curam.util.exception.InformationalException

Deprecated. Since Curam 6.1 replaced by readActionUpdateDisplayDetails. The new operation supports the new page configuration. Reads the display details for the OutcomePlanAction edit page. This method is intended to be used by users responsible for the management of outcome plans.

Parameters:

key - The details of the action to read

Returns:

The display details for the action edit page

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

listFactorsForAction

curam.outcomeplanning.outcomeplan.facade.struct.FactorDeliverySummaryDetailsList listFactorsForAction(curam.outcomeplanning.outcomeplan.entity.struct.OutcomePlanActionKey key)
                                                                                               throws curam.util.exception.AppException,
                                                                                                      curam.util.exception.InformationalException

Returns the list of factors linked to the given OutcomePlanAction. This method is intended to be used by users responsible for the management of outcome plans.

Parameters:

key - The unique identifier of the action

Returns:

The list of factors linked to the given action

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

removeClientFromAction

void removeClientFromAction(curam.outcomeplanning.outcomeplan.entity.struct.OutcomePlanActionKey outcomePlanActionKey,
                            curam.core.sl.entity.struct.CaseParticipantRoleKey caseParticipantRoleKey)
                     throws curam.util.exception.AppException,
                            curam.util.exception.InformationalException

Removes the given client from the OutcomePlanAction. This method is intended to be used by users responsible for the management of outcome plans.

Parameters:

outcomePlanActionKey - The unique identifier of the action.

caseParticipantRoleKey - The unique identifier of the client to be removed from the action.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

updateCompletedAction

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

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

Parameters:

The - details of the action to be updated

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

readVersionNumber

curam.outcomeplanning.outcomeplan.facade.struct.OutcomePlanActionVersionedKey readVersionNumber(curam.outcomeplanning.outcomeplan.entity.struct.OutcomePlanActionKey key)
                                                                                         throws curam.util.exception.AppException,
                                                                                                curam.util.exception.InformationalException

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

Parameters:

key - The unique identifier of the action to read

Returns:

The version number of the action

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

listAttachments

curam.outcomeplanning.outcomeplan.facade.struct.OPListAttachmentLinkDetails listAttachments(curam.outcomeplanning.outcomeplan.entity.struct.OutcomePlanActionKey key)
                                                                                     throws curam.util.exception.AppException,
                                                                                            curam.util.exception.InformationalException

Returns a list of AttachmentLink for the given OutcomePlanAction. 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 action

Returns:

The list of attachment links for the given outcome plan action

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

createAttachment

void createAttachment(curam.attachmentlink.struct.AttachmentLinkDetails details)
               throws curam.util.exception.AppException,
                      curam.util.exception.InformationalException

Creates an attachment for the OutcomePlanAction. This method is intended to be used by users responsible for the management of outcome plans.

Parameters:

details - Details of the attachment to be added

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

listPotentialClientsForAction

curam.outcomeplanning.outcomeplan.facade.struct.CaseClientSummaryDetailsList listPotentialClientsForAction(curam.outcomeplanning.outcomeplan.entity.struct.OutcomePlanActionKey key)
                                                                                                    throws curam.util.exception.AppException,
                                                                                                           curam.util.exception.InformationalException

Returns the list of clients that may be added to the OutcomePlanAction. This includes all clients on the OutcomePlan that are not currently on the action. This method is intended to be used by users responsible for the management of outcome plans.

Parameters:

key - The unique identifier of the action

Returns:

The list of clients that may be added to the given action

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

addClientsToAction

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

Adds the given list of clients to the OutcomePlanAction. This method is intended to be used by users responsible for the management of outcome plans.

Parameters:

details - The details of the clients to be added to the action

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

addNote

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

Adds the given note to the OutcomePlanAction. 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 action

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

readLatestNote

curam.outcomeplanning.outcomeplan.facade.struct.LatestNoteDetails readLatestNote(curam.outcomeplanning.outcomeplan.entity.struct.OutcomePlanActionKey key)
                                                                          throws curam.util.exception.AppException,
                                                                                 curam.util.exception.InformationalException

Returns the latest note for this OutcomePlanAction

Returns:

The last note

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

readContextPanelDetails

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

Reads the context panel details for the given OutcomePlanAction. 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 action

Returns:

The context panel details

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

readActionNotes

curam.outcomeplanning.outcomeplan.facade.struct.OutcomePlanActionNoteDetails readActionNotes(curam.outcomeplanning.outcomeplan.entity.struct.OutcomePlanActionKey key)
                                                                                      throws curam.util.exception.AppException,
                                                                                             curam.util.exception.InformationalException

Returns the notes for the given OutcomePlanAction. This method is intended to be used by users responsible for the management of outcome plans.

Returns:

The notes for the given action

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

updateActionReason

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

Edits the reason text for an action.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

updateAction

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

Updates an OutcomePlanAction with the given details. This should only be used where the status is not 'Completed'. This method is intended to be used by users responsible for the management of outcome plans.

Parameters:

The - details of the action to be updated

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

readActionUpdateDisplayDetails

curam.outcomeplanning.outcomeplan.facade.struct.OutcomePlanActionDisplayDetailsForUpdate readActionUpdateDisplayDetails(curam.outcomeplanning.outcomeplan.entity.struct.OutcomePlanActionKey key)
                                                                                                                 throws curam.util.exception.AppException,
                                                                                                                        curam.util.exception.InformationalException

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

Parameters:

key - The details of the action to read

Returns:

The display details for the action edit page

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException