@AccessLevel(value=EXTERNAL) public interface Compartment extends CompartmentAccessor, curam.util.persistence.Insertable, curam.util.persistence.helper.Commented, curam.util.type.DateRanged, curam.util.type.DateTimeRanged, curam.util.persistence.helper.Lifecycle<curam.place.impl.CompartmentStatusEntry>, curam.util.persistence.OptimisticLockModifiable
Modifier and Type | Interface and Description |
---|---|
static interface |
Compartment.CompartmentCancelEvents
Interface to the compartment events functionality surrounding the cancel
method.
|
static interface |
Compartment.CompartmentCloseEvents
Interface to the compartment events functionality surrounding the close
method.
|
static interface |
Compartment.CompartmentInsertEvents
Interface to the compartment events functionality surrounding the insert
method.
|
static interface |
Compartment.CompartmentModifyEvents
Interface to the compartment events functionality surrounding the modify
method.
|
Modifier and Type | Method and Description |
---|---|
void |
cancel(int versionNo)
Logically deletes a Compartment and its child compartments.
|
void |
close(int versionNo,
curam.util.type.Date closeDate)
Closes the Compartment and its child compartments.
|
java.util.Set<Compartment> |
getChildren()
Gets the immutable set of all child compartments.
|
java.util.Set<Place> |
getEmergencyPlaces()
Gets the immutable set of all emergency places within the compartment.
|
java.util.Set<Compartment> |
getImmediateChildren()
Gets the set of immediate child compartments.
|
Compartment |
getParentCompartment()
Gets the parent compartment.
|
java.util.Set<PlacementCharacteristic> |
getPlacementCharacteristics()
Gets the immutable set of placement characteristics for a provider which
are used to identify appropriate placements for clients within a
compartment.
|
java.util.Set<Place> |
getPlacesByStatus(curam.place.impl.PlaceStatusEntry placeStatus)
Gets the immutable set of all places by status.
|
Provider |
getProvider()
Gets the provider the compartment is associated with.
|
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 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 compartment.
|
void |
setDescription(java.lang.String value)
Sets the description of the compartment.
|
void |
setName(java.lang.String name)
Sets the Name of the compartment.
|
void |
setParentCompartment(Compartment value)
Sets the parent compartment.
|
void |
setProvider(Provider value)
Sets the provider for the Compartment.
|
getDateRange, getDateTimeRange, getDescription, getName
Provider getProvider()
CompartmentAccessor
The returned object is intentionally accessor-only. Calling code must not attempt to cast the object to its mutator interface, nor use the object's ID to re-retrieve a mutable instance from the database.
getProvider
in interface CompartmentAccessor
void setProvider(Provider value)
value
- Provider for the compartment.Compartment getParentCompartment()
CompartmentAccessor
The returned object is intentionally accessor-only. Calling code must not attempt to cast the object to its mutator interface, nor use the object's ID to re-retrieve a mutable instance from the database.
getParentCompartment
in interface CompartmentAccessor
void setParentCompartment(Compartment value)
value
- The parent Compartment.java.util.Set<PlacementCharacteristic> getPlacementCharacteristics()
CompartmentAccessor
The returned objects are intentionally accessor-only. Calling code must not attempt to cast any of these objects to its mutator interface, nor use the object's ID to re-retrieve a mutable instance from the database.
getPlacementCharacteristics
in interface CompartmentAccessor
java.util.Set<Place> getPlacesByStatus(curam.place.impl.PlaceStatusEntry placeStatus)
CompartmentAccessor
The returned objects are intentionally accessor-only. Calling code must not attempt to cast any of these objects to its mutator interface, nor use the object's ID to re-retrieve a mutable instance from the database.
getPlacesByStatus
in interface CompartmentAccessor
placeStatus
- Status of Place.java.util.Set<Place> getEmergencyPlaces()
CompartmentAccessor
getEmergencyPlaces
in interface CompartmentAccessor
java.util.Set<Compartment> getChildren()
CompartmentAccessor
getChildren
in interface CompartmentAccessor
java.util.Set<Compartment> getImmediateChildren()
CompartmentAccessor
getImmediateChildren
in interface CompartmentAccessor
void setName(java.lang.String name)
name
- Name of the Compartment.void setDescription(java.lang.String value)
value
- Description of the compartment.@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 has been introduced. See release note:
CR00198774.value
- DateRange to be set for the compartment.void cancel(int versionNo) throws curam.util.exception.InformationalException
versionNo
- The version number as previously retrieved.curam.util.exception.InformationalException
- Generic Exception Signature.The default
implementation - curam.place.impl.CompartmentImpl#cancel(int)
void close(int versionNo, curam.util.type.Date closeDate) throws curam.util.exception.InformationalException
versionNo
- The version number as previously retrieved.closeDate
- The close date of the compartment.curam.util.exception.InformationalException
- Generic Exception Signature.The default
implementation - curam.place.impl.CompartmentImpl#close(int,Date)
void setDateTimeRange(curam.util.type.DateTimeRange clientDateTimeRange)
clientDateTimeRange
- The "lifetime" of the compartment in the client time zone.