@AccessLevel(value=EXTERNAL)
public interface Reservation
extends curam.reservation.impl.ReservationAccessor, curam.util.persistence.Insertable, curam.util.type.DateTimeRanged, curam.util.persistence.helper.Commented, curam.util.persistence.OptimisticLockModifiable, curam.util.persistence.helper.Lifecycle<curam.codetable.impl.RESERVATIONSTATUSEntry>
Modifier and Type | Interface and Description |
---|---|
static interface |
Reservation.ReservationCancelEvents
Interface to the reservation events functionality surrounding the cancel
method.
|
static interface |
Reservation.ReservationCancelOverlappingActiveReservationsEvents
Interface to the reservation events functionality surrounding the
cancelOverlappingActiveReservations method.
|
static interface |
Reservation.ReservationCancelReservationEvents
Interface to the reservation events functionality surrounding the
cancelReservation method.
|
static interface |
Reservation.ReservationConfirmPlacementEvents
Interface to the reservation events functionality surrounding the
confirmPlacement method.
|
static interface |
Reservation.ReservationConfirmPlacementWithCancelActiveReservationIndEvents
Interface to the reservation events functionality surrounding the
confirmPlacement method which contains indicator for cancellation of active
reservation overlapping with the reservation period.
|
static interface |
Reservation.ReservationCreateReservationEvents
Interface to the reservation events functionality surrounding the
createReservation method.
|
static interface |
Reservation.ReservationExpireEvents
Interface to the reservation events functionality surrounding the expire
method.
|
static interface |
Reservation.ReservationGetPlaceAvailableInDateRangeEvents
Interface to the reservation events functionality surrounding the
getPlaceAvailableInDateRange
method.
|
static interface |
Reservation.ReservationInsertEvents
Interface to the reservation events functionality surrounding the insert
method.
|
static interface |
Reservation.ReservationModifyEvents
Interface to the reservation events functionality surrounding the modify
method.
|
static interface |
Reservation.ReservationUpdateReservationEvents
Interface to the reservation events functionality surrounding the
updateReservation method.
|
Modifier and Type | Method and Description |
---|---|
void |
cancel(int versionNo,
curam.codetable.impl.RESERVATIONCANCELREASONEntry reason)
Deletes the Reservation.
|
void |
cancelOverlappingActiveReservations()
Cancels the overlapping active reservations.
|
Reservation |
cancelReservation(int versionNo,
curam.codetable.impl.RESERVATIONCANCELREASONEntry reason,
java.lang.String comments)
Cancels a reservation.
|
Reservation |
confirmPlacement(Place place,
curam.util.type.DateTimeRange reservationPeriod,
int reservationVersionNo,
boolean existingPlacementPeriodChangeInd,
boolean cancelOverlappingReservationInd,
java.lang.String comments)
Transfers a reservation to actual placement.
|
Reservation |
confirmPlacement(Place place,
curam.util.type.DateTimeRange reservationPeriod,
int reservationVersionNo,
boolean existingPlacementPeriodChangeInd,
boolean cancelOverlappingReservationInd,
java.lang.String comments,
boolean cancelOverlappingReservationIndForAnyClient)
Confirms the reservation as placement.
|
Reservation |
createReservation(long caseParticipantRoleID,
ServiceOffering serviceOffering,
Provider provider,
curam.util.type.DateTimeRange reservationPeriod,
curam.util.type.Money unitAmount,
boolean unitAmountFixedIndicator,
Place place,
boolean createWithoutPlaceIndicator,
java.lang.String comments)
Creates a reservation for a participant at a place of a provider.
|
void |
expire(int versionNo)
Expires the reservation if current date has crossed the to date or the
reservation expiry date.
|
curam.participant.person.impl.Person |
getClient() |
Place |
getPlace() |
java.util.Set<Place> |
getPlaceAvailableInDateRange(Provider provider,
curam.util.type.DateTimeRange reservationPeriod)
Gets the set of first available places in a compartment for the provider
specified.
|
Placement |
getPlacement() |
Provider |
getProvider() |
ProviderOffering |
getProviderOffering() |
ServiceOffering |
getServiceOffering() |
java.util.List<curam.reservation.impl.ReservationStatusHistory> |
getStatusHistory()
Gets the immutable
List with all the history of changes to
the state of this reservation, returned in ascending date/time order (i.e. |
void |
setCaseParticipantRoleID(long value)
Sets the Case Participant of the Reservation.
|
void |
setDateTimeRange(curam.util.type.DateTimeRange dateTimeRange)
Sets the from date time and the to date time of the Reservation.
|
void |
setExpiryDateTime(curam.util.type.DateTime dateTime)
Sets the expiry date time of the Reservation.
|
void |
setPlace(Place place)
Sets the Place where the Reservation is to be made.
|
void |
setPlacement(Placement placement)
Deprecated.
Since 5.2 SP2, as this API was allowing the placement details
to be modified after the reservation was confirmed which
actually should not be allowed. Hence this method is
deprecated. The caller of this method has to handle the setting
of placement details.
|
void |
setProviderOffering(ProviderOffering providerOffering)
Sets the placement service provided by the provider.
|
void |
setUnitAmount(curam.util.type.Money unitAmount)
Sets the unit amount for the Reservation.
|
void |
setUnitAmountFixedIndicator(boolean unitAmountFixedIndicator)
Sets the unit amount fixed indicator for the Reservation.
|
Reservation |
updateReservation(curam.util.type.DateTimeRange reservationPeriod,
ServiceOffering serviceOffering,
Place place,
java.lang.String comments,
int versionNo)
Modifies the Reservation with the given details.
|
getCaseParticipantRoleID, getExpiryDateTime, getUnitAmount, isUnitAmountFixed
ProviderOffering getProviderOffering()
getProviderOffering
in interface curam.reservation.impl.ReservationAccessor
void setProviderOffering(ProviderOffering providerOffering)
providerOffering
- The placement service provided by the provider.Place getPlace()
getPlace
in interface curam.reservation.impl.ReservationAccessor
void setPlace(Place place)
place
- The Place where the Reservation is to be made.void setCaseParticipantRoleID(long value)
value
- Case participant role ID of the client for whom the reservation
has to be done.curam.participant.person.impl.Person getClient()
getClient
in interface curam.reservation.impl.ReservationAccessor
void setDateTimeRange(curam.util.type.DateTimeRange dateTimeRange)
dateTimeRange
- The date range for which the Reservation is to be done.void setUnitAmount(curam.util.type.Money unitAmount)
unitAmount
- The stipulated amount per unit that the agency authorizes for
payment to a provider for delivering the service to a particular
client.void setUnitAmountFixedIndicator(boolean unitAmountFixedIndicator)
unitAmountFixedIndicator
- Indicates whether or not the Unit Amount is considered a fixed or
estimated amount.void setExpiryDateTime(curam.util.type.DateTime dateTime)
dateTime
- The date time for which the Reservation is expired.Placement getPlacement()
getPlacement
in interface curam.reservation.impl.ReservationAccessor
@Deprecated void setPlacement(Placement placement)
placement
- The Placement for the Reservation.java.util.List<curam.reservation.impl.ReservationStatusHistory> getStatusHistory()
List
with all the history of changes to
the state of this reservation, returned in ascending date/time order (i.e.
earliest first).getStatusHistory
in interface curam.reservation.impl.ReservationAccessor
void cancel(int versionNo, curam.codetable.impl.RESERVATIONCANCELREASONEntry reason) throws curam.util.exception.InformationalException, curam.util.exception.AppException
versionNo
- The version number of the reservation record.reason
- The cancellation reason.curam.util.exception.InformationalException
- Generic Exception Signature.curam.util.exception.AppException
- Generic Exception Signature.The default implementation -
curam.reservation.impl.ReservationImpl#cancel(int,
RESERVATIONCANCELREASONEntry).
void expire(int versionNo) throws curam.util.exception.AppException, curam.util.exception.InformationalException
versionNo
- The version number of the reservation record.curam.util.exception.AppException
- Generic Exception Signature.curam.util.exception.InformationalException
- Generic Exception Signature.ServiceOffering getServiceOffering()
getServiceOffering
in interface curam.reservation.impl.ReservationAccessor
Provider getProvider()
getProvider
in interface curam.reservation.impl.ReservationAccessor
@AccessLevel(value=EXTERNAL) Reservation createReservation(long caseParticipantRoleID, ServiceOffering serviceOffering, Provider provider, curam.util.type.DateTimeRange reservationPeriod, curam.util.type.Money unitAmount, boolean unitAmountFixedIndicator, Place place, boolean createWithoutPlaceIndicator, java.lang.String comments) throws curam.util.exception.AppException, curam.util.exception.InformationalException
caseParticipantRoleID
- The case participant key of the client.serviceOffering
- The placement service details.provider
- The provider details with whom the client has to be placed.reservationPeriod
- The reservation start and end date.unitAmount
- The stipulated amount per unit that the agency authorizes
for
payment to a provider for delivering the service to a client.unitAmountFixedIndicator
- This indicates whether (or) not the unit
amount
is considered a fixed or estimated amount.place
- The details of the place which has to be reserved.createWithoutPlaceIndicator
- The indicator that specifies if the
reservation can be created without a place.comments
- The comments text.curam.util.exception.AppException
curam.util.exception.InformationalException
Reservation |
@AccessLevel(value=EXTERNAL) Reservation cancelReservation(int versionNo, curam.codetable.impl.RESERVATIONCANCELREASONEntry reason, java.lang.String comments) throws curam.util.exception.AppException, curam.util.exception.InformationalException
versionNo
- The version number.reason
- The reason for canceling the reservation.comments
- The comments for the cancellation.curam.util.exception.AppException
curam.util.exception.InformationalException
Reservation |
Reservation confirmPlacement(Place place, curam.util.type.DateTimeRange reservationPeriod, int reservationVersionNo, boolean existingPlacementPeriodChangeInd, boolean cancelOverlappingReservationInd, java.lang.String comments) throws curam.util.exception.AppException, curam.util.exception.InformationalException
place
- Place which has to be confirmed.reservationPeriod
- Contains reservation start and end date.reservationVersionNo
- Version number of the reservation.existingPlacementPeriodChangeInd
- If set to true, existing placement's end date is set to one day
before the from date of the new placement.cancelOverlappingReservationInd
- If set to true, overlapping active reservations are canceled and
the reason is set as 'Client placed elsewhere'.comments
- Comments recorded by a user relating to the placement.curam.util.exception.AppException
- Generic Exception Signature.curam.util.exception.InformationalException
- Generic Exception Signature.The default
implementation -
curam.reservation.impl.ReservationImpl#confirmPlacement(Place,
DateTimeRange, int, boolean, boolean, String).
Reservation confirmPlacement(Place place, curam.util.type.DateTimeRange reservationPeriod, int reservationVersionNo, boolean existingPlacementPeriodChangeInd, boolean cancelOverlappingReservationInd, java.lang.String comments, boolean cancelOverlappingReservationIndForAnyClient) throws curam.util.exception.AppException, curam.util.exception.InformationalException
place
- Place which has to be confirmed.reservationPeriod
- Contains reservation start and end date.reservationVersionNo
- Version number of the reservation.existingPlacementPeriodChangeInd
- If set to true, existing placement's end date is set to one day
before the from date of the new placement.cancelOverlappingReservationInd
- If set to true, overlapping active reservations are canceled and
the reason is set as 'Client placed elsewhere'.comments
- Comments recorded by a user relating to the placement. *cancelOverlappingReservationIndForAnyClient
- If set to true, then the overlapping active reservation, if exists
any, will be canceled and the reason is set as 'Overridden by
placement'curam.util.exception.AppException
- Generic Exception Signature.curam.util.exception.InformationalException
- Generic Exception Signature.The default
implementation -
curam.reservation.impl.ReservationImpl#confirmPlacement(Place,
DateTimeRange, int, boolean, boolean, String, boolean).
java.util.Set<Place> getPlaceAvailableInDateRange(Provider provider, curam.util.type.DateTimeRange reservationPeriod) throws curam.util.exception.AppException, curam.util.exception.InformationalException
getPlaceAvailableInDateRange
in interface curam.reservation.impl.ReservationAccessor
provider
- Contains Provider.reservationPeriod
- Contains reservation date range.curam.util.exception.AppException
- Generic Exception Signature.curam.util.exception.InformationalException
- Generic Exception Signature.Reservation updateReservation(curam.util.type.DateTimeRange reservationPeriod, ServiceOffering serviceOffering, Place place, java.lang.String comments, int versionNo) throws curam.util.exception.AppException, curam.util.exception.InformationalException
reservationPeriod
- Contains Reservation period.serviceOffering
- The placement service offered to the client.place
- Place which has to be modified.comments
- Contains comments added at modification time.versionNo
- Contains version number.curam.util.exception.AppException
- Generic Exception Signature.curam.util.exception.InformationalException
- Generic Exception Signature.The default implementation -
curam.reservation.impl.ReservationImpl#updateReservation(DateTimeRange,
ServiceOffering, Place, String, int).
void cancelOverlappingActiveReservations() throws curam.util.exception.InformationalException, curam.util.exception.AppException
curam.util.exception.AppException
- Generic Exception Signature.curam.util.exception.InformationalException
- Generic Exception Signature.