curam.cpm.facade.intf

Interface MaintainWaitList

All Known Implementing Classes:

MaintainWaitList, curam.cpm.facade.impl.MaintainWaitList, MaintainWaitListFactory

@AccessLevel(value=EXTERNAL)
public interface MaintainWaitList

This business interface maintains a wait list for a provider. A wait list is a queue for a resource needed by clients. When searching for providers to deliver services, the most suitable provider may not always have availability. Where no other suitable provider is available, a client may be put on to a wait list for a provider. A client can be wait listed to receive both non-placement services and placement services, and either for the provider, or for a specific provider service. Each client in a wait lists represents a wait list entry.

Method Summary

Modifier and Type	Method and Description
curam.cpm.facade.struct.AssignPlaceDetails	assignPlace(curam.cpm.facade.struct.AllocatePlaceDetails details) Creates a reservation (if the period is in the future) or a placement (if the start of the period is today or in the past) for the wait listed client.
curam.cpm.facade.struct.AllocatePlaceDetails	cancelOverlappingReservation(curam.cpm.facade.struct.AllocatePlaceDetails key) Cancels any existing reservations for the client, when a place is allocated to a wait listed client.
curam.cpm.facade.struct.PlaceAndPlaceLocationDetailsList	getAvailablePlaces(curam.cpm.facade.struct.WaitListPeriodKey key) Returns the list of available places for a wait list entry and for specified period.
curam.cpm.facade.struct.ProviderOfferingSummaryDetailsList	listApprovedProviderOffering(curam.cpm.facade.struct.ResourceKey key) Returns the list of provider services for a provider associated with a wait list entry.
curam.cpm.facade.struct.WaitListEntryHistoryDetailsList	listHistoryForWaitListEntry(curam.core.struct.WaitListEntryKey key) Reads the history of a wait list entry.
curam.cpm.facade.struct.ProviderOfferingSummaryDetailsList	listProviderOfferingWaitListForProvider(curam.cpm.facade.struct.ProviderKey key) Returns the list of provider services which have wait lists, for the specified provider.
curam.cpm.facade.struct.WaitListEntryReviewDetailsList	listRecentWaitListEntriesDueForReview() Reads the list of wait list entries which are due for renewal.
curam.cpm.facade.struct.WaitListEntryDetailsList	listWaitListEntryForResource(curam.cpm.facade.struct.ResourceKey key) Returns the list of wait list entries for a resource.
void	markAsAllocated(curam.cpm.facade.struct.KeyVersionDetails details) Marks a wait list entry as allocated and assigns new positions to the other wait listed clients.
void	removeWaitListEntry(curam.cpm.facade.struct.WaitListRemovalDetails details) Cancels a wait list entry.
curam.cpm.facade.struct.WaitListEntryDetailsList	searchWaitListEntryForProvider(curam.cpm.facade.struct.SearchWaitListEntryKey key) Returns the list of wait list entries for a provider based on the search criteria.
curam.cpm.facade.struct.WaitListEntryAndTypeDetailsList	searchWaitListEntryForProviderAndPO(curam.cpm.facade.struct.SearchWaitListEntryKey key) Returns the list of wait list entries for a provider and for the related provider services based on the search criteria.
curam.cpm.facade.struct.WaitListEntryDetailsList	searchWaitListEntryForProviderOffering(curam.cpm.facade.struct.SearchWaitListEntryKey key) Returns the list of wait list entries for a provider service based on the search criteria.
void	updateWaitListEntry(curam.cpm.facade.struct.WaitListEntryDetails details) Modifies a wait list entry.
curam.cpm.facade.struct.WaitListEntryDetailsInfo	viewWaitListEntryDetails(curam.core.struct.WaitListEntryKey key) Reads the details of a wait list entry.
curam.cpm.facade.struct.WaitListEntryHistoryDetails	viewWaitListEntryHistory(curam.cpm.facade.struct.WaitListEntryHistoryKey key) Reads the history of the wait list entry.

