public interface Agreement
Modifier and Type | Method and Description |
---|---|
void |
addActivity(curam.outcomeplanning.outcomeplan.facade.struct.RoleOrActivityAgreementDetails details)
Adds a activity to the given
Agreement . |
void |
addAttachment(curam.attachmentlink.struct.AttachmentLinkDetails details)
Creates an attachment for the
Agreement . |
void |
addClient(curam.outcomeplanning.outcomeplan.facade.struct.RoleOrActivityAgreementDetails details)
Adds a client to the given
Agreement . |
void |
addComments(curam.outcomeplanning.outcomeplan.facade.struct.AgreementCommentsKey key)
Adds comments to the given
Agreement overriding the currently
entered comments.. |
void |
addSignatory(curam.outcomeplanning.outcomeplan.facade.struct.RoleOrActivityAgreementDetails details)
Adds a signatory to the given
Agreement . |
void |
approve(curam.outcomeplanning.outcomeplan.facade.struct.AgreementAndVersionNoKey key)
Approves the given
Agreement transitioning the status
from submitted to complete. |
void |
cancel(curam.outcomeplanning.outcomeplan.facade.struct.AgreementCancellationDetails key)
Cancels the given
Agreement
setting the cancellation reason, any entered cancellation comments, and
transitioning the status from cancelled. |
void |
complete(curam.outcomeplanning.outcomeplan.facade.struct.AgreementAndVersionNoKey key)
Completes the given
Agreement transitioning the status
from in-edit to complete. |
void |
issue(curam.outcomeplanning.outcomeplan.facade.struct.AgreementIssueKey key)
Issues the given
Agreement
to the selected client or signatory. |
curam.outcomeplanning.outcomeplan.facade.struct.OutcomePlanActivityDetailsList |
listActivitiesForAgreements(curam.outcomeplanning.outcomeplan.entity.struct.AgreementKey key)
Returns a list of the all activities that exist on the given
Agreement . |
curam.outcomeplanning.outcomeplan.facade.struct.AgreementListDetailsList |
listAgreementsForOutcomePlan(curam.outcomeplanning.outcomeplan.entity.struct.OutcomePlanKey key)
Returns a list of all active
Agreement for the given OutcomePlan . |
curam.attachmentlink.struct.ListAttachmentLinkDetails |
listAttachments(curam.outcomeplanning.outcomeplan.entity.struct.AgreementKey key)
Retrieves a list of the attachments related to the given
Agreement . |
curam.outcomeplanning.outcomeplan.facade.struct.AgreementRoleDetailsList |
listClientsForAgreements(curam.outcomeplanning.outcomeplan.entity.struct.AgreementKey key)
Returns a list of the all clients that exist on the given
Agreement . |
curam.outcomeplanning.outcomeplan.facade.struct.AgreementIssueHistoryDetailsList |
listIssueHistory(curam.outcomeplanning.outcomeplan.entity.struct.AgreementKey key)
Returns a list of the
AgreementIssueHistory for the
given Agreement . |
curam.outcomeplanning.outcomeplan.facade.struct.OutcomePlanActivityDetailsList |
listPotentialActivitiesForAgreements(curam.outcomeplanning.outcomeplan.entity.struct.AgreementKey key)
Returns a list of the all potential activities that exist on the
OutcomePlan the given Agreement is related to that can
related to the given agreement. |
curam.outcomeplanning.outcomeplan.facade.struct.CaseClientSummaryDetailsList |
listPotentialClientsForAgreements(curam.outcomeplanning.outcomeplan.entity.struct.AgreementKey key)
Returns a list of the all clients that exist on the
OutcomePlan the given Agreement is related to that can
added as clients. |
curam.outcomeplanning.outcomeplan.facade.struct.CaseClientSummaryDetailsList |
listPotentialSignatoriesForAgreements(curam.outcomeplanning.outcomeplan.entity.struct.AgreementKey key)
Retrieves a list of the all clients existing on the
OutcomePlan the given Agreement is related to that can
added as signatories. |
curam.outcomeplanning.outcomeplan.facade.struct.AgreementSignatoriesDetailsList |
listSignatoriesForAgreements(curam.outcomeplanning.outcomeplan.entity.struct.AgreementKey key)
Returns a list of the all signatoies that exist on the given
Agreement . |
curam.outcomeplanning.outcomeplan.facade.struct.AgreementStatusHistoryDetailsList |
listStatusHistory(curam.outcomeplanning.outcomeplan.entity.struct.AgreementKey key)
Returns a list of the
AgreementStatusHistory for the
given Agreement . |
curam.outcomeplanning.outcomeplan.facade.struct.AgreementDetails |
readAgreementDetails(curam.outcomeplanning.outcomeplan.entity.struct.AgreementKey key)
Reads the details of the given
Agreement . |
curam.outcomeplanning.outcomeplan.facade.struct.ParticipantAddressEmailAddressCommunicationDetails |
readAgreementParticipantDetailsForIssue(curam.core.facade.struct.CaseParticipantRoleKey key)
Reads the addresses, and email addresses of the given agreement
participant.
|
curam.outcomeplanning.outcomeplan.facade.struct.AgreementAndVersionNoKey |
readAgreementVersionNumber(curam.outcomeplanning.outcomeplan.entity.struct.AgreementKey key)
Reads the version number for the given
agreement identifier. |
curam.outcomeplanning.outcomeplan.facade.struct.AgreementComments |
readComments(curam.outcomeplanning.outcomeplan.entity.struct.AgreementKey key)
Reads the comments for the given
Agreement . |
curam.outcomeplanning.outcomeplan.facade.struct.AgreementIssueDetails |
readIssueDetails(curam.outcomeplanning.outcomeplan.entity.struct.AgreementKey key)
Reads the issue details for the given
Agreement . |
void |
reject(curam.outcomeplanning.outcomeplan.facade.struct.AgreementRejectionDetails key)
Rejects the completion attempt for the given
Agreement transitioning the status
from submitted to in-edit. |
void |
removeActivity(curam.outcomeplanning.outcomeplan.facade.struct.RoleOrActivityAgreementDetails details)
Removes an activity from an
Agreement . |
void |
removeClient(curam.outcomeplanning.outcomeplan.facade.struct.RoleOrActivityAgreementDetails details)
Removes a client from the given
Agreement . |
void |
removeSignatory(curam.outcomeplanning.outcomeplan.facade.struct.RoleOrActivityAgreementDetails details)
Removes a signatory from the given
Agreement . |
void |
signMultipleSignatories(curam.outcomeplanning.outcomeplan.facade.struct.AgreementSignatorySignDetailsMultiple details)
Registers multiple signatories on the given
Agreement as signed for the
specified date. |
void |
signSignatory(curam.outcomeplanning.outcomeplan.facade.struct.AgreementSignatorySignDetailsIndividual details)
Registers a signatory on the given
Agreement as signed for the
specified date. |
curam.outcomeplanning.outcomeplan.facade.struct.AgreementDocument |
viewAgreementDocument(curam.outcomeplanning.outcomeplan.entity.struct.AgreementKey key)
Retrieves the agreement document in relation to the given
Agreement for viewing. |
curam.outcomeplanning.outcomeplan.facade.struct.AgreementListDetailsList listAgreementsForOutcomePlan(curam.outcomeplanning.outcomeplan.entity.struct.OutcomePlanKey key) throws curam.util.exception.AppException, curam.util.exception.InformationalException
Agreement
for the given OutcomePlan
. This method is
intended to be used by users responsible for the management of outcome
plans.key
- The unique identifier of the outcome plan to search bycuram.util.exception.AppException
curam.util.exception.InformationalException
void addActivity(curam.outcomeplanning.outcomeplan.facade.struct.RoleOrActivityAgreementDetails details) throws curam.util.exception.AppException, curam.util.exception.InformationalException
Agreement
. This method is intended
to be used by users responsible for the management of outcome plans.details
- A tab separated list of selected activities to be related
to the agreement, and the unique identifier of the agreement to add the
selected activites tocuram.util.exception.AppException
curam.util.exception.InformationalException
void addClient(curam.outcomeplanning.outcomeplan.facade.struct.RoleOrActivityAgreementDetails details) throws curam.util.exception.AppException, curam.util.exception.InformationalException
Agreement
. This method is intended
to be used by users responsible for the management of outcome plans.details
- A tab separated list of selected individuals to be
registered as clients for the agreement, and the unique identifier of the
agreement to add the selected clients tocuram.util.exception.AppException
curam.util.exception.InformationalException
void addSignatory(curam.outcomeplanning.outcomeplan.facade.struct.RoleOrActivityAgreementDetails details) throws curam.util.exception.AppException, curam.util.exception.InformationalException
Agreement
. This method is intended
to be used by users responsible for the management of outcome plans.details
- A tab separated list of selected individuals to be
registered as signatories for the agreement, and the unique identifier of
the agreement to add the selected signatories tocuram.util.exception.AppException
curam.util.exception.InformationalException
void removeActivity(curam.outcomeplanning.outcomeplan.facade.struct.RoleOrActivityAgreementDetails details) throws curam.util.exception.AppException, curam.util.exception.InformationalException
Agreement
. This method is intended
to be used by users responsible for the management of outcome plans.details
- the unique identifier and type of the activity to be remove
from an agreement.curam.util.exception.AppException
curam.util.exception.InformationalException
void removeClient(curam.outcomeplanning.outcomeplan.facade.struct.RoleOrActivityAgreementDetails details) throws curam.util.exception.AppException, curam.util.exception.InformationalException
Agreement
. This method is intended
to be used by users responsible for the management of outcome plans.details
- the unique identifier of the client to be removed from an
agreement, the identifier of the agreement the client is to be removed
from, and the version number of the role through which the client is
related to the agreementcuram.util.exception.AppException
curam.util.exception.InformationalException
void removeSignatory(curam.outcomeplanning.outcomeplan.facade.struct.RoleOrActivityAgreementDetails details) throws curam.util.exception.AppException, curam.util.exception.InformationalException
Agreement
. This method is intended
to be used by users responsible for the management of outcome plans.details
- the unique identifier of the signatory to be removed from
the agreement, the identifier of the agreement the signatory is to be
removed from, and the version number of the role through which the
signatory is related to the agreementcuram.util.exception.AppException
curam.util.exception.InformationalException
curam.outcomeplanning.outcomeplan.facade.struct.CaseClientSummaryDetailsList listPotentialClientsForAgreements(curam.outcomeplanning.outcomeplan.entity.struct.AgreementKey key) throws curam.util.exception.AppException, curam.util.exception.InformationalException
OutcomePlan
the given Agreement
is related to that can
added as clients. The retrieved list, contains only clients from the
outcome plan that are not currently related to the agreement as clients.
This method is intended to be used by users responsible for the management
of outcome plans.key
- The unique identifier of the agreement to search bycuram.util.exception.AppException
curam.util.exception.InformationalException
curam.outcomeplanning.outcomeplan.facade.struct.CaseClientSummaryDetailsList listPotentialSignatoriesForAgreements(curam.outcomeplanning.outcomeplan.entity.struct.AgreementKey key) throws curam.util.exception.AppException, curam.util.exception.InformationalException
OutcomePlan
the given Agreement
is related to that can
added as signatories. The retrieved list contains only the clients from
the outcome plan that are not currently related to the agreement as
signatories. This method is intended to be used by users responsible for
the management of outcome plans.key
- The unique identifier of the agreement to search bycuram.util.exception.AppException
curam.util.exception.InformationalException
curam.outcomeplanning.outcomeplan.facade.struct.OutcomePlanActivityDetailsList listPotentialActivitiesForAgreements(curam.outcomeplanning.outcomeplan.entity.struct.AgreementKey key) throws curam.util.exception.AppException, curam.util.exception.InformationalException
OutcomePlan
the given Agreement
is related to that can
related to the given agreement. The retrieved list, contains only
activities from the outcome plan that are not currently related to the
agreement. This method is intended to be used by users responsible for
the management of outcome plans.key
- The unique identifier of the agreement to search bycuram.util.exception.AppException
curam.util.exception.InformationalException
curam.outcomeplanning.outcomeplan.facade.struct.OutcomePlanActivityDetailsList listActivitiesForAgreements(curam.outcomeplanning.outcomeplan.entity.struct.AgreementKey key) throws curam.util.exception.AppException, curam.util.exception.InformationalException
Agreement
. This method is intended
to be used by users responsible for the management of outcome plans.key
- The unique identifier of the agreement to search bycuram.util.exception.AppException
curam.util.exception.InformationalException
curam.outcomeplanning.outcomeplan.facade.struct.AgreementRoleDetailsList listClientsForAgreements(curam.outcomeplanning.outcomeplan.entity.struct.AgreementKey key) throws curam.util.exception.AppException, curam.util.exception.InformationalException
Agreement
. This method is
intended to be used by users responsible for the management of outcome
plans.key
- The unique identifier of the agreement to search bycuram.util.exception.AppException
curam.util.exception.InformationalException
curam.outcomeplanning.outcomeplan.facade.struct.AgreementSignatoriesDetailsList listSignatoriesForAgreements(curam.outcomeplanning.outcomeplan.entity.struct.AgreementKey key) throws curam.util.exception.AppException, curam.util.exception.InformationalException
Agreement
. This method is
intended to be used by users responsible for the management of outcome
plans.key
- The unique identifier of the agreement to search bycuram.util.exception.AppException
curam.util.exception.InformationalException
void signSignatory(curam.outcomeplanning.outcomeplan.facade.struct.AgreementSignatorySignDetailsIndividual details) throws curam.util.exception.AppException, curam.util.exception.InformationalException
Agreement
as signed for the
specified date. If this results in all signatories on the agreement been
signed the agreement status is updated to signed. This method is intended
to be used by users responsible for the management of outcome plans.details
- The selected signatory to be signed, the date the selected
signatory is to be registered as signing on, and the unique identifier of
the agreement the signatory is related tocuram.util.exception.AppException
curam.util.exception.InformationalException
void complete(curam.outcomeplanning.outcomeplan.facade.struct.AgreementAndVersionNoKey key) throws curam.util.exception.AppException, curam.util.exception.InformationalException
Agreement
transitioning the status
from in-edit to complete. This method is intended to be used by users
responsible for the management of outcome plans.key
- the unique identifier of the agreement and its related version
numbercuram.util.exception.AppException
curam.util.exception.InformationalException
void addComments(curam.outcomeplanning.outcomeplan.facade.struct.AgreementCommentsKey key) throws curam.util.exception.AppException, curam.util.exception.InformationalException
Agreement
overriding the currently
entered comments.. This method is intended to be used by users responsible
for the management of outcome plans.key
- the entered comment, the unique identifier of the agreement,
and its related version numbercuram.util.exception.AppException
curam.util.exception.InformationalException
curam.outcomeplanning.outcomeplan.facade.struct.AgreementComments readComments(curam.outcomeplanning.outcomeplan.entity.struct.AgreementKey key) throws curam.util.exception.AppException, curam.util.exception.InformationalException
Agreement
. This method is
intended to be used by users responsible for the management of outcome
plans.key
- the unique identider of the agreement the comments are to be
read forcuram.util.exception.AppException
curam.util.exception.InformationalException
void cancel(curam.outcomeplanning.outcomeplan.facade.struct.AgreementCancellationDetails key) throws curam.util.exception.AppException, curam.util.exception.InformationalException
Agreement
setting the cancellation reason, any entered cancellation comments, and
transitioning the status from cancelled. This method is intended to be
used by users responsible for the management of outcome plans.details
- the cancellation detailscuram.util.exception.AppException
curam.util.exception.InformationalException
void addAttachment(curam.attachmentlink.struct.AttachmentLinkDetails details) throws curam.util.exception.AppException, curam.util.exception.InformationalException
Agreement
. This method is
intended to be used by users responsible for the management of Referrals.details
- attachment details.curam.util.exception.AppException
curam.util.exception.InformationalException
curam.attachmentlink.struct.ListAttachmentLinkDetails listAttachments(curam.outcomeplanning.outcomeplan.entity.struct.AgreementKey key) throws curam.util.exception.AppException, curam.util.exception.InformationalException
Agreement
. This method is
intended to be used by users responsible for the management of outcome
plans.key
- The unique identifer of the agreement the retrieved attachments
are in relation tocuram.util.exception.AppException
curam.util.exception.InformationalException
curam.outcomeplanning.outcomeplan.facade.struct.AgreementDocument viewAgreementDocument(curam.outcomeplanning.outcomeplan.entity.struct.AgreementKey key) throws curam.util.exception.AppException, curam.util.exception.InformationalException
Agreement
for viewing. Enables
the user to view the details of the agreement and optionally print it.
This method is intended to be used by users responsible for the management
of outcome plans.key
- unique identifier of the agreement the agreement document being
retrieved is in relation tocuram.util.exception.AppException
curam.util.exception.InformationalException
curam.outcomeplanning.outcomeplan.facade.struct.AgreementStatusHistoryDetailsList listStatusHistory(curam.outcomeplanning.outcomeplan.entity.struct.AgreementKey key) throws curam.util.exception.AppException, curam.util.exception.InformationalException
AgreementStatusHistory
for the
given Agreement
. This
method is intended to be used by users responsible for the management of
outcome plans.key
- The unique identifier of the agreement to search bycuram.util.exception.AppException
curam.util.exception.InformationalException
curam.outcomeplanning.outcomeplan.facade.struct.AgreementIssueHistoryDetailsList listIssueHistory(curam.outcomeplanning.outcomeplan.entity.struct.AgreementKey key) throws curam.util.exception.AppException, curam.util.exception.InformationalException
AgreementIssueHistory
for the
given Agreement
. This
method is intended to be used by users responsible for the management of
outcome plans.key
- The unique identifier of the agreement to search bycuram.util.exception.AppException
curam.util.exception.InformationalException
void issue(curam.outcomeplanning.outcomeplan.facade.struct.AgreementIssueKey key) throws curam.util.exception.AppException, curam.util.exception.InformationalException
Agreement
to the selected client or signatory. If the this is the first time
issuing the agreement, the agreement status is transitioned issued. This
method is intended to be used by users responsible for the management of
outcome plans.key
- the unique identifier of the agreement and related issue detailscuram.util.exception.AppException
curam.util.exception.InformationalException
curam.outcomeplanning.outcomeplan.facade.struct.ParticipantAddressEmailAddressCommunicationDetails readAgreementParticipantDetailsForIssue(curam.core.facade.struct.CaseParticipantRoleKey key) throws curam.util.exception.AppException, curam.util.exception.InformationalException
key
- The unique identifier for the agreement participant role.curam.util.exception.AppException
curam.util.exception.InformationalException
curam.outcomeplanning.outcomeplan.facade.struct.AgreementIssueDetails readIssueDetails(curam.outcomeplanning.outcomeplan.entity.struct.AgreementKey key) throws curam.util.exception.AppException, curam.util.exception.InformationalException
Agreement
. This method is intended
to be used by users responsible for the management of outcome plans.key
- the unique identifier of the agreement and related issue
detailscuram.util.exception.AppException
curam.util.exception.InformationalException
curam.outcomeplanning.outcomeplan.facade.struct.AgreementDetails readAgreementDetails(curam.outcomeplanning.outcomeplan.entity.struct.AgreementKey key) throws curam.util.exception.AppException, curam.util.exception.InformationalException
Agreement
. The details include a
list of all related activities and the details of the agreement. If the
agreement is cancelled the cancellation details are allso included. This
method is intended to be used by users responsible for the management of
outcome plans.key
- the unique identider of the agreement the details are to be
read forcuram.util.exception.AppException
curam.util.exception.InformationalException
void signMultipleSignatories(curam.outcomeplanning.outcomeplan.facade.struct.AgreementSignatorySignDetailsMultiple details) throws curam.util.exception.AppException, curam.util.exception.InformationalException
Agreement
as signed for the
specified date. If this results in all signatories on the agreement been
signed the agreement status is updated to signed. This method is intended
to be used by users responsible for the management of outcome plans.details
- A tab separated list of selected signatories to be signed,
the date the selected signatories are to be registered as signing on, and
the unique identifier of the agreement the signatories are related tocuram.util.exception.AppException
curam.util.exception.InformationalException
void approve(curam.outcomeplanning.outcomeplan.facade.struct.AgreementAndVersionNoKey key) throws curam.util.exception.AppException, curam.util.exception.InformationalException
Agreement
transitioning the status
from submitted to complete. This method is intended to be used by users
responsible for the management of outcome plans.key
- the unique identifier of the agreement and its related version
numbercuram.util.exception.AppException
curam.util.exception.InformationalException
void reject(curam.outcomeplanning.outcomeplan.facade.struct.AgreementRejectionDetails key) throws curam.util.exception.AppException, curam.util.exception.InformationalException
Agreement
transitioning the status
from submitted to in-edit. This method is intended to be used by users
responsible for the management of outcome plans.key
- the unique identifier of the agreement and its related version
numbercuram.util.exception.AppException
curam.util.exception.InformationalException
curam.outcomeplanning.outcomeplan.facade.struct.AgreementAndVersionNoKey readAgreementVersionNumber(curam.outcomeplanning.outcomeplan.entity.struct.AgreementKey key) throws curam.util.exception.AppException, curam.util.exception.InformationalException
agreement
identifier.
This method is intended to be used by users responsible for the management
of outcome plans.key
- the unique identider of the agreement the version number is to
be read forcuram.util.exception.AppException
curam.util.exception.InformationalException