Package org.cyclos.impl.users

Class BaseProductsOwnerServiceImpl<O extends ProductOwner,L extends ProductAssignmentLog<O>,VO extends EntityVO,D extends ProductsCollections>

java.lang.Object

org.cyclos.impl.AbstractServerComponent

org.cyclos.impl.AbstractNetworkedServerComponent

org.cyclos.impl.BaseServiceImpl

org.cyclos.impl.users.BaseProductsOwnerServiceImpl<O,L,VO,D>

All Implemented Interfaces:

BaseProductsOwnerServiceLocal<O,VO,D>, Service, BaseProductsOwnerService<VO,D>

Direct Known Subclasses:

ProductsGroupServiceImpl, ProductsUserServiceImpl

public abstract class BaseProductsOwnerServiceImpl<O extends ProductOwner,L extends ProductAssignmentLog<O>,VO extends EntityVO,D extends ProductsCollections>
extends BaseServiceImpl
implements BaseProductsOwnerServiceLocal<O,VO,D>

Implementation for BaseProductsOwnerService

Field Summary

Fields

Modifier and Type	Field	Description
protected Class<L>	logClass
protected Class<O>	ownerClass

Fields inherited from class org.cyclos.impl.AbstractNetworkedServerComponent

authHandler, conversionHandler, customFieldValueHandler, entityManagerHandler, groupsHandler, productsHandler, restBeanPropertyMapping, userLocatorHandler

Fields inherited from class org.cyclos.impl.AbstractServerComponent

accountHandler, configurationHandler, dataTranslationHandler, notificationHandler, profileFieldHandler, transactionHandler, translationHandler

Constructor Summary

Constructors

Constructor	Description
BaseProductsOwnerServiceImpl(Class<O> ownerClass, Class<L> logClass)

Method Summary

Modifier and Type	Method	Description
boolean	assign(ProductVO productVO, VO ownerVO)	Assigns the given product to the product owner.
ActiveProductsData	getActiveProducts(VO ownerVO, ChannelVO channelVO, PrincipalTypeVO principalTypeVO)	Returns the ActiveProductsData, containing all the actual product data for the user/group with the given id and the specified channel (if null then it doesn't filter the products by channel) and principal type (if null then it doesn't filter the products by principal type).
D	getData(O owner)	Returns the data used to view / manage an owner's individual products
D	getData(VO ownerVO)	Returns the data used to view / manage an owner's individual products
protected abstract D	getDataWithoutLogs(O owner)
protected abstract List<ProductAssignmentLogVO>	getLogs(O owner)
List<ProductAssignmentLogVO>	getLogs(VO ownerVO)	Returns the log for the individually assigned products to the given user.
protected abstract boolean	isCanAssign(O owner)	Returns if products can be assigned to the owner
protected boolean	isProductInHigherHierarchy(O owner, Product product)	Returns whether the given product is available higher in the hierarchy than the given owner.
protected void	log(ProductAssignmentAction action, Product product, O owner)	Logs a given action
protected abstract void	onProductAssigned(O owner, Product product)
protected abstract void	onProductUnassigned(O owner, Product product)
boolean	unassign(ProductVO productVO, VO ownerVO)	Unassigns the given product from the owner
protected abstract void	validateAssign(O owner, Product product)
protected abstract void	validateUnAssign(O owner, Product product)

Methods inherited from class org.cyclos.impl.BaseServiceImpl

initializeNetworkMappings, registerNetworkMappings

Methods inherited from class org.cyclos.impl.AbstractNetworkedServerComponent

canManage, checkManagesUser, checkPermission, checkRelatesToUser, checkValue, clearAlreadyValidated, getBaseEntityManagerHandler, getConfiguration, getLoggedBasicUser, getLoggedUser, getProducts, getTranslatedName, getTranslatedValue, hasPermission, hasValue, inSameNetwork, inSameNetworkOrGlobal, isAdmin, isAlreadyValidated, isBroker, isGlobalAdmin, isGlobalAdminInNetwork, isGuest, isLoggedIn, isMember, isMemberOnly, isNetworkAdmin, isOperator, isRelatedToUser, isSystem, isUserManager, isUserManagerOf, message, message, permission, permission, permissionOptionalValue, permissionOptionalValue, setAlreadyValidated, toDate, toDateTime, validate

Methods inherited from class org.cyclos.impl.AbstractServerComponent

dataTranslationProxy, dataTranslationProxy, delete, detach, doDataTranslationProxy, find, flush, from, getApplicationContext, getFormatter, getFormatter, getFormatter, getLogger, getRemoteAddress, getSessionData, mailContentBuilder, message, message, persist, processBatch, processBatch, refresh, remove, selectFrom, subQuery, update

Methods inherited from class java.lang.Object

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

Field Detail

ownerClass

protected final Class<O extends ProductOwner> ownerClass

logClass

protected final Class<L extends ProductAssignmentLog<O>> logClass

Constructor Detail

BaseProductsOwnerServiceImpl

public BaseProductsOwnerServiceImpl(Class<O> ownerClass,
                                    Class<L> logClass)

Method Detail

assign

public boolean assign(ProductVO productVO,
                      VO ownerVO)
               throws FrameworkException

Description copied from interface: BaseProductsOwnerService

Assigns the given product to the product owner.

Specified by:

assign in interface BaseProductsOwnerService<O extends ProductOwner,L extends ProductAssignmentLog<O>>

Throws:

FrameworkException

getActiveProducts

public ActiveProductsData getActiveProducts(VO ownerVO,
                                            ChannelVO channelVO,
                                            PrincipalTypeVO principalTypeVO)
                                     throws EntityNotFoundException

Description copied from interface: BaseProductsOwnerService

Returns the ActiveProductsData, containing all the actual product data for the user/group with the given id and the specified channel (if null then it doesn't filter the products by channel) and principal type (if null then it doesn't filter the products by principal type).

Specified by:

getActiveProducts in interface BaseProductsOwnerService<O extends ProductOwner,L extends ProductAssignmentLog<O>>

Throws:

EntityNotFoundException

getData

public final D getData(O owner)

Description copied from interface: BaseProductsOwnerServiceLocal

Returns the data used to view / manage an owner's individual products

Specified by:

getData in interface BaseProductsOwnerServiceLocal<O extends ProductOwner,L extends ProductAssignmentLog<O>,VO extends EntityVO>

getData

public final D getData(@NotNull
                       VO ownerVO)

Description copied from interface: BaseProductsOwnerService

Returns the data used to view / manage an owner's individual products

Specified by:

getData in interface BaseProductsOwnerService<O extends ProductOwner,L extends ProductAssignmentLog<O>>

getLogs

public final List<ProductAssignmentLogVO> getLogs(@NotNull
                                                  VO ownerVO)
                                           throws FrameworkException

Description copied from interface: BaseProductsOwnerService

Returns the log for the individually assigned products to the given user.

Specified by:

getLogs in interface BaseProductsOwnerService<O extends ProductOwner,L extends ProductAssignmentLog<O>>

Throws:

FrameworkException

unassign

public boolean unassign(ProductVO productVO,
                        VO ownerVO)
                 throws FrameworkException

Description copied from interface: BaseProductsOwnerService

Unassigns the given product from the owner

Specified by:

unassign in interface BaseProductsOwnerService<O extends ProductOwner,L extends ProductAssignmentLog<O>>

Throws:

FrameworkException

getDataWithoutLogs

protected abstract D getDataWithoutLogs(O owner)

getLogs

protected abstract List<ProductAssignmentLogVO> getLogs(O owner)

isCanAssign

protected abstract boolean isCanAssign(O owner)

Returns if products can be assigned to the owner

isProductInHigherHierarchy

protected boolean isProductInHigherHierarchy(O owner,
                                             Product product)

Returns whether the given product is available higher in the hierarchy than the given owner.

log

protected final void log(ProductAssignmentAction action,
                         Product product,
                         O owner)

Logs a given action

onProductAssigned

protected abstract void onProductAssigned(O owner,
                                          Product product)

onProductUnassigned

protected abstract void onProductUnassigned(O owner,
                                            Product product)

validateAssign

protected abstract void validateAssign(O owner,
                                       Product product)

validateUnAssign

protected abstract void validateUnAssign(O owner,
                                         Product product)