org.opencrx.kernel.depot1.jmi1
Interface Depot

All Superinterfaces:

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

public interface Depot
extends Depot, PropertySet, ContractReferenceHolder, CrxObject, DescriptionContainer

Class Depot

Nested Class Summary

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

Depot.Identity

Method Summary

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)
CloseDepotResult	closeDepot(CloseDepotParams params) Note: This is an extension to the JMI 1 standard. In order to remain standard compliant you should use the non-struct signature..
CloseDepotResult	closeDepot(Date closingDate)
DepotGroup	getDepotGroup() Retrieves the value for the reference depotGroup.
DepotHolder	getDepotHolder() Retrieves the value for the reference depotHolder.
DepotReport	getLatestReport() Retrieves the value for the reference latestReport.
DepotPosition	getPosition(boolean idIsPersistent, String id) Retrieves the value for the reference position for the specified qualifier attribute value.
<T extends DepotPosition> List<T>	getPosition(DepotPositionQuery query) Retrieves the value for the reference position for the specified query.
DepotPosition	getPosition(String id) Retrieves the value for the reference position for the specified qualifier attribute value.
DepotReport	getReport(boolean idIsPersistent, String id) Retrieves the value for the reference report for the specified qualifier attribute value.
<T extends DepotReport> List<T>	getReport(DepotReportQuery query) Retrieves the value for the reference report for the specified query.
DepotReport	getReport(String id) Retrieves the value for the reference report for the specified qualifier attribute value.
OpenDepotPositionResult	openDepotPosition(OpenDepotPositionParams params) Note: This is an extension to the JMI 1 standard. In order to remain standard compliant you should use the non-struct signature..
OpenDepotPositionResult	openDepotPosition(String description, String name, Date openingDate, Product product, ContractPositionConstrained productRole, String qualifier)
void	setDepotGroup(DepotGroup depotGroup) Sets a new value for the reference depotGroup.
void	setLatestReport(DepotReport latestReport) Sets a new value for the reference latestReport.

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

getClosingDate, getDepotNumber, getDepotType, getDescription, getName, getOpeningDate, getPosition, getReport, isAllowPositionAutoCreate, isDefault, isLocked, setAllowPositionAutoCreate, setClosingDate, setDefault, setDepotNumber, setDescription, setLocked, setName, setOpeningDate

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

addProperty, getProperty, getProperty, getProperty

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

addProperty, getProperty

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

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

addAdditionalDescription, getAdditionalDescription, getAdditionalDescription, getAdditionalDescription

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

addAdditionalDescription, getAdditionalDescription

Method Detail

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 Depot

closeDepot

CloseDepotResult closeDepot(CloseDepotParams 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

closeDepot

CloseDepotResult closeDepot(Date closingDate)

Specified by:

closeDepot in interface Depot

getDepotGroup

DepotGroup getDepotGroup()

Retrieves the value for the reference depotGroup.

Specified by:

getDepotGroup in interface Depot

Returns:

The – possibly null – value for this reference.

setDepotGroup

void setDepotGroup(DepotGroup depotGroup)

Sets a new value for the reference depotGroup.

Specified by:

setDepotGroup in interface Depot

Parameters:

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

getDepotHolder

DepotHolder getDepotHolder()

Retrieves the value for the reference depotHolder.

Specified by:

getDepotHolder in interface Depot

Returns:

The non-null value for this reference.

getLatestReport

DepotReport getLatestReport()

Retrieves the value for the reference latestReport.

Specified by:

getLatestReport in interface Depot

Returns:

The – possibly null – value for this reference.

setLatestReport

void setLatestReport(DepotReport latestReport)

Sets a new value for the reference latestReport.

Specified by:

setLatestReport in interface Depot

Parameters:

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

openDepotPosition

OpenDepotPositionResult openDepotPosition(OpenDepotPositionParams 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

openDepotPosition

OpenDepotPositionResult openDepotPosition(String description,
                                          String name,
                                          Date openingDate,
                                          Product product,
                                          ContractPositionConstrained productRole,
                                          String qualifier)

Specified by:

openDepotPosition in interface Depot

getPosition

<T extends DepotPosition> List<T> getPosition(DepotPositionQuery query)

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

getPosition

DepotPosition getPosition(boolean idIsPersistent,
                          String id)

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

Specified by:

getPosition in interface Depot

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

getPosition

DepotPosition getPosition(String id)

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

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

Parameters:

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

Returns:

The possibly null value for this qualifier

getReport

<T extends DepotReport> List<T> getReport(DepotReportQuery query)

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

getReport

DepotReport getReport(boolean idIsPersistent,
                      String id)

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

Specified by:

getReport in interface Depot

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

getReport

DepotReport getReport(String id)

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

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

Parameters:

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

Returns:

The possibly null value for this qualifier