@AccessLevel(value=EXTERNAL)
public interface Place
extends curam.place.impl.PlaceAccessor, curam.util.persistence.Insertable, curam.util.persistence.helper.Named, curam.util.persistence.helper.Lifecycle<curam.place.impl.PlaceStatusEntry>, curam.util.type.DateRanged, curam.util.type.DateTimeRanged, curam.util.persistence.OptimisticLockModifiable
Modifier and Type | Interface and Description |
---|---|
static interface |
Place.PlaceCancelEvents
Interface to the place events functionality surrounding the cancel method.
|
static interface |
Place.PlaceCloseEvents
Interface to the place events functionality surrounding the close method.
|
static interface |
Place.PlaceGetLocationForPlaceEvents
Interface to the place events functionality surrounding the get location
for place method.
|
static interface |
Place.PlaceInsertEvents
Interface to the place events functionality surrounding the insert method.
|
static interface |
Place.PlaceMarkInUseEvents
Interface to the place events functionality surrounding the markInUse
method.
|
static interface |
Place.PlaceMarkOutOfUseEvents
Interface to the place events functionality surrounding the markOutOfUse
method.
|
static interface |
Place.PlaceModifyEvents
Interface to the place events functionality surrounding the modify method.
|
static interface |
Place.PlaceOccupiedEvents
Interface to the place events functionality surrounding the occupied
method.
|
Modifier and Type | Method and Description |
---|---|
void |
cancel(int versionNo)
Deletes the Place.
|
void |
close(int versionNo)
Closes the Place.
|
Compartment |
getCompartment() |
void |
markInUse(int versionNo)
Marks the Place in use.
|
void |
markOutOfUse(int versionNo)
Marks the Place out of use.
|
void |
occupied(int versionNo)
Marks the Place as occupied.
|
void |
setCompartment(Compartment compartment)
Sets the Compartment to which the Place is associated to.
|
void |
setDateRange(curam.util.type.DateRange value)
Deprecated.
Since Curam 6.0, replaced with
(final DateTimeRange clientDateTimeRange) . To overcome the
problem with time zone when only date is considered, the method
setDateTimeRange which accepts date and time in the client
specific time zone has been introduced. See release note:
CR00198774. |
void |
setDateTimeRange(curam.util.type.DateTimeRange clientDateTimeRange)
Sets the creation date time and the close date time of the place.
|
void |
setType(curam.place.impl.PlaceTypeEntry value)
Sets the type of the Place.
|
getDateTimeRange, getLocationForPlace, getType
Compartment getCompartment()
getCompartment
in interface curam.place.impl.PlaceAccessor
void setCompartment(Compartment compartment)
compartment
- Contains the compartmentID.void setType(curam.place.impl.PlaceTypeEntry value)
value
- The type of the place which are designated or emergency.@Deprecated void setDateRange(curam.util.type.DateRange value)
(final DateTimeRange clientDateTimeRange)
. To overcome the
problem with time zone when only date is considered, the method
setDateTimeRange which accepts date and time in the client
specific time zone has been introduced. See release note:
CR00198774.value
- The "lifetime" of the place. This place cannot be offered to
clients outside of the date range.void markOutOfUse(int versionNo) throws curam.util.exception.InformationalException
versionNo
- To update the place with the status of "OutOfUse" by passing
versionNo.curam.util.exception.InformationalException
- Generic Exception Signature.The default
implementation - curam.place.impl.PlaceImpl#markOutOfUse(int)
void occupied(int versionNo) throws curam.util.exception.InformationalException
versionNo
- To update the place with the status of "Occupied" by passing
versionNo.curam.util.exception.InformationalException
- Generic Exception Signature.void close(int versionNo) throws curam.util.exception.InformationalException
versionNo
- To update the place with the status of "Closed" by passing
versionNo.curam.util.exception.InformationalException
- Generic Exception Signature.void markInUse(int versionNo) throws curam.util.exception.InformationalException
versionNo
- To update the place with the status of "Available" by passing
versionNo.curam.util.exception.InformationalException
- Generic Exception Signature.The default implementation -
curam.place.impl.PlaceImpl#markInUse(int)
void cancel(int versionNo) throws curam.util.exception.InformationalException
versionNo
- To update the Place with the status of "Canceled" by passing
versionNo.curam.util.exception.InformationalException
- Generic Exception Signature.The default implementation -
curam.place.impl.PlaceImpl#cancel(int)
void setDateTimeRange(curam.util.type.DateTimeRange clientDateTimeRange)
clientDateTimeRange
- The "lifetime" of the place in the client time zone.