org.opencrx.kernel.depot1.jmi1

Interface DepotEntity

All Superinterfaces:

AlertSender, Auditee, org.openmdx.base.cci2.BasicObject, Cloneable, org.openmdx.base.cci2.ContextCapable, org.openmdx.base.cci2.Creatable, CrxObject, DepotEntity, Exporter, org.openmdx.base.cci2.ExtentCapable, Importer, Indexed, LocalizedFieldContainer, org.openmdx.base.cci2.Modifiable, javax.jmi.reflect.RefBaseObject, javax.jmi.reflect.RefFeatured, javax.jmi.reflect.RefObject, org.openmdx.base.accessor.jmi.cci.RefObject_1_0, SecureObject

public interface DepotEntity
extends DepotEntity, CrxObject

Class DepotEntity

Nested Class Summary

Nested classes/interfaces inherited from interface org.opencrx.kernel.depot1.cci2.DepotEntity

DepotEntity.Identity

Method Summary

Modifier and Type	Method and Description
void	addBookingEntry(boolean idIsPersistent, String id, SingleBookingEntry bookingEntry) Adds the specified element to the set of the values for the reference bookingEntry.
void	addBookingEntry(SingleBookingEntry bookingEntry) Adds the specified element to the set of the values for the reference bookingEntry using an implementation-specific, reassignable qualifier.
void	addBookingEntry(String id, SingleBookingEntry bookingEntry) Adds the specified element to the set of the values for the reference bookingEntry using a reassignable qualifier.
void	addBookingPeriod(BookingPeriod bookingPeriod) Adds the specified element to the set of the values for the reference bookingPeriod using an implementation-specific, reassignable qualifier.
void	addBookingPeriod(boolean idIsPersistent, String id, BookingPeriod bookingPeriod) Adds the specified element to the set of the values for the reference bookingPeriod.
void	addBookingPeriod(String id, BookingPeriod bookingPeriod) Adds the specified element to the set of the values for the reference bookingPeriod using a reassignable qualifier.
void	addBookingText(BookingText bookingText) Adds the specified element to the set of the values for the reference bookingText using an implementation-specific, reassignable qualifier.
void	addBookingText(boolean idIsPersistent, String id, BookingText bookingText) Adds the specified element to the set of the values for the reference bookingText.
void	addBookingText(String id, BookingText bookingText) Adds the specified element to the set of the values for the reference bookingText using a reassignable qualifier.
void	addDepotGroup(boolean idIsPersistent, String id, DepotGroup depotGroup) Adds the specified element to the set of the values for the reference depotGroup.
void	addDepotGroup(DepotGroup depotGroup) Adds the specified element to the set of the values for the reference depotGroup using an implementation-specific, reassignable qualifier.
void	addDepotGroup(String id, DepotGroup depotGroup) Adds the specified element to the set of the values for the reference depotGroup using a reassignable qualifier.
void	addDepotHolder(boolean idIsPersistent, String id, DepotHolder depotHolder) Adds the specified element to the set of the values for the reference depotHolder.
void	addDepotHolder(DepotHolder depotHolder) Adds the specified element to the set of the values for the reference depotHolder using an implementation-specific, reassignable qualifier.
void	addDepotHolder(String id, DepotHolder depotHolder) Adds the specified element to the set of the values for the reference depotHolder using a reassignable qualifier.
CreateBookingResult	createBookingByPosition(CreateBookingByPositionParams in)
CreateBookingResult	createBookingByPositionName(CreateBookingByPositionNameParams in)
CreateBookingResult	createBookingByProduct(CreateBookingByProductParams in)
CreateCompoundBookingResult	createCompoundBooking(CreateCompoundBookingParams in)
SingleBookingEntry	getBookingEntry(boolean idIsPersistent, String id) Retrieves the value for the reference bookingEntry for the specified qualifier attribute value.
<T extends SingleBookingEntry> List<T>	getBookingEntry(SingleBookingEntryQuery query) Retrieves the value for the reference bookingEntry for the specified query.
SingleBookingEntry	getBookingEntry(String id) Retrieves the value for the reference bookingEntry for the specified qualifier attribute value.
<T extends BookingPeriod> List<T>	getBookingPeriod(BookingPeriodQuery query) Retrieves the value for the reference bookingPeriod for the specified query.
BookingPeriod	getBookingPeriod(boolean idIsPersistent, String id) Retrieves the value for the reference bookingPeriod for the specified qualifier attribute value.
BookingPeriod	getBookingPeriod(String id) Retrieves the value for the reference bookingPeriod for the specified qualifier attribute value.
<T extends BookingText> List<T>	getBookingText(BookingTextQuery query) Retrieves the value for the reference bookingText for the specified query.
BookingText	getBookingText(boolean idIsPersistent, String id) Retrieves the value for the reference bookingText for the specified qualifier attribute value.
BookingText	getBookingText(String id) Retrieves the value for the reference bookingText for the specified qualifier attribute value.
Depot	getDepot(boolean idIsPersistent, String id) Retrieves the value for the reference depot for the specified qualifier attribute value.
<T extends Depot> List<T>	getDepot(DepotQuery query) Retrieves the value for the reference depot for the specified query.
Depot	getDepot(String id) Retrieves the value for the reference depot for the specified qualifier attribute value.
DepotGroup	getDepotGroup(boolean idIsPersistent, String id) Retrieves the value for the reference depotGroup for the specified qualifier attribute value.
<T extends DepotGroup> List<T>	getDepotGroup(DepotGroupQuery query) Retrieves the value for the reference depotGroup for the specified query.
DepotGroup	getDepotGroup(String id) Retrieves the value for the reference depotGroup for the specified qualifier attribute value.
DepotHolder	getDepotHolder(boolean idIsPersistent, String id) Retrieves the value for the reference depotHolder for the specified qualifier attribute value.
<T extends DepotHolder> List<T>	getDepotHolder(DepotHolderQuery query) Retrieves the value for the reference depotHolder for the specified query.
DepotHolder	getDepotHolder(String id) Retrieves the value for the reference depotHolder for the specified qualifier attribute value.

Methods inherited from interface org.opencrx.kernel.depot1.cci2.DepotEntity

createBookingByPosition, createBookingByPositionName, createBookingByProduct, createCompoundBooking, getBookingEntry, getBookingPeriod, getBookingText, getDepot, getDepotEntityNumber, getDepotGroup, getDepotHolder, getDescription, getName, setDepotEntityNumber, setDescription, setName

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

addAdditionalExternalLink, addAdditionalExternalLink, addAdditionalExternalLink, addAttachedDocument, addAttachedDocument, addAttachedDocument, addDocumentFolderAssignment, addDocumentFolderAssignment, addDocumentFolderAssignment, addInvolvedObject, addInvolvedObject, addInvolvedObject, addMedia, addMedia, addMedia, addNote, addNote, addNote, addPropertySet, addPropertySet, addPropertySet, addRating, addRating, addRating, disableCrxObject, enableCrxObject, getAdditionalExternalLink, getAdditionalExternalLink, getAdditionalExternalLink, getAssignedTimer, getAssignedTimer, getAssignedTimer, getAttachedDocument, getAttachedDocument, getAttachedDocument, getCategory, getDocumentFolderAssignment, getDocumentFolderAssignment, getDocumentFolderAssignment, getExternalLink, getInvolvedObject, getInvolvedObject, getInvolvedObject, getMedia, getMedia, getMedia, getNote, getNote, getNote, getPropertySet, getPropertySet, getPropertySet, getPropertySetEntry, getPropertySetEntry, getPropertySetEntry, getRating, getRating, getRating, getUserBoolean4, getUserCode4, getUserDate4, getUserDateTime4, getUserNumber4, getUserString4, setCategory, setExternalLink, setUserBoolean4, setUserCode4, setUserDate4, setUserDateTime4, setUserNumber4, setUserString4

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

disableCrxObject, enableCrxObject, getAdditionalExternalLink, getAssignedTimer, getAttachedDocument, getDisabledReason, getDocumentFolderAssignment, getInvolvedObject, getMedia, getNote, getPropertySet, getPropertySetEntry, getRating, getUserCode0, getUserCode1, getUserCode2, getUserCode3, getUserDate0, getUserDate1, getUserDate2, getUserDate3, getUserDateTime0, getUserDateTime1, getUserDateTime2, getUserDateTime3, getUserNumber0, getUserNumber1, getUserNumber2, getUserNumber3, getUserString0, getUserString1, getUserString2, getUserString3, 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.jmi1.AlertSender

sendAlert

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

sendAlert

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

getAudit, getAudit, getAudit

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

getAudit

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

clone_

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

clone_

Methods inherited from interface org.opencrx.kernel.base.jmi1.Exporter

exportItem, exportItemAdvanced

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

exportItem, exportItemAdvanced

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

importItem

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

importItem

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

getIndexEntry, getIndexEntry, getIndexEntry, updateIndex

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

getIndexEntry, updateIndex

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

addOwningGroup, checkPermissions, getOwner, getOwningUser, removeAllOwningGroup, removeOwningGroup, replaceOwningGroup, setAccessLevel, setOwner, setOwningUser, setOwningUser

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

addOwningGroup, checkPermissions, getAccessLevelBrowse, getAccessLevelDelete, getAccessLevelUpdate, getOwningGroup, removeAllOwningGroup, removeOwningGroup, replaceOwningGroup, setAccessLevel, setAccessLevelBrowse, setAccessLevelDelete, setAccessLevelUpdate, setOwner, setOwningUser

Methods inherited from interface org.opencrx.kernel.generic.jmi1.LocalizedFieldContainer

addLocalizedField, addLocalizedField, addLocalizedField, getLocalizedField, getLocalizedField, getLocalizedField

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

getLocalizedField

Methods inherited from interface org.openmdx.base.jmi1.Creatable

getCreatedBy

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

getCreatedAt

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

getIdentity

Methods inherited from interface org.openmdx.base.jmi1.Modifiable

getModifiedBy

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

getModifiedAt

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

refDefaultFetchGroup, refDelegate, refGetPath, refGetValue, refInitialize, refInitialize, refSetValue

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

getBookingEntry

<T extends SingleBookingEntry> List<T> getBookingEntry(SingleBookingEntryQuery query)

Retrieves the value for the reference bookingEntry for the specified query. Note: This is an extension to the JMI 1 standard.
In order to remain standard compliant you should substitute this method with java.jdo.Query

Parameters:

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

Returns:

The objects for which the predicate evaluates to true.

getBookingEntry

SingleBookingEntry getBookingEntry(boolean idIsPersistent,
                                   String id)

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

Parameters:

idIsPersistent - Defines whether value for the qualifier is persistent or not

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

Returns:

The possibly null value for this qualifier

getBookingEntry

SingleBookingEntry getBookingEntry(String id)

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

This method is equivalent to the preferred invocation getBookingEntry(false,id).

Parameters:

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

Returns:

The possibly null value for this qualifier

addBookingEntry

void addBookingEntry(boolean idIsPersistent,
                     String id,
                     SingleBookingEntry bookingEntry)

Adds the specified element to the set of the values for the reference bookingEntry.

Note: This is an extension to the JMI 1 standard.

Parameters:

idIsPersistent - true if id is persistent

id - The qualifier attribute value that qualifies the reference to get the element to be appended.

bookingEntry - The element to be appended.

addBookingEntry

void addBookingEntry(String id,
                     SingleBookingEntry bookingEntry)

Adds the specified element to the set of the values for the reference bookingEntry using a reassignable qualifier.

Note: This is an extension to the JMI 1 standard.

Parameters:

id - The qualifier attribute value that qualifies the reference to get the element to be appended.

bookingEntry - The element to be appended.

addBookingEntry

void addBookingEntry(SingleBookingEntry bookingEntry)

Adds the specified element to the set of the values for the reference bookingEntry using an implementation-specific, reassignable qualifier.

Note: This is an extension to the JMI 1 standard.

Parameters:

bookingEntry - The element to be appended.

getBookingPeriod

<T extends BookingPeriod> List<T> getBookingPeriod(BookingPeriodQuery query)

Retrieves the value for the reference bookingPeriod for the specified query. Note: This is an extension to the JMI 1 standard.
In order to remain standard compliant you should substitute this method with java.jdo.Query

Parameters:

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

Returns:

The objects for which the predicate evaluates to true.

getBookingPeriod

BookingPeriod getBookingPeriod(boolean idIsPersistent,
                               String id)

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

Parameters:

idIsPersistent - Defines whether value for the qualifier is persistent or not

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

Returns:

The possibly null value for this qualifier

getBookingPeriod

BookingPeriod getBookingPeriod(String id)

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

This method is equivalent to the preferred invocation getBookingPeriod(false,id).

Parameters:

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

Returns:

The possibly null value for this qualifier

addBookingPeriod

void addBookingPeriod(boolean idIsPersistent,
                      String id,
                      BookingPeriod bookingPeriod)

Adds the specified element to the set of the values for the reference bookingPeriod.

Note: This is an extension to the JMI 1 standard.

Parameters:

idIsPersistent - true if id is persistent

id - The qualifier attribute value that qualifies the reference to get the element to be appended.

bookingPeriod - The element to be appended.

addBookingPeriod

void addBookingPeriod(String id,
                      BookingPeriod bookingPeriod)

Adds the specified element to the set of the values for the reference bookingPeriod using a reassignable qualifier.

Note: This is an extension to the JMI 1 standard.

Parameters:

id - The qualifier attribute value that qualifies the reference to get the element to be appended.

bookingPeriod - The element to be appended.

addBookingPeriod

void addBookingPeriod(BookingPeriod bookingPeriod)

Adds the specified element to the set of the values for the reference bookingPeriod using an implementation-specific, reassignable qualifier.

Note: This is an extension to the JMI 1 standard.

Parameters:

bookingPeriod - The element to be appended.

getBookingText

<T extends BookingText> List<T> getBookingText(BookingTextQuery query)

Retrieves the value for the reference bookingText for the specified query. Note: This is an extension to the JMI 1 standard.
In order to remain standard compliant you should substitute this method with java.jdo.Query

Parameters:

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

Returns:

The objects for which the predicate evaluates to true.

getBookingText

BookingText getBookingText(boolean idIsPersistent,
                           String id)

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

Parameters:

idIsPersistent - Defines whether value for the qualifier is persistent or not

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

Returns:

The possibly null value for this qualifier

getBookingText

BookingText getBookingText(String id)

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

This method is equivalent to the preferred invocation getBookingText(false,id).

Parameters:

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

Returns:

The possibly null value for this qualifier

addBookingText

void addBookingText(boolean idIsPersistent,
                    String id,
                    BookingText bookingText)

Adds the specified element to the set of the values for the reference bookingText.

Note: This is an extension to the JMI 1 standard.

Parameters:

idIsPersistent - true if id is persistent

id - The qualifier attribute value that qualifies the reference to get the element to be appended.

bookingText - The element to be appended.

addBookingText

void addBookingText(String id,
                    BookingText bookingText)

Adds the specified element to the set of the values for the reference bookingText using a reassignable qualifier.

Note: This is an extension to the JMI 1 standard.

Parameters:

id - The qualifier attribute value that qualifies the reference to get the element to be appended.

bookingText - The element to be appended.

addBookingText

void addBookingText(BookingText bookingText)

Adds the specified element to the set of the values for the reference bookingText using an implementation-specific, reassignable qualifier.

Note: This is an extension to the JMI 1 standard.

Parameters:

bookingText - The element to be appended.

createBookingByPosition

CreateBookingResult createBookingByPosition(CreateBookingByPositionParams in)

createBookingByPositionName

CreateBookingResult createBookingByPositionName(CreateBookingByPositionNameParams in)

createBookingByProduct

CreateBookingResult createBookingByProduct(CreateBookingByProductParams in)

createCompoundBooking

CreateCompoundBookingResult createCompoundBooking(CreateCompoundBookingParams in)

getDepot

<T extends Depot> List<T> getDepot(DepotQuery query)

Retrieves the value for the reference depot for the specified query. Note: This is an extension to the JMI 1 standard.
In order to remain standard compliant you should substitute this method with java.jdo.Query

Parameters:

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

Returns:

The objects for which the predicate evaluates to true.

getDepot

Depot getDepot(boolean idIsPersistent,
               String id)

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

Parameters:

idIsPersistent - Defines whether value for the qualifier is persistent or not

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

Returns:

The possibly null value for this qualifier

getDepot

Depot getDepot(String id)

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

This method is equivalent to the preferred invocation getDepot(false,id).

Parameters:

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

Returns:

The possibly null value for this qualifier

getDepotGroup

<T extends DepotGroup> List<T> getDepotGroup(DepotGroupQuery query)

Retrieves the value for the reference depotGroup for the specified query. Note: This is an extension to the JMI 1 standard.
In order to remain standard compliant you should substitute this method with java.jdo.Query

Parameters:

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

Returns:

The objects for which the predicate evaluates to true.

getDepotGroup

DepotGroup getDepotGroup(boolean idIsPersistent,
                         String id)

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

Parameters:

idIsPersistent - Defines whether value for the qualifier is persistent or not

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

Returns:

The possibly null value for this qualifier

getDepotGroup

DepotGroup getDepotGroup(String id)

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

This method is equivalent to the preferred invocation getDepotGroup(false,id).

Parameters:

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

Returns:

The possibly null value for this qualifier

addDepotGroup

void addDepotGroup(boolean idIsPersistent,
                   String id,
                   DepotGroup depotGroup)

Adds the specified element to the set of the values for the reference depotGroup.

Note: This is an extension to the JMI 1 standard.

Parameters:

idIsPersistent - true if id is persistent

id - The qualifier attribute value that qualifies the reference to get the element to be appended.

depotGroup - The element to be appended.

addDepotGroup

void addDepotGroup(String id,
                   DepotGroup depotGroup)

Adds the specified element to the set of the values for the reference depotGroup using a reassignable qualifier.

Note: This is an extension to the JMI 1 standard.

Parameters:

id - The qualifier attribute value that qualifies the reference to get the element to be appended.

depotGroup - The element to be appended.

addDepotGroup

void addDepotGroup(DepotGroup depotGroup)

Adds the specified element to the set of the values for the reference depotGroup using an implementation-specific, reassignable qualifier.

Note: This is an extension to the JMI 1 standard.

Parameters:

depotGroup - The element to be appended.

getDepotHolder

<T extends DepotHolder> List<T> getDepotHolder(DepotHolderQuery query)

Retrieves the value for the reference depotHolder for the specified query. Note: This is an extension to the JMI 1 standard.
In order to remain standard compliant you should substitute this method with java.jdo.Query

Parameters:

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

Returns:

The objects for which the predicate evaluates to true.

getDepotHolder

DepotHolder getDepotHolder(boolean idIsPersistent,
                           String id)

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

Parameters:

idIsPersistent - Defines whether value for the qualifier is persistent or not

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

Returns:

The possibly null value for this qualifier

getDepotHolder

DepotHolder getDepotHolder(String id)

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

This method is equivalent to the preferred invocation getDepotHolder(false,id).

Parameters:

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

Returns:

The possibly null value for this qualifier

addDepotHolder

void addDepotHolder(boolean idIsPersistent,
                    String id,
                    DepotHolder depotHolder)

Adds the specified element to the set of the values for the reference depotHolder.

Note: This is an extension to the JMI 1 standard.

Parameters:

idIsPersistent - true if id is persistent

id - The qualifier attribute value that qualifies the reference to get the element to be appended.

depotHolder - The element to be appended.

addDepotHolder

void addDepotHolder(String id,
                    DepotHolder depotHolder)

Adds the specified element to the set of the values for the reference depotHolder using a reassignable qualifier.

Note: This is an extension to the JMI 1 standard.

Parameters:

id - The qualifier attribute value that qualifies the reference to get the element to be appended.

depotHolder - The element to be appended.

addDepotHolder

void addDepotHolder(DepotHolder depotHolder)

Adds the specified element to the set of the values for the reference depotHolder using an implementation-specific, reassignable qualifier.

Note: This is an extension to the JMI 1 standard.

Parameters:

depotHolder - The element to be appended.