org.opencrx.kernel.depot1.cci
Interface DepotHolder

All Superinterfaces:

AlertSender, Auditee, BasicObject, Cloneable, ContextCapable, ContractReferenceHolder, CrxObject, ExtentCapable, Importer, Indexed, RefBaseObject, RefFeatured, RefObject, RefObject_1_0, SecureObject, SubscriptionTarget, TemplateEnabled, ViewCapable, XmlExporter

All Known Subinterfaces:

DepotContract, Site, Warehouse

All Known Implementing Classes:

DepotContractImpl, DepotHolderImpl, SiteImpl, WarehouseImpl

public interface DepotHolder
extends TemplateEnabled, ContractReferenceHolder, CrxObject

Method Summary

void	addAddress(DepotAddress newValue)
void	addAddress(String id, DepotAddress newValue)
Void	assertReports()
Void	assertReports(Void params)
Collection	getAddress() Retrieves a collection containing all the elements for the reference address.
List	getAddress(DepotAddressFilter filter) Retrieves the value for the reference address for the specified filter.
List	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.
Collection	getDepot() Retrieves a collection containing all the elements for the reference depot.
List	getDepot(DepotFilter filter) Retrieves the value for the reference depot for the specified filter.
List	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.
String	getDepotHolderNumber() Retrieves the value for the attribute depotHolderNumber.
String	getDescription()
DepotEntity	getEntity() Retrieves the value for the reference entity.
String	getName() Retrieves the value for the attribute name.
OpenDepotResult	openDepot(DepotGroup depotGroup, String depotNumber, DepotType depotType, String description, String name, Date openingDate)
OpenDepotResult	openDepot(OpenDepotParams params)
void	removeAddress(String id)
void	setDepotHolderNumber(String newValue) Sets a new value for the attribute depotHolderNumber.
void	setDescription(String newValue) Sets a new value for the attribute description.
void	setName(String newValue) Sets a new value for the attribute name.

Methods inherited from interface org.opencrx.kernel.base.cci.TemplateEnabled

addReplacement, addReplacement, applyReplacements, applyReplacements, createObject, createObject, deleteObject, deleteObject, getReplacement, getReplacement, getReplacement, getReplacement, getTemplateReferenceFilter, isTemplate, removeReplacement, setTemplate, setTemplateReferenceFilter

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

addContract, addContract, getContract, getContract, getContractRole, getContractRole, getContractRole, getContractRole, removeContract

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

addAdditionalExternalLink, addAdditionalExternalLink, addAttachedDocument, addAttachedDocument, addMedia, addMedia, addNote, addNote, addPropertySet, addPropertySet, addRating, addRating, getAdditionalExternalLink, getAdditionalExternalLink, getAdditionalExternalLink, getAdditionalExternalLink, getAttachedDocument, getAttachedDocument, getAttachedDocument, getAttachedDocument, getCategory, getCategory, getDisabledReason, getExternalLink, getExternalLink, getMedia, getMedia, getMedia, getMedia, getNote, getNote, getNote, getNote, getPropertySet, getPropertySet, getPropertySet, getPropertySet, getPropertySetEntry, getPropertySetEntry, getPropertySetEntry, getPropertySetEntry, getRating, getRating, getRating, getRating, getUserCode0, getUserCode1, getUserCode2, getUserCode3, getUserCode4, getUserCode4, getUserDate0, getUserDate1, getUserDate2, getUserDate3, getUserDate4, getUserDate4, getUserDateTime0, getUserDateTime1, getUserDateTime2, getUserDateTime3, getUserDateTime4, getUserDateTime4, getUserNumber0, getUserNumber1, getUserNumber2, getUserNumber3, getUserNumber4, getUserNumber4, getUserString0, getUserString1, getUserString2, getUserString3, getUserString4, getUserString4, isDisabled, isUserBoolean0, isUserBoolean1, isUserBoolean2, isUserBoolean3, isUserBoolean4, isUserBoolean4, removeAdditionalExternalLink, removeAttachedDocument, removeMedia, removeNote, removePropertySet, removeRating, setCategory, setCategory, setDisabled, setDisabledReason, setExternalLink, setExternalLink, setUserBoolean0, setUserBoolean1, setUserBoolean2, setUserBoolean3, setUserBoolean4, setUserBoolean4, setUserCode0, setUserCode1, setUserCode2, setUserCode3, setUserCode4, setUserCode4, setUserDate0, setUserDate1, setUserDate2, setUserDate3, setUserDate4, setUserDate4, setUserDateTime0, setUserDateTime1, setUserDateTime2, setUserDateTime3, setUserDateTime4, setUserDateTime4, setUserNumber0, setUserNumber1, setUserNumber2, setUserNumber3, setUserNumber4, setUserNumber4, setUserString0, setUserString1, setUserString2, setUserString3, setUserString4, setUserString4

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

