org.opencrx.kernel.depot1.jmi1
Interface DepotEntity

All Superinterfaces:

AlertSender, Auditee, org.openmdx.base.cci2.BasicObject, Cloneable, org.openmdx.base.cci2.ContextCapable, CrxObject, DepotEntity, org.openmdx.base.cci2.ExtentCapable, Importer, Indexed, RefBaseObject, RefFeatured, RefObject, RefObject_1_0, SecureObject, org.openmdx.compatibility.view1.cci2.ViewCapable, XmlExporter

public interface DepotEntity
extends DepotEntity, CrxObject

Class DepotEntity

Nested Class Summary

Nested classes/interfaces inherited from interface org.opencrx.kernel.depot1.cci2.DepotEntity

DepotEntity.Identity

Method Summary

void	addBookingPeriod(boolean idIsPersistent, String id, BookingPeriod bookingPeriod) Adds the specified element to the set of the values for the reference bookingPeriod.
void	addBookingText(boolean idIsPersistent, String id, BookingText bookingText) Adds the specified element to the set of the values for the reference bookingText.
void	addDepotGroup(boolean idIsPersistent, String id, DepotGroup depotGroup) Adds the specified element to the set of the values for the reference depotGroup.
void	addDepotHolder(boolean idIsPersistent, String id, DepotHolder depotHolder) Adds the specified element to the set of the values for the reference depotHolder.
CreateBookingResult	createBookingByPosition(BookingText bookingText, String bookingTextName, short bookingType, BookingOrigin origin, DepotPosition positionCredit, DepotPosition positionDebit, BigDecimal quantity, CompoundBooking reversalOf, Date valueDate)
CreateBookingResult	createBookingByPosition(CreateBookingByPositionParams params) Note: This is an extension to the JMI 1 standard. In order to remain standard compliant you should use the non-struct signature..
CreateBookingResult	createBookingByPositionName(BookingText bookingText, String bookingTextName, short bookingType, Depot depotCredit, Depot depotDebit, String depotNumberCredit, String depotNumberDebit, BookingOrigin origin, String positionName, BigDecimal quantity, CompoundBooking reversalOf, Date valueDate)
CreateBookingResult	createBookingByPositionName(CreateBookingByPositionNameParams params) Note: This is an extension to the JMI 1 standard. In order to remain standard compliant you should use the non-struct signature..
CreateBookingResult	createBookingByProduct(BookingText bookingText, String bookingTextName, short bookingType, Depot depotCredit, Depot depotDebit, String depotNumberCredit, String depotNumberDebit, BookingOrigin origin, Product product, BigDecimal quantity, CompoundBooking reversalOf, Date valueDate)
CreateBookingResult	createBookingByProduct(CreateBookingByProductParams params) Note: This is an extension to the JMI 1 standard. In order to remain standard compliant you should use the non-struct signature..
<T extends BookingPeriod> List<T>	getBookingPeriod(BookingPeriodQuery query) Retrieves the value for the reference bookingPeriod for the specified query.
BookingPeriod	getBookingPeriod(boolean idIsPersistent, String id) Retrieves the value for the reference bookingPeriod for the specified qualifier attribute value.
BookingPeriod	getBookingPeriod(String id) Retrieves the value for the reference bookingPeriod for the specified qualifier attribute value.
<T extends BookingText> List<T>	getBookingText(BookingTextQuery query) Retrieves the value for the reference bookingText for the specified query.
BookingText	getBookingText(boolean idIsPersistent, String id) Retrieves the value for the reference bookingText for the specified qualifier attribute value.
BookingText	getBookingText(String id) Retrieves the value for the reference bookingText for the specified qualifier attribute value.
Depot	getDepot(boolean idIsPersistent, String id) Retrieves the value for the reference depot for the specified qualifier attribute value.
<T extends Depot> List<T>	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.
DepotGroup	getDepotGroup(boolean idIsPersistent, String id) Retrieves the value for the reference depotGroup for the specified qualifier attribute value.
<T extends DepotGroup> List<T>	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.
DepotHolder	getDepotHolder(boolean idIsPersistent, String id) Retrieves the value for the reference depotHolder for the specified qualifier attribute value.
<T extends DepotHolder> List<T>	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.

Methods inherited from interface org.opencrx.kernel.depot1.cci2.DepotEntity

addBookingPeriod, addBookingText, addDepotGroup, addDepotHolder, getBookingPeriod, getBookingText, getDepot, getDepotEntityNumber, getDepotGroup, getDepotHolder, getDescription, getName, setDepotEntityNumber, setDescription, setName

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

addAdditionalExternalLink, addAttachedDocument, addMedia, addNote, addPropertySet, addRating, getAdditionalExternalLink, getAdditionalExternalLink, getAdditionalExternalLink, getAttachedDocument, getAttachedDocument, getAttachedDocument, getCategory, getExternalLink, getMedia, getMedia, getMedia, getNote, getNote, getNote, getPropertySet, getPropertySet, getPropertySet, getPropertySetEntry, getPropertySetEntry, getPropertySetEntry, getRating, getRating, getRating, getUserBoolean4, getUserCode4, getUserDate4, getUserDateTime4, getUserNumber4, getUserString4, setCategory, setExternalLink, setUserBoolean4, setUserCode4, setUserDate4, setUserDateTime4, setUserNumber4, setUserString4

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

addAdditionalExternalLink, addAttachedDocument, addMedia, addNote, addPropertySet, addRating, getAdditionalExternalLink, getAttachedDocument, getDisabledReason, getMedia, getNote, getPropertySet, getPropertySetEntry, getRating, getUserCode0, getUserCode1, getUserCode2, getUserCode3, getUserDate0, getUserDate1, getUserDate2, getUserDate3, getUserDateTime0, getUserDateTime1, getUserDateTime2, getUserDateTime3, getUserNumber0, getUserNumber1, getUserNumber2, getUserNumber3, getUserString0, getUserString1, getUserString2, getUserString3, 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, sendAlert

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

getAudit, getAudit, getAudit

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

getAudit

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

clone_, clone_

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

importItem, importItem

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

getIndexEntry, getIndexEntry, getIndexEntry, updateIndex, updateIndex

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

getIndexEntry

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

addOwningGroup, addOwningGroup, checkPermissions, checkPermissions, getAccessGrantedByParent, getOwner, getOwningUser, removeAllOwningGroup, removeAllOwningGroup, removeOwningGroup, removeOwningGroup, setAccessLevel, setAccessLevel, setOwningUser, setOwningUser, setOwningUser

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

getAccessLevelBrowse, getAccessLevelDelete, getAccessLevelUpdate, getOwningGroup, setAccessLevelBrowse, setAccessLevelDelete, setAccessLevelUpdate

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

exportXml, 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.jmi1.ViewCapable

getView, getView, getView

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

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

<T extends BookingPeriod> List<T> getBookingPeriod(BookingPeriodQuery query)

Retrieves the value for the reference bookingPeriod for the specified query. Note: This is an extension to the JMI 1 standard.
In order to remain standard compliant you should substitute this method with java.jdo.Query

Parameters:

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

Returns:

The objects for which the predicate evaluates to true.

getBookingPeriod

BookingPeriod getBookingPeriod(boolean idIsPersistent,
                               String id)

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

Specified by:

getBookingPeriod in interface DepotEntity

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

getBookingPeriod

BookingPeriod getBookingPeriod(String id)

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

This method is equivalent to the preferred invocation getBookingPeriod(false,id).

Parameters:

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

Returns:

The possibly null value for this qualifier

addBookingPeriod

void addBookingPeriod(boolean idIsPersistent,
                      String id,
                      BookingPeriod bookingPeriod)

Adds the specified element to the set of the values for the reference bookingPeriod.

Note: This is an extension to the JMI 1 standard.

Parameters:

idIsPersistent - true if id is persistent

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

bookingPeriod - The element to be appended.

getBookingText

<T extends BookingText> List<T> getBookingText(BookingTextQuery query)

Retrieves the value for the reference bookingText for the specified query. Note: This is an extension to the JMI 1 standard.
In order to remain standard compliant you should substitute this method with java.jdo.Query

Parameters:

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

Returns:

The objects for which the predicate evaluates to true.

getBookingText

BookingText getBookingText(boolean idIsPersistent,
                           String id)

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

Specified by:

getBookingText in interface DepotEntity

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

getBookingText

BookingText getBookingText(String id)

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

This method is equivalent to the preferred invocation getBookingText(false,id).

Parameters:

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

Returns:

The possibly null value for this qualifier

addBookingText

void addBookingText(boolean idIsPersistent,
                    String id,
                    BookingText bookingText)

Adds the specified element to the set of the values for the reference bookingText.

Note: This is an extension to the JMI 1 standard.

Parameters:

idIsPersistent - true if id is persistent

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

bookingText - The element to be appended.

createBookingByPosition

CreateBookingResult createBookingByPosition(CreateBookingByPositionParams params)
                                            throws RefException

Note: This is an extension to the JMI 1 standard.
In order to remain standard compliant you should use the non-struct signature..

Throws:

RefException

createBookingByPosition

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

Specified by:

createBookingByPosition in interface DepotEntity

createBookingByPositionName

CreateBookingResult createBookingByPositionName(CreateBookingByPositionNameParams params)
                                                throws RefException

Note: This is an extension to the JMI 1 standard.
In order to remain standard compliant you should use the non-struct signature..

Throws:

RefException

createBookingByPositionName

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

Specified by:

createBookingByPositionName in interface DepotEntity

createBookingByProduct

CreateBookingResult createBookingByProduct(CreateBookingByProductParams params)
                                           throws RefException

Note: This is an extension to the JMI 1 standard.
In order to remain standard compliant you should use the non-struct signature..

Throws:

RefException

createBookingByProduct

CreateBookingResult createBookingByProduct(BookingText bookingText,
                                           String bookingTextName,
                                           short bookingType,
                                           Depot depotCredit,
                                           Depot depotDebit,
                                           String depotNumberCredit,
                                           String depotNumberDebit,
                                           BookingOrigin origin,
                                           Product product,
                                           BigDecimal quantity,
                                           CompoundBooking reversalOf,
                                           Date valueDate)

Specified by:

createBookingByProduct in interface DepotEntity

getDepot

<T extends Depot> List<T> getDepot(DepotQuery query)

Retrieves the value for the reference depot for the specified query. Note: This is an extension to the JMI 1 standard.
In order to remain standard compliant you should substitute this method with java.jdo.Query

Parameters:

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

Returns:

The objects for which the predicate evaluates to true.

getDepot

Depot getDepot(boolean idIsPersistent,
               String id)

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

Specified by:

getDepot in interface DepotEntity

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

getDepot

Depot getDepot(String id)

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

This method is equivalent to the preferred invocation getDepot(false,id).

Parameters:

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

Returns:

The possibly null value for this qualifier

getDepotGroup

<T extends DepotGroup> List<T> getDepotGroup(DepotGroupQuery query)

Retrieves the value for the reference depotGroup for the specified query. Note: This is an extension to the JMI 1 standard.
In order to remain standard compliant you should substitute this method with java.jdo.Query

Parameters:

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

Returns:

The objects for which the predicate evaluates to true.

getDepotGroup

DepotGroup getDepotGroup(boolean idIsPersistent,
                         String id)

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

Specified by:

getDepotGroup in interface DepotEntity

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

getDepotGroup

DepotGroup getDepotGroup(String id)

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

This method is equivalent to the preferred invocation getDepotGroup(false,id).

Parameters:

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

Returns:

The possibly null value for this qualifier

addDepotGroup

void addDepotGroup(boolean idIsPersistent,
                   String id,
                   DepotGroup depotGroup)

Adds the specified element to the set of the values for the reference depotGroup.

Note: This is an extension to the JMI 1 standard.

Parameters:

idIsPersistent - true if id is persistent

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

depotGroup - The element to be appended.

getDepotHolder

<T extends DepotHolder> List<T> getDepotHolder(DepotHolderQuery query)

Retrieves the value for the reference depotHolder for the specified query. Note: This is an extension to the JMI 1 standard.
In order to remain standard compliant you should substitute this method with java.jdo.Query

Parameters:

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

Returns:

The objects for which the predicate evaluates to true.

getDepotHolder

DepotHolder getDepotHolder(boolean idIsPersistent,
                           String id)

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

Specified by:

getDepotHolder in interface DepotEntity

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

getDepotHolder

DepotHolder getDepotHolder(String id)

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

This method is equivalent to the preferred invocation getDepotHolder(false,id).

Parameters:

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

Returns:

The possibly null value for this qualifier

addDepotHolder

void addDepotHolder(boolean idIsPersistent,
                    String id,
                    DepotHolder depotHolder)

Adds the specified element to the set of the values for the reference depotHolder.

Note: This is an extension to the JMI 1 standard.

Parameters:

idIsPersistent - true if id is persistent

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

depotHolder - The element to be appended.