curam.cpm.facade.intf

Interface Compartment

All Known Implementing Classes:

Compartment, curam.cpm.facade.impl.Compartment, CompartmentFactory

@AccessLevel(value=EXTERNAL)
public interface Compartment

This business interface manages a compartment for a provider. Providers are people or companies who provide services to a social enterprise management agency's clients on behalf of the agency. A placement service is defined as a service for which the client is physically placed with the provider for a period of time. For example, depending on the placement service the placement may be a bed in a foster home, a room in a women's shelter, or a cell in a juvenile detention unit. Within a provider facility, the smaller units such as beds may be logically grouped into compartments. Compartment contains places, placements, reservations and placement characteristic information. A place is a space which can be allocated to a client. Placements refer to circumstances where the client is physically placed with the provider for a time period. A reservation indicates that a place is reserved for a particular client for a period of time. A place can also be marked as out of use for a period of time. A characteristic is a trait which can be applied to a place, compartment or provider against which rules can be applied to allow only suitable clients to be placed there. Placement characteristics include ethnicity, gang affiliation, language and religion. An ethnicity characteristic defines the ethnicity to which the client must belong, in order to place that client in a particular compartment. A gang affiliation characteristic defines the gang affiliation that a client must have in order to place that client in the compartment. A language characteristic defines the language that must be spoken by a client in order to place that client in the compartment. A religion characteristic defines the religion to be practiced by the client in order to place that client in the compartment.

Method Summary

Modifier and Type	Method and Description
void	addCharacteristicForCompartment(curam.cpm.facade.struct.PlacementCharacteristicDetails placementCharDetails) Adds a new placement characteristic to a compartment.
void	addEthnicityCharacteristics(curam.cpm.facade.struct.PlacementCharacteristicDetails ethnicityDetails) Adds an ethnicity characteristic to a given placement characteristic of a compartment.
void	addExistingPlace(curam.cpm.sl.entity.struct.CompartmentKey compartmentkey, curam.cpm.facade.struct.PlaceIDTabList placeIDList) Adds an existing place to the given compartment.
void	addGangAffiliationCharacteristics(curam.cpm.facade.struct.PlacementCharacteristicDetails gangAffiliationDetails) Adds a gang affiliation characteristic to a given placement characteristic of a compartment.
void	addLanguageCharacteristics(curam.cpm.facade.struct.PlacementCharacteristicDetails languageDetails) Adds a language characteristic to a given placement characteristic of a compartment.
void	addReligionCharacteristics(curam.cpm.facade.struct.PlacementCharacteristicDetails religionDetails) Adds a religion characteristic to a given placement characteristic of a compartment.
void	closeCompartment(curam.cpm.facade.struct.CloseCompartmentDetails closeCompartmentDetails) Closes a compartment and any child compartments and places within in.
curam.cpm.sl.entity.struct.CompartmentKey	createCompartment(curam.cpm.sl.entity.struct.CompartmentDtls compartmentDetails) Creates a compartment for a provider.
void	deleteCompartment(curam.cpm.sl.entity.struct.CompartmentKeyAndVersion deleteCompartmentDetails) Cancels a compartment.
void	deleteCompartmentCharacteristic(curam.cpm.facade.struct.CharacteristicIDVersionDetails key) Cancels a placement characteristic for a compartment.
curam.cpm.facade.struct.UpdateCompartmentDetails	getCompartmentDetailsForUpdate(curam.cpm.sl.entity.struct.CompartmentKey key) Retrieves the details of a compartment for modification.
curam.cpm.facade.struct.PlacementCharacetristicsSummaryDeatils	getPlacementCharacteristicDetails(curam.cpm.sl.entity.struct.CompartmentKey key) Reads a list of characteristics that could be applied to a compartment.
void	removeEthnicityCharacteristic(curam.cpm.facade.struct.CharacteristicIDVersionDetails key) Removes an ethnicity characteristic from a given placement characteristic of a compartment.
void	removeGangAffiliationCharacteristic(curam.cpm.facade.struct.CharacteristicIDVersionDetails key) Removes a gang affiliation characteristic from a given placement characteristic of a compartment.
void	removeLanguageCharacteristic(curam.cpm.facade.struct.CharacteristicIDVersionDetails key) Removes a language characteristic from a given placement characteristic of a compartment.
void	removeReligionCharacteristic(curam.cpm.facade.struct.CharacteristicIDVersionDetails key) Removes a religion characteristic from a given placement characteristic of a compartment.
void	updateCompartment(curam.cpm.facade.struct.UpdateCompartmentDetails updateCompartmentDetails) Modifies the details of a compartment.
void	updateCompartmentCharacteristic(curam.cpm.facade.struct.PlacementCharacteristicDetails updatePlacementCharDetails) Modifies the details of a placement characteristic for a compartment.
curam.cpm.facade.struct.CompartmentDetails	viewCompartment(curam.cpm.facade.struct.ViewCompartmentKey compartmentKey) Reads the compartment details for a provider including place, placement, out of use period, reservation and placement characteristic information.
curam.cpm.facade.struct.ViewPlacementCharacteristicDetails	viewCompartmentCharacteristic(curam.cpm.sl.entity.struct.PlacementCharacteristicKey key) Reads the details of a placement characteristic for a compartment.

