@AccessLevel(value=EXTERNAL) public interface OutcomePlanExpectedOutcome extends curam.util.persistence.StandardEntity, curam.util.persistence.OptimisticLockModifiable, curam.util.persistence.helper.LogicallyDeleteable, curam.progress.impl.Progressable, curam.outcomeplanning.outcomeplan.impl.Timelineable, curam.piwrapper.outcomeplan.impl.Reviewable, java.lang.Comparable<OutcomePlanExpectedOutcome>, curam.piwrapper.outcomeplan.impl.OutcomePlanDateTrackableItem
OutcomePlan
, e.g.
Safety, Self Sufficiency.
The following exceptions are thrown by this entity:
OUTCOMEPLANEXPECTEDOUTCOME#ERR_FV_EXPECTED_END_DATE_MUST_BE_ENTERED
-
if the expected end date has not been set.
OUTCOMEPLANEXPECTEDOUTCOME#ERR_FV_EXPECTED_OUTCOME_MUST_BE_ENTERED
-
if the expected outcome has not been set.
OUTCOMEPLANEXPECTEDOUTCOME#ERR_FV_OUTCOME_MUST_BE_ENTERED
- if the
outcome has not been set.
OUTCOMEPLANEXPECTEDOUTCOME#ERR_FV_OUTCOME_PLAN_MUST_BE_ENTERED
- if
the outcome plan has not been set.
OUTCOMEPLANEXPECTEDOUTCOME#ERR_FV_RATIONALE_MUST_BE_ENTERED
- if the
rationale for the expected outcome has not been set.
OUTCOMEPLANEXPECTEDOUTCOME#ERR_XFV_REASON_UNATTAINED_MUST_BE_ENTERED_FOR_OUTCOME_UNATTAINED
- if the outcome is set to 'Not Attained' and a 'Reason Unattained' is not
entered.
OUTCOMEPLANEXPECTEDOUTCOME#ERR_XRV_EXPECTED_OUTCOME_CANNOT_BE_DELETED_AS_OUTCOME_ENTERED
- if the expected outcome is cancelled and the outcome is set to 'Attained'
or 'Not Attained'.
OUTCOMEPLANEXPECTEDOUTCOME#ERR_XRV_EXPECTED_OUTCOME_CAN_NOT_BE_DELETED_NOTES_ADDED
- if the expected outcome is cancelled and notes had been added.
OUTCOMEPLANEXPECTEDOUTCOME#ERR_XRV_EXPECTED_OUTCOME_CAN_NOT_BE_DELETED_PROGRESS_ADDED
- if the expected outcome is cancelled and progress had been added.
OUTCOMEPLANEXPECTEDOUTCOME#ERR_XRV_EXPECTED_OUTCOME_CAN_NOT_BE_DELETED_EXPECTED_END_DATE_DETAILS_ADDED
- if the expected outcome is cancelled and the expected end date had been
updated.
Modifier and Type | Interface and Description |
---|---|
static class |
OutcomePlanExpectedOutcome.OutcomePlanExpectedOutcomeEvent
Events are raised during the processing of an
OutcomePlanExpectedOutcome instance, these events allow customers
to add additional processing as required. |
Modifier and Type | Method and Description |
---|---|
java.lang.Boolean |
clientsRemovable()
Determines if it is possible to remove
clients
from this outcome plan expected outcome. |
java.lang.Boolean |
clientsSelectable()
Determines if it is possible to select and relate
CaseParticipantRole to this OutcomePlanExpectedOutcome from the
parent OutcomePlan . |
java.lang.Boolean |
factorsRemovable()
Determines if it is possible to remove
factors from
this Objective. |
java.lang.Boolean |
factorsSelectable()
Determines if it is possible to select and relate
factors to this OutcomePlanExpectedOutcome. |
curam.piwrapper.user.impl.User |
getCompletedBy()
Getter for the user who completed the outcome plan expected outcome.
|
curam.util.type.Date |
getCompletionDate()
Getter for the date the outcome plan expected outcome was completed.
|
curam.piwrapper.user.impl.User |
getCreatedBy()
Getter for the user who created the outcome plan expected outcome.
|
curam.util.type.Date |
getCreationDate()
Getter for the date the outcome plan expected outcome was created.
|
curam.workspaceservices.localization.impl.LocalizableText |
getCustomNameLocalizableText()
Reads the custom localizable name of the
OutcomePlanExpectedOutcome
. |
curam.util.type.Date |
getExpectedEndDate() |
java.lang.String |
getName() |
curam.workspaceservices.localization.impl.LocalizableText |
getNameLocalizableText()
Reads the custom localizable name of the
OutcomePlanExpectedOutcome
if present, or the ExpectedOutcome if a delivery side setting is
not present. |
curam.piwrapper.impl.Note |
getNote()
Getter for the notes for the outcome plan expected outcome.
|
curam.codetable.impl.EXPECTEDOUTCOMEACHIEVEDEntry |
getOutcome() |
OutcomePlan |
getOutcomePlan()
Getter for the
OutcomePlan . |
java.lang.String |
getReason() |
curam.codetable.impl.REASONOUTCOMEUNATTAINEDEntry |
getReasonOutcomeUnattained()
Getter for the reason outcome unattained value.
|
java.lang.Boolean |
hasProgress()
Retries a boolean indicating if progress has being entered and exists for
this expected outcome.
|
boolean |
isActive()
Indicates if the activity is
OutcomePlanExpectedOutcome , i.e. the
outcome plan expected outcome status is not Cancelled and the outcome plan
expected outcome has not been completed. |
boolean |
isDeleteNotAllowed()
Indicates if this
OutcomePlanExpectedOutcome may be deleted. |
getProgressableRelatedType, isProgressUpdateAllowed
getTimelineType, listActivities, listCurrentActivities
getCompletionComments, getCompletionURI, getRelatedCase, getReviewRelatedType, getTabURI, isCompleted, isCompletionAllowed
getCase, getClients, getDateTrackableItemType, getDaysOverDue, getItemName, getItemsOverDueCompletionConfigType, getItemsToCompleteConfigType, getStartDate, getTabURI, isCompleted, isDueToCompleteOnOrBefore, isDueToStartOnOrBefore, isOverdueCompletion
curam.util.type.Date getExpectedEndDate()
getExpectedEndDate
in interface curam.piwrapper.outcomeplan.impl.OutcomePlanDateTrackableItem
OutcomePlan getOutcomePlan()
OutcomePlan
.OutcomePlan
object instancecuram.codetable.impl.EXPECTEDOUTCOMEACHIEVEDEntry getOutcome()
getOutcome
in interface curam.piwrapper.outcomeplan.impl.Reviewable
java.lang.String getReason()
getReason
in interface curam.piwrapper.outcomeplan.impl.Reviewable
curam.codetable.impl.REASONOUTCOMEUNATTAINEDEntry getReasonOutcomeUnattained()
curam.piwrapper.user.impl.User getCreatedBy()
curam.util.type.Date getCreationDate()
curam.util.type.Date getCompletionDate()
curam.piwrapper.user.impl.User getCompletedBy()
java.lang.Boolean hasProgress()
curam.piwrapper.impl.Note getNote() throws curam.util.exception.InformationalException
curam.util.exception.InformationalException
- Generic Exception Signaturejava.lang.String getName()
getName
in interface curam.piwrapper.outcomeplan.impl.Reviewable
curam.workspaceservices.localization.impl.LocalizableText getNameLocalizableText()
OutcomePlanExpectedOutcome
if present, or the ExpectedOutcome
if a delivery side setting is
not present.OutcomePlanExpectedOutcome
if present, or the
ExpectedOutcome
if a delivery side setting is not present.curam.workspaceservices.localization.impl.LocalizableText getCustomNameLocalizableText()
OutcomePlanExpectedOutcome
.OutcomePlanExpectedOutcome
.java.lang.Boolean factorsSelectable()
factors
to this OutcomePlanExpectedOutcome.
If no factors exist on the OutcomePlan
that are related to the
individuals
this objective is in relation to
then it is not possible to relate factors and false is returned. If factors
do exist on the outcome plan that are related to the individuals this
objective is in relation to and all are already related to this objective
then it is not possible to related any factors to this objective and false
is returned. If this objective is complete or canceled then false is
returned.
java.lang.Boolean clientsSelectable()
CaseParticipantRole
to this OutcomePlanExpectedOutcome from the
parent OutcomePlan
.
If clients exist on the outcome plan that are not currently related to this outcome plan expected outcome then it is possible to select and associate case participant roles to this expected outcome and true is returned. If this expected outcome is not complete or canceled then true is returned.
java.lang.Boolean clientsRemovable()
clients
from this outcome plan expected outcome.
If this outcome plan expected outcome is complete or canceled then false is returned. If this expected outcome is in relation to a single client then false is returned. If progress exists for this expected outcome then false is returned. If this each client of this expected outcome is related to a factor on this expected outcome then false is returned.
java.lang.Boolean factorsRemovable()
factors
from
this Objective.
If this objective is complete or canceled then false is returned. If no factors are related to this objective then false is returned.
boolean isActive()
OutcomePlanExpectedOutcome
, i.e. the
outcome plan expected outcome status is not Cancelled and the outcome plan
expected outcome has not been completed.boolean isDeleteNotAllowed() throws curam.util.exception.InformationalException
OutcomePlanExpectedOutcome
may be deleted.
Returns true if the expected outcome cannot be deleted, false otherwise.curam.util.exception.InformationalException
- Generic Exception Signature