@AccessLevel(value=EXTERNAL)
public interface FactorDelivery
extends curam.util.persistence.StandardEntity, curam.progress.impl.Progressable, curam.util.persistence.OptimisticLockModifiable, curam.util.persistence.helper.Lifecycle<curam.codetable.impl.RECORDSTATUSEntry>, curam.util.persistence.helper.LogicallyDeleteable, curam.util.persistence.Insertable, curam.outcomeplanning.outcomeplan.impl.Timelineable
Outcome Plan
in three ways: by running an assessment, by adding a factor which has been
configured in the administration application or by the addition of a user
defined factor.Modifier and Type | Method and Description |
---|---|
java.lang.Integer |
getAge()
Retrieves the age of the concern role.
|
curam.util.exception.LocalisableString |
getAgeLocalisableString()
Returns a
LocalisableString with the age of the concern role. |
curam.piwrapper.casemanager.impl.CaseParticipantRole |
getCaseParticipantRole()
Returns the
CaseParticipantRole linked to the Factor Delivery. |
java.util.List<curam.piwrapper.casemanager.impl.CaseParticipantRole> |
getClientsRelatedToFactorDelivery(java.util.List<curam.piwrapper.casemanager.impl.CaseParticipantRole> caseParticipatnRoleListToFileter)
Filters the passed in list of
case participant
roles to contain only participant roles related to this factor delivery. |
java.lang.String |
getFactorName()
Returns the localizable factor name.
|
FactorResult |
getInitialFactorResult()
Returns the initialResult for this Factor Delivery.
|
FactorResult |
getLatestResult()
Returns the latestResult for this Factor Delivery.
|
java.lang.String |
getName()
Returns the name of this this Factor Delivery.
|
curam.util.type.Date |
getNextAssessmentDueDate()
Returns the next date an assessment is due for this Factor Delivery.
|
java.lang.String |
getReason()
Returns the reason this Factor Delivery was recorded.
|
curam.piwrapper.user.impl.User |
getRecordedByUser()
Returns the user who recorded this Factor Delivery.
|
curam.util.type.DateTime |
getRecordedDateTime()
Returns the date and time this Factor Delivery was recorded.
|
java.util.List<curam.piwrapper.casemanager.impl.CaseParticipantRole> |
getRelatedCaseParticipantRoles()
For group based assessments the factor delivery is not related to a single
client, instead it is for a group of clients, this operation returns the
case participants that the factor delivery is related to.
|
java.lang.String |
getRelatedClientNames()
Retrieves a comma separated list of the clients that the factor delivery is
for.
|
curam.codetable.impl.FACTORDELIVERYTYPEEntry |
getType()
Retrieves the type of this FactorDelivery, that is Assessment, Stand alone
or User Defined.
|
java.lang.Boolean |
hasGuidance()
Retries a boolean indicating if guidance has being entered and exists for
this factor delivery.
|
java.lang.Boolean |
hasProgress()
Retries a boolean indicating if progress has being entered and exists for
this factor delivery.
|
boolean |
isPlanning()
Indicates whether this factor is a planning factor.
|
java.util.List<FactorResult> |
listFactorResults()
Retrieves a list of all the
FactorResult that exist for this Factor
Delivery. |
getProgressableRelatedType, isProgressUpdateAllowed
java.lang.String getName()
java.lang.String getFactorName()
curam.piwrapper.casemanager.impl.CaseParticipantRole getCaseParticipantRole()
CaseParticipantRole
linked to the Factor Delivery. For
Group Based assessments no case participant role will be recorded for the
factor delivery, in this instance null
will be returned.CaseParticipantRole
, or null if one is not
linked to the factor delivery.java.util.List<curam.piwrapper.casemanager.impl.CaseParticipantRole> getRelatedCaseParticipantRoles()
getCaseParticipantRole()
.java.lang.String getRelatedClientNames()
FactorResult getLatestResult()
curam.piwrapper.user.impl.User getRecordedByUser()
curam.util.type.DateTime getRecordedDateTime()
java.lang.String getReason()
FactorResult getInitialFactorResult()
curam.util.type.Date getNextAssessmentDueDate()
java.lang.Boolean hasGuidance() throws curam.util.exception.AppException, curam.util.exception.InformationalException
curam.util.exception.AppException
- Generic Application Exception.curam.util.exception.InformationalException
- Generic Application Exception.java.lang.Boolean hasProgress()
curam.codetable.impl.FACTORDELIVERYTYPEEntry getType()
java.util.List<FactorResult> listFactorResults()
FactorResult
that exist for this Factor
Delivery. If no factor results exist for this factor delivery an empty list
is returned.java.lang.Integer getAge()
curam.util.exception.LocalisableString getAgeLocalisableString()
LocalisableString
with the age of the concern role.boolean isPlanning()
java.util.List<curam.piwrapper.casemanager.impl.CaseParticipantRole> getClientsRelatedToFactorDelivery(java.util.List<curam.piwrapper.casemanager.impl.CaseParticipantRole> caseParticipatnRoleListToFileter)
case participant
roles
to contain only participant roles related to this factor delivery.
The case participant role instances can differ from those passed in to
those that are related to this factor delivery. As a result the comparison
to determine if the case participant role passed is related to this factor
delivery is done through the ConcernRole
the case participant roles
are related to.
The returned list of case participant roles are instances of the case
participant roles that from the passed in list. The instances of case
participant roles retrieved from getRelatedCaseParticipantRoles()
are contained in the returned list.
caseParticipatnRoleListToFileter
- the list of case participant roles to be filtered and the returned
list to be created fromList
of case participant roles representing the clients
contained in the passed in list that are related to the factor
delivery.