org.opencrx.kernel.depot1.cci
Interface Depot

All Superinterfaces:

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

All Known Implementing Classes:

DepotImpl

public interface Depot
extends PropertySet, ContractReferenceHolder, CrxObject, DescriptionContainer

Method Summary

void	addDepotType(DepotType newValue)
void	addDepotType(int index, DepotType newValue)
Void	assertReports()
Void	assertReports(Void params)
CloseDepotResult	closeDepot(CloseDepotParams params)
CloseDepotResult	closeDepot(Date closingDate)
Date	getClosingDate()
DepotGroup	getDepotGroup() Retrieves the value for the optional reference depotGroup.
DepotHolder	getDepotHolder() Retrieves the value for the reference depotHolder.
String	getDepotNumber() Retrieves the value for the attribute depotNumber.
Collection	getDepotType() Retrieves the objects referenced by depotType.
DepotType	getDepotType(int index) Retrieves the value for the reference depotType for the specified qualifier attribute value.
String	getDescription()
DepotReport	getLatestReport() Retrieves the value for the optional reference latestReport.
String	getName() Retrieves the value for the attribute name.
Date	getOpeningDate() Retrieves the value for the attribute openingDate.
Collection	getPosition() Retrieves a collection containing all the elements for the reference position.
List	getPosition(DepotPositionFilter filter) Retrieves the value for the reference position for the specified filter.
List	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.
Collection	getReport() Retrieves a collection containing all the elements for the reference report.
List	getReport(DepotReportFilter filter) Retrieves the value for the reference report for the specified filter.
List	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.
boolean	isAllowPositionAutoCreate() Retrieves the value for the attribute allowPositionAutoCreate.
boolean	isDefault() Retrieves the value for the attribute isDefault.
boolean	isLocked() Retrieves the value for the attribute isLocked.
OpenDepotPositionResult	openDepotPosition(OpenDepotPositionParams params)
OpenDepotPositionResult	openDepotPosition(String description, String name, Date openingDate, Product product, ContractPositionConstrained productRole, String qualifier)
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	setAllowPositionAutoCreate(boolean newValue) Sets a new value for the attribute allowPositionAutoCreate.
void	setClosingDate(Date newValue) Sets a new value for the attribute closingDate.
void	setDefault_(boolean newValue) Sets a new value for the attribute isDefault.
void	setDepotGroup(DepotGroup newValue) Sets a new value for the reference depotGroup.
void	setDepotNumber(String newValue) Sets a new value for the attribute depotNumber.
void	setDescription(String newValue) Sets a new value for the attribute description.
void	setLatestReport(DepotReport newValue) Sets a new value for the reference latestReport.
void	setLocked(boolean newValue) Sets a new value for the attribute isLocked.
void	setName(String newValue) Sets a new value for the attribute name.
void	setOpeningDate(Date newValue) Sets a new value for the attribute openingDate.

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

addProperty, addProperty, getProperty, getProperty, getProperty, getProperty, removeProperty

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

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

addAdditionalDescription, addAdditionalDescription, getAdditionalDescription, getAdditionalDescription, getAdditionalDescription, getAdditionalDescription, removeAdditionalDescription

Method Detail

isAllowPositionAutoCreate

boolean isAllowPositionAutoCreate()

Retrieves the value for the attribute allowPositionAutoCreate.

Returns:

The non-null value for attribute allowPositionAutoCreate.

Throws:

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

setAllowPositionAutoCreate

void setAllowPositionAutoCreate(boolean newValue)

Sets a new value for the attribute allowPositionAutoCreate.

Parameters:

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

Throws:

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

assertReports

Void assertReports(Void params)
                   throws RefException

Throws:

RefException

assertReports

Void assertReports()
                   throws RefException

Throws:

RefException

closeDepot

CloseDepotResult closeDepot(CloseDepotParams params)
                            throws RefException

Throws:

RefException

closeDepot

CloseDepotResult closeDepot(Date closingDate)
                            throws RefException

Throws:

RefException

getClosingDate

Date getClosingDate()

Returns:

The possibly null value for attribute closingDate.

Throws:

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

setClosingDate

void setClosingDate(Date newValue)

Sets a new value for the attribute closingDate.

Parameters:

newValue - The possibly null new value for attribute closingDate.

Throws:

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

getDepotGroup

DepotGroup getDepotGroup()

Retrieves the value for the optional reference depotGroup.

Returns:

The possibly null value for this reference.

Throws:

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

setDepotGroup

void setDepotGroup(DepotGroup newValue)

Sets a new value for the reference depotGroup.

Parameters:

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

Throws:

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

removeDepotGroup

void removeDepotGroup()

Removes the value for the optional reference depotGroup.

Throws:

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

getDepotHolder

DepotHolder getDepotHolder()

Retrieves the value for the reference depotHolder.

Returns:

The non-null value for this reference.

Throws:

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

getDepotNumber

String getDepotNumber()

Retrieves the value for the attribute depotNumber.

Returns:

The non-null value for attribute depotNumber.

Throws:

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

setDepotNumber

void setDepotNumber(String newValue)

Sets a new value for the attribute depotNumber.

Parameters:

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

Throws:

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

getDepotType

DepotType getDepotType(int index)

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

Parameters:

index - 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.

getDepotType

Collection getDepotType()

Retrieves the objects referenced by depotType.

Returns:

The collection of referenced objects.

Throws:

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

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.

Throws:

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

addDepotType

void addDepotType(DepotType newValue)

Parameters:

newValue - The element to be appended.

Throws:

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

removeDepotType

void removeDepotType(int index)

Throws:

JmiException - If the value cannot be removed 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.

isDefault

boolean isDefault()

Retrieves the value for the attribute isDefault.

Returns:

The non-null value for attribute isDefault.

Throws:

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

setDefault_

void setDefault_(boolean newValue)

Sets a new value for the attribute isDefault.

Parameters:

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

Throws:

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

isLocked

boolean isLocked()

Retrieves the value for the attribute isLocked.

Returns:

The non-null value for attribute isLocked.

Throws:

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

setLocked

void setLocked(boolean newValue)

Sets a new value for the attribute isLocked.

Parameters:

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

Throws:

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

getLatestReport

DepotReport getLatestReport()

Retrieves the value for the optional reference latestReport.

Returns:

The possibly null value for this reference.

Throws:

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

setLatestReport

void setLatestReport(DepotReport newValue)

Sets a new value for the reference latestReport.

Parameters:

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

Throws:

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

removeLatestReport

void removeLatestReport()

Removes the value for the optional reference latestReport.

Throws:

JmiException - If the value cannot be removed 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.

openDepotPosition

OpenDepotPositionResult openDepotPosition(OpenDepotPositionParams params)
                                          throws RefException

Throws:

RefException

openDepotPosition

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

Throws:

RefException

getOpeningDate

Date getOpeningDate()

Retrieves the value for the attribute openingDate.

Returns:

The non-null value for attribute openingDate.

Throws:

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

setOpeningDate

void setOpeningDate(Date newValue)

Sets a new value for the attribute openingDate.

Parameters:

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

Throws:

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

getPosition

DepotPosition getPosition(String id)

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

getPosition

Collection getPosition()

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

Returns:

A collection containing all the elements for this reference.

Throws:

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

getPosition

List getPosition(DepotPositionFilter filter)

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

getPosition

List getPosition(DepotPositionQuery query)

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

getReport

DepotReport getReport(String id)

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

getReport

Collection getReport()

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

Returns:

A collection containing all the elements for this reference.

Throws:

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

getReport

List getReport(DepotReportFilter filter)

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

getReport

List getReport(DepotReportQuery query)

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