curam.isproduct.facade.intf

Interface ISPCase

All Known Implementing Classes:

ISPCase, curam.isproduct.facade.impl.ISPCase, ISPCaseFactory

@AccessLevel(value=EXTERNAL)
public interface ISPCase

This business interface provides the functionality for the income support product case.

Method Summary

Modifier and Type	Method and Description
curam.application.facade.struct.IEGExecutionApplicationDetails	addNewMember(curam.isproduct.facade.struct.ISPCaseIDKey key) Add the new member to the income support integrated case.
curam.isproduct.facade.struct.ISPCaseIDKey	createCase(curam.isproduct.facade.struct.ISPCaseRegistrationDetails details) Creates an integrated case for an income support.
void	createEmployment(curam.isproduct.facade.struct.CreateISPEmploymentDetails dtls) Creates an employment record for a case participant.
curam.isproduct.facade.struct.ISPCaseContextDetails	getContextDescription(curam.isproduct.facade.struct.ISPCaseContextKey key) Reads the details of the context description for the income support product case.
curam.core.sl.struct.ViewCaseParticipantRoleDetailsList	listActiveMembersByCase(curam.core.struct.CaseKey key) Reads the list of details of the active members associated with the case.
curam.application.facade.struct.ApplicationDisplayDtlsList	listApplicationsByCase(curam.core.struct.CaseKey key) Reads the list of details of the applications associated with the case.
curam.isproduct.facade.struct.SpousalImpoverishmentDetailsList	listSpousalImpoverishment(curam.isproduct.facade.struct.ISPCaseIDKey key) Reads the details of the income support spousal impoverishment records for a case.
void	modifyCaseDetails(curam.core.facade.struct.ModifyIntegratedCaseDetails details) Modifies the details of the case header.
curam.isproduct.facade.struct.ISPSiteMapDetails	readSiteMapDetails(curam.isproduct.sl.struct.ISPCaseID key) Reads the details of the income support product site map.
curam.isproduct.facade.struct.SpousalImpoverishmentDetails	readSpousalImpoverishment(curam.isproduct.facade.struct.SpousalImpoverishmentKey key) Reads the details of an income support spousal impoverishment record.
void	validateSelectPrimaryClient(curam.core.struct.ConcernRoleKey key) Validates the selection of the primary client.

Method Detail

createCase

@AccessLevel(value=EXTERNAL)
curam.isproduct.facade.struct.ISPCaseIDKey createCase(curam.isproduct.facade.struct.ISPCaseRegistrationDetails details)
                                                                            throws curam.util.exception.AppException,
                                                                                   curam.util.exception.InformationalException

Creates an integrated case for an income support.

Parameters:

details - The details of the new case to create.

Returns:

Identifier of the case.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

CaseParticipantRole, ConcernRole, CaseHeader, Users, Address, CaseRelationship

Business Object Write:

CaseParticipantRole, CaseHeader, CaseStatus, CaseRelationship

createEmployment

@AccessLevel(value=EXTERNAL)
void createEmployment(curam.isproduct.facade.struct.CreateISPEmploymentDetails dtls)
                                            throws curam.util.exception.AppException,
                                                   curam.util.exception.InformationalException

Creates an employment record for a case participant.

Parameters:

dtls - The details of an employment record.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

CaseParticipantRole, ConcernRole, Person, ProspectPerson, Employer, Employment, Address

Business Object Write:

CaseParticipantRole, Representative

getContextDescription

@AccessLevel(value=EXTERNAL)
curam.isproduct.facade.struct.ISPCaseContextDetails getContextDescription(curam.isproduct.facade.struct.ISPCaseContextKey key)
                                                                                                throws curam.util.exception.AppException,
                                                                                                       curam.util.exception.InformationalException

Reads the details of the context description for the income support product case.

Parameters:

key - Identifier of the case.

Returns:

The details of the context description.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

CaseHeader

readSiteMapDetails

