curam.cpm.facade.intf

Interface Place

All Known Implementing Classes:

Place, curam.cpm.facade.impl.Place, PlaceFactory

@AccessLevel(value=EXTERNAL)
public interface Place

This business interface maintains places for a compartment. The place represents a physical location such as a bed. The places are logically grouped within a compartment.

Method Summary

Modifier and Type	Method and Description
curam.cpm.sl.entity.struct.PlaceKey	createPlace(curam.cpm.sl.entity.struct.PlaceDtls placeDetails) Creates a place for a compartment.
void	deletePlace(curam.cpm.facade.struct.PlaceIDAndVersionNo placeIDAndVersionNo) Cancels a place.
curam.cpm.facade.struct.PlaceAndPlaceLocationDetailsList	getAvailablePlacesBasedOnCurrentPlacement(curam.cpm.sl.entity.struct.PlacementDtls key) Returns the list of places available for a provider in a time period starting from the specified start date and specified placement's end date.
curam.cpm.facade.struct.ProviderAvailablePlacesList	getAvailablePlacesForAllProviders(curam.cpm.facade.struct.ProviderPlacesDetails providerPlacesDetails) Searches for available places for all providers based on the search criteria.
curam.cpm.facade.struct.PlaceLocationDetails	getLocationForPlace(curam.cpm.sl.entity.struct.PlaceKey key) Reads the location details of a place.
curam.cpm.facade.struct.CompartmentPlaceWithIndicatorDetailsList	listAllCompartmentPlaces(curam.cpm.sl.entity.struct.CompartmentKey key) Returns the list of places for a compartment.
curam.cpm.facade.struct.PlaceAndPlacementDetailsList	listAllOccupiedPlacesForAProvider(curam.cpm.sl.entity.struct.ProviderKey key) Returns the list of occupied places for a provider.
curam.cpm.facade.struct.ListPlacesAvailable	listAllPlaces(curam.cpm.sl.entity.struct.CompartmentKey compartmentKey) Returns the list of places for a provider excluding any places that are associated with the specified compartment.
void	markAllPlacesInUse(curam.cpm.sl.entity.struct.CompartmentKey compartmentKey) Indicates all places are available for selection when placing a client, and updates the status of each to Available.
void	markAllPlacesOutOfUse(curam.cpm.facade.struct.MarkAllPlacesOutOfUse key) Marks all available places in a compartment as out of use so that they are not available for selection when placing a client, and updates the status of each to Out of Use.
void	markPlaceInUse(curam.cpm.facade.struct.PlaceIDAndVersionNo placeIDAndVersionNo) Indicates a place is available for selection when placing a client, and updates the status to Available.
void	markPlaceOutOfUse(curam.cpm.sl.entity.struct.OutOfUsePeriodDtls outOfUseDetails) Marks a place out of use so that it is not available for selection when placing a client, and updates the status to Out Of Use.
void	updatePlace(curam.cpm.sl.entity.struct.PlaceDtls placeDetails) Modifies the details of a place.
curam.cpm.facade.struct.PlaceAndPlacementDetailsList	viewAllPlacesForProvider(curam.cpm.sl.entity.struct.ProviderKey key) Returns a list of all available places for a provider.
curam.cpm.facade.struct.PlaceDetails	viewPlace(curam.cpm.sl.entity.struct.PlaceKey key) Reads the details of a place, placement, and reservation.

Method Detail

createPlace

@AccessLevel(value=EXTERNAL)
curam.cpm.sl.entity.struct.PlaceKey createPlace(curam.cpm.sl.entity.struct.PlaceDtls placeDetails)
                                                                      throws curam.util.exception.AppException,
                                                                             curam.util.exception.InformationalException

Creates a place for a compartment.

Parameters:

placeDetails - The details of the place and the compartment.

Returns:

The key of the place.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Write:

Place

updatePlace

@AccessLevel(value=EXTERNAL)
void updatePlace(curam.cpm.sl.entity.struct.PlaceDtls placeDetails)
                                       throws curam.util.exception.AppException,
                                              curam.util.exception.InformationalException

Modifies the details of a place.

Parameters:

placeDetails - The details of the place.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Write:

Place

viewPlace

@AccessLevel(value=EXTERNAL)
curam.cpm.facade.struct.PlaceDetails viewPlace(curam.cpm.sl.entity.struct.PlaceKey key)
                                                                     throws curam.util.exception.AppException,
                                                                            curam.util.exception.InformationalException

Reads the details of a place, placement, and reservation.

Parameters:

key - The key of the place.

Returns:

The details of a place.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

Place, Placement, Reservation

deletePlace

@AccessLevel(value=EXTERNAL)
void deletePlace(curam.cpm.facade.struct.PlaceIDAndVersionNo placeIDAndVersionNo)
                                       throws curam.util.exception.AppException,
                                              curam.util.exception.InformationalException

Cancels a place.

Parameters:

placeIDAndVersionNo - Contains the place key and the version number.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Write:

Place

markPlaceOutOfUse

@AccessLevel(value=EXTERNAL)
void markPlaceOutOfUse(curam.cpm.sl.entity.struct.OutOfUsePeriodDtls outOfUseDetails)
                                             throws curam.util.exception.AppException,
                                                    curam.util.exception.InformationalException