sendAlert, sendAlert

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

getAudit, getAudit, getAudit, getAudit

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

clone_, clone_

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

importItem, importItem

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

getIndexEntry, getIndexEntry, getIndexEntry, getIndexEntry, updateIndex, updateIndex

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

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

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

addSubscription, addSubscription, addSubscriptionForParent, addSubscriptionForParent, removeSubscription, removeSubscription, removeSubscriptionForParent, removeSubscriptionForParent

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

exportXml, exportXml

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

getCreatedAt, getCreatedBy, getModifiedAt, getModifiedBy

Methods inherited from interface org.openmdx.base.cci.ContextCapable

getContext, getContext

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

getIdentity

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

getView, getView, getView, 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

DepotAddress getAddress(String id)

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

Parameters:

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

Returns:

The possibly null value for this reference.

Throws:

JmiException - If the value cannot be retrieved for some reason.

getAddress

Collection getAddress()

Retrieves a collection containing all the elements for the reference address.

Returns:

A collection containing all the elements for this reference.

Throws:

JmiException - If the values cannot be retrieved for some reason.

getAddress

List getAddress(DepotAddressFilter filter)

Retrieves the value for the reference address for the specified filter.

Parameters:

filter - filter which is applied to the set of referenced objects.

Returns:

The filtered collection of referenced objects.

Throws:

JmiException - If the value cannot be retrieved for some reason.

getAddress

List getAddress(DepotAddressQuery query)

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

Parameters:

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

Returns:

The filtered collection of referenced objects.

Throws:

JmiException - If the value cannot be retrieved for some reason.

addAddress

void addAddress(String id,
                DepotAddress newValue)

Parameters:

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

newValue - The element to be appended.

Throws:

JmiException - If the value cannot be appended for some reason.

addAddress

void addAddress(DepotAddress newValue)

Parameters:

newValue - The element to be appended.

Throws:

JmiException - If the value cannot be appended for some reason.

removeAddress

void removeAddress(String id)

Throws:

JmiException - If the value cannot be removed for some reason.

assertReports

Void assertReports(Void params)
                   throws RefException

Throws:

RefException

assertReports

Void assertReports()
                   throws RefException

Throws:

RefException

getDepot

Depot getDepot(String id)

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

Parameters:

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

Returns:

The possibly null value for this reference.

Throws:

JmiException - If the value cannot be retrieved for some reason.

getDepot

Collection getDepot()

Retrieves a collection containing all the elements for the reference depot.

Returns:

A collection containing all the elements for this reference.

Throws:

JmiException - If the values cannot be retrieved for some reason.

getDepot

List getDepot(DepotFilter filter)

Retrieves the value for the reference depot for the specified filter.

Parameters:

filter - filter which is applied to the set of referenced objects.

Returns:

The filtered collection of referenced objects.

Throws:

JmiException - If the value cannot be retrieved for some reason.

getDepot

List getDepot(DepotQuery query)

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

Parameters:

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

Returns:

The filtered collection of referenced objects.

Throws:

JmiException - If the value cannot be retrieved for some reason.

getDepotHolderNumber

String getDepotHolderNumber()

Retrieves the value for the attribute depotHolderNumber.

Returns:

The non-null value for attribute depotHolderNumber.

Throws:

JmiException - If the value cannot be retrieved for some reason.

setDepotHolderNumber

void setDepotHolderNumber(String newValue)

Sets a new value for the attribute depotHolderNumber.

Parameters:

newValue - The non-null new value for attribute depotHolderNumber.

Throws:

JmiException - If the value cannot be set for some reason.

getDescription

String getDescription()

Returns:

The possibly null value for attribute description.

Throws:

JmiException - If the value cannot be retrieved for some reason.

setDescription

void setDescription(String newValue)

Sets a new value for the attribute description.

Parameters:

newValue - The possibly null new value for attribute description.

Throws:

JmiException - If the value cannot be set for some reason.

getEntity

DepotEntity getEntity()

Retrieves the value for the reference entity.

Returns:

The non-null value for this reference.

Throws:

JmiException - If the value cannot be retrieved for some reason.

getName

String getName()

Retrieves the value for the attribute name.

Returns:

The non-null value for attribute name.

Throws:

JmiException - If the value cannot be retrieved for some reason.

setName

void setName(String newValue)

Sets a new value for the attribute name.

Parameters:

newValue - The non-null new value for attribute name.

Throws:

JmiException - If the value cannot be set for some reason.

openDepot

OpenDepotResult openDepot(OpenDepotParams params)
                          throws RefException

Throws:

RefException

openDepot

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

Throws:

RefException