org.opencrx.kernel.depot1.cci2
Interface BookingPeriod

All Superinterfaces:

AlertSender, Auditee, org.openmdx.base.cci2.BasicObject, Cloneable, org.openmdx.base.cci2.ContextCapable, CrxObject, org.openmdx.base.cci2.ExtentCapable, Importer, Indexed, SecureObject, SubscriptionTarget, org.openmdx.compatibility.view1.cci2.ViewCapable, XmlExporter

All Known Subinterfaces:

BookingPeriod

All Known Implementing Classes:

BookingPeriod

public interface BookingPeriod
extends CrxObject

Class BookingPeriod

Nested Class Summary

static interface

BookingPeriod.Identity Object Identity

Method Summary

<T extends org.openmdx.base.cci2.Void> T	closePeriod(Date periodEndsAtExclusive)
<T extends org.openmdx.base.cci2.Void> T	finalizePeriod()
short	getClosingBookingTypeThreshold() Retrieves the value for the attribute closingBookingTypeThreshold.
String	getDescription()
String	getName() Retrieves the value for the attribute name.
Date	getPeriodEndsAtExclusive()
Date	getPeriodStartsAt() Retrieves the value for the attribute periodStartsAt.
Boolean	isClosed()
Boolean	isFinal()
void	setClosed(Boolean isClosed) Sets a new value for the attribute isClosed.
void	setClosingBookingTypeThreshold(short closingBookingTypeThreshold) Sets a new value for the attribute closingBookingTypeThreshold.
void	setDepotEntity(DepotEntity depotEntity) Sets a new value for the reference depotEntity.
void	setDepotEntity(DepotEntity depotEntity, boolean idIsPersistent, String id) Set the object's composite association org:opencrx:kernel:depot1:DepotEntityHasBookingPeriod.
void	setDescription(String description) Sets a new value for the attribute description.
void	setFinal(Boolean isFinal) Sets a new value for the attribute isFinal.
void	setName(String name) Sets a new value for the attribute name.
void	setPeriodEndsAtExclusive(Date periodEndsAtExclusive) Sets a new value for the attribute periodEndsAtExclusive.
void	setPeriodStartsAt(Date periodStartsAt) Sets a new value for the attribute periodStartsAt.

Methods inherited from interface org.opencrx.kernel.generic.cci2.CrxObject

getAdditionalExternalLink, getAttachedDocument, getCategory, getDisabledReason, getExternalLink, getMedia, getNote, getPropertySet, getPropertySetEntry, getRating, getUserBoolean4, getUserCode0, getUserCode1, getUserCode2, getUserCode3, getUserCode4, getUserDate0, getUserDate1, getUserDate2, getUserDate3, getUserDate4, getUserDateTime0, getUserDateTime1, getUserDateTime2, getUserDateTime3, getUserDateTime4, getUserNumber0, getUserNumber1, getUserNumber2, getUserNumber3, getUserNumber4, getUserString0, getUserString1, getUserString2, getUserString3, getUserString4, isDisabled, isUserBoolean0, isUserBoolean1, isUserBoolean2, isUserBoolean3, setCategory, setDisabled, setDisabledReason, setExternalLink, setUserBoolean0, setUserBoolean1, setUserBoolean2, setUserBoolean3, setUserBoolean4, setUserCode0, setUserCode1, setUserCode2, setUserCode3, setUserCode4, setUserDate0, setUserDate1, setUserDate2, setUserDate3, setUserDate4, setUserDateTime0, setUserDateTime1, setUserDateTime2, setUserDateTime3, setUserDateTime4, setUserNumber0, setUserNumber1, setUserNumber2, setUserNumber3, setUserNumber4, setUserString0, setUserString1, setUserString2, setUserString3, setUserString4

Methods inherited from interface org.opencrx.kernel.base.cci2.AlertSender

sendAlert

Methods inherited from interface org.opencrx.kernel.base.cci2.Auditee

getAudit

Methods inherited from interface org.opencrx.kernel.base.cci2.Cloneable

clone_

Methods inherited from interface org.opencrx.kernel.base.cci2.Importer

importItem

Methods inherited from interface org.opencrx.kernel.base.cci2.Indexed

getIndexEntry, updateIndex