Marks a place out of use so that it is not available for selection when placing a client, and updates the status to Out Of Use.

Parameters:

outOfUseDetails - Contains the place key, the out of use period and reason details.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Write:

Place

markPlaceInUse

@AccessLevel(value=EXTERNAL)
void markPlaceInUse(curam.cpm.facade.struct.PlaceIDAndVersionNo placeIDAndVersionNo)
                                          throws curam.util.exception.AppException,
                                                 curam.util.exception.InformationalException

Indicates a place is available for selection when placing a client, and updates the status to Available.

Parameters:

placeIDAndVersionNo - Contains the place key and the version number.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Write:

Place

markAllPlacesOutOfUse

@AccessLevel(value=EXTERNAL)
void markAllPlacesOutOfUse(curam.cpm.facade.struct.MarkAllPlacesOutOfUse key)
                                                 throws curam.util.exception.AppException,
                                                        curam.util.exception.InformationalException

Marks all available places in a compartment as out of use so that they are not available for selection when placing a client, and updates the status of each to Out of Use.

Parameters:

key - Contains the compartment key and the out of use reason.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Write:

Place

listAllPlaces

@AccessLevel(value=EXTERNAL)
curam.cpm.facade.struct.ListPlacesAvailable listAllPlaces(curam.cpm.sl.entity.struct.CompartmentKey compartmentKey)
                                                                                throws curam.util.exception.AppException,
                                                                                       curam.util.exception.InformationalException

Returns the list of places for a provider excluding any places that are associated with the specified compartment.

Parameters:

compartmentKey - The key of the compartment.

Returns:

The list of places.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

Place, Compartment

viewAllPlacesForProvider

@AccessLevel(value=EXTERNAL)
curam.cpm.facade.struct.PlaceAndPlacementDetailsList viewAllPlacesForProvider(curam.cpm.sl.entity.struct.ProviderKey key)
                                                                                                    throws curam.util.exception.AppException,
                                                                                                           curam.util.exception.InformationalException

Returns a list of all available places for a provider.

Parameters:

key - The key of the provider.

Returns:

The list of available places for a provider.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

Place, Compartment

markAllPlacesInUse

@AccessLevel(value=EXTERNAL)
void markAllPlacesInUse(curam.cpm.sl.entity.struct.CompartmentKey compartmentKey)
                                              throws curam.util.exception.AppException,
                                                     curam.util.exception.InformationalException

Indicates all places are available for selection when placing a client, and updates the status of each to Available.

Parameters:

compartmentKey - The key of the compartment.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

Compartment

Business Object Write:

Place

getLocationForPlace

@AccessLevel(value=EXTERNAL)
curam.cpm.facade.struct.PlaceLocationDetails getLocationForPlace(curam.cpm.sl.entity.struct.PlaceKey key)
                                                                                       throws curam.util.exception.AppException,
                                                                                              curam.util.exception.InformationalException

Reads the location details of a place.

Parameters:

key - The key of the place.

Returns:

The location details of the place.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

Place

listAllOccupiedPlacesForAProvider

@AccessLevel(value=EXTERNAL)
curam.cpm.facade.struct.PlaceAndPlacementDetailsList listAllOccupiedPlacesForAProvider(curam.cpm.sl.entity.struct.ProviderKey key)
                                                                                                             throws curam.util.exception.AppException,
                                                                                                                    curam.util.exception.InformationalException

Returns the list of occupied places for a provider.

Parameters:

key - The key of the provider.

Returns:

The list of occupied places for a provider.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

Place, Compartment

listAllCompartmentPlaces

@AccessLevel(value=EXTERNAL)
curam.cpm.facade.struct.CompartmentPlaceWithIndicatorDetailsList listAllCompartmentPlaces(curam.cpm.sl.entity.struct.CompartmentKey key)
                                                                                                                throws curam.util.exception.AppException,
                                                                                                                       curam.util.exception.InformationalException

Returns the list of places for a compartment.

Parameters:

key - The key of the compartment.

Returns:

The list of places for the compartment.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

Place, Compartment

getAvailablePlacesForAllProviders

@AccessLevel(value=EXTERNAL)
curam.cpm.facade.struct.ProviderAvailablePlacesList getAvailablePlacesForAllProviders(curam.cpm.facade.struct.ProviderPlacesDetails providerPlacesDetails)
                                                                                                            throws curam.util.exception.AppException,
                                                                                                                   curam.util.exception.InformationalException

Searches for available places for all providers based on the search criteria. The search criteria consists of service, provider name, street, city, from date and to date.

Parameters:

providerPlacesDetails - Contains the details of the search criteria.

Returns:

The list of places which satisfies the search criteria.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

Place

getAvailablePlacesBasedOnCurrentPlacement

@AccessLevel(value=EXTERNAL)
curam.cpm.facade.struct.PlaceAndPlaceLocationDetailsList getAvailablePlacesBasedOnCurrentPlacement(curam.cpm.sl.entity.struct.PlacementDtls key)
                                                                                                                         throws curam.util.exception.AppException,
                                                                                                                                curam.util.exception.InformationalException

Returns the list of places available for a provider in a time period starting from the specified start date and specified placement's end date.

Parameters:

key - Contains the provider key, start date and placement key.

Returns:

The list of available places.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

Place, Placement