org.opencrx.kernel.depot1.cci
Interface DepotEntity

All Superinterfaces:

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

All Known Implementing Classes:

DepotEntityImpl

public interface DepotEntity
extends CrxObject

Method Summary

void	addBookingPeriod(BookingPeriod newValue)
void	addBookingPeriod(String id, BookingPeriod newValue)
void	addBookingText(BookingText newValue)
void	addBookingText(String id, BookingText newValue)
void	addDepotGroup(DepotGroup newValue)
void	addDepotGroup(String id, DepotGroup newValue)
void	addDepotHolder(DepotHolder newValue)
void	addDepotHolder(String id, DepotHolder newValue)
CreateBookingResult	createBookingByPosition(BookingText bookingText, String bookingTextName, short bookingType, DepotPosition positionCredit, DepotPosition positionDebit, BigDecimal quantity, CompoundBooking reversalOf, Date valueDate)
CreateBookingResult	createBookingByPosition(CreateBookingByPositionParams params)
CreateBookingResult	createBookingByPositionName(BookingText bookingText, String bookingTextName, short bookingType, Depot depotCredit, Depot depotDebit, String depotNumberCredit, String depotNumberDebit, String positionName, BigDecimal quantity, CompoundBooking reversalOf, Date valueDate)
CreateBookingResult	createBookingByPositionName(CreateBookingByPositionNameParams params)
CreateBookingResult	createBookingByProduct(BookingText bookingText, String bookingTextName, short bookingType, Depot depotCredit, Depot depotDebit, String depotNumberCredit, String depotNumberDebit, Product product, BigDecimal quantity, CompoundBooking reversalOf, Date valueDate)
CreateBookingResult	createBookingByProduct(CreateBookingByProductParams params)
Collection	getBookingPeriod() Retrieves a collection containing all the elements for the reference bookingPeriod.
List	getBookingPeriod(BookingPeriodFilter filter) Retrieves the value for the reference bookingPeriod for the specified filter.
List	getBookingPeriod(BookingPeriodQuery query) Retrieves the value for the reference bookingPeriod for the specified query.
BookingPeriod	getBookingPeriod(String id) Retrieves the value for the reference bookingPeriod for the specified qualifier attribute value.
Collection	getBookingText() Retrieves a collection containing all the elements for the reference bookingText.
List	getBookingText(BookingTextFilter filter) Retrieves the value for the reference bookingText for the specified filter.
List	getBookingText(BookingTextQuery query) Retrieves the value for the reference bookingText for the specified query.
BookingText	getBookingText(String id) Retrieves the value for the reference bookingText 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	getDepotEntityNumber() Retrieves the value for the attribute depotEntityNumber.
Collection	getDepotGroup() Retrieves a collection containing all the elements for the reference depotGroup.
List	getDepotGroup(DepotGroupFilter filter) Retrieves the value for the reference depotGroup for the specified filter.
List	getDepotGroup(DepotGroupQuery query) Retrieves the value for the reference depotGroup for the specified query.
DepotGroup	getDepotGroup(String id) Retrieves the value for the reference depotGroup for the specified qualifier attribute value.
Collection	getDepotHolder() Retrieves a collection containing all the elements for the reference depotHolder.
List	getDepotHolder(DepotHolderFilter filter) Retrieves the value for the reference depotHolder for the specified filter.
List	getDepotHolder(DepotHolderQuery query) Retrieves the value for the reference depotHolder for the specified query.
DepotHolder	getDepotHolder(String id) Retrieves the value for the reference depotHolder for the specified qualifier attribute value.
String	getDescription()
String	getName() Retrieves the value for the attribute name.
void	removeBookingPeriod(String id)
void	removeBookingText(String id)
void	removeDepotGroup(String id)
void	removeDepotHolder(String id)
void	setDepotEntityNumber(String newValue) Sets a new value for the attribute depotEntityNumber.
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.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

getBookingPeriod

BookingPeriod getBookingPeriod(String id)

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

getBookingPeriod

Collection getBookingPeriod()

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

Returns:

A collection containing all the elements for this reference.

Throws:

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

getBookingPeriod

List getBookingPeriod(BookingPeriodFilter filter)

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

getBookingPeriod

List getBookingPeriod(BookingPeriodQuery query)

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

addBookingPeriod

void addBookingPeriod(String id,
                      BookingPeriod 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.

addBookingPeriod

void addBookingPeriod(BookingPeriod newValue)

Parameters:

newValue - The element to be appended.

Throws:

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

removeBookingPeriod

void removeBookingPeriod(String id)

Throws:

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

getBookingText

BookingText getBookingText(String id)

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

getBookingText

Collection getBookingText()

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

Returns:

A collection containing all the elements for this reference.

Throws:

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

getBookingText

List getBookingText(BookingTextFilter filter)

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

getBookingText

List getBookingText(BookingTextQuery query)

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

addBookingText

void addBookingText(String id,
                    BookingText 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.

addBookingText

void addBookingText(BookingText newValue)

Parameters:

newValue - The element to be appended.

Throws:

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

removeBookingText

void removeBookingText(String id)

Throws:

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

createBookingByPosition

CreateBookingResult createBookingByPosition(CreateBookingByPositionParams params)
                                            throws RefException

Throws:

RefException

createBookingByPosition

CreateBookingResult createBookingByPosition(BookingText bookingText,
                                            String bookingTextName,
                                            short bookingType,
                                            DepotPosition positionCredit,
                                            DepotPosition positionDebit,
                                            BigDecimal quantity,
                                            CompoundBooking reversalOf,
                                            Date valueDate)
                                            throws RefException

Throws:

RefException

createBookingByPositionName

CreateBookingResult createBookingByPositionName(CreateBookingByPositionNameParams params)
                                                throws RefException

Throws:

RefException

createBookingByPositionName

CreateBookingResult createBookingByPositionName(BookingText bookingText,
                                                String bookingTextName,
                                                short bookingType,
                                                Depot depotCredit,
                                                Depot depotDebit,
                                                String depotNumberCredit,
                                                String depotNumberDebit,
                                                String positionName,
                                                BigDecimal quantity,
                                                CompoundBooking reversalOf,
                                                Date valueDate)
                                                throws RefException

Throws:

RefException

createBookingByProduct

CreateBookingResult createBookingByProduct(CreateBookingByProductParams params)
                                           throws RefException

Throws:

RefException

createBookingByProduct

CreateBookingResult createBookingByProduct(BookingText bookingText,
                                           String bookingTextName,
                                           short bookingType,
                                           Depot depotCredit,
                                           Depot depotDebit,
                                           String depotNumberCredit,
                                           String depotNumberDebit,
                                           Product product,
                                           BigDecimal quantity,
                                           CompoundBooking reversalOf,
                                           Date valueDate)
                                           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.

getDepotEntityNumber

String getDepotEntityNumber()

Retrieves the value for the attribute depotEntityNumber.

Returns:

The non-null value for attribute depotEntityNumber.

Throws:

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

setDepotEntityNumber

void setDepotEntityNumber(String newValue)

Sets a new value for the attribute depotEntityNumber.

Parameters:

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

Throws:

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

getDepotGroup

DepotGroup getDepotGroup(String id)

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

getDepotGroup

Collection getDepotGroup()

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

Returns:

A collection containing all the elements for this reference.

Throws:

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

getDepotGroup

List getDepotGroup(DepotGroupFilter filter)

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

getDepotGroup

List getDepotGroup(DepotGroupQuery query)

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

addDepotGroup

void addDepotGroup(String id,
                   DepotGroup 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.

addDepotGroup

void addDepotGroup(DepotGroup newValue)

Parameters:

newValue - The element to be appended.

Throws:

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

removeDepotGroup

void removeDepotGroup(String id)

Throws:

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

getDepotHolder

DepotHolder getDepotHolder(String id)

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

getDepotHolder

Collection getDepotHolder()

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

Returns:

A collection containing all the elements for this reference.

Throws:

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

getDepotHolder

List getDepotHolder(DepotHolderFilter filter)

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

getDepotHolder

List getDepotHolder(DepotHolderQuery query)

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

addDepotHolder

void addDepotHolder(String id,
                    DepotHolder 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.

addDepotHolder

void addDepotHolder(DepotHolder newValue)

Parameters:

newValue - The element to be appended.

Throws:

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

removeDepotHolder

void removeDepotHolder(String id)

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.

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.