org.opencrx.kernel.backend

Class Depots

java.lang.Object

org.opencrx.kernel.backend.AbstractImpl

org.opencrx.kernel.backend.Depots

public class Depots
extends AbstractImpl

Field Summary

Fields

Modifier and Type	Field and Description
static short	BOOKING_STATUS_FINAL
static short	BOOKING_STATUS_PENDING
static short	BOOKING_TYPE_CLOSING
static short	BOOKING_TYPE_REVERSAL
static short	BOOKING_TYPE_STANDARD
static short	DEPOT_USAGE_GOODS_DELIVERY
static short	DEPOT_USAGE_GOODS_ISSUE
static short	DEPOT_USAGE_GOODS_RETURN
static short	DEPOT_USAGE_WORK_EFFORT

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Depots()

Method Summary

Methods

Modifier and Type	Method and Description
void	acceptCompoundBooking(CompoundBooking compoundBooking) Accept compound booking.
void	assertReports(Depot depot, short bookingStatusThreshold) Re-calculate depot reports.
CompoundBooking	cancelCompoundBooking(CompoundBooking cb, List<String> errors) Cancel compound booking.
void	closeDepot(Depot depot, Date closingDate, List<String> errors)
void	closeDepotPosition(DepotPosition depotPosition, Date closingDate, List<String> errors)
CompoundBooking	createBookingByPosition(DepotEntity depotEntity, Date valueDate, short bookingType, BigDecimal quantity, String bookingTextName, BookingText bookingText, DepotPosition positionCredit, DepotPosition positionDebit, BookingOrigin origin, CompoundBooking reversalOf, List<String> errors)
CompoundBooking	createBookingByPositionName(DepotEntity depotEntity, Date valueDate, short bookingType, BigDecimal quantity, String bookingTextName, BookingText bookingText, String positionName, String depotNumberCredit, Depot depotCredit, String depotNumberDebit, Depot depotDebit, BookingOrigin origin, CompoundBooking reversalOf, List<String> errors)
CompoundBooking	createBookingByProduct(DepotEntity depotEntity, Date valueDate, short bookingType, BigDecimal quantity, String bookingTextName, BookingText bookingText, Product product, String depotNumberCredit, Depot depotCredit, String depotNumberDebit, Depot depotDebit, BookingOrigin origin, CompoundBooking reversalOf, List<String> errors)
CompoundBooking	createCompoundBooking(DepotEntity depotEntity, Date valueDate, short bookingType, BigDecimal[] quantities, String[] bookingTextNames, BookingText[] bookingTexts, DepotPosition[] creditPositions, DepotPosition[] debitPositions, BookingOrigin[] origins, CompoundBooking reversalOf, List<String> errors)
CompoundBooking	createCreditDebitBooking(DepotEntity depotEntity, Date valueDate, short bookingType, BigDecimal quantity, String bookingTextName, BookingText bookingText, DepotPosition positionCredit, DepotPosition positionDebit, BookingOrigin originIdentity, CompoundBooking reversalOf, List<String> errors)
void	finalizeCompoundBooking(CompoundBooking cb) Finalize compound booking.
DepotPosition	getAndCreateDepotPosition(DepotEntity depotEntity, String depotNumber, Depot depot, String positionName, Product product, Date openingDate)
Segment	getDepotSegment(javax.jdo.PersistenceManager pm, String providerName, String segmentName)
static Depots	getInstance()
boolean	hasBookings(CrxObject bookingTarget) Test for bookings having a depot position which is composite of the given booking target.
void	lockCompoundBooking(CompoundBooking cb, short lockingReason)
Depot	openDepot(DepotHolder depotHolder, String name, String description, String depotNumber, Date openingDate, DepotType depotType, DepotGroup depotGroup, List<String> errors)
DepotPosition	openDepotPosition(Depot depot, String positionName, String positionDescription, Date openingDate, String depotPositionQualifier, Product product, Boolean isLocked)
void	preDelete(org.openmdx.base.accessor.jmi.cci.RefObject_1_0 object, boolean preDelete) Pre-delete callback.
void	preStore(org.openmdx.base.accessor.jmi.cci.RefObject_1_0 object) Pre-store callback.
void	refreshReport(Depot depot, DepotReport report, DepotReport reportPreviousPeriod) Re-calculate depot reports.
static void	register()
protected void	removeCompoundBooking(CompoundBooking compoundBooking, boolean preDelete) Remove compound booking.
protected void	removeDepot(Depot depot, boolean preDelete) Remove depot.
protected void	removeDepotEntity(DepotEntity depotEntity, boolean preDelete) Remove depot entity.
protected void	removeDepotGroup(DepotGroup depotGroup, boolean preDelete) Remove depot group.
protected void	removeDepotHolder(DepotHolder depotHolder, boolean preDelete) Remove depot holder.
protected void	removeDepotPosition(DepotPosition depotPosition, boolean preDelete) Remove depot position.
protected void	removeSimpleBooking(SimpleBooking simpleBooking, boolean preDelete) Remove simple booking.
protected void	removeSingleBooking(SingleBooking singleBooking, boolean preDelete) Remove single booking.
void	testForBalance(CompoundBooking cb, BigDecimal balance, javax.jdo.PersistenceManager pm)
void	testForOpenPosition(Date valueDate, short bookingType, DepotPosition depotPosition)
void	unlockCompoundBooking(CompoundBooking cb)

Methods inherited from class org.opencrx.kernel.backend.AbstractImpl

getInstance, getUidAsString, registerImpl

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

BOOKING_TYPE_STANDARD

public static final short BOOKING_TYPE_STANDARD

See Also:

Constant Field Values

BOOKING_TYPE_CLOSING

public static final short BOOKING_TYPE_CLOSING

See Also:

Constant Field Values

BOOKING_TYPE_REVERSAL

public static final short BOOKING_TYPE_REVERSAL

See Also:

Constant Field Values

BOOKING_STATUS_PENDING

public static final short BOOKING_STATUS_PENDING

See Also:

Constant Field Values

BOOKING_STATUS_FINAL

public static final short BOOKING_STATUS_FINAL

See Also:

Constant Field Values

DEPOT_USAGE_GOODS_ISSUE

public static final short DEPOT_USAGE_GOODS_ISSUE

See Also:

Constant Field Values

DEPOT_USAGE_GOODS_RETURN

public static final short DEPOT_USAGE_GOODS_RETURN

See Also:

Constant Field Values

DEPOT_USAGE_GOODS_DELIVERY

public static final short DEPOT_USAGE_GOODS_DELIVERY

See Also:

Constant Field Values

DEPOT_USAGE_WORK_EFFORT

public static final short DEPOT_USAGE_WORK_EFFORT

See Also:

Constant Field Values

Constructor Detail

Depots

protected Depots()

Method Detail

register

public static void register()

getInstance

public static Depots getInstance()
                          throws org.openmdx.base.exception.ServiceException

Throws:

org.openmdx.base.exception.ServiceException

getDepotSegment

public Segment getDepotSegment(javax.jdo.PersistenceManager pm,
                      String providerName,
                      String segmentName)

Returns:

Returns the depot segment.

testForOpenPosition

public void testForOpenPosition(Date valueDate,
                       short bookingType,
                       DepotPosition depotPosition)
                         throws org.openmdx.base.exception.ServiceException

Throws:

org.openmdx.base.exception.ServiceException

testForBalance

public void testForBalance(CompoundBooking cb,
                  BigDecimal balance,
                  javax.jdo.PersistenceManager pm)
                    throws org.openmdx.base.exception.ServiceException

Throws:

org.openmdx.base.exception.ServiceException

createCreditDebitBooking

public CompoundBooking createCreditDebitBooking(DepotEntity depotEntity,
                                       Date valueDate,
                                       short bookingType,
                                       BigDecimal quantity,
                                       String bookingTextName,
                                       BookingText bookingText,
                                       DepotPosition positionCredit,
                                       DepotPosition positionDebit,
                                       BookingOrigin originIdentity,
                                       CompoundBooking reversalOf,
                                       List<String> errors)
                                         throws org.openmdx.base.exception.ServiceException

Throws:

org.openmdx.base.exception.ServiceException

createCompoundBooking

public CompoundBooking createCompoundBooking(DepotEntity depotEntity,
                                    Date valueDate,
                                    short bookingType,
                                    BigDecimal[] quantities,
                                    String[] bookingTextNames,
                                    BookingText[] bookingTexts,
                                    DepotPosition[] creditPositions,
                                    DepotPosition[] debitPositions,
                                    BookingOrigin[] origins,
                                    CompoundBooking reversalOf,
                                    List<String> errors)
                                      throws org.openmdx.base.exception.ServiceException

Throws:

org.openmdx.base.exception.ServiceException

getAndCreateDepotPosition

public DepotPosition getAndCreateDepotPosition(DepotEntity depotEntity,
                                      String depotNumber,
                                      Depot depot,
                                      String positionName,
                                      Product product,
                                      Date openingDate)
                                        throws org.openmdx.base.exception.ServiceException

Throws:

org.openmdx.base.exception.ServiceException

createBookingByPosition

public CompoundBooking createBookingByPosition(DepotEntity depotEntity,
                                      Date valueDate,
                                      short bookingType,
                                      BigDecimal quantity,
                                      String bookingTextName,
                                      BookingText bookingText,
                                      DepotPosition positionCredit,
                                      DepotPosition positionDebit,
                                      BookingOrigin origin,
                                      CompoundBooking reversalOf,
                                      List<String> errors)
                                        throws org.openmdx.base.exception.ServiceException

Throws:

org.openmdx.base.exception.ServiceException

createBookingByProduct

public CompoundBooking createBookingByProduct(DepotEntity depotEntity,
                                     Date valueDate,
                                     short bookingType,
                                     BigDecimal quantity,
                                     String bookingTextName,
                                     BookingText bookingText,
                                     Product product,
                                     String depotNumberCredit,
                                     Depot depotCredit,
                                     String depotNumberDebit,
                                     Depot depotDebit,
                                     BookingOrigin origin,
                                     CompoundBooking reversalOf,
                                     List<String> errors)
                                       throws org.openmdx.base.exception.ServiceException

Throws:

org.openmdx.base.exception.ServiceException

createBookingByPositionName

public CompoundBooking createBookingByPositionName(DepotEntity depotEntity,
                                          Date valueDate,
                                          short bookingType,
                                          BigDecimal quantity,
                                          String bookingTextName,
                                          BookingText bookingText,
                                          String positionName,
                                          String depotNumberCredit,
                                          Depot depotCredit,
                                          String depotNumberDebit,
                                          Depot depotDebit,
                                          BookingOrigin origin,
                                          CompoundBooking reversalOf,
                                          List<String> errors)
                                            throws org.openmdx.base.exception.ServiceException

Throws:

org.openmdx.base.exception.ServiceException

refreshReport

public void refreshReport(Depot depot,
                 DepotReport report,
                 DepotReport reportPreviousPeriod)
                   throws org.openmdx.base.exception.ServiceException

Re-calculate depot reports.

Parameters:

depot -

report -

reportPreviousPeriod -

Throws:

org.openmdx.base.exception.ServiceException

assertReports

public void assertReports(Depot depot,
                 short bookingStatusThreshold)
                   throws org.openmdx.base.exception.ServiceException

Re-calculate depot reports.

Parameters:

depot -

bookingStatusThreshold -

Throws:

org.openmdx.base.exception.ServiceException

cancelCompoundBooking

public CompoundBooking cancelCompoundBooking(CompoundBooking cb,
                                    List<String> errors)
                                      throws org.openmdx.base.exception.ServiceException

Cancel compound booking.

Parameters:

cb -

errors -

Returns:

Throws:

org.openmdx.base.exception.ServiceException

acceptCompoundBooking

public void acceptCompoundBooking(CompoundBooking compoundBooking)
                           throws org.openmdx.base.exception.ServiceException

Accept compound booking.

Parameters:

compoundBooking -

Throws:

org.openmdx.base.exception.ServiceException

finalizeCompoundBooking

public void finalizeCompoundBooking(CompoundBooking cb)
                             throws org.openmdx.base.exception.ServiceException

Finalize compound booking.

Parameters:

cb -

Throws:

org.openmdx.base.exception.ServiceException

removeCompoundBooking

protected void removeCompoundBooking(CompoundBooking compoundBooking,
                         boolean preDelete)
                              throws org.openmdx.base.exception.ServiceException

Remove compound booking.

Parameters:

compoundBooking -

preDelete -

Throws:

org.openmdx.base.exception.ServiceException

removeSimpleBooking

protected void removeSimpleBooking(SimpleBooking simpleBooking,
                       boolean preDelete)
                            throws org.openmdx.base.exception.ServiceException

Remove simple booking.

Parameters:

simpleBooking -

preDelete -

Throws:

org.openmdx.base.exception.ServiceException

removeSingleBooking

protected void removeSingleBooking(SingleBooking singleBooking,
                       boolean preDelete)
                            throws org.openmdx.base.exception.ServiceException

