com.neurosys.ecom.strategy.service

Interface LockStrategy<P extends Product,U extends User>

All Known Implementing Classes:

DefaultLockStrategy

public interface LockStrategy<P extends Product,U extends User>

A Support strategy on how concurrent purchases will be handled using LockStrategy.Lock
SaleStrategy and OrderStrategy would be typical consumers of this Strategy; as opposed to other Strategies that find direct business use cases.

Author:

Arjun Dhar

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	LockStrategy.Lock An abstract concept for Locking some units
static class	LockStrategy.LockException Exception regarding LockStrategy.Locks

Method Summary

Modifier and Type	Method and Description
Collection<LockStrategy.Lock>	getLocksForProducts(Collection<P> products) Get LockStrategy.Lock for a Product
Collection<LockStrategy.Lock>	getLocksForProducts(Collection<P> products, U user, String sessionId) Get LockStrategy.Lock for a Product
Collection<LockStrategy.Lock>	getLocksForUser(U user, String sessionId) Get the LockStrategy.Locks for a User
boolean	isLockValid(LockStrategy.Lock lock) While processing locks, check if a LockStrategy.Lock is valid or not @ the given instance of time By default a LockStrategy.Lock more than #minutesForLockExpire minutes is invalid.
LockStrategy.Lock	lockUnitsForUser(P product, U user, String sessionId, Number units) During the purchase process allow the ability to lock away certain units for a User.
void	remove(P product) Clear entries for A Product
void	unlock(Collection<LockStrategy.Lock> locks) If a transaction was abandoned, not completed or forced out then one can unlock it.
void	unlock(LockStrategy.Lock lock) If a transaction was abandoned, not completed or forced out then one can unlock it.
void	unlockSession(U user, String usessionId) Convenience/Consistent method; commonly used to Unlock all Locks for a Users session

Method Detail

lockUnitsForUser

LockStrategy.Lock lockUnitsForUser(P product,
                                   U user,
                                   String sessionId,
                                   Number units)
                            throws LockStrategy.LockException

During the purchase process allow the ability to lock away certain units for a User. The LOCK may have a t

Parameters:

product -

user - @nullable true

sessionId - @nullable true

units; - Number of units to Lock

Throws:

LockStrategy.LockException - if unable to LockStrategy.Lock

getLocksForUser

Collection<LockStrategy.Lock> getLocksForUser(U user,
                                              String sessionId)

Get the LockStrategy.Locks for a User

Parameters:

user - as U

Returns:

getLocksForProducts

Collection<LockStrategy.Lock> getLocksForProducts(Collection<P> products,
                                                  U user,
                                                  String sessionId)

Get LockStrategy.Lock for a Product

Parameters:

product - as P

user - as U

sessionId - as String

Returns:

Collection of LockStrategy.Lock @nullable true

getLocksForProducts

Collection<LockStrategy.Lock> getLocksForProducts(Collection<P> products)

Get LockStrategy.Lock for a Product

Parameters:

product - as P

user - as U

sessionId - as String

Returns:

Collection of LockStrategy.Lock @nullable true

unlock

void unlock(LockStrategy.Lock lock)
     throws LockStrategy.LockException

If a transaction was abandoned, not completed or forced out then one can unlock it.

Parameters:

lock - as LockStrategy.Lock

Throws:

LockStrategy.LockException - if unable to LockStrategy.Lock

unlock

void unlock(Collection<LockStrategy.Lock> locks)
     throws LockStrategy.LockException

If a transaction was abandoned, not completed or forced out then one can unlock it.

Parameters:

locks - as Collection of LockStrategy.Lock

Throws:

LockStrategy.LockException - if unable to LockStrategy.Lock

unlockSession

void unlockSession(U user,
                   String usessionId)

Convenience/Consistent method; commonly used to Unlock all Locks for a Users session

Parameters:

user - as U

usessionId - as String

remove

void remove(P product)

Clear entries for A Product

isLockValid

boolean isLockValid(LockStrategy.Lock lock)

While processing locks, check if a LockStrategy.Lock is valid or not @ the given instance of time By default a LockStrategy.Lock more than #minutesForLockExpire minutes is invalid.

Returns: