curam.evidence.facade.intf

Interface Income

All Known Implementing Classes:

Income, curam.evidence.facade.impl.Income, IncomeFactory

@AccessLevel(value=EXTERNAL)
public interface Income

This business interface provides operations for maintaining various types of income evidence.

Method Summary

Modifier and Type	Method and Description
curam.evidence.facade.struct.DisplayExpenseTypeAndReturnParticipantNameDtls	displayExpenseTypeAndReturnParticipantName(curam.evidence.facade.struct.DisplayExpenseTypeAndReturnParticipantNameKey key) Generates a concatenated string containing the case participant name and alternate ID for a given evidence record.
curam.evidence.facade.struct.ReadEmployerAndCaseParticipantDetails	readEmployerAndCaseParticipant(curam.evidence.facade.struct.ReadEmployerAndCaseParticipantDetailsKey key) Reads case participant and related employer details.
curam.evidence.facade.struct.SearchActiveEmploymentsByCaseParticipantListDetailsList	searchActiveEmploymentsByCaseParticipant(curam.evidence.facade.struct.SearchActiveEmploymentsByCaseParticipantKey key) Reads a list of all active employments for a case participant.
curam.evidence.facade.struct.StoredIncomeAllocationExpenseDetailsResult	storeIncomeAllocationExpenseInfo(curam.evidence.facade.struct.StoredIncomeAllocationExpenseDetailsKey key) Copies the input fields directly to corresponding values in the return fields.

Method Detail

searchActiveEmploymentsByCaseParticipant

@AccessLevel(value=EXTERNAL)
curam.evidence.facade.struct.SearchActiveEmploymentsByCaseParticipantListDetailsList searchActiveEmploymentsByCaseParticipant(curam.evidence.facade.struct.SearchActiveEmploymentsByCaseParticipantKey key)
                                                                                                                                                    throws curam.util.exception.AppException,
                                                                                                                                                           curam.util.exception.InformationalException

Reads a list of all active employments for a case participant.

Parameters:

key - The key of the case participant.

Returns:

The employment details.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

Employment, Employer, CaseParticipantRole

readEmployerAndCaseParticipant

@AccessLevel(value=EXTERNAL)
curam.evidence.facade.struct.ReadEmployerAndCaseParticipantDetails readEmployerAndCaseParticipant(curam.evidence.facade.struct.ReadEmployerAndCaseParticipantDetailsKey key)
                                                                                                                        throws curam.util.exception.AppException,
                                                                                                                               curam.util.exception.InformationalException

Reads case participant and related employer details.

Parameters:

key - The key for the case participant and the employer.

Returns:

The employer and case participant details.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

Employer, Representative, CaseParticipantRole

displayExpenseTypeAndReturnParticipantName

@AccessLevel(value=EXTERNAL)
curam.evidence.facade.struct.DisplayExpenseTypeAndReturnParticipantNameDtls displayExpenseTypeAndReturnParticipantName(curam.evidence.facade.struct.DisplayExpenseTypeAndReturnParticipantNameKey key)
                                                                                                                                             throws curam.util.exception.AppException,
                                                                                                                                                    curam.util.exception.InformationalException

Generates a concatenated string containing the case participant name and alternate ID for a given evidence record.

Parameters:

key - The key for the evidence record.

Returns:

The concatenated string.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

CaseParticipantRole, EvidenceDescriptor, HouseholdMember

storeIncomeAllocationExpenseInfo

@AccessLevel(value=EXTERNAL)
curam.evidence.facade.struct.StoredIncomeAllocationExpenseDetailsResult storeIncomeAllocationExpenseInfo(curam.evidence.facade.struct.StoredIncomeAllocationExpenseDetailsKey key)
                                                                                                                               throws curam.util.exception.AppException,
                                                                                                                                      curam.util.exception.InformationalException

Copies the input fields directly to corresponding values in the return fields.

No other processing is performed. This business interface is typically used as a utility by client pages.

Parameters:

key - The input fields.

Returns:

A copy of the input fields.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException