org.opencrx.kernel.depot1.cci2
Interface Depot

All Superinterfaces:

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

All Known Subinterfaces:

Depot

All Known Implementing Classes:

Depot

public interface Depot
extends PropertySet, ContractReferenceHolder, CrxObject, DescriptionContainer

Class Depot

Nested Class Summary

static interface

Depot.Identity Object Identity

Method Summary

org.openmdx.base.cci2.Void	assertReports(short bookingStatusThreshold)
CloseDepotResult	closeDepot(Date closingDate)
Date	getClosingDate() Retrieves the possibly null value for the optional attribute closingDate.
DepotGroup	getDepotGroup() Retrieves the value for the reference depotGroup.
DepotHolder	getDepotHolder() Retrieves the value for the reference depotHolder.
String	getDepotNumber() Retrieves the value for the attribute depotNumber.
<T extends DepotType> List<T>	getDepotType() Retrieves the Collection of objects referenced by depotType.
String	getDescription() Retrieves the possibly null value for the optional attribute description.
DepotReport	getLatestReport() Retrieves the value for the reference latestReport.
String	getName() Retrieves the value for the attribute name.
Date	getOpeningDate() Retrieves the value for the attribute openingDate.
<T extends DepotPosition> Collection<T>	getPosition() Retrieves a set containing all the elements for the reference position.
DepotPosition	getPosition(boolean idIsPersistent, String id) Retrieves the value for the reference position for the specified qualifier attribute value.
<T extends DepotReport> Collection<T>	getReport() Retrieves a set containing all the elements for the reference report.
DepotReport	getReport(boolean idIsPersistent, 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(String description, String name, Date openingDate, Product product, ContractPositionConstrained productRole, String qualifier)
void	setAllowPositionAutoCreate(boolean allowPositionAutoCreate) Sets a new value for the attribute allowPositionAutoCreate.
void	setClosingDate(Date closingDate) Sets a new value for the attribute closingDate.
void	setDefault(boolean isDefault) Sets a new value for the attribute isDefault.
void	setDepotGroup(DepotGroup depotGroup) Sets a new value for the reference depotGroup.
void	setDepotNumber(String depotNumber) Sets a new value for the attribute depotNumber.
void	setDescription(String description) Sets a new value for the attribute description.
void	setLatestReport(DepotReport latestReport) Sets a new value for the reference latestReport.
void	setLocked(boolean isLocked) Sets a new value for the attribute isLocked.
void	setName(String name) Sets a new value for the attribute name.
void	setOpeningDate(Date openingDate) Sets a new value for the attribute openingDate.

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

addProperty, getProperty, getProperty

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

getContract

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

addAdditionalExternalLink, addAttachedDocument, addMedia, addNote, addPropertySet, addRating, getAdditionalExternalLink, getAdditionalExternalLink, getAttachedDocument, getAttachedDocument, getCategory, getDisabledReason, getExternalLink, getMedia, getMedia, getNote, getNote, getPropertySet, getPropertySet, getPropertySetEntry, getPropertySetEntry, getRating, 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.cci2.AlertSender

sendAlert

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

getAudit, getAudit

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

clone_

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

importItem

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

getIndexEntry, getIndexEntry, updateIndex

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

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

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

exportXml

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

getCreatedAt, getCreatedBy, getModifiedAt, getModifiedBy

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

getIdentity

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

getView, getView

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

addAdditionalDescription, getAdditionalDescription, getAdditionalDescription

Method Detail

isAllowPositionAutoCreate

boolean isAllowPositionAutoCreate()

Retrieves the value for the attribute allowPositionAutoCreate.

Returns:

The non-null value for attribute allowPositionAutoCreate.

setAllowPositionAutoCreate

void setAllowPositionAutoCreate(boolean allowPositionAutoCreate)

Sets a new value for the attribute allowPositionAutoCreate.

Parameters:

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

assertReports

org.openmdx.base.cci2.Void assertReports(short bookingStatusThreshold)

closeDepot

CloseDepotResult closeDepot(Date closingDate)

getClosingDate

Date getClosingDate()

Retrieves the possibly null value for the optional attribute closingDate.

Returns:

The possibly null value for attribute closingDate.

setClosingDate

void setClosingDate(Date closingDate)

Sets a new value for the attribute closingDate.

Parameters:

closingDate - The possibly null new value for attribute closingDate.

getDepotGroup

DepotGroup getDepotGroup()

Retrieves the value for the reference depotGroup.

Returns:

The – possibly null – value for this reference.

setDepotGroup

void setDepotGroup(DepotGroup depotGroup)

Sets a new value for the reference depotGroup.

Parameters:

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

getDepotHolder

DepotHolder getDepotHolder()

Retrieves the value for the reference depotHolder.

Returns:

The non-null value for this reference.

getDepotNumber

String getDepotNumber()

Retrieves the value for the attribute depotNumber.

Returns:

The non-null value for attribute depotNumber.

setDepotNumber

void setDepotNumber(String depotNumber)

Sets a new value for the attribute depotNumber.

Parameters:

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

getDepotType

<T extends DepotType> List<T> getDepotType()

Retrieves the Collection of objects referenced by depotType.

Returns:

The Collection of referenced objects.

getDescription

String getDescription()

Retrieves the possibly null value for the optional attribute description.

Returns:

The possibly null value for attribute description.

setDescription

void setDescription(String description)

Sets a new value for the attribute description.

Parameters:

description - The possibly null new value for attribute description.

isDefault

boolean isDefault()

Retrieves the value for the attribute isDefault.

Returns:

The non-null value for attribute isDefault.

setDefault

void setDefault(boolean isDefault)

Sets a new value for the attribute isDefault.

Parameters:

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

isLocked

boolean isLocked()

Retrieves the value for the attribute isLocked.

Returns:

The non-null value for attribute isLocked.

setLocked

void setLocked(boolean isLocked)

Sets a new value for the attribute isLocked.

Parameters:

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

getLatestReport

DepotReport getLatestReport()

Retrieves the value for the reference latestReport.

Returns:

The – possibly null – value for this reference.

setLatestReport

void setLatestReport(DepotReport latestReport)

Sets a new value for the reference latestReport.

Parameters:

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

getName

String getName()

Retrieves the value for the attribute name.

Returns:

The non-null value for attribute name.

setName

void setName(String name)

Sets a new value for the attribute name.

Parameters:

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

openDepotPosition

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

getOpeningDate

Date getOpeningDate()

Retrieves the value for the attribute openingDate.

Returns:

The non-null value for attribute openingDate.

setOpeningDate

void setOpeningDate(Date openingDate)

Sets a new value for the attribute openingDate.

Parameters:

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

getPosition

<T extends DepotPosition> Collection<T> getPosition()

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

Returns:

A set containing all the elements for this reference.

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

getReport

<T extends DepotReport> Collection<T> getReport()

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

Returns:

A set containing all the elements for this reference.

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