@AccessLevel(value=EXTERNAL) public interface Agreement extends curam.util.persistence.helper.Lifecycle<curam.codetable.impl.AGREEMENTSTATUSEntry>, curam.util.persistence.OptimisticLockModifiable, curam.util.persistence.StandardEntity, curam.outcomeplanning.outcomeplan.impl.AgreementCancellation, java.lang.Comparable<Agreement>
The following exception messages are thrown by this entity:
AGREEMENT#ERR_FV_CASE_MANDATORY
- If the case is not set when
creating an agreement.
AGREEMENT#ERR_FV_ROLE_MANDATORY
- If no clients on the case are
selected to be signatories when creating an agreement.
AGREEMENT#ERR_FV_ROLE_MANDATORY
- If no clients on the case are
selected to be clients when creating an agreement.
AGREEMENT#ERR_CANNOT_MODIFY_AGREEMENT_FOR_STATUS
- If an agreement is
attempted to be modified and its status is
AGREEMENTSTATUSEntry.CANCELLED
AGREEMENT#ERR_XRV_AGREEMENT_CANNOT_BE_CREATED_OR_MODIFIED_ON_A_CASE_WITH_STATUS
- If an agreement is attempted to be created and the related case is closed.
AGREEMENT#ERR_XRV_AGREEMENT_CANNOT_BE_CREATED_OR_MODIFIED_ON_A_CASE_WITH_STATUS
- If an agreement is attempted to be modified and the related case is closed.
AGREEMENT#ERR_XRV_AGREEMENT_CLIENTS_SIGNATORIES_ACTIVITIES_CANNOT_BE_MODIFIED_FOR_STATUS
- If the clients, signatories or activities on an agreement are attempted to
be modified and the agreement status is AGREEMENTSTATUSEntry.COMPLETE
, AGREEMENTSTATUSEntry.ISSUED
, or AGREEMENTSTATUSEntry.SIGNED
.
AGREEMENT#ERR_XRV_AGREEMENT_NOT_COMPLETE_OR_ISSUED_IT_CANNOT_BE_SIGNED
- If an agreement is attempted to be signed and its status is not
AGREEMENTSTATUSEntry.COMPLETE
or AGREEMENTSTATUSEntry.ISSUED
.
AGREEMENT#ERR_XFV_REASON_MANDATORY_WHEN_AGREEMENT_CANCELLED
- If a
client is attempted to be canceled and the AGREEMENTCANCELREASONEntry
has not been specified.
AGREEMENT#ERR_XFV_ISSUE_REASON_MANDATORY_WHEN_REISSUING_AGREEMENT
if
the agreement is being reissued and the issue reason is not entered
AGREEMENT#ERR_XFV_AGREEMENT_CANNOT_BE_ISSUED_BECAUSE_OF_AGREEMENT_STATUS
if the agreement status is AGREEMENTSTATUSEntry.INEDIT
or
AGREEMENTSTATUSEntry.SIGNED
curam.outcomeplanning.outcomeplan.entity.intf.Agreement}
Modifier and Type | Interface and Description |
---|---|
static class |
Agreement.AgreementDocumentDataStrategy
Strategy pattern to allow customers the populate extensions they have made
to
AgreementDocumentData with the required data. |
static class |
Agreement.AgreementEvent
Business events for the
Agreement entity. |
Modifier and Type | Method and Description |
---|---|
curam.piwrapper.caseheader.impl.CaseHeader |
getCase()
Retrieves the
case this agreement exists on. |
java.lang.String |
getComments()
Retrieves the comments entered for this agreement.
|
curam.piwrapper.user.impl.User |
getCreatedBy()
Retrieves the
User who created this agreement. |
curam.util.type.Date |
getCreationDate()
Retrieves the
Date this agreement was created on. |
getContextContainer, getID, getPersistenceEventDispatcher
java.lang.String getComments()
AgreementDtls#comments
curam.util.type.Date getCreationDate()
Date
this agreement was created on.AgreementDtls#creationDate
curam.piwrapper.user.impl.User getCreatedBy()
User
who created this agreement.AgreementDtls#createdBy
curam.piwrapper.caseheader.impl.CaseHeader getCase()
case
this agreement exists on.AgreementDtls#caseID