@AccessLevel(value=EXTERNAL)
curam.isproduct.facade.struct.ISPSiteMapDetails readSiteMapDetails(curam.isproduct.sl.struct.ISPCaseID key)
                                                                                         throws curam.util.exception.AppException,
                                                                                                curam.util.exception.InformationalException

Reads the details of the income support product site map.

Parameters:

key - Identifier of the case.

Returns:

The details of the income support product site map.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

readSpousalImpoverishment

@AccessLevel(value=EXTERNAL)
curam.isproduct.facade.struct.SpousalImpoverishmentDetails readSpousalImpoverishment(curam.isproduct.facade.struct.SpousalImpoverishmentKey key)
                                                                                                           throws curam.util.exception.AppException,
                                                                                                                  curam.util.exception.InformationalException

Reads the details of an income support spousal impoverishment record.

Parameters:

key - Identifier of the spousal impoverishment.

Returns:

The details of the income support spousal impoverishment record.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

ISPSpousalImpoverishment

listSpousalImpoverishment

@AccessLevel(value=EXTERNAL)
curam.isproduct.facade.struct.SpousalImpoverishmentDetailsList listSpousalImpoverishment(curam.isproduct.facade.struct.ISPCaseIDKey key)
                                                                                                               throws curam.util.exception.AppException,
                                                                                                                      curam.util.exception.InformationalException

Reads the details of the income support spousal impoverishment records for a case.

Parameters:

key - Identifier of the case.

Returns:

The list of details of the income support spousal impoverishment records.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

ISPSpousalImpoverishment, ProductDelivery, CaseHeader

modifyCaseDetails

@AccessLevel(value=EXTERNAL)
void modifyCaseDetails(curam.core.facade.struct.ModifyIntegratedCaseDetails details)
                                             throws curam.util.exception.AppException,
                                                    curam.util.exception.InformationalException

Modifies the details of the case header.

Parameters:

key - The details of the case header.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

CaseHeader, Outcome, ConcernRole, OrgObjectLink, Users, OrgObjectLink, Position, WorkQueue, Address, PhoneNumber, ConcernRolePhoneNumber, Bookmark, SpecialCaution

listApplicationsByCase

@AccessLevel(value=EXTERNAL)
curam.application.facade.struct.ApplicationDisplayDtlsList listApplicationsByCase(curam.core.struct.CaseKey key)
                                                                                                        throws curam.util.exception.AppException,
                                                                                                               curam.util.exception.InformationalException

Reads the list of details of the applications associated with the case.

Parameters:

key - Identifier of the case.

Returns:

The list of details of the applications associated with the case.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

Application

listActiveMembersByCase

@AccessLevel(value=EXTERNAL)
curam.core.sl.struct.ViewCaseParticipantRoleDetailsList listActiveMembersByCase(curam.core.struct.CaseKey key)
                                                                                                      throws curam.util.exception.AppException,
                                                                                                             curam.util.exception.InformationalException

Reads the list of details of the active members associated with the case.
A case member is defined by having a role of either member or primary client.

Parameters:

key - Identifier of the case.

Returns:

The list of details of the active case members.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

CaseParticipantRole, ConcernRole, SpecialCaution

validateSelectPrimaryClient

@AccessLevel(value=EXTERNAL)
void validateSelectPrimaryClient(curam.core.struct.ConcernRoleKey key)
                                                       throws curam.util.exception.AppException,
                                                              curam.util.exception.InformationalException

Validates the selection of the primary client.

Parameters:

key - Identifier of a person.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

addNewMember

@AccessLevel(value=EXTERNAL)
curam.application.facade.struct.IEGExecutionApplicationDetails addNewMember(curam.isproduct.facade.struct.ISPCaseIDKey key)
                                                                                                  throws curam.util.exception.AppException,
                                                                                                         curam.util.exception.InformationalException

Add the new member to the income support integrated case.

Parameters:

key - Identifier of the case.

Returns:

The details of the IEG execution.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException