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, SecureObject, SubscriptionTarget, 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

void	addAdditionalDescription(Description newValue)
void	addAdditionalDescription(String id, Description newValue)
void	addAdditionalExternalLink(AdditionalExternalLink newValue)
void	addAdditionalExternalLink(String id, AdditionalExternalLink newValue)
void	addAttachedDocument(DocumentAttachment newValue)
void	addAttachedDocument(String id, DocumentAttachment newValue)
void	addContract(AbstractContract newValue)
void	addContract(int index, AbstractContract newValue)
void	addDepotType(DepotType newValue)
void	addDepotType(int index, DepotType newValue)
void	addMedia(Media newValue)
void	addMedia(String id, Media newValue)
void	addNote(Note newValue)
void	addNote(String id, Note newValue)
void	addOwningGroup(int index, PrincipalGroup newValue)
void	addOwningGroup(PrincipalGroup newValue)
void	addProperty(Property newValue)
void	addProperty(String id, Property newValue)
void	addPropertySet(PropertySet newValue)
void	addPropertySet(String id, PropertySet newValue)
void	addRating(Rating newValue)
void	addRating(String id, Rating newValue)
<T extends org.openmdx.base.cci2.Void> T	assertReports(org.openmdx.base.cci2.Void params)
<T extends CloseDepotResult> T	closeDepot(CloseDepotParams params)
org.openmdx.base.cci2.BasicObject	getAccessGrantedByParent() Retrieves the value for the reference accessGrantedByParent.
<T extends Description> List<T>	getAdditionalDescription(DescriptionQuery query) Retrieves the value for the reference additionalDescription for the specified query.
<T extends AdditionalExternalLink> List<T>	getAdditionalExternalLink(AdditionalExternalLinkQuery query) Retrieves the value for the reference additionalExternalLink for the specified query.
<T extends DocumentAttachment> List<T>	getAttachedDocument(DocumentAttachmentQuery query) Retrieves the value for the reference attachedDocument for the specified query.
<T extends AuditEntry> List<T>	getAudit(AuditEntryQuery query) Retrieves the value for the reference audit for the specified query.
<T extends ContractRole> List<T>	getContractRole(ContractRoleQuery query) Retrieves the value for the reference contractRole for the specified query.
DepotGroup	getDepotGroup() Retrieves the value for the reference depotGroup.
DepotHolder	getDepotHolder() Retrieves the value for the reference depotHolder.
<T extends IndexEntry> List<T>	getIndexEntry(IndexEntryQuery query) Retrieves the value for the reference indexEntry for the specified query.
DepotReport	getLatestReport() Retrieves the value for the reference latestReport.
<T extends Media> List<T>	getMedia(MediaQuery query) Retrieves the value for the reference media for the specified query.
<T extends Note> List<T>	getNote(NoteQuery query) Retrieves the value for the reference note for the specified query.
User	getOwningUser() Retrieves the value for the reference owningUser.
<T extends DepotPosition> List<T>	getPosition(DepotPositionQuery query) Retrieves the value for the reference position for the specified query.
<T extends Property> List<T>	getProperty(PropertyQuery query) Retrieves the value for the reference property for the specified query.
<T extends PropertySet> List<T>	getPropertySet(PropertySetQuery query) Retrieves the value for the reference propertySet for the specified query.
<T extends PropertySetEntry> List<T>	getPropertySetEntry(PropertySetEntryQuery query) Retrieves the value for the reference propertySetEntry for the specified query.
<T extends Rating> List<T>	getRating(RatingQuery query) Retrieves the value for the reference rating for the specified query.
<T extends DepotReport> List<T>	getReport(DepotReportQuery query) Retrieves the value for the reference report for the specified query.
<T extends org.openmdx.compatibility.view1.cci2.View> List<T>	getView(org.openmdx.compatibility.view1.cci2.ViewQuery query) Retrieves the value for the reference view for the specified query.
<T extends OpenDepotPositionResult> T	openDepotPosition(OpenDepotPositionParams params)
void	removeAdditionalDescription(String id)
void	removeAdditionalExternalLink(String id)
void	removeAttachedDocument(String id)
void	removeContract(int index)
void	removeDepotGroup() Removes the value for the optional reference depotGroup.
void	removeDepotType(int index)
void	removeLatestReport() Removes the value for the optional reference latestReport.
void	removeMedia(String id)
void	removeNote(String id)
void	removeOwningGroup(int index)
void	removeOwningUser() Removes the value for the optional reference owningUser.
void	removeProperty(String id)
void	removePropertySet(String id)
void	removeRating(String id)
void	setDepotGroup(DepotGroup depotGroup) Sets a new value for the reference depotGroup.
void	setDepotHolder(DepotHolder depotHolder) Sets a new value for the reference depotHolder.
void	setDepotHolder(DepotHolder depotHolder, boolean idIsPersistent, String id) Set the object's composite association org:opencrx:kernel:depot1:DepotHolderHasDepot.
void	setLatestReport(DepotReport latestReport) Sets a new value for the reference latestReport.
void	setOwningUser(User owningUser) Sets a new value for the reference owningUser.

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.cci2.PropertySet