Method Detail

createCompartment

@AccessLevel(value=EXTERNAL)
curam.cpm.sl.entity.struct.CompartmentKey createCompartment(curam.cpm.sl.entity.struct.CompartmentDtls compartmentDetails)
                                                                                  throws curam.util.exception.AppException,
                                                                                         curam.util.exception.InformationalException

Creates a compartment for a provider.

Parameters:

compartmentDetails - The details of the compartment.

Returns:

The key of the compartment.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Write:

Compartment

updateCompartment

@AccessLevel(value=EXTERNAL)
void updateCompartment(curam.cpm.facade.struct.UpdateCompartmentDetails updateCompartmentDetails)
                                             throws curam.util.exception.AppException,
                                                    curam.util.exception.InformationalException

Modifies the details of a compartment.

Parameters:

updateCompartmentDetails - The compartment details.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Write:

Compartment

viewCompartment

@AccessLevel(value=EXTERNAL)
curam.cpm.facade.struct.CompartmentDetails viewCompartment(curam.cpm.facade.struct.ViewCompartmentKey compartmentKey)
                                                                                 throws curam.util.exception.AppException,
                                                                                        curam.util.exception.InformationalException

Reads the compartment details for a provider including place, placement, out of use period, reservation and placement characteristic information.

Parameters:

compartmentKey - Contains the key of the compartment and the provider.

Returns:

The details of the compartment.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

Compartment, Place, Placement, OutOfUsePeriod, Reservation, PlacementCharacteristic

deleteCompartment

@AccessLevel(value=EXTERNAL)
void deleteCompartment(curam.cpm.sl.entity.struct.CompartmentKeyAndVersion deleteCompartmentDetails)
                                             throws curam.util.exception.AppException,
                                                    curam.util.exception.InformationalException

Cancels a compartment.

Parameters:

deleteCompartmentDetails - Contains the key of the compartment and the version number.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Write:

Compartment, Place

closeCompartment

@AccessLevel(value=EXTERNAL)
void closeCompartment(curam.cpm.facade.struct.CloseCompartmentDetails closeCompartmentDetails)
                                            throws curam.util.exception.AppException,
                                                   curam.util.exception.InformationalException

Closes a compartment and any child compartments and places within in.

Parameters:

closeCompartmentDetails - Contains the key of the compartment, date closed and the version number.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Write:

Compartment, Place

addCharacteristicForCompartment

@AccessLevel(value=EXTERNAL)
void addCharacteristicForCompartment(curam.cpm.facade.struct.PlacementCharacteristicDetails placementCharDetails)
                                                           throws curam.util.exception.AppException,
                                                                  curam.util.exception.InformationalException

Adds a new placement characteristic to a compartment.

Parameters:

placementCharDetails - The placement characteristic details.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

ProviderService

Business Object Write:

PlacementCharacteristic

updateCompartmentCharacteristic

@AccessLevel(value=EXTERNAL)
void updateCompartmentCharacteristic(curam.cpm.facade.struct.PlacementCharacteristicDetails updatePlacementCharDetails)
                                                           throws curam.util.exception.AppException,
                                                                  curam.util.exception.InformationalException

