org.opencrx.kernel.depot1.jmi1
Interface DepotHolder

All Superinterfaces:

AlertSender, Auditee, org.openmdx.base.cci2.BasicObject, Cloneable, org.openmdx.base.cci2.ContextCapable, ContractReferenceHolder, CrxObject, DepotHolder, org.openmdx.base.cci2.ExtentCapable, Importer, Indexed, RefBaseObject, RefFeatured, RefObject, RefObject_1_0, SecureObject, org.openmdx.compatibility.view1.cci2.ViewCapable, XmlExporter

All Known Subinterfaces:

DepotContract, Site, Warehouse

public interface DepotHolder
extends DepotHolder, ContractReferenceHolder, CrxObject

Abstract class DepotHolder

Nested Class Summary

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

DepotHolder.Identity

Method Summary

void	addAddress(boolean idIsPersistent, String id, DepotAddress address) Adds the specified element to the set of the values for the reference address.
org.openmdx.base.jmi1.Void	assertReports(AssertReportsParams params) Note: This is an extension to the JMI 1 standard. In order to remain standard compliant you should use the non-struct signature..
org.openmdx.base.jmi1.Void	assertReports(short bookingStatusThreshold)
DepotAddress	getAddress(boolean idIsPersistent, String id) Retrieves the value for the reference address for the specified qualifier attribute value.
<T extends DepotAddress> List<T>	getAddress(DepotAddressQuery query) Retrieves the value for the reference address for the specified query.
DepotAddress	getAddress(String id) Retrieves the value for the reference address 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.
DepotEntity	getEntity() Retrieves the value for the reference entity.
OpenDepotResult	openDepot(DepotGroup depotGroup, String depotNumber, DepotType depotType, String description, String name, Date openingDate)
OpenDepotResult	openDepot(OpenDepotParams params) Note: This is an extension to the JMI 1 standard. In order to remain standard compliant you should use the non-struct signature..

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

addAddress, getAddress, getDepot, getDepotHolderNumber, getDescription, getName, setDepotHolderNumber, setDescription, setName

Methods inherited from interface org.opencrx.kernel.contract1.cci2.ContractReferenceHolder

getContract

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

addAdditionalExternalLink, addAttachedDocument, addMedia, addNote, addPropertySet, addRating, getAdditionalExternalLink, getAdditionalExternalLink, getAdditionalExternalLink, getAttachedDocument, getAttachedDocument, getAttachedDocument, getCategory, getExternalLink, 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

addAdditionalExternalLink, addAttachedDocument, addMedia, addNote, addPropertySet, addRating, getAdditionalExternalLink, getAttachedDocument, getDisabledReason, 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, 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_, clone_

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

importItem, importItem

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

getIndexEntry, getIndexEntry, getIndexEntry, updateIndex, updateIndex

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

getIndexEntry

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

addOwningGroup, addOwningGroup, checkPermissions, checkPermissions, getAccessGrantedByParent, getOwner, getOwningUser, removeAllOwningGroup, removeAllOwningGroup, removeOwningGroup, removeOwningGroup, setAccessLevel, setAccessLevel, setOwningUser, setOwningUser, setOwningUser

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

getAccessLevelBrowse, getAccessLevelDelete, getAccessLevelUpdate, getOwningGroup, setAccessLevelBrowse, setAccessLevelDelete, setAccessLevelUpdate

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

exportXml, exportXml

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

getCreatedBy, getModifiedBy

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

getCreatedAt, getModifiedAt

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

getIdentity

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

getView, getView, getView

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

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

getAddress

<T extends DepotAddress> List<T> getAddress(DepotAddressQuery query)

Retrieves the value for the reference address 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.

getAddress

DepotAddress getAddress(boolean idIsPersistent,
                        String id)

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

Specified by:

getAddress in interface DepotHolder

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

getAddress

DepotAddress getAddress(String id)

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

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

Parameters:

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

Returns:

The possibly null value for this qualifier

addAddress

void addAddress(boolean idIsPersistent,
                String id,
                DepotAddress address)

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

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.

address - The element to be appended.

assertReports

org.openmdx.base.jmi1.Void assertReports(AssertReportsParams params)
                                         throws RefException

Note: This is an extension to the JMI 1 standard.
In order to remain standard compliant you should use the non-struct signature..

Throws:

RefException

assertReports

org.openmdx.base.jmi1.Void assertReports(short bookingStatusThreshold)

Specified by:

assertReports in interface DepotHolder

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.

Specified by:

getDepot in interface DepotHolder

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

getEntity

DepotEntity getEntity()

Retrieves the value for the reference entity.

Specified by:

getEntity in interface DepotHolder

Returns:

The non-null value for this reference.

openDepot

OpenDepotResult openDepot(OpenDepotParams params)
                          throws RefException

Note: This is an extension to the JMI 1 standard.
In order to remain standard compliant you should use the non-struct signature..

Throws:

RefException

openDepot

OpenDepotResult openDepot(DepotGroup depotGroup,
                          String depotNumber,
                          DepotType depotType,
                          String description,
                          String name,
                          Date openingDate)

Specified by:

openDepot in interface DepotHolder