org.opencrx.kernel.depot1.cci
Interface DepotReport

All Superinterfaces:

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

All Known Implementing Classes:

DepotReportImpl

public interface DepotReport
extends CrxObject, DescriptionContainer

Method Summary

BookingPeriod	getBookingPeriod() Retrieves the value for the optional reference bookingPeriod.
Depot	getDepot() Retrieves the value for the reference depot.
String	getDescription()
Collection	getItemBooking() Retrieves a collection containing all the elements for the reference itemBooking.
List	getItemBooking(DepotReportItemBookingFilter filter) Retrieves the value for the reference itemBooking for the specified filter.
List	getItemBooking(DepotReportItemBookingQuery query) Retrieves the value for the reference itemBooking for the specified query.
DepotReportItemBooking	getItemBooking(String id) Retrieves the value for the reference itemBooking for the specified qualifier attribute value.
Collection	getItemPosition() Retrieves a collection containing all the elements for the reference itemPosition.
List	getItemPosition(DepotReportItemPositionFilter filter) Retrieves the value for the reference itemPosition for the specified filter.
List	getItemPosition(DepotReportItemPositionQuery query) Retrieves the value for the reference itemPosition for the specified query.
DepotReportItemPosition	getItemPosition(String id) Retrieves the value for the reference itemPosition for the specified qualifier attribute value.
String	getName() Retrieves the value for the attribute name.
boolean	isDraft() Retrieves the value for the attribute isDraft.
void	removeBookingPeriod() Removes the value for the optional reference bookingPeriod.
void	setBookingPeriod(BookingPeriod newValue) Sets a new value for the reference bookingPeriod.
void	setDescription(String newValue) Sets a new value for the attribute description.
void	setDraft(boolean newValue) Sets a new value for the attribute isDraft.
void	setName(String newValue) Sets a new value for the attribute name.

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

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

addAdditionalDescription, addAdditionalDescription, getAdditionalDescription, getAdditionalDescription, getAdditionalDescription, getAdditionalDescription, removeAdditionalDescription

Method Detail

getBookingPeriod

BookingPeriod getBookingPeriod()

Retrieves the value for the optional reference bookingPeriod.

Returns:

The possibly null value for this reference.

Throws:

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

setBookingPeriod

void setBookingPeriod(BookingPeriod newValue)

Sets a new value for the reference bookingPeriod.

Parameters:

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

Throws:

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

removeBookingPeriod

void removeBookingPeriod()

Removes the value for the optional reference bookingPeriod.

Throws:

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

getDepot

Depot getDepot()

Retrieves the value for the reference depot.

Returns:

The non-null value for this reference.

Throws:

JmiException - If the value cannot be retrieved 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.

isDraft

boolean isDraft()

Retrieves the value for the attribute isDraft.

Returns:

The non-null value for attribute isDraft.

Throws:

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

setDraft

void setDraft(boolean newValue)

Sets a new value for the attribute isDraft.

Parameters:

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

Throws:

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

getItemBooking

DepotReportItemBooking getItemBooking(String id)

Retrieves the value for the reference itemBooking for the specified qualifier attribute value.

Parameters:

id - The value for the qualifier attribute that qualifies this reference.

Returns:

The possibly null value for this reference.

Throws:

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

getItemBooking

Collection getItemBooking()

Retrieves a collection containing all the elements for the reference itemBooking.

Returns:

A collection containing all the elements for this reference.

Throws:

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

getItemBooking

List getItemBooking(DepotReportItemBookingFilter filter)

Retrieves the value for the reference itemBooking for the specified filter.

Parameters:

filter - filter which is applied to the set of referenced objects.

Returns:

The filtered collection of referenced objects.

Throws:

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

getItemBooking

List getItemBooking(DepotReportItemBookingQuery query)

Retrieves the value for the reference itemBooking for the specified query.

Parameters:

predicate - predicate which is applied to the set of referenced objects.

Returns:

The filtered collection of referenced objects.

Throws:

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

getItemPosition

DepotReportItemPosition getItemPosition(String id)

Retrieves the value for the reference itemPosition for the specified qualifier attribute value.

Parameters:

id - The value for the qualifier attribute that qualifies this reference.

Returns:

The possibly null value for this reference.

Throws:

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

getItemPosition

Collection getItemPosition()

Retrieves a collection containing all the elements for the reference itemPosition.

Returns:

A collection containing all the elements for this reference.

Throws:

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

getItemPosition

List getItemPosition(DepotReportItemPositionFilter filter)

Retrieves the value for the reference itemPosition for the specified filter.

Parameters:

filter - filter which is applied to the set of referenced objects.

Returns:

The filtered collection of referenced objects.

Throws:

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

getItemPosition

List getItemPosition(DepotReportItemPositionQuery query)

Retrieves the value for the reference itemPosition for the specified query.

Parameters:

predicate - predicate which is applied to the set of referenced objects.

Returns:

The filtered collection of referenced objects.

Throws:

JmiException - If the value cannot be retrieved 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.