Method Detail

listWaitListEntryForResource

@AccessLevel(value=EXTERNAL)
curam.cpm.facade.struct.WaitListEntryDetailsList listWaitListEntryForResource(curam.cpm.facade.struct.ResourceKey key)
                                                                                                    throws curam.util.exception.AppException,
                                                                                                           curam.util.exception.InformationalException

Returns the list of wait list entries for a resource.

Parameters:

key - The key of the resource.

Returns:

The list of wait list entries for a resource.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

WaitListEntry

listProviderOfferingWaitListForProvider

@AccessLevel(value=EXTERNAL)
curam.cpm.facade.struct.ProviderOfferingSummaryDetailsList listProviderOfferingWaitListForProvider(curam.cpm.facade.struct.ProviderKey key)
                                                                                                                         throws curam.util.exception.AppException,
                                                                                                                                curam.util.exception.InformationalException

Returns the list of provider services which have wait lists, for the specified provider.

Parameters:

key - The key of the provider.

Returns:

The list of the provider services associated with provider.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

ProviderService, WaitListEntry

searchWaitListEntryForProvider

@AccessLevel(value=EXTERNAL)
curam.cpm.facade.struct.WaitListEntryDetailsList searchWaitListEntryForProvider(curam.cpm.facade.struct.SearchWaitListEntryKey key)
                                                                                                      throws curam.util.exception.AppException,
                                                                                                             curam.util.exception.InformationalException

Returns the list of wait list entries for a provider based on the search criteria.

Parameters:

key - Contains client name, priority, expiry date and/or status and provider key.

Returns:

The list of wait list entries for the provider which satisfies the search criteria.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

WaitListEntry

updateWaitListEntry

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

Modifies a wait list entry.

Parameters:

details - The details of the wait list entry.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Write:

WaitListEntry

removeWaitListEntry

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

Cancels a wait list entry.

Parameters:

key - Contains the wait list entry key , version number and removal reason.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Write:

WaitListEntry

markAsAllocated

@AccessLevel(value=EXTERNAL)
void markAsAllocated(curam.cpm.facade.struct.KeyVersionDetails details)
                                           throws curam.util.exception.AppException,
                                                  curam.util.exception.InformationalException

Marks a wait list entry as allocated and assigns new positions to the other wait listed clients.

Parameters:

key - The key of the wait list entry.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Write:

WaitListEntry

cancelOverlappingReservation

@AccessLevel(value=EXTERNAL)
curam.cpm.facade.struct.AllocatePlaceDetails cancelOverlappingReservation(curam.cpm.facade.struct.AllocatePlaceDetails key)
                                                                                                throws curam.util.exception.AppException,
                                                                                                       curam.util.exception.InformationalException

Cancels any existing reservations for the client, when a place is allocated to a wait listed client.

Parameters:

key - Contains the wait list entry key and period.

Returns:

The waitlist key and period.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Write:

Reservation

searchWaitListEntryForProviderOffering

@AccessLevel(value=EXTERNAL)
curam.cpm.facade.struct.WaitListEntryDetailsList searchWaitListEntryForProviderOffering(curam.cpm.facade.struct.SearchWaitListEntryKey key)
                                                                                                              throws curam.util.exception.AppException,
                                                                                                                     curam.util.exception.InformationalException

Returns the list of wait list entries for a provider service based on the search criteria.

Parameters:

key - Contains client name, priority, expiry date and/or status and provider service key.

Returns:

The list of wait list entries for the provider service which satisfies the search criteria.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

WaitListEntry

listApprovedProviderOffering

@AccessLevel(value=EXTERNAL)
curam.cpm.facade.struct.ProviderOfferingSummaryDetailsList listApprovedProviderOffering(curam.cpm.facade.struct.ResourceKey key)
                                                                                                              throws curam.util.exception.AppException,
                                                                                                                     curam.util.exception.InformationalException

