org.opencrx.kernel.depot1.cci
Interface BookingPeriod

All Superinterfaces:

AlertSender, Auditee, BasicObject, Cloneable, ContextCapable, CrxObject, ExtentCapable, Importer, Indexed, RefBaseObject, RefFeatured, RefObject, RefObject_1_0, SecureObject, SubscriptionTarget, ViewCapable, XmlExporter

All Known Implementing Classes:

BookingPeriodImpl

public interface BookingPeriod
extends CrxObject

Method Summary

Void	closePeriod(ClosePeriodParams params)
Void	closePeriod(Date periodEndsAtExclusive)
Void	finalizePeriod()
Void	finalizePeriod(Void params)
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 newValue) Sets a new value for the attribute isClosed.
void	setClosingBookingTypeThreshold(short newValue) Sets a new value for the attribute closingBookingTypeThreshold.
void	setDescription(String newValue) Sets a new value for the attribute description.
void	setFinal_(Boolean newValue) Sets a new value for the attribute isFinal.
void	setName(String newValue) Sets a new value for the attribute name.
void	setPeriodEndsAtExclusive(Date newValue) Sets a new value for the attribute periodEndsAtExclusive.
void	setPeriodStartsAt(Date newValue) Sets a new value for the attribute periodStartsAt.

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

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

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

sendAlert, sendAlert

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

getAudit, getAudit, getAudit, getAudit

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

clone_, clone_

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

importItem, importItem

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

getIndexEntry, getIndexEntry, getIndexEntry, getIndexEntry, updateIndex, updateIndex

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

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

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

addSubscription, addSubscription, addSubscriptionForParent, addSubscriptionForParent, removeSubscription, removeSubscription, removeSubscriptionForParent, removeSubscriptionForParent

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

exportXml, exportXml

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

getCreatedAt, getCreatedBy, getModifiedAt, getModifiedBy

Methods inherited from interface org.openmdx.base.cci.ContextCapable

getContext, getContext

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

getIdentity

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

getView, getView, getView, getView

Methods inherited from interface org.openmdx.base.accessor.jmi.cci.RefObject_1_0

refAddEventListener, refAddToUnitOfWork, refAddValue, refContext, refDefaultFetchGroup, refDelegate, refFlush, refGetEventListeners, refGetPath, refGetValue, refGetValue, refInitialize, refInitialize, refIsDeleted, refIsDirty, refIsNew, refIsPersistent, refIsWriteProtected, refRefresh, refRefreshAsynchronously, refRemoveEventListener, refRemoveFromUnitOfWork, refRemoveValue, refRemoveValue, refSetValue, refWriteProtect

Methods inherited from interface javax.jmi.reflect.RefObject

refClass, refDelete, refImmediateComposite, refIsInstanceOf, refOutermostComposite

Methods inherited from interface javax.jmi.reflect.RefFeatured

refGetValue, refGetValue, refInvokeOperation, refInvokeOperation, refSetValue, refSetValue

Methods inherited from interface javax.jmi.reflect.RefBaseObject

equals, hashCode, refImmediatePackage, refMetaObject, refMofId, refOutermostPackage, refVerifyConstraints

Method Detail

closePeriod

Void closePeriod(ClosePeriodParams params)
                 throws RefException

Throws:

RefException

closePeriod

Void 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.

Throws:

JmiException - If the value cannot be retrieved for some reason.

setClosingBookingTypeThreshold

void setClosingBookingTypeThreshold(short newValue)

Sets a new value for the attribute closingBookingTypeThreshold.

Parameters:

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

Throws:

JmiException - If the value cannot be set for some reason.

getDescription

String getDescription()

Returns:

The possibly null value for attribute description.

Throws:

JmiException - If the value cannot be retrieved for some reason.

setDescription

void setDescription(String newValue)

Sets a new value for the attribute description.

Parameters:

newValue - The possibly null new value for attribute description.

Throws:

JmiException - If the value cannot be set for some reason.

finalizePeriod

Void finalizePeriod(Void params)
                    throws RefException

Throws:

RefException

finalizePeriod

Void finalizePeriod()
                    throws RefException

Throws:

RefException

isClosed

Boolean isClosed()

Returns:

The possibly null value for attribute isClosed.

Throws:

JmiException - If the value cannot be retrieved for some reason.

setClosed

void setClosed(Boolean newValue)

Sets a new value for the attribute isClosed.

Parameters:

newValue - The possibly null new value for attribute isClosed.

Throws:

JmiException - If the value cannot be set for some reason.

isFinal

Boolean isFinal()

Returns:

The possibly null value for attribute isFinal.

Throws:

JmiException - If the value cannot be retrieved for some reason.

setFinal_

void setFinal_(Boolean newValue)

Sets a new value for the attribute isFinal.

Parameters:

newValue - The possibly null new value for attribute isFinal.

Throws:

JmiException - If the value cannot be set for some reason.

getName

String getName()

Retrieves the value for the attribute name.

Returns:

The non-null value for attribute name.

Throws:

JmiException - If the value cannot be retrieved for some reason.

setName

void setName(String newValue)

Sets a new value for the attribute name.

Parameters:

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

Throws:

JmiException - If the value cannot be set for some reason.

getPeriodEndsAtExclusive

Date getPeriodEndsAtExclusive()

Returns:

The possibly null value for attribute periodEndsAtExclusive.

Throws:

JmiException - If the value cannot be retrieved for some reason.

setPeriodEndsAtExclusive

void setPeriodEndsAtExclusive(Date newValue)

Sets a new value for the attribute periodEndsAtExclusive.

Parameters:

newValue - The possibly null new value for attribute periodEndsAtExclusive.

Throws:

JmiException - If the value cannot be set for some reason.

getPeriodStartsAt

Date getPeriodStartsAt()

Retrieves the value for the attribute periodStartsAt.

Returns:

The non-null value for attribute periodStartsAt.

Throws:

JmiException - If the value cannot be retrieved for some reason.

setPeriodStartsAt

void setPeriodStartsAt(Date newValue)

Sets a new value for the attribute periodStartsAt.

Parameters:

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

Throws:

JmiException - If the value cannot be set for some reason.