Modifies the details of a placement characteristic for a compartment.

Parameters:

updatePlacementCharDetails - The placement characteristic details.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

ProviderService

Business Object Write:

PlacementCharacteristic

viewCompartmentCharacteristic

@AccessLevel(value=EXTERNAL)
curam.cpm.facade.struct.ViewPlacementCharacteristicDetails viewCompartmentCharacteristic(curam.cpm.sl.entity.struct.PlacementCharacteristicKey key)
                                                                                                               throws curam.util.exception.AppException,
                                                                                                                      curam.util.exception.InformationalException

Reads the details of a placement characteristic for a compartment.

Parameters:

key - The key of the placement characteristic.

Returns:

The placement characteristic details.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

PlacementCharacteristic

deleteCompartmentCharacteristic

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

Cancels a placement characteristic for a compartment.

Parameters:

key - Contains the key of the placement characteristic and the version number.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Write:

PlacementCharacteristic

addExistingPlace

@AccessLevel(value=EXTERNAL)
void addExistingPlace(curam.cpm.sl.entity.struct.CompartmentKey compartmentkey,
                                                   curam.cpm.facade.struct.PlaceIDTabList placeIDList)
                                            throws curam.util.exception.AppException,
                                                   curam.util.exception.InformationalException

Adds an existing place to the given compartment.

Parameters:

compartmentKey - The key of the compartment.

placeIDList - The list of place IDs.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

getPlacementCharacteristicDetails

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

Reads a list of characteristics that could be applied to a compartment.

Parameters:

key - The compartment identifier.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

removeLanguageCharacteristic

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

Removes a language characteristic from a given placement characteristic of a compartment.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Write:

PlacementCharacteristic

removeGangAffiliationCharacteristic

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

Removes a gang affiliation characteristic from a given placement characteristic of a compartment.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Write:

PlacementCharacteristic

removeEthnicityCharacteristic

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

Removes an ethnicity characteristic from a given placement characteristic of a compartment.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Write:

PlacementCharacteristic

removeReligionCharacteristic

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

Removes a religion characteristic from a given placement characteristic of a compartment.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Write:

PlacementCharacteristic

addLanguageCharacteristics

@AccessLevel(value=EXTERNAL)
void addLanguageCharacteristics(curam.cpm.facade.struct.PlacementCharacteristicDetails languageDetails)
                                                      throws curam.util.exception.AppException,
                                                             curam.util.exception.InformationalException

Adds a language characteristic to a given placement characteristic of a compartment.

Parameters:

languageDetails - The placement characteristic details.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Write:

PlacementCharacteristic

addGangAffiliationCharacteristics

@AccessLevel(value=EXTERNAL)
void addGangAffiliationCharacteristics(curam.cpm.facade.struct.PlacementCharacteristicDetails gangAffiliationDetails)
                                                             throws curam.util.exception.AppException,
                                                                    curam.util.exception.InformationalException

Adds a gang affiliation characteristic to a given placement characteristic of a compartment.

Parameters:

gangAffiliationDetails - The placement characteristic details.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Write:

PlacementCharacteristic

addEthnicityCharacteristics

@AccessLevel(value=EXTERNAL)
void addEthnicityCharacteristics(curam.cpm.facade.struct.PlacementCharacteristicDetails ethnicityDetails)
                                                       throws curam.util.exception.AppException,
                                                              curam.util.exception.InformationalException

Adds an ethnicity characteristic to a given placement characteristic of a compartment.

Parameters:

ethnicityDetails - The placement characteristic details.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Write:

PlacementCharacteristic

addReligionCharacteristics

@AccessLevel(value=EXTERNAL)
void addReligionCharacteristics(curam.cpm.facade.struct.PlacementCharacteristicDetails religionDetails)
                                                      throws curam.util.exception.AppException,
                                                             curam.util.exception.InformationalException

Adds a religion characteristic to a given placement characteristic of a compartment.

Parameters:

religionDetails - The placement characteristic details.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Write:

PlacementCharacteristic

getCompartmentDetailsForUpdate

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

Retrieves the details of a compartment for modification.

Parameters:

key - The key of the compartment.

Returns:

The compartment details.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

Compartment