getProperty

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

getContract, getContractRole

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

getCategory, getExternalLink, 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, getCategory, getDisabledReason, getExternalLink, getMedia, getNote, getPropertySet, getPropertySetEntry, getRating, getUserBoolean4, getUserCode0, getUserCode1, getUserCode2, getUserCode3, getUserCode4, getUserDate0, getUserDate1, getUserDate2, getUserDate3, getUserDate4, getUserDateTime0, getUserDateTime1, getUserDateTime2, getUserDateTime3, getUserDateTime4, getUserNumber0, getUserNumber1, getUserNumber2, getUserNumber3, getUserNumber4, getUserString0, getUserString1, getUserString2, getUserString3, getUserString4, 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.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.Importer

importItem

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

importItem

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

updateIndex

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

getIndexEntry, updateIndex

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

addOwningGroup, getOwner, removeAllOwningGroup, removeOwningGroup, setAccessLevel, setOwningUser

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

addOwningGroup, getAccessLevelBrowse, getAccessLevelDelete, getAccessLevelUpdate, getOwner, getOwningGroup, removeAllOwningGroup, removeOwningGroup, setAccessLevel, setAccessLevelBrowse, setAccessLevelDelete, setAccessLevelUpdate, setOwningUser

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

addSubscription, addSubscriptionForParent, removeSubscription, removeSubscriptionForParent

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

addSubscription, addSubscriptionForParent, removeSubscription, removeSubscriptionForParent

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

exportXml

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

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.cci2.ViewCapable

getView

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.cci2.DescriptionContainer

getAdditionalDescription

Method Detail

getAudit

<T extends AuditEntry> List<T> getAudit(AuditEntryQuery query)

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

Parameters:

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

Returns:

The objects for which the predicate evaluates to true.

getIndexEntry

<T extends IndexEntry> List<T> getIndexEntry(IndexEntryQuery query)

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

Parameters:

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

Returns:

The objects for which the predicate evaluates to true.

getProperty

<T extends Property> List<T> getProperty(PropertyQuery query)

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

Parameters:

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

Returns:

The objects for which the predicate evaluates to true.

addProperty

void addProperty(String id,
                 Property newValue)

Parameters:

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

newValue - The element to be appended.

addProperty

void addProperty(Property newValue)

Parameters:

newValue - The element to be appended.

removeProperty

void removeProperty(String id)

getAccessGrantedByParent

org.openmdx.base.cci2.BasicObject getAccessGrantedByParent()

Retrieves the value for the reference accessGrantedByParent.

Specified by:

getAccessGrantedByParent in interface SecureObject

Returns:

The – possibly null – value for this reference.

addOwningGroup

void addOwningGroup(int index,
                    PrincipalGroup newValue)

Parameters:

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

newValue - The element to be appended.

addOwningGroup

void addOwningGroup(PrincipalGroup newValue)

Parameters:

newValue - The element to be appended.

removeOwningGroup

void removeOwningGroup(int index)

getOwningUser

User getOwningUser()

Retrieves the value for the reference owningUser.

Specified by:

getOwningUser in interface SecureObject

Returns:

The – possibly null – value for this reference.

setOwningUser

void setOwningUser(User owningUser)

Sets a new value for the reference owningUser.

Specified by:

setOwningUser in interface SecureObject

Parameters:

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

removeOwningUser

void removeOwningUser()

Removes the value for the optional reference owningUser.

addContract

void addContract(int index,
                 AbstractContract newValue)

Parameters:

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

newValue - The element to be appended.

addContract

void addContract(AbstractContract newValue)

Parameters:

newValue - The element to be appended.

