@AccessLevel(value=EXTERNAL) public interface OutcomePlanDAO extends curam.util.persistence.StandardDAO<OutcomePlan>
OutcomePlan
entity.Modifier and Type | Method and Description |
---|---|
OutcomePlan |
getLatest(curam.participant.impl.ConcernRole concernRole)
Retrieves the latest
OutcomePlan for the specified
ConcernRole . |
java.util.List<OutcomePlan> |
searchByActivityOwner(curam.piwrapper.user.impl.User user)
Searches for
OutcomePlans that the user passed in is
the owner of. |
java.util.List<OutcomePlan> |
searchByNextReviewDueDateAndUser(curam.piwrapper.user.impl.User user,
curam.util.type.Date date)
Searches for
OutcomePlans that the user passed in is
the owner of, and for which the nextReviewDueDate is before the Date
specified, closed OutcomePlans are not returned and only cases that have
the user OrgObjectType will also be returned. |
java.util.List<OutcomePlan> |
searchByOwner(curam.piwrapper.user.impl.User user)
Searches for
OutcomePlans that the user passed in is
the owner of. |
java.util.List<OutcomePlan> |
searchByOwnerOrCollaborationMember(curam.piwrapper.user.impl.User user)
Searches for
OutcomePlans that the user passed in is
the owner of or a collaboration member. |
java.util.List<OutcomePlan> |
searchByParticipant(curam.participant.impl.ConcernRole concernRole)
Searches for
OutcomePlans that the participant has is a
member on. |
java.util.List<OutcomePlan> |
searchByRelatedCase(curam.piwrapper.caseheader.impl.CaseHeader caseHeader)
Searches for
OutcomePlan instances related to the specified case. |
java.util.List<OutcomePlan> |
searchDueToCompleteByOwner(curam.piwrapper.user.impl.User user,
curam.util.type.Date dueToCompleteOnOrBefore)
Searches for
OutcomePlans that the user passed in is
the owner of, and that is due to complete on or before the specified date. |
java.util.List<OutcomePlan> |
searchOverdueCompletionByOwner(curam.piwrapper.user.impl.User user,
int numDaysOverThreshold)
Searches for
OutcomePlans that the user passed in is
the owner of, and that is overdue completion. |
void |
updateNextReviewDueDate(curam.outcomeplanning.outcomeplan.entity.struct.OutcomePlanDtls dtls)
Updates just the next review due date of the
OutcomePlan without
triggering any validations. |
java.util.List<OutcomePlan> searchByRelatedCase(curam.piwrapper.caseheader.impl.CaseHeader caseHeader)
OutcomePlan
instances related to the specified case.
The list returned is sorted with the most recent outcome plan returned
first.caseHeader
- The related case to search by.OutcomePlan
instances, or an empty list if
none are found.java.util.List<OutcomePlan> searchByOwner(curam.piwrapper.user.impl.User user) throws curam.util.exception.AppException, curam.util.exception.InformationalException
OutcomePlans
that the user passed in is
the owner of.user
- The user to search outcome plans for.curam.util.exception.AppException
- Generic Application Exceptioncuram.util.exception.InformationalException
- Generic Application Exceptionjava.util.List<OutcomePlan> searchDueToCompleteByOwner(curam.piwrapper.user.impl.User user, curam.util.type.Date dueToCompleteOnOrBefore) throws curam.util.exception.AppException, curam.util.exception.InformationalException
OutcomePlans
that the user passed in is
the owner of, and that is due to complete on or before the specified date.user
- The user to search outcome plans for.dueToCompleteOnOrBefore
- potential completion date. Returns records that are due to
complete on or before this date.curam.util.exception.AppException
- Generic Application Exceptioncuram.util.exception.InformationalException
- Generic Application Exceptionjava.util.List<OutcomePlan> searchOverdueCompletionByOwner(curam.piwrapper.user.impl.User user, int numDaysOverThreshold) throws curam.util.exception.AppException, curam.util.exception.InformationalException
OutcomePlans
that the user passed in is
the owner of, and that is overdue completion.user
- The user to search outcome plans for.numDaysOverThreshold
- The number of days an item must be past its expected end date
before it's considered overdue completioncuram.util.exception.AppException
- Generic Application Exceptioncuram.util.exception.InformationalException
- Generic Application Exceptionjava.util.List<OutcomePlan> searchByNextReviewDueDateAndUser(curam.piwrapper.user.impl.User user, curam.util.type.Date date) throws curam.util.exception.AppException, curam.util.exception.InformationalException
OutcomePlans
that the user passed in is
the owner of, and for which the nextReviewDueDate is before the Date
specified, closed OutcomePlans are not returned and only cases that have
the user OrgObjectType will also be returned.user
- The user to search outcome plans for.date
- the date to compare the nextReviewDate to. Only outcome plans with
a nextReviewDueDate before this date are returned.curam.util.exception.AppException
- Generic Application Exceptioncuram.util.exception.InformationalException
- Generic Application Exceptionjava.util.List<OutcomePlan> searchByParticipant(curam.participant.impl.ConcernRole concernRole)
OutcomePlans
that the participant has is a
member on. Lists all the Outcome Plans that the client has an active role
on, including closed Outcome Plans.concernRole
- The concern role/participant to search by.java.util.List<OutcomePlan> searchByOwnerOrCollaborationMember(curam.piwrapper.user.impl.User user) throws curam.util.exception.AppException, curam.util.exception.InformationalException
OutcomePlans
that the user passed in is
the owner of or a collaboration member.user
- The user to search outcome plans for.curam.util.exception.AppException
- Generic Application Exceptioncuram.util.exception.InformationalException
- Generic Application ExceptionOutcomePlan getLatest(curam.participant.impl.ConcernRole concernRole) throws curam.util.exception.AppException, curam.util.exception.InformationalException
OutcomePlan
for the specified
ConcernRole
. The latest plan is defined as the most recent open
plan on which the specified ConcernRole
is the ConcernRole
on the related CaseHeader
record. If the ConcernRole
has no
open plans, then the most recent closed plan determined on the basis of end
date on which the ConcernRole
is present on the related
CaseHeader
is deemed to be the latest. Failing this
null
is returned. If there are two or more plans for the
ConcernRole
on the same date the first returned by the database
will be returned.concernRole
- The ConcernRole
for whom the latest OutcomePlan
is
being sought.OutcomePlan
for the specified
ConcernRole
. If no plan exists for the ConcernRole
then
null
is returned.curam.util.exception.InformationalException
- Generic Application Exceptioncuram.util.exception.AppException
- Generic Application Exceptionjava.util.List<OutcomePlan> searchByActivityOwner(curam.piwrapper.user.impl.User user) throws curam.util.exception.AppException, curam.util.exception.InformationalException
OutcomePlans
that the user passed in is
the owner of.user
- The user to search outcome plans for.curam.util.exception.AppException
- Generic Application Exceptioncuram.util.exception.InformationalException
- Generic Application Exceptionvoid updateNextReviewDueDate(curam.outcomeplanning.outcomeplan.entity.struct.OutcomePlanDtls dtls) throws curam.util.exception.AppException, curam.util.exception.InformationalException
OutcomePlan
without
triggering any validations.dtls
- curam.util.exception.AppException
curam.util.exception.InformationalException