Remove single booking.

Parameters:

singleBooking -

preDelete -

Throws:

org.openmdx.base.exception.ServiceException

hasBookings

public boolean hasBookings(CrxObject bookingTarget)
                    throws org.openmdx.base.exception.ServiceException

Test for bookings having a depot position which is composite of the given booking target. The booking target can be a depot entity, a depot holder, a depot or a depot position.

Parameters:

bookingTarget -

Returns:

Throws:

org.openmdx.base.exception.ServiceException

removeDepotEntity

protected void removeDepotEntity(DepotEntity depotEntity,
                     boolean preDelete)
                          throws org.openmdx.base.exception.ServiceException

Remove depot entity. Test for existing bookings.

Parameters:

depotEntity -

preDelete -

Throws:

org.openmdx.base.exception.ServiceException

removeDepotHolder

protected void removeDepotHolder(DepotHolder depotHolder,
                     boolean preDelete)
                          throws org.openmdx.base.exception.ServiceException

Remove depot holder. Test for existing bookings.

Parameters:

depotHolder -

preDelete -

Throws:

org.openmdx.base.exception.ServiceException

removeDepot

protected void removeDepot(Depot depot,
               boolean preDelete)
                    throws org.openmdx.base.exception.ServiceException

Remove depot. Test for existing bookings.

Parameters:

depot -

preDelete -

Throws:

org.openmdx.base.exception.ServiceException

removeDepotPosition

protected void removeDepotPosition(DepotPosition depotPosition,
                       boolean preDelete)
                            throws org.openmdx.base.exception.ServiceException

Remove depot position. Test for existing bookings.

Parameters:

depotPosition -

preDelete -

Throws:

org.openmdx.base.exception.ServiceException

removeDepotGroup

protected void removeDepotGroup(DepotGroup depotGroup,
                    boolean preDelete)
                         throws org.openmdx.base.exception.ServiceException

Remove depot group.

Parameters:

depotGroup -

preDelete -

Throws:

org.openmdx.base.exception.ServiceException

openDepot

public Depot openDepot(DepotHolder depotHolder,
              String name,
              String description,
              String depotNumber,
              Date openingDate,
              DepotType depotType,
              DepotGroup depotGroup,
              List<String> errors)
                throws org.openmdx.base.exception.ServiceException

Throws:

org.openmdx.base.exception.ServiceException

closeDepot

public void closeDepot(Depot depot,
              Date closingDate,
              List<String> errors)
                throws org.openmdx.base.exception.ServiceException

Throws:

org.openmdx.base.exception.ServiceException

openDepotPosition

public DepotPosition openDepotPosition(Depot depot,
                              String positionName,
                              String positionDescription,
                              Date openingDate,
                              String depotPositionQualifier,
                              Product product,
                              Boolean isLocked)
                                throws org.openmdx.base.exception.ServiceException

Throws:

org.openmdx.base.exception.ServiceException

closeDepotPosition

public void closeDepotPosition(DepotPosition depotPosition,
                      Date closingDate,
                      List<String> errors)
                        throws org.openmdx.base.exception.ServiceException

Throws:

org.openmdx.base.exception.ServiceException

lockCompoundBooking

public void lockCompoundBooking(CompoundBooking cb,
                       short lockingReason)
                         throws org.openmdx.base.exception.ServiceException

Throws:

org.openmdx.base.exception.ServiceException

unlockCompoundBooking

public void unlockCompoundBooking(CompoundBooking cb)
                           throws org.openmdx.base.exception.ServiceException

Throws:

org.openmdx.base.exception.ServiceException

preDelete

public void preDelete(org.openmdx.base.accessor.jmi.cci.RefObject_1_0 object,
             boolean preDelete)
               throws org.openmdx.base.exception.ServiceException

Description copied from class: AbstractImpl

Pre-delete callback. This method is called before can object is deleted. Override this method for custom-specific behaviour.

Overrides:

preDelete in class AbstractImpl

Throws:

org.openmdx.base.exception.ServiceException

preStore

public void preStore(org.openmdx.base.accessor.jmi.cci.RefObject_1_0 object)
              throws org.openmdx.base.exception.ServiceException

Description copied from class: AbstractImpl

Pre-store callback. This method is called before an object is made persistent. Override this method for custom-specific behaviour.

Overrides:

preStore in class AbstractImpl

Throws:

org.openmdx.base.exception.ServiceException