Methods inherited from interface org.opencrx.kernel.base.cci2.SecureObject

addOwningGroup, getAccessGrantedByParent, getAccessLevelBrowse, getAccessLevelDelete, getAccessLevelUpdate, getOwner, getOwningGroup, getOwningUser, removeAllOwningGroup, removeOwningGroup, setAccessLevel, setAccessLevelBrowse, setAccessLevelDelete, setAccessLevelUpdate, setOwningUser, setOwningUser

Methods inherited from interface org.opencrx.kernel.base.cci2.SubscriptionTarget

addSubscription, addSubscriptionForParent, removeSubscription, removeSubscriptionForParent

Methods inherited from interface org.opencrx.kernel.base.cci2.XmlExporter

exportXml

Methods inherited from interface org.openmdx.base.cci2.BasicObject

getCreatedAt, getCreatedBy, getModifiedAt, getModifiedBy

Methods inherited from interface org.openmdx.base.cci2.ExtentCapable

getIdentity

Methods inherited from interface org.openmdx.compatibility.view1.cci2.ViewCapable

getView

Method Detail

closePeriod

<T extends org.openmdx.base.cci2.Void> T closePeriod(Date periodEndsAtExclusive)
                                                 throws RefException

Throws:

RefException

getClosingBookingTypeThreshold

short getClosingBookingTypeThreshold()

Retrieves the value for the attribute closingBookingTypeThreshold.

Returns:

The non-null value for attribute closingBookingTypeThreshold.

setClosingBookingTypeThreshold

void setClosingBookingTypeThreshold(short closingBookingTypeThreshold)

Sets a new value for the attribute closingBookingTypeThreshold.

Parameters:

closingBookingTypeThreshold - The non-null new value for attribute closingBookingTypeThreshold.

getDescription

String getDescription()

Returns:

The possibly null value for attribute description.

setDescription

void setDescription(String description)

Sets a new value for the attribute description.

Parameters:

description - The possibly null new value for attribute description.

finalizePeriod

<T extends org.openmdx.base.cci2.Void> T finalizePeriod()
                                                    throws RefException

Throws:

RefException

isClosed

Boolean isClosed()

Returns:

The possibly null value for attribute isClosed.

setClosed

void setClosed(Boolean isClosed)

Sets a new value for the attribute isClosed.

Parameters:

isClosed - The possibly null new value for attribute isClosed.

isFinal

Boolean isFinal()

Returns:

The possibly null value for attribute isFinal.

setFinal

void setFinal(Boolean isFinal)

Sets a new value for the attribute isFinal.

Parameters:

isFinal - The possibly null new value for attribute isFinal.

getName

String getName()

Retrieves the value for the attribute name.

Returns:

The non-null value for attribute name.

setName

void setName(String name)

Sets a new value for the attribute name.

Parameters:

name - The non-null new value for attribute name.

getPeriodEndsAtExclusive

Date getPeriodEndsAtExclusive()

Returns:

The possibly null value for attribute periodEndsAtExclusive.

setPeriodEndsAtExclusive

void setPeriodEndsAtExclusive(Date periodEndsAtExclusive)

Sets a new value for the attribute periodEndsAtExclusive.

Parameters:

periodEndsAtExclusive - The possibly null new value for attribute periodEndsAtExclusive.

getPeriodStartsAt

Date getPeriodStartsAt()

Retrieves the value for the attribute periodStartsAt.

Returns:

The non-null value for attribute periodStartsAt.

setPeriodStartsAt

void setPeriodStartsAt(Date periodStartsAt)

Sets a new value for the attribute periodStartsAt.

Parameters:

periodStartsAt - The non-null new value for attribute periodStartsAt.

setDepotEntity

void setDepotEntity(DepotEntity depotEntity)

Sets a new value for the reference depotEntity.

Parameters:

depotEntity - The non-null new value for this reference.

setDepotEntity

void setDepotEntity(DepotEntity depotEntity,
                    boolean idIsPersistent,
                    String id)

Set the object's composite association org:opencrx:kernel:depot1:DepotEntityHasBookingPeriod.

Parameters:

depotEntity - The non-null new value for this object's composite owner.

idIsPersistent - Defines whether the id is persistent.

id - The non-null new value for this object's qualifier.