curam.cpm.facade.intf

Interface MaintainReservation

All Known Implementing Classes:

MaintainReservation, curam.cpm.facade.impl.MaintainReservation, MaintainReservationFactory

@AccessLevel(value=EXTERNAL)
public interface MaintainReservation

This business interface maintains the reservations for a provider. When a client is authorized to receive a service in the future, the caseworker can allocate a place to the client for a period in the future. This is called a reservation, and is broadly similar to a reservation in a hotel booking system. The reservation process would usually start with a caseworker searching for available places for a certain period. When a place is found with a suitable provider, the reservation can be created for the client. Since a reservation represents a potential future placement rather than the placement itself, it cannot start from a past or current date.

Method Summary

Modifier and Type	Method and Description
curam.cpm.facade.struct.ReservationKey	cancelReservation(curam.cpm.facade.struct.ReservationCancelKey key) Cancels a reservation.
curam.cpm.facade.struct.ReservationConfirmDetails	confirmCancelExistingReservation(curam.cpm.facade.struct.ReservationConfirmDetails reservationUpdateDetails) Cancels any existing reservations which overlap with the specified reservation.
curam.cpm.facade.struct.PlaceAndPlaceLocationDetailsList	getAvailablePlacesForReservation(curam.cpm.facade.struct.ReservationPeriodKey key) Returns the list of places that are available for reservation for a provider.
curam.cpm.facade.struct.ReservationViewDetailsList	listReservationDetails(curam.cpm.facade.struct.ProviderKey providerKey) Returns the list of active reservations for a provider.
curam.cpm.facade.struct.ReservationSearchDetailsList	searchByReservationStatusProviderAndClient(curam.cpm.facade.struct.ReservationClientIDAndProviderStatusSearchCriteria key) Searches reservations by reservation status, reservation period and client for a provider
curam.cpm.facade.struct.ReservationKey	updateReservation(curam.cpm.facade.struct.ReservationUpdateDetails key) Modifies the details of a reservation.
curam.cpm.facade.struct.ReservationVerifyDetails	verifyReservation(curam.cpm.facade.struct.ReservationConfirmDetails key) Creates a placement from the reservation, if no overlapping placement exists.
curam.cpm.facade.struct.ReservationViewSummaryDetails	viewReservation(curam.cpm.facade.struct.ReservationKey key) Reads the details of a reservation.

Method Detail

viewReservation

@AccessLevel(value=EXTERNAL)
curam.cpm.facade.struct.ReservationViewSummaryDetails viewReservation(curam.cpm.facade.struct.ReservationKey key)
                                                                                            throws curam.util.exception.AppException,
                                                                                                   curam.util.exception.InformationalException

Reads the details of a reservation.

Parameters:

key - The key of the reservation.

Returns:

The details of a reservation.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

Reservation

updateReservation

@AccessLevel(value=EXTERNAL)
curam.cpm.facade.struct.ReservationKey updateReservation(curam.cpm.facade.struct.ReservationUpdateDetails key)
                                                                               throws curam.util.exception.AppException,
                                                                                      curam.util.exception.InformationalException

Modifies the details of a reservation.

Parameters:

key - Contains the reservation details.

Returns:

The key of a reservation.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Write:

Reservation

cancelReservation

@AccessLevel(value=EXTERNAL)
curam.cpm.facade.struct.ReservationKey cancelReservation(curam.cpm.facade.struct.ReservationCancelKey key)
                                                                               throws curam.util.exception.AppException,
                                                                                      curam.util.exception.InformationalException

Cancels a reservation.

Parameters:

key - Contains the reservation key, version number, comments and cancellation reason.

Returns:

The key of a reservation.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Write:

Reservation

confirmCancelExistingReservation

@AccessLevel(value=EXTERNAL)
curam.cpm.facade.struct.ReservationConfirmDetails confirmCancelExistingReservation(curam.cpm.facade.struct.ReservationConfirmDetails reservationUpdateDetails)
                                                                                                         throws curam.util.exception.AppException,
                                                                                                                curam.util.exception.InformationalException

Cancels any existing reservations which overlap with the specified reservation.

Parameters:

reservationUpdateDetails - The key of the reservation.

Returns:

The key of a reservation.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Write:

Reservation

searchByReservationStatusProviderAndClient

@AccessLevel(value=EXTERNAL)
curam.cpm.facade.struct.ReservationSearchDetailsList searchByReservationStatusProviderAndClient(curam.cpm.facade.struct.ReservationClientIDAndProviderStatusSearchCriteria key)
                                                                                                                      throws curam.util.exception.AppException,
                                                                                                                             curam.util.exception.InformationalException

Searches reservations by reservation status, reservation period and client for a provider

Parameters:

key - Contains provider key, client key, reservation period and status.

Returns:

List of reservations which matches the search criteria.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

Reservation

listReservationDetails

@AccessLevel(value=EXTERNAL)
curam.cpm.facade.struct.ReservationViewDetailsList listReservationDetails(curam.cpm.facade.struct.ProviderKey providerKey)
                                                                                                throws curam.util.exception.AppException,
                                                                                                       curam.util.exception.InformationalException

Returns the list of active reservations for a provider.

Parameters:

key - The key of the provider.

Returns:

The list of reservations for a provider.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

Reservation

verifyReservation

@AccessLevel(value=EXTERNAL)
curam.cpm.facade.struct.ReservationVerifyDetails verifyReservation(curam.cpm.facade.struct.ReservationConfirmDetails key)
                                                                                         throws curam.util.exception.AppException,
                                                                                                curam.util.exception.InformationalException

Creates a placement from the reservation, if no overlapping placement exists.

Parameters:

key - Contains the reservation details.

Returns:

The reservation details.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Write:

Reservation, Placement

getAvailablePlacesForReservation

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

Returns the list of places that are available for reservation for a provider.

Parameters:

key - The key of the reservation.

Returns:

The list of places available for reservation.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

Reservation, Place