curam.outcomeplanning.outcomeplan.facade.intf

Interface OutcomePlanCollaboration

All Known Implementing Classes:

OutcomePlanCollaboration, curam.outcomeplanning.outcomeplan.facade.impl.OutcomePlanCollaboration, OutcomePlanCollaborationFactory

public interface OutcomePlanCollaboration

Facade layer class for reading details about Collaborative Outcome Plans for external MDT Members.

Method Summary

Modifier and Type	Method and Description
curam.outcomeplanning.outcomeplan.facade.struct.OutcomePlanActivityDetailsList	listActivities(curam.core.struct.CaseHeaderKey key) Reads the list of active activities on the given Outcome Plan.
curam.outcomeplanning.outcomeplan.facade.struct.OPActionHomePageDetails	readActionHomePage(curam.outcomeplanning.outcomeplan.entity.struct.OutcomePlanActionKey key) Reads the details to be displayed on the action home page on an Outcome Plan.
curam.outcomeplanning.outcomeplan.facade.struct.OPCollaborationContextPanelDetails	readContextPanelDetails(curam.core.struct.CaseHeaderKey key) Reads the context panel details for an Outcome Plan.
curam.outcomeplanning.outcomeplan.facade.struct.OPCollaborationHomePageDetails	readHomePage(curam.core.struct.CaseHeaderKey key) Reads the details to be displayed on the home page of the Outcome Plan.
curam.outcomeplanning.outcomeplan.facade.struct.OPReferralHomePageDetails	readReferralHomePage(curam.outcomeplanning.outcomeplan.facade.struct.ReferralKey key) Reads the details to be displayed on the referral home page on an Outcome Plan.
curam.outcomeplanning.outcomeplan.facade.struct.OPServiceDeliveryHomePageDetails	readServiceDeliveryHomePage(curam.outcomeplanning.outcomeplan.facade.struct.ServiceDeliveryKey key) Reads the details to be displayed on the service delivery home page on an Outcome Plan.

Method Detail

readHomePage

curam.outcomeplanning.outcomeplan.facade.struct.OPCollaborationHomePageDetails readHomePage(curam.core.struct.CaseHeaderKey key)
                                                                                     throws curam.util.exception.AppException,
                                                                                            curam.util.exception.InformationalException

Reads the details to be displayed on the home page of the Outcome Plan. This method is intended to be used by external multidisciplinary team members.

Parameters:

key - The unique identifier of the outcome plan to be read

Returns:

The outcome plan home page details to be displayed for the external multidisciplinary team member

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

readContextPanelDetails

curam.outcomeplanning.outcomeplan.facade.struct.OPCollaborationContextPanelDetails readContextPanelDetails(curam.core.struct.CaseHeaderKey key)
                                                                                                    throws curam.util.exception.AppException,
                                                                                                           curam.util.exception.InformationalException

Reads the context panel details for an Outcome Plan. This method is intended to be used by external multidisciplinary team members.

Parameters:

key - The unique identifier of the outcome plan to be read

Returns:

The context panel details to be displayed for the external multidisciplinary team member

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

listActivities

curam.outcomeplanning.outcomeplan.facade.struct.OutcomePlanActivityDetailsList listActivities(curam.core.struct.CaseHeaderKey key)
                                                                                       throws curam.util.exception.AppException,
                                                                                              curam.util.exception.InformationalException

Reads the list of active activities on the given Outcome Plan. This method is intended to be used by external multidisciplinary team members.

Parameters:

key - The unique identifier of the outcome plan to read

Returns:

The list of activities for the outcome plan to be displayed for the external multidisciplinary team member

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

readActionHomePage

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

Reads the details to be displayed on the action home page on an Outcome Plan. This method is intended to be used by external multidisciplinary team members.

Parameters:

key - The unique identifier of the outcome plan action to be read

Returns:

The outcome plan action home page details to be displayed for the external multidisciplinary team member

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

readServiceDeliveryHomePage

curam.outcomeplanning.outcomeplan.facade.struct.OPServiceDeliveryHomePageDetails readServiceDeliveryHomePage(curam.outcomeplanning.outcomeplan.facade.struct.ServiceDeliveryKey key)
                                                                                                      throws curam.util.exception.AppException,
                                                                                                             curam.util.exception.InformationalException

Reads the details to be displayed on the service delivery home page on an Outcome Plan. This method is intended to be used by external multidisciplinary team members.

Parameters:

key - The unique identifier of the outcome plan service delivery to be read

Returns:

The outcome plan service delivery home page details to be displayed for the external multidisciplinary team member

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

readReferralHomePage

curam.outcomeplanning.outcomeplan.facade.struct.OPReferralHomePageDetails readReferralHomePage(curam.outcomeplanning.outcomeplan.facade.struct.ReferralKey key)
                                                                                        throws curam.util.exception.AppException,
                                                                                               curam.util.exception.InformationalException

Reads the details to be displayed on the referral home page on an Outcome Plan. This method is intended to be used by external multidisciplinary team members.

Parameters:

key - The unique identifier of the outcome plan referral to be read

Returns:

The outcome plan referral home page details to be displayed for the external multidisciplinary team member

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException