@AccessLevel(value=EXTERNAL) public interface OutcomePlanAction extends curam.util.persistence.helper.Lifecycle<curam.outcomeplanning.codetable.impl.OPACTIONSTATUSEntry>, curam.util.persistence.OptimisticLockModifiable, curam.piwrapper.outcomeplan.impl.OutcomePlanActivity, curam.progress.impl.Progressable, curam.piwrapper.attendance.impl.DailyAttendanceRelatedItem, curam.clientdiary.impl.ScheduledAppointment, curam.piwrapper.outcomeplan.impl.Reviewable, java.lang.Comparable<OutcomePlanAction>, curam.piwrapper.outcomeplan.impl.OutcomePlanDateTrackableItem
outcome plan
to address client needs.
The following exception messages are thrown by this entity:
OUTCOMEPLANADMIN#ERR_FV_NAME_MUST_BE_ENTERED
- If the name field is
empty and it is not a predefined action.
OUTCOMEPLANADMIN#ERR_FV_NAME_MUST_BE_UNIQUE
- If the action is user
defined, and another action exists with the same name, client and overlapping
date range.
OUTCOMEPLANACTION#ERR_XFV_CANNOT_MODIFY_OUTCOME_FOR_NONCOMPLETED_ACTION
- If the outcome is set but the status is not
OPACTIONSTATUSEntry.COMPLETED
OUTCOMEPLANACTION#ERR_XFV_CANNOT_MODIFY_OUTCOME_REASON_FOR_NONCOMPLETED_ACTION
- If the outcome reason is set but the status is not
OPACTIONSTATUSEntry.COMPLETED
OUTCOMEPLANACTION#ERR_XFV_CANNOT_MODIFY_ACTUAL_COST_FOR_NONCOMPLETED_ACTION
- If the actual cost is set but the status is not
OPACTIONSTATUSEntry.COMPLETED
OUTCOMEPLANACTION#ERR_XFV_OUTCOME_MANDATORY_FOR_COMPLETED_ACTION
- If
the status is OPACTIONSTATUSEntry.COMPLETED
but the outcome is not
given
OUTCOMEPLANACTION#ERR_XFV_OUTCOME_REASON_MANDATORY_IF_OUTCOME_NOT_SUCCESSFUL
- If the outcome is OPACTIONOUTCOME#NOTSUCCESSFUL
but no reason is
given
curam.outcomeplanning.outcomeplan.entity.intf.OutcomePlanAction}
Modifier and Type | Interface and Description |
---|---|
static class |
OutcomePlanAction.OutcomePlanActionSecurityStrategy
Strategy pattern to allow customers to change the default behavior of
OutcomePlanAction security functionality. |
Modifier and Type | Method and Description |
---|---|
java.lang.Boolean |
clientsSelectable()
Determines if it is possible to select and relate
CaseParticipantRole to this OutcomePlanAction from the parent
OutcomePlan . |
curam.util.type.Money |
getActualCost()
Returns the actual cost of the
OutcomePlanAction . |
curam.util.type.Money |
getCost()
Returns the estimated cost of the
OutcomePlanAction . |
curam.piwrapper.user.impl.User |
getCreatedBy()
Returns the
User who created the OutcomePlanAction . |
curam.util.type.Date |
getCreationDate()
Returns the date date of creation of the
OutcomePlanAction . |
java.lang.String |
getName() |
curam.piwrapper.impl.Note |
getNote()
Returns the
Note recorded for this OutcomePlanAction . |
curam.piwrapper.outcomeplan.codetable.impl.ACTIVITYOUTCOMEACHIEVEDEntry |
getOutcome() |
java.lang.String |
getOutcomeComments()
Returns any comments specified on completion of the
OutcomePlanAction was unsuccessful. |
OutcomePlan |
getOutcomePlan()
Returns the
OutcomePlan that this OutcomePlanAction has
been added to. |
OutcomePlanActionAdmin |
getOutcomePlanActionAdmin()
Returns the
OutcomePlanActionAdmin that this
OutcomePlanAction is based on. |
curam.piwrapper.outcomeplan.codetable.impl.ACTIVITYOUTCOMEREASONEntry |
getOutcomeReason()
Returns the
reason why the outcome was
ACTIVITYOUTCOMEACHIEVEDEntry.NOTSUCCESSFUL . |
curam.piwrapper.user.impl.User |
getOwner() |
java.lang.String |
getReason() |
java.lang.String |
getResponsibilityRelatedID()
Returns the unique identifier of the
User or
CaseParticipantRole who is responsible for the
OutcomePlanAction . |
curam.outcomeplanning.codetable.impl.OPACTIONRESPONSABILITYRELATEDTYPEEntry |
getResponsibilityRelatedType()
Returns the
type of the
person who is responsible for the OutcomePlanAction . |
curam.codetable.impl.SENSITIVITYEntry |
getSensitivity()
Returns the sensitivity level associated with the
OutcomePlanAction
. |
java.lang.Boolean |
hasProgress()
Indicates if
Progress exists for this OutcomePlanAction . |
boolean |
isDeletable()
Indicates if this
OutcomePlanAction may be deleted. |
boolean |
isMultipleClientAction()
Indicates if multiple clients may be added to this
OutcomePlanAction . |
boolean |
isPredefined()
Indicates if this
OutcomePlanAction is based on a predefined
OutcomePlanActionAdmin . |
java.util.List<curam.piwrapper.casemanager.impl.CaseParticipantRole> |
listCaseParticipantRoles() |
java.util.List<FactorDelivery> |
listFactors()
Returns the list of
FactorDelivery linked to the
OutcomePlanAction . |
getActivityStatus, getActivityType, getListSummaryURI, getOutcomePlanActivityAdmin, getRelatedCase, getServiceOfferingID, getTabURI, getWorkspaceSummaryURI, isActive, isParticipationAllowed
getProgressableRelatedType, isProgressUpdateAllowed
getAttendanceRelatedType, getDurationHours, getDurationMinutes, getFrequencyPattern, listParticipation
getClientDiaryRelatedType, getDescription, getEnd, getFrequencyAndDuration, getOwnerName, getOwnerOrgObjectReference, getOwnerOrgObjectType, getStart
getCompletionComments, getCompletionURI, getRelatedCase, getReviewRelatedType, getTabURI, isCompleted, isCompletionAllowed
getCase, getClients, getDateTrackableItemType, getDaysOverDue, getExpectedEndDate, getItemName, getItemsOverDueCompletionConfigType, getItemsToCompleteConfigType, getStartDate, getTabURI, isCompleted, isDueToCompleteOnOrBefore, isDueToStartOnOrBefore, isOverdueCompletion
java.lang.String getName()
getName
in interface curam.piwrapper.outcomeplan.impl.OutcomePlanActivity
getName
in interface curam.piwrapper.outcomeplan.impl.Reviewable
java.lang.String getReason()
getReason
in interface curam.piwrapper.outcomeplan.impl.Reviewable
curam.util.type.Money getCost()
OutcomePlanAction
.curam.util.type.Money getActualCost()
OutcomePlanAction
. The
cost model
defined on the
OutcomePlanActionAdmin
determines the type of this cost. This is
usually specified on completion of the action, unless the cost model is
OPACTIONCOSTMODELEntry#FIXEDACTUAL
in which case it is populated on
creation of the action.curam.codetable.impl.SENSITIVITYEntry getSensitivity()
OutcomePlanAction
. A user must have at least an equivalent sensitivity to view, modify,
create or delete an action.curam.piwrapper.outcomeplan.codetable.impl.ACTIVITYOUTCOMEACHIEVEDEntry getOutcome()
getOutcome
in interface curam.piwrapper.outcomeplan.impl.Reviewable
java.lang.String getOutcomeComments()
OutcomePlanAction
was unsuccessful.curam.piwrapper.outcomeplan.codetable.impl.ACTIVITYOUTCOMEREASONEntry getOutcomeReason()
reason
why the outcome was
ACTIVITYOUTCOMEACHIEVEDEntry.NOTSUCCESSFUL
. This is mandatory when
the outcome is not successful.OutcomePlan getOutcomePlan()
OutcomePlan
that this OutcomePlanAction
has
been added to.OutcomePlan
that this action has been added toOutcomePlanActionAdmin getOutcomePlanActionAdmin()
OutcomePlanActionAdmin
that this
OutcomePlanAction
is based on. This only applies for predefined
actions, and is null for user defined actions.OutcomePlanActionAdmin
that this action is based oncuram.piwrapper.user.impl.User getOwner()
getOwner
in interface curam.piwrapper.outcomeplan.impl.OutcomePlanActivity
curam.outcomeplanning.codetable.impl.OPACTIONRESPONSABILITYRELATEDTYPEEntry getResponsibilityRelatedType()
type
of the
person who is responsible for the OutcomePlanAction
.java.lang.String getResponsibilityRelatedID()
User
or
CaseParticipantRole
who is responsible for the
OutcomePlanAction
.boolean isDeletable()
OutcomePlanAction
may be deleted. Returns
false
action has a status of
OPACTIONSTATUSEntry.COMPLETED
or if the OutcomePlan
is
CASESTATUSEntry#CLOSED
. The method also returns false
if a modify SID has been defined for the action and the current user does
not have the specified SID as part of their security profile.true
if this action may be logically deleted,
false
otherwiseboolean isPredefined()
OutcomePlanAction
is based on a predefined
OutcomePlanActionAdmin
. Returns true
if the action is
based on a predefined action, or false
if it is a user defined
action.true
if this action is based on a predefined
OutcomePlanActionAdmin
, false
otherwiseboolean isMultipleClientAction()
OutcomePlanAction
. This is true if the action is predefined and
multiple clients is set on the OutcomePlanActionAdmin
or if the
action is user defined.java.util.List<curam.piwrapper.casemanager.impl.CaseParticipantRole> listCaseParticipantRoles()
listCaseParticipantRoles
in interface curam.piwrapper.outcomeplan.impl.OutcomePlanActivity
java.lang.Boolean hasProgress()
Progress
exists for this OutcomePlanAction
.
Returns true if progress exists, false otherwise.curam.piwrapper.impl.Note getNote()
Note
recorded for this OutcomePlanAction
. If no
note was specified, null is returned.curam.util.type.Date getCreationDate()
OutcomePlanAction
.curam.piwrapper.user.impl.User getCreatedBy()
User
who created the OutcomePlanAction
.java.util.List<FactorDelivery> listFactors()
FactorDelivery
linked to the
OutcomePlanAction
.java.lang.Boolean clientsSelectable()
CaseParticipantRole
to this OutcomePlanAction from the parent
OutcomePlan
.
If this action is complete or canceled then false is returned. If the parent case case upon which this action exists must closed then false is returned. If all clients that exist on the outcome plan are currently related to this action then false is returned.