org.opencrx.kernel.depot1.jmi1
Interface Depot

All Superinterfaces:

AlertSender, Auditee, BasicObject, Cloneable, ContextCapable, ContractReferenceHolder, Creatable, CrxObject, Depot, DescriptionContainer, Exporter, ExtentCapable, Importer, Indexed, Modifiable, PropertySet, RefBaseObject, RefFeatured, RefObject, RefObject_1_0, SecureObject

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

Class Depot

isFrozen

Nested Class Summary

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

Depot.Identity

Method Summary

void	addPosition(boolean idIsPersistent, String id, DepotPosition position) Adds the specified element to the set of the values for the reference position.
void	addPosition(DepotPosition position) Adds the specified element to the set of the values for the reference position using an implementation-specific, reassignable qualifier.
void	addPosition(String id, DepotPosition position) Adds the specified element to the set of the values for the reference position using a reassignable qualifier.
void	addReport(boolean idIsPersistent, String id, DepotReport report) Adds the specified element to the set of the values for the reference report.
void	addReport(DepotReport report) Adds the specified element to the set of the values for the reference report using an implementation-specific, reassignable qualifier.
void	addReport(String id, DepotReport report) Adds the specified element to the set of the values for the reference report using a reassignable qualifier.
Void	assertReports(AssertReportsParams in)
CloseDepotResult	closeDepot(CloseDepotParams in)
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 in)
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

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

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

addProperty, addProperty, addProperty, getProperty, getProperty, getProperty

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

getProperty

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

getContract

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

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

getAdditionalExternalLink, getAttachedDocument, getDisabledReason, getDocumentFolderAssignment, 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

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

addOwningGroup, checkPermissions, getAccessGrantedByParent, 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.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

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

addAdditionalDescription, addAdditionalDescription, addAdditionalDescription, getAdditionalDescription, getAdditionalDescription, getAdditionalDescription

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

getAdditionalDescription

Method Detail

assertReports

Void assertReports(AssertReportsParams in)

closeDepot

CloseDepotResult closeDepot(CloseDepotParams in)

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 in)

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.

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

addPosition

void addPosition(boolean idIsPersistent,
                 String id,
                 DepotPosition position)

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

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.

position - The element to be appended.

addPosition

void addPosition(String id,
                 DepotPosition position)

Adds the specified element to the set of the values for the reference position 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.

position - The element to be appended.

addPosition

void addPosition(DepotPosition position)

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

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

Parameters:

position - The element to be appended.

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.

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

addReport

void addReport(boolean idIsPersistent,
               String id,
               DepotReport report)

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

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.

report - The element to be appended.

addReport

void addReport(String id,
               DepotReport report)

Adds the specified element to the set of the values for the reference report 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.

report - The element to be appended.

addReport

void addReport(DepotReport report)

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

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

Parameters:

report - The element to be appended.