removeContract

void removeContract(int index)

getContractRole

<T extends ContractRole> List<T> getContractRole(ContractRoleQuery query)

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

Parameters:

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

Returns:

The objects for which the predicate evaluates to true.

assertReports

<T extends org.openmdx.base.cci2.Void> T assertReports(org.openmdx.base.cci2.Void params)
                                                   throws RefException

Throws:

RefException

closeDepot

<T extends CloseDepotResult> T closeDepot(CloseDepotParams params)
                                      throws RefException

Throws:

RefException

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.

removeDepotGroup

void removeDepotGroup()

Removes the value for the optional reference depotGroup.

getDepotHolder

DepotHolder getDepotHolder()

Retrieves the value for the reference depotHolder.

Specified by:

getDepotHolder in interface Depot

Returns:

The non-null value for this reference.

addDepotType

void addDepotType(int index,
                  DepotType newValue)

Parameters:

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

newValue - The element to be appended.

addDepotType

void addDepotType(DepotType newValue)

Parameters:

newValue - The element to be appended.

removeDepotType

void removeDepotType(int index)

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.

removeLatestReport

void removeLatestReport()

Removes the value for the optional reference latestReport.

openDepotPosition

<T extends OpenDepotPositionResult> T openDepotPosition(OpenDepotPositionParams params)
                                                    throws RefException

Throws:

RefException

getPosition

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

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

Parameters:

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

Returns:

The objects for which the predicate evaluates to true.

getReport

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

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

Parameters:

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

Returns:

The objects for which the predicate evaluates to true.

getAdditionalExternalLink

<T extends AdditionalExternalLink> List<T> getAdditionalExternalLink(AdditionalExternalLinkQuery query)

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

Parameters:

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

Returns:

The objects for which the predicate evaluates to true.

addAdditionalExternalLink

void addAdditionalExternalLink(String id,
                               AdditionalExternalLink newValue)

Parameters:

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

newValue - The element to be appended.

addAdditionalExternalLink

void addAdditionalExternalLink(AdditionalExternalLink newValue)

Parameters:

newValue - The element to be appended.

removeAdditionalExternalLink

void removeAdditionalExternalLink(String id)

getAttachedDocument

<T extends DocumentAttachment> List<T> getAttachedDocument(DocumentAttachmentQuery query)

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

Parameters:

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

Returns:

The objects for which the predicate evaluates to true.

addAttachedDocument

void addAttachedDocument(String id,
                         DocumentAttachment newValue)

Parameters:

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

newValue - The element to be appended.

addAttachedDocument

void addAttachedDocument(DocumentAttachment newValue)

Parameters:

newValue - The element to be appended.

removeAttachedDocument

void removeAttachedDocument(String id)

getMedia

<T extends Media> List<T> getMedia(MediaQuery query)

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

Parameters:

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

Returns:

The objects for which the predicate evaluates to true.

addMedia

void addMedia(String id,
              Media newValue)

Parameters:

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

newValue - The element to be appended.

addMedia

void addMedia(Media newValue)

Parameters:

newValue - The element to be appended.

removeMedia

void removeMedia(String id)

getNote

<T extends Note> List<T> getNote(NoteQuery query)

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

Parameters:

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

Returns:

The objects for which the predicate evaluates to true.

addNote

void addNote(String id,
             Note newValue)

Parameters:

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

newValue - The element to be appended.

addNote

void addNote(Note newValue)

Parameters:

newValue - The element to be appended.

removeNote

void removeNote(String id)

getPropertySet

<T extends PropertySet> List<T> getPropertySet(PropertySetQuery query)

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

Parameters:

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

Returns:

The objects for which the predicate evaluates to true.

addPropertySet

void addPropertySet(String id,
                    PropertySet newValue)

Parameters:

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

newValue - The element to be appended.

addPropertySet

void addPropertySet(PropertySet newValue)

Parameters:

newValue - The element to be appended.

removePropertySet

void removePropertySet(String id)

getPropertySetEntry

<T extends PropertySetEntry> List<T> getPropertySetEntry(PropertySetEntryQuery query)

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

Parameters:

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

Returns:

The objects for which the predicate evaluates to true.

getRating

<T extends Rating> List<T> getRating(RatingQuery query)

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

Parameters:

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

Returns:

The objects for which the predicate evaluates to true.

addRating

void addRating(String id,
               Rating newValue)

Parameters:

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