@AccessLevel(value=EXTERNAL)
public interface OutcomePlan
extends curam.piwrapper.caseheader.impl.CaseHeader, curam.assessmentplanning.delivery.impl.FactorResultRelateable, curam.assessmentplanning.delivery.impl.FactorDeliveryRelateable, curam.assessmentplanning.delivery.impl.PriorityFactorable, curam.progress.impl.Progressable, curam.util.persistence.OptimisticLockModifiable, curam.piwrapper.outcomeplan.impl.OutcomePlanDateTrackableItem
The following exceptions may be raised by this entity:
OUTCOMEPLAN#ERR_FV_OUTCOME_PLAN_TYPE_MANDATORY
- if the outcome plan
type has not been set.
OUTCOMEPLAN#ERR_FV_EXPECTED_END_DATE_IN_PAST
- if the expected end
date is in the past.
OUTCOMEPLAN#ERR_XFV_START_DATE_AFTER_EXPECTED_END_DATE
- if the
expected end date is before the start date.
OUTCOMEPLAN#ERR_FV_OUTCOME_PLAN_NAME_MANDATORY
- if the name has not
been set.
OUTCOMEPLAN#ERR_FV_OUTCOME_PLAN_NAME_TOO_LONG
- if the name value is
too long.
OutcomePlan
Modifier and Type | Interface and Description |
---|---|
static class |
OutcomePlan.OutcomePlanEvent
Events are raised during the processing of an
OutcomePlan instance,
these events allow customers to add additional processing as required. |
static class |
OutcomePlan.OutcomePlanRecommendationEvent
Events raised during the processing of
OutcomePlan recommendation
processing. |
static class |
OutcomePlan.OutcomePlanWorkspaceEvents
Events raised to allow addition of new activity types.
|
Modifier and Type | Method and Description |
---|---|
curam.outcomeplanning.outcomeplan.impl.ActivityRecommendationDetail |
getActivityRecommendationDetail(curam.piwrapper.casemanager.impl.CaseParticipantRole caseParticipantRole,
curam.piwrapper.outcomeplan.codetable.impl.OUTCOMEPLANACTIVITYTYPEEntry activityType,
long activityAdminID)
Retrieve the
OutcomePlanActivity recommendation reasons. |
curam.util.exception.LocalisableString |
getAgreementsSignedState()
Retrieves a
LocalisableString containing the state for all
agreements that exist on this outcome plan, and whether
they are all signed, pending signing, or it is not applicable for this
outcome plan. |
curam.piwrapper.user.impl.User |
getCreatedBy()
Retrieves the
User who created the OutcomePlan . |
curam.outcomeplanning.outcomeplan.impl.ExpectedOutcomeRecommendationDetail |
getExpectedOutcomeRecommendationReason(curam.piwrapper.casemanager.impl.CaseParticipantRole caseParticipantRole,
long expectedOutcomeID)
Retrieve the
ExpectedOutcome recommendation reasons. |
java.lang.String |
getName() |
curam.util.type.Date |
getNextReviewDate()
Returns the next review date for the
OutcomePlan . |
PlanReview |
getOpenPlanReview()
|
java.util.List<PlanReview> |
listActivePlanReviews()
Returns all active
PlanReview for the OutcomePlan . |
java.util.List<curam.outcomeplanning.outcomeplan.impl.ActivityRecommendationDetail> |
listActivityRecommendationDetails()
List the
ActivityRecommendationDetail for this plan. |
java.util.List<OutcomePlanExpectedOutcome> |
listOutcomePlanExpectedOutcomes()
Returns a list of all objectives for this outcome plan.
|
java.util.List<Recommendation> |
listPlanRecommendations()
Lists all plan recommendations on this Outcome Plan, ie recommendations of
type
RECOMMENDATIONTYPEEntry.OUTCOMEPLAN . |
java.util.List<curam.piwrapper.caseheader.impl.CaseHeader> |
listRelatedCases()
Retrieves a list of all the
cases related to the outcome
plan ordered by the date the link was created on. |
java.util.List<curam.outcomeplanning.outcomeplan.impl.OutcomePlanRecommendationsRulesResult> |
listRulesetRecommendations(curam.codetable.impl.RECOMMENDABLETYPEEntry recommendableType)
Retrieves a list of the recommended activities and objectives as determined
by the recommendation rule set specified on the
OutcomePlanAdmin . |
void |
updateNextReviewDueDate(curam.outcomeplanning.outcomeplan.entity.struct.OutcomePlanDtls dtls)
Updates just the next review due date of the
OutcomePlan without
triggering any validations. |
getFactorResultRelatedType
getFactorDeliveryRelatedType
checkSecurity, getActualOutcome, getAdminCaseConfiguration, getAdminConfigurationID, getCaseHeaderVersionNo, getCaseReference, getCaseType, getClassification, getComments, getConcernRole, getDefaultCurrency, getDefaultDeliveryMethod, getDescription, getEffectiveDate, getEndDate, getExpectedEndDate, getExpectedOutcome, getExpectedStartDate, getFirstReviewDate, getHomePageName, getIntegratedCaseType, getObjective, getOutcome, getOwnerOrgObjectLink, getParentCase, getPriority, getReceivedDate, getRegistrationDate, getServicePlanDelivery, getStartDate, getStatus, hasAppeal, listActiveCaseMembers, listActiveCaseParticipantRoles, listSupervisorsForCaseOwner, readSupervisor, readSupervisorForCaseOwner
getContextContainer, getID, getPersistenceEventDispatcher
cancelPriority, isPriority, listPriorityHistory, readPriority, setAsPriority
getProgressableRelatedType, isProgressUpdateAllowed
getCase, getClients, getDateTrackableItemType, getDaysOverDue, getExpectedEndDate, getItemName, getItemsOverDueCompletionConfigType, getItemsToCompleteConfigType, getStartDate, getTabURI, isCompleted, isDueToCompleteOnOrBefore, isDueToStartOnOrBefore, isOverdueCompletion
curam.piwrapper.user.impl.User getCreatedBy()
User
who created the OutcomePlan
.OutcomePlan
record.java.lang.String getName()
getName
in interface curam.piwrapper.caseheader.impl.CaseHeader
java.util.List<curam.piwrapper.caseheader.impl.CaseHeader> listRelatedCases()
cases
related to the outcome
plan ordered by the date the link was created on.java.util.List<Recommendation> listPlanRecommendations() throws curam.util.exception.AppException, curam.util.exception.InformationalException
RECOMMENDATIONTYPEEntry.OUTCOMEPLAN
. This is distinctive from
listRecommendations()
in that listRecommendations()
lists
factor recommendations and plan recommendations, ie of type
RECOMMENDATIONTYPEEntry.OUTCOMEPLAN
and
RECOMMENDATIONTYPEEntry.FACTOR
. When only plan recommendations are
required use this listPlanRecommendations()
operation.curam.util.exception.AppException
curam.util.exception.InformationalException
curam.outcomeplanning.outcomeplan.impl.ExpectedOutcomeRecommendationDetail getExpectedOutcomeRecommendationReason(curam.piwrapper.casemanager.impl.CaseParticipantRole caseParticipantRole, long expectedOutcomeID) throws curam.util.exception.AppException, curam.util.exception.InformationalException
ExpectedOutcome
recommendation reasons.caseParticipantRole
- The CaseParticipantRole
this recommendation relates to.expectedOutcomeID
- The expected outcome ID.ExpectedOutcome
recommendation and reasons.curam.util.exception.AppException
- Generic Application Exception.curam.util.exception.InformationalException
- Generic Application Exception.PlanReview getOpenPlanReview()
PLANREVIEWSTATUSEntry#OPEN
PlanReview
for the
OutcomePlan
. null
is returned if no open review
exists.java.util.List<PlanReview> listActivePlanReviews()
PlanReview
for the OutcomePlan
. This
includes all reviews whose status is not
PLANREVIEWSTATUSEntry#CANCELLED
.curam.util.type.Date getNextReviewDate()
OutcomePlan
. This is the date
on which the next PlanReview
is due. It is calculated based on plan
reviews previously carried out on the case and the OutcomePlanAdmin
configurations. This is optional and Date.kZeroDate
is returned if
the next review date is not applicable.Date.kZeroDate
if none existscuram.util.exception.LocalisableString getAgreementsSignedState()
LocalisableString
containing the state for all
agreements
that exist on this outcome plan, and whether
they are all signed, pending signing, or it is not applicable for this
outcome plan. The meaning of not applicable is that either no agreements
exist on this outcome plan or they exist but all have a status of canceled.
The following are the possible states that can be returned:
GENERALASSESSMENTPLANNING#INF_YES
- if agreements exists on
this outcome plan and at least one has a status of
AGREEMENTSTATUSEntry#SIGNED
and the remainder
AGREEMENTSTATUSEntry#CANCELLED
, or all have a status of
AGREEMENTSTATUSEntry#SIGNED
GENERALASSESSMENTPLANNING#INF_AWAITING_CREATION
- if no
agreements exist on this outcome plan or if all agreements existing on this
outcome plan have a status of AGREEMENTSTATUSEntry#CANCELLED
GENERALASSESSMENTPLANNING#INF_PENDING
- if an agreement exists
on this outcome plan and one or more have a status of
AGREEMENTSTATUSEntry#INEDIT
, AGREEMENTSTATUSEntry#ISSUED
,
or AGREEMENTSTATUSEntry#COMPLETE
LocalisableString
containing the signed state for the
agreement or agreements that exists on this outcome planjava.util.List<curam.outcomeplanning.outcomeplan.impl.OutcomePlanRecommendationsRulesResult> listRulesetRecommendations(curam.codetable.impl.RECOMMENDABLETYPEEntry recommendableType) throws curam.util.exception.AppException, curam.util.exception.InformationalException
OutcomePlanAdmin
.recommendableType
- The type of recommendation i.e. whether it is an objective or
activity. *curam.util.exception.InformationalException
- Generic Exception Signaturecuram.util.exception.AppException
- Generic Exception Signaturejava.util.List<curam.outcomeplanning.outcomeplan.impl.ActivityRecommendationDetail> listActivityRecommendationDetails() throws curam.util.exception.AppException, curam.util.exception.InformationalException
ActivityRecommendationDetail
for this plan.ActivityRecommendationDetail
for this plan.curam.util.exception.InformationalException
- Generic Exception Signaturecuram.util.exception.AppException
- Generic Exception Signaturecuram.outcomeplanning.outcomeplan.impl.ActivityRecommendationDetail getActivityRecommendationDetail(curam.piwrapper.casemanager.impl.CaseParticipantRole caseParticipantRole, curam.piwrapper.outcomeplan.codetable.impl.OUTCOMEPLANACTIVITYTYPEEntry activityType, long activityAdminID) throws curam.util.exception.AppException, curam.util.exception.InformationalException
OutcomePlanActivity
recommendation reasons.caseParticipantRole
- The CaseParticipantRole
this recommendation relates to.activityType
- The activity type.activityAdminID
- The recommendation activity admin ID.OutcomePlanActivity
recommendation and reasons.curam.util.exception.AppException
- Generic Application Exception.curam.util.exception.InformationalException
- Generic Application Exception.java.util.List<OutcomePlanExpectedOutcome> listOutcomePlanExpectedOutcomes()
void updateNextReviewDueDate(curam.outcomeplanning.outcomeplan.entity.struct.OutcomePlanDtls dtls) throws curam.util.exception.InformationalException
OutcomePlan
without
triggering any validations.dtls
- curam.util.exception.AppException
curam.util.exception.InformationalException