@AccessLevel(value=EXTERNAL)
public interface CaseHeader
extends curam.util.persistence.StandardEntity
CaseHeader
entity.
This interface is used as the base for case types that are supported buy the
Curam application.CaseHeaderImpl
class to inherit the default implementation and also
to avoid upgrade impact as new operations will be added to this interface
over time.Modifier and Type | Method and Description |
---|---|
void |
checkSecurity()
Performs case security and location check for accessing this case header.
|
curam.codetable.impl.OUTCOMEACHIEVEDEntry |
getActualOutcome()
Returns the actual outcome recorded for the case.
|
CaseConfiguration |
getAdminCaseConfiguration()
Retrieves the admin
CaseConfiguration details for this case. |
java.lang.Long |
getAdminConfigurationID()
Returns the admin configuration id for this type of case.
|
java.lang.Integer |
getCaseHeaderVersionNo()
Returns the version number for the case header record.
|
java.lang.String |
getCaseReference()
Returns the reference for the case.
|
curam.codetable.impl.CASETYPECODEEntry |
getCaseType()
Returns the case type for this case.
|
curam.codetable.impl.CASECLASSIFICATIONEntry |
getClassification()
Returns the classification code table entry for the case.
|
java.lang.String |
getComments()
Returns the comments recorded for the case.
|
ConcernRole |
getConcernRole()
Returns the concern role details for the case.
|
curam.codetable.impl.CURRENCYEntry |
getDefaultCurrency()
Returns the default currency on the case.
|
curam.codetable.impl.METHODOFDELIVERYEntry |
getDefaultDeliveryMethod()
Returns the default delivery method on the case.
|
java.lang.String |
getDescription()
Gets a description of the Case.
|
curam.util.type.Date |
getEffectiveDate()
Returns the case effective date.
|
curam.util.type.Date |
getEndDate()
Returns the case end date.
|
curam.util.type.Date |
getExpectedEndDate()
Returns the expected end date on the case.
|
java.lang.Long |
getExpectedOutcome()
Returns the expected outcome on the case.
|
curam.util.type.Date |
getExpectedStartDate()
Returns the expected start date for the case.
|
curam.util.type.Date |
getFirstReviewDate()
Returns the first review date for the case.
|
ClientURI |
getHomePageName()
Returns case home page name as per case type configuration.
|
curam.codetable.impl.PRODUCTCATEGORYEntry |
getIntegratedCaseType()
Returns the type of integrated case type if one exists for this case
record,
null otherwise. |
java.lang.String |
getName()
Returns the name of the case.
|
curam.codetable.impl.CASEOBJECTIVEEntry |
getObjective()
Returns the objective of the case.
|
curam.codetable.impl.CASEOUTCOMEEntry |
getOutcome()
Returns the outcome of the case.
|
OrgObjectLink |
getOwnerOrgObjectLink()
Returns the owner organization object link record.
|
CaseHeader |
getParentCase()
Returns the parent case header instance if this case record has a parent
case.
|
curam.codetable.impl.CASEPRIORITYEntry |
getPriority()
Retrieves the priority of the case.
|
curam.util.type.Date |
getReceivedDate()
Returns the case received date.
|
curam.util.type.Date |
getRegistrationDate()
Returns the case registration date.
|
curam.piwrapper.serviceplans.impl.ServicePlanDelivery |
getServicePlanDelivery()
Returns the
ServicePlanDelivery instance for the case if one
exists. |
curam.util.type.Date |
getStartDate()
Returns the case start date.
|
curam.codetable.impl.CASESTATUSEntry |
getStatus()
Returns the case status.
|
java.lang.Boolean |
hasAppeal()
Indicates if the case has an appeal.
|
java.util.List<CaseParticipantRole> |
listActiveCaseMembers()
Retrieves a list of active
members for the
case. |
java.util.List<CaseParticipantRole> |
listActiveCaseParticipantRoles()
Retrieves a list of all the active
CaseParticipantRole records for
this case. |
java.util.List<User> |
listSupervisorsForCaseOwner()
Method to return a list of supervisors based on the case owner.
|
User |
readSupervisor()
Method to return the supervisor for this case header.
|
User |
readSupervisorForCaseOwner()
Method to return the supervisor based on the case owner.
|
java.lang.String getName()
CASETYPECODEEntry
.java.lang.String getComments()
curam.codetable.impl.OUTCOMEACHIEVEDEntry getActualOutcome()
java.lang.Boolean hasAppeal()
java.lang.String getCaseReference()
curam.codetable.impl.CASETYPECODEEntry getCaseType()
curam.codetable.impl.CASECLASSIFICATIONEntry getClassification()
ConcernRole getConcernRole()
curam.codetable.impl.CURRENCYEntry getDefaultCurrency()
curam.codetable.impl.METHODOFDELIVERYEntry getDefaultDeliveryMethod()
curam.util.type.Date getEffectiveDate()
curam.util.type.Date getEndDate()
Zero Date
if no
end date is recorded.Date
form.curam.util.type.Date getExpectedEndDate()
Zero Date
if no date is set.java.lang.Long getExpectedOutcome()
curam.util.type.Date getExpectedStartDate()
Zero Date
if no date is set.Date
form.curam.util.type.Date getFirstReviewDate()
Zero Date
if no date is set.CaseHeader getParentCase()
curam.codetable.impl.PRODUCTCATEGORYEntry getIntegratedCaseType()
null
otherwise.null
if this case doesn't hang off an integrated case.curam.codetable.impl.CASEOBJECTIVEEntry getObjective()
curam.codetable.impl.CASEOUTCOMEEntry getOutcome()
OrgObjectLink getOwnerOrgObjectLink()
curam.piwrapper.serviceplans.impl.ServicePlanDelivery getServicePlanDelivery()
ServicePlanDelivery
instance for the case if one
exists. If the case is not related to a service, null
will be
returned.curam.codetable.impl.CASEPRIORITYEntry getPriority()
curam.util.type.Date getReceivedDate()
Zero Date
if no date is set.Date
form.curam.util.type.Date getRegistrationDate()
Zero
Date
if no date is set.Date
form.curam.util.type.Date getStartDate()
Zero Date
if no
date is set.Date
form.curam.codetable.impl.CASESTATUSEntry getStatus()
java.lang.Integer getCaseHeaderVersionNo()
java.lang.Long getAdminConfigurationID()
CaseHeaderImpl
and must be
implemented by its concrete subclasses as it changes based on the case
type.CaseConfiguration getAdminCaseConfiguration()
CaseConfiguration
details for this case.getAdminConfigurationID()
java.lang.String getDescription() throws curam.util.exception.AppException, curam.util.exception.InformationalException
curam.util.exception.AppException
curam.util.exception.InformationalException
java.util.List<CaseParticipantRole> listActiveCaseParticipantRoles()
CaseParticipantRole
records for
this case.java.util.List<CaseParticipantRole> listActiveCaseMembers()
members
for the
case. A case member is defined as having a role of either
member
or
primary client
.void checkSecurity() throws curam.util.exception.InformationalException
The following checks are performed in this process:
curam.util.exception.InformationalException
- GENERALCASEExceptionCreator#ERR_CASESECURITY_CHECK_ACCESS_RIGHTS()
if the user does not have access rights to view this case headerCaseSecurity#authorize(curam.core.struct.CaseSecurityCheckKey,
curam.core.struct.UsersKey)
,
LocationBasedSecurity#checkCaseSecurity(curam.core.struct.CaseSecurityKey)
User readSupervisor()
User readSupervisorForCaseOwner()
java.util.List<User> listSupervisorsForCaseOwner()
ClientURI getHomePageName() throws curam.util.exception.AppException, curam.util.exception.InformationalException
curam.util.exception.AppException
curam.util.exception.InformationalException