curam.fundpm.facade.intf

Interface MaintainFundWaitList

All Known Implementing Classes:

MaintainFundWaitList, curam.fundpm.facade.impl.MaintainFundWaitList, MaintainFundWaitListFactory

@AccessLevel(value=EXTERNAL)
public interface MaintainFundWaitList

This business interface defines the operations for maintaining fund wait lists. A fund wait list allows a client to be placed on a wait list for a fund fiscal year when funds are insufficient to cover the full amount of an obligation, and a fund balance cannot fall below zero. The fund must be configured to enable wait listing. For example, when a client is authorized to receive child care services and in turn, an obligation request is received for the child care fund, if the child care fund does not have a sufficient amount to cover the obligation, over obligation is not permitted and wait listing is configured, the client is placed on a wait list for that fund fiscal year.

Method Summary

Modifier and Type	Method and Description
void	expireFundWaitListEntry() Expires a fund wait list entry whose expiration date is on or before the system processing date.
void	removeWaitListEntry(curam.fundpm.facade.struct.WaitListRemovalDetails details) Cancels a wait list entry.
curam.fundpm.facade.struct.WaitListSearchResultList	searchWaitListDetails(curam.fundpm.facade.struct.WaitListSearchCriteria key) Searches a list of fund wait list entries for the given search criteria.
void	updateWaitListEntry(curam.fundpm.facade.struct.FundWaitListEntryDetails details) Modifies a fund wait list entry.
curam.fundpm.facade.struct.FundWaitListEntryStatusHistoryDtls	viewFundWaitListEntryHistory(curam.fundpm.facade.struct.WaitListEntryKeyDetails key) Reads history information for a fund wait list entry.
curam.fundpm.facade.struct.FundWaitListEntryDetails	viewWaitListEntry(curam.fundpm.facade.struct.WaitListEntryKey key) Reads the details of a fund wait list entry.
curam.fundpm.facade.struct.FundWaitListEntryStatusHistoryDtlsList	viewWaitListEntryStatusHistory(curam.fundpm.facade.struct.WaitListEntryKey key) Returns the status history for a fund wait list entry.

Method Detail

viewWaitListEntry

@AccessLevel(value=EXTERNAL)
curam.fundpm.facade.struct.FundWaitListEntryDetails viewWaitListEntry(curam.fundpm.facade.struct.WaitListEntryKey key)
                                                                                            throws curam.util.exception.AppException,
                                                                                                   curam.util.exception.InformationalException

Reads the details of a fund wait list entry.

Parameters:

key - The key of the wait list entry.

Returns:

The details of the fund wait list entry.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

WaitList

updateWaitListEntry

@AccessLevel(value=EXTERNAL)
void updateWaitListEntry(curam.fundpm.facade.struct.FundWaitListEntryDetails details)
                                               throws curam.util.exception.AppException,
                                                      curam.util.exception.InformationalException

Modifies a fund wait list entry.

Parameters:

details - The details of a wait list entry.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Write:

WaitList

removeWaitListEntry

@AccessLevel(value=EXTERNAL)
void removeWaitListEntry(curam.fundpm.facade.struct.WaitListRemovalDetails details)
                                               throws curam.util.exception.AppException,
                                                      curam.util.exception.InformationalException

Cancels a wait list entry.

Parameters:

details - The details of the wait list entry to be cancelled.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Write:

WaitList.

searchWaitListDetails

@AccessLevel(value=EXTERNAL)
curam.fundpm.facade.struct.WaitListSearchResultList searchWaitListDetails(curam.fundpm.facade.struct.WaitListSearchCriteria key)
                                                                                                throws curam.util.exception.AppException,
                                                                                                       curam.util.exception.InformationalException

Searches a list of fund wait list entries for the given search criteria.

Parameters:

key - Contains the wait list search criteria.

Returns:

The list of fund wait list entries.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

WaitList

viewWaitListEntryStatusHistory

@AccessLevel(value=EXTERNAL)
curam.fundpm.facade.struct.FundWaitListEntryStatusHistoryDtlsList viewWaitListEntryStatusHistory(curam.fundpm.facade.struct.WaitListEntryKey key)
                                                                                                                       throws curam.util.exception.AppException,
                                                                                                                              curam.util.exception.InformationalException

Returns the status history for a fund wait list entry.

Parameters:

key - The wait list entry key.

Returns:

The list of fund wait list entry status history.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

WaitList

expireFundWaitListEntry

@AccessLevel(value=EXTERNAL)
void expireFundWaitListEntry()
                                                   throws curam.util.exception.AppException,
                                                          curam.util.exception.InformationalException

Expires a fund wait list entry whose expiration date is on or before the system processing date.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Write:

WaitList

viewFundWaitListEntryHistory

@AccessLevel(value=EXTERNAL)
curam.fundpm.facade.struct.FundWaitListEntryStatusHistoryDtls viewFundWaitListEntryHistory(curam.fundpm.facade.struct.WaitListEntryKeyDetails key)
                                                                                                                 throws curam.util.exception.AppException,
                                                                                                                        curam.util.exception.InformationalException

Reads history information for a fund wait list entry.

Parameters:

key - Contains the wait list entry history key and the wait list entry key.

Returns:

The fund wait list entry history.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

WaitList