Returns the list of provider services for a provider associated with a wait list entry.

Parameters:

key - The key of wait list entry.

Returns:

The list of provider services for the wait list entry.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

ProviderService, Provider

listHistoryForWaitListEntry

@AccessLevel(value=EXTERNAL)
curam.cpm.facade.struct.WaitListEntryHistoryDetailsList listHistoryForWaitListEntry(curam.core.struct.WaitListEntryKey key)
                                                                                                          throws curam.util.exception.AppException,
                                                                                                                 curam.util.exception.InformationalException

Reads the history of a wait list entry.

Parameters:

key - The key of the wait list entry.

Returns:

The history of a wait list entry.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

WaitListEntry

viewWaitListEntryHistory

@AccessLevel(value=EXTERNAL)
curam.cpm.facade.struct.WaitListEntryHistoryDetails viewWaitListEntryHistory(curam.cpm.facade.struct.WaitListEntryHistoryKey key)
                                                                                                   throws curam.util.exception.AppException,
                                                                                                          curam.util.exception.InformationalException

Reads the history of the wait list entry.

Parameters:

key - The key of the wait list entry.

Returns:

The history of the wait list entry.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

WaitListEntry

viewWaitListEntryDetails

@AccessLevel(value=EXTERNAL)
curam.cpm.facade.struct.WaitListEntryDetailsInfo viewWaitListEntryDetails(curam.core.struct.WaitListEntryKey key)
                                                                                                throws curam.util.exception.AppException,
                                                                                                       curam.util.exception.InformationalException

Reads the details of a wait list entry.

Parameters:

key - The key of the wait list entry.

Returns:

The details of the wait list entry.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

WaitListEntry

searchWaitListEntryForProviderAndPO

@AccessLevel(value=EXTERNAL)
curam.cpm.facade.struct.WaitListEntryAndTypeDetailsList searchWaitListEntryForProviderAndPO(curam.cpm.facade.struct.SearchWaitListEntryKey key)
                                                                                                                  throws curam.util.exception.AppException,
                                                                                                                         curam.util.exception.InformationalException

Returns the list of wait list entries for a provider and for the related provider services based on the search criteria.

Parameters:

key - Contains client name, priority, expiry date and/or status and provider key.

Returns:

The list of wait list entries for the provider and for the related provider services which satisfies the search criteria.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

WaitListEntry

listRecentWaitListEntriesDueForReview

@AccessLevel(value=EXTERNAL)
curam.cpm.facade.struct.WaitListEntryReviewDetailsList listRecentWaitListEntriesDueForReview()
                                                                                                                   throws curam.util.exception.AppException,
                                                                                                                          curam.util.exception.InformationalException

Reads the list of wait list entries which are due for renewal.

Returns:

The list of wait list entries which are due for renewal.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

WaitListEntry

assignPlace

@AccessLevel(value=EXTERNAL)
curam.cpm.facade.struct.AssignPlaceDetails assignPlace(curam.cpm.facade.struct.AllocatePlaceDetails details)
                                                                             throws curam.util.exception.AppException,
                                                                                    curam.util.exception.InformationalException

Creates a reservation (if the period is in the future) or a placement (if the start of the period is today or in the past) for the wait listed client.

Parameters:

details - Contains the wait list entry, client, period and place details.

Returns:

The details of the wait list entry, client, period and place.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

WaitListEntry

Business Object Write:

Placement, Reservation

getAvailablePlaces

@AccessLevel(value=EXTERNAL)
curam.cpm.facade.struct.PlaceAndPlaceLocationDetailsList getAvailablePlaces(curam.cpm.facade.struct.WaitListPeriodKey key)
                                                                                                  throws curam.util.exception.AppException,
                                                                                                         curam.util.exception.InformationalException

Returns the list of available places for a wait list entry and for specified period.

Parameters:

key - Contains the key for wait list entry and period.

Returns:

The list of available places.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

Reservation, Place