Package org.cyclos.impl.users

Class TransactionFeedbackServiceImpl

java.lang.Object

org.cyclos.impl.AbstractServerComponent

org.cyclos.impl.AbstractNetworkedServerComponent

org.cyclos.impl.BaseServiceImpl

org.cyclos.impl.CRUDServiceImpl<E,A,DTO,D,DP>

org.cyclos.impl.users.BaseReferenceServiceImpl<TransactionFeedback,QTransactionFeedback,TransactionFeedbackDTO,TransactionFeedbackEntryVO,TransactionFeedbackQuery,TransactionFeedbackData,TransactionVO>

org.cyclos.impl.users.TransactionFeedbackServiceImpl

All Implemented Interfaces:

CRUDServiceLocal<TransactionFeedback,TransactionFeedbackDTO,TransactionFeedbackData,TransactionVO>, TransactionFeedbackServiceLocal, CRUDService<TransactionFeedbackDTO,TransactionFeedbackData,TransactionVO>, CRUDWithConfirmationPasswordService<TransactionFeedbackDTO,TransactionFeedbackData,TransactionVO>, Service, TransactionFeedbackService

@Service
public class TransactionFeedbackServiceImpl
extends BaseReferenceServiceImpl<TransactionFeedback,QTransactionFeedback,TransactionFeedbackDTO,TransactionFeedbackEntryVO,TransactionFeedbackQuery,TransactionFeedbackData,TransactionVO>
implements TransactionFeedbackServiceLocal

implementation for TransactionFeedbackService

Field Summary

Fields inherited from class org.cyclos.impl.users.BaseReferenceServiceImpl

entryVoClass, r

Fields inherited from class org.cyclos.impl.CRUDServiceImpl

$, ATTR_CURRENT_COPY, cacheHandler, dtoClass, entityClass, extensionPointService, idPath, internalNamePath, namePath, ownerEntityIdPath, ownerEntityPath, ownerEntityPropertyName, passwordHandler, richTextHandler, withConfirmationPassword

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
TransactionFeedbackServiceImpl()

Method Summary

Modifier and Type	Method	Description
void	cancelAll(UserAccount account)	Cancels all pending feedback for the given account
boolean	canComment(BasePayment payment)	Whether the logged user can comment (i.e give) a feedback for the given payment.
boolean	canReply(BasePayment payment)	Whether the logged user can reply a received feedback for the given payment.
Long	comment(TransactionVO transaction, ReferenceLevel level, String comment)	Creates or edits the comments for the feedback of the given payment (be it a direct/scheduled/recurring payment)
protected DBQuery<?>	crateStatisticsQuery(User owner, ReferenceType type, DatePeriod period)
TransactionFeedback	createExpiredFeedback(BasePayment transaction)	Create a default TransactionFeedback, when the time to provide a feedback has expired
protected DBQuery<?>	createSearchQuery(TransactionFeedbackQuery params)
protected void	doRemove(TransactionFeedback feedback, boolean flush)	May be overridden in order to perform logical removing, instead of physical removing, or to remove some extra relationships as well
protected TransactionFeedbackData	getData(TransactionFeedback feedback)	Returns details data for the given entity
TransactionFeedbackData	getDataFromTransaction(TransactionVO vo)	Retrieve the data but from the transaction instead of using the feedback's id
TransactionFeedbackData	getGiveData(TransactionVO transaction)	Return data for create or modify a feedback.
TransactionFeedbackData	getReplyData(TransactionVO transaction)	Return data for reply for an already given feedback. The logged user must be the payment's receiver with Permission.MY_TRANSACTION_FEEDBACKS_RECEIVE permission.
TransactionFeedbackSearchData	getSearchData(UserLocatorVO locator)	Returns data used for search, like results and statistics
TransactionFeedbackVO	getTransactionFeedback(TransactionVO transaction)	Returns the transaction feedback related to the given payment
boolean	hasTransactionFeedbacks(User user)	Returns if the given user has given or received feedback
boolean	isFeedbackEnabled(BasePayment payment)	Whether the feedbacks are enabled for the given payment
List<UserVO>	listIgnoredUsers()	Returns all users ignored for feedbacks for the logged user
boolean	markAsIgnored(UserLocatorVO locator, boolean ignored)	Adds/Removes the given user to/from the logged user's ignore list for feedbacks.
TransactionFeedback	newEntity(TransactionVO transaction)	Should be implemented in order to instantiate a new entity based on the given context parameters
void	notifyTransactionFeedback(PaymentTransferType paymentTransferType)	Notifies a transaction feedback in case transfer type has feedback enabled and configured to be sent after payment is done
protected void	onAfterSave(TransactionFeedback feedback, TransactionFeedback currentCopy, Object dataFromOnBeforeSave)	May be overridden in order to perform custom logic after saving an entity
protected Object	onBeforeSave(TransactionFeedback entity, TransactionFeedback currentCopy)	May be overridden in order to perform custom logic before saving an entity.
TransactionFeedback	readPaymentAsSystemAndGetFeedback(TransactionVO vo)	Reads the payment as System and return the associated feedback if any.
protected QReference	ref()
void	removeFromTransaction(TransactionVO vo)	Removes (logically) the feedback associated to the given transaction.
Long	reply(TransactionVO transaction, String replyComments)	Creates or edits the comments for the feedback of the given payment (be it a transfer os scheduled payment)
protected Validator	resolveValidator(TransactionFeedbackDTO dto)
Page<TransactionResultVO>	searchTransactionsAwaitingFeedback(TransactionsAwaitingFeedbackQuery query)	Searches for transactions awaiting feedback by the given from user.
void	setFeedbackData(BasePayment payment, BasePaymentData paymentData)	Set data related to feedbacks
TransactionFeedbackDTO	toDTO(TransactionFeedback feedback)	Converts the given entity in a DTO, handling the CRUDServiceImpl.subClassMappings() mappings for subclasses
protected TransactionFeedbackEntryVO	toSearchResultEntry(TransactionFeedback feedback)
void	updateFeedbackFromTransaction(TransactionVO vo, TransactionFeedbackUpdateDTO update)	Updates the feedback associated to the given transaction as an admin/broker

Methods inherited from class org.cyclos.impl.users.BaseReferenceServiceImpl

countReceived, getReferenceLevels, getStatistics, registerNetworkMappings, removeAll, search

Methods inherited from class org.cyclos.impl.CRUDServiceImpl

addCustomInternalNameValidations, addCustomNameValidations, checkConfirmationPassword, find, findAll, from, getConfirmationPasswordInput, getConfirmationPasswordInputForRemove, getData, getDataForNew, getDeviceConfirmationParams, getEntityClass, getEntityInternalNameKey, getExcludedPropertiesToDTO, getExcludedPropertiesToEntity, getNameLabel, getUniqueInternalNameQuery, getUniqueNameQuery, isEntityInternalNameRequired, isNameRequired, load, logEntity, onAfterRemove, onBeforeRemove, preProcessCurrentCopy, remove, remove, removeAll, removeAll, removeAllWithConfirmationPassword, removeWithConfirmationPassword, resolveDTOType, resolveEntityType, resolveExtensionPointAccessor, save, saveOrder, saveSkippingEntityLog, saveWithConfirmationPassword, shouldCheckConfirmationPassword, subClassMappings, toEntity, validate

Methods inherited from class org.cyclos.impl.BaseServiceImpl

initializeNetworkMappings

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

Methods inherited from interface org.cyclos.services.CRUDService

getData, getDataForNew, load, remove, removeAll, save

Methods inherited from interface org.cyclos.impl.CRUDServiceLocal

find, findAll, getEntityClass, remove, removeAll, saveEntity, saveSkippingEntityLog, toEntity, validate

Methods inherited from interface org.cyclos.services.users.TransactionFeedbackService

getStatistics, search

Methods inherited from interface org.cyclos.impl.users.TransactionFeedbackServiceLocal

countReceived, removeAll

Constructor Detail

TransactionFeedbackServiceImpl

public TransactionFeedbackServiceImpl()

Method Detail

cancelAll

public void cancelAll(UserAccount account)
               throws FrameworkException

Description copied from interface: TransactionFeedbackServiceLocal

Cancels all pending feedback for the given account

Specified by:

cancelAll in interface TransactionFeedbackServiceLocal

Throws:

FrameworkException

canComment

public boolean canComment(BasePayment payment)

Description copied from interface: TransactionFeedbackServiceLocal

Whether the logged user can comment (i.e give) a feedback for the given payment.

Specified by:

canComment in interface TransactionFeedbackServiceLocal

canReply

public boolean canReply(BasePayment payment)

Description copied from interface: TransactionFeedbackServiceLocal

Whether the logged user can reply a received feedback for the given payment.

Specified by:

canReply in interface TransactionFeedbackServiceLocal

comment

public Long comment(TransactionVO transaction,
                    ReferenceLevel level,
                    String comment)
             throws FrameworkException,
                    IllegalActionException

Description copied from interface: TransactionFeedbackService

Creates or edits the comments for the feedback of the given payment (be it a direct/scheduled/recurring payment)

Specified by:

comment in interface TransactionFeedbackService

Throws:

IllegalActionException - When the given payment cannot receive a feedback comment (feedbacks not used, already replied or timed out)

FrameworkException

createExpiredFeedback

public TransactionFeedback createExpiredFeedback(BasePayment transaction)
                                          throws FrameworkException

Description copied from interface: TransactionFeedbackServiceLocal

Create a default TransactionFeedback, when the time to provide a feedback has expired

Specified by:

createExpiredFeedback in interface TransactionFeedbackServiceLocal

Throws:

FrameworkException

getDataFromTransaction

public TransactionFeedbackData getDataFromTransaction(TransactionVO vo)

Description copied from interface: TransactionFeedbackService

Retrieve the data but from the transaction instead of using the feedback's id

Specified by:

getDataFromTransaction in interface TransactionFeedbackService

getGiveData

public TransactionFeedbackData getGiveData(TransactionVO transaction)

Description copied from interface: TransactionFeedbackService

Return data for create or modify a feedback. This method is similar to the #getDataForNew(TransactionVO) but it doesn't throw a PermissionDeniedException The logged user must be the payment's payer.

Specified by:

getGiveData in interface TransactionFeedbackService

getReplyData

public TransactionFeedbackData getReplyData(TransactionVO transaction)

Description copied from interface: TransactionFeedbackService

Return data for reply for an already given feedback.
The logged user must be the payment's receiver with Permission.MY_TRANSACTION_FEEDBACKS_RECEIVE permission.

Specified by:

getReplyData in interface TransactionFeedbackService

getSearchData

public TransactionFeedbackSearchData getSearchData(UserLocatorVO locator)
                                            throws FrameworkException

Description copied from interface: TransactionFeedbackService

Returns data used for search, like results and statistics

Specified by:

getSearchData in interface TransactionFeedbackService

Throws:

FrameworkException

getTransactionFeedback

public TransactionFeedbackVO getTransactionFeedback(TransactionVO transaction)
                                             throws FrameworkException

Description copied from interface: TransactionFeedbackService

Returns the transaction feedback related to the given payment

Specified by:

getTransactionFeedback in interface TransactionFeedbackService

Throws:

FrameworkException

hasTransactionFeedbacks

public boolean hasTransactionFeedbacks(User user)

Description copied from interface: TransactionFeedbackServiceLocal

Returns if the given user has given or received feedback

Specified by:

hasTransactionFeedbacks in interface TransactionFeedbackServiceLocal

isFeedbackEnabled

public boolean isFeedbackEnabled(BasePayment payment)

Description copied from interface: TransactionFeedbackServiceLocal

Whether the feedbacks are enabled for the given payment

Specified by:

isFeedbackEnabled in interface TransactionFeedbackServiceLocal

listIgnoredUsers

public List<UserVO> listIgnoredUsers()
                              throws FrameworkException

Description copied from interface: TransactionFeedbackService

Returns all users ignored for feedbacks for the logged user

Specified by:

listIgnoredUsers in interface TransactionFeedbackService

Throws:

FrameworkException

markAsIgnored

public boolean markAsIgnored(UserLocatorVO locator,
                             boolean ignored)
                      throws FrameworkException

Description copied from interface: TransactionFeedbackService

Adds/Removes the given user to/from the logged user's ignore list for feedbacks.

Specified by:

markAsIgnored in interface TransactionFeedbackService

Returns:

true if the user was not ignored and now is ignored and vice versa.

Throws:

FrameworkException

newEntity

public TransactionFeedback newEntity(TransactionVO transaction)

Description copied from class: CRUDServiceImpl

Should be implemented in order to instantiate a new entity based on the given context parameters

Specified by:

newEntity in interface CRUDServiceLocal<TransactionFeedback,TransactionFeedbackDTO,TransactionFeedbackData,TransactionVO>

Specified by:

newEntity in class CRUDServiceImpl<TransactionFeedback,QTransactionFeedback,TransactionFeedbackDTO,TransactionFeedbackData,TransactionVO>

notifyTransactionFeedback

public void notifyTransactionFeedback(PaymentTransferType paymentTransferType)

Description copied from interface: TransactionFeedbackServiceLocal

Notifies a transaction feedback in case transfer type has feedback enabled and configured to be sent after payment is done

Specified by:

notifyTransactionFeedback in interface TransactionFeedbackServiceLocal

readPaymentAsSystemAndGetFeedback

public TransactionFeedback readPaymentAsSystemAndGetFeedback(TransactionVO vo)
                                                      throws EntityNotFoundException

Reads the payment as System and return the associated feedback if any.
Otherwise it throws an EntityNotFoundException

Specified by:

readPaymentAsSystemAndGetFeedback in interface TransactionFeedbackServiceLocal

Throws:

EntityNotFoundException - if there is no such payment or it hasn't got a feedback.

removeFromTransaction

public void removeFromTransaction(TransactionVO vo)

Description copied from interface: TransactionFeedbackService

Removes (logically) the feedback associated to the given transaction. It's used only by the REST layer because the paymentFeedback REST API works with transaction's id instead of feedback's id.
Only for admin/brokers with manage permission.

Specified by:

removeFromTransaction in interface TransactionFeedbackService

reply

public Long reply(TransactionVO transaction,
                  String replyComments)
           throws FrameworkException,
                  IllegalActionException

Description copied from interface: TransactionFeedbackService

Creates or edits the comments for the feedback of the given payment (be it a transfer os scheduled payment)

Specified by:

reply in interface TransactionFeedbackService

Throws:

IllegalActionException - When the given payment cannot receive a feedback reply (feedbacks not used or timed out)

FrameworkException

searchTransactionsAwaitingFeedback

public Page<TransactionResultVO> searchTransactionsAwaitingFeedback(TransactionsAwaitingFeedbackQuery query)

Description copied from interface: TransactionFeedbackService

Searches for transactions awaiting feedback by the given from user. The logged must have permission to give feedback or manage feedback (manager)

Specified by:

searchTransactionsAwaitingFeedback in interface TransactionFeedbackService

setFeedbackData

public void setFeedbackData(BasePayment payment,
                            BasePaymentData paymentData)

Description copied from interface: TransactionFeedbackServiceLocal

Set data related to feedbacks

Specified by:

setFeedbackData in interface TransactionFeedbackServiceLocal

toDTO

public TransactionFeedbackDTO toDTO(TransactionFeedback feedback)

Description copied from class: CRUDServiceImpl

Converts the given entity in a DTO, handling the CRUDServiceImpl.subClassMappings() mappings for subclasses

Specified by:

toDTO in interface CRUDServiceLocal<TransactionFeedback,TransactionFeedbackDTO,TransactionFeedbackData,TransactionVO>

Overrides:

toDTO in class CRUDServiceImpl<TransactionFeedback,QTransactionFeedback,TransactionFeedbackDTO,TransactionFeedbackData,TransactionVO>

updateFeedbackFromTransaction

public void updateFeedbackFromTransaction(TransactionVO vo,
                                          TransactionFeedbackUpdateDTO update)
                                   throws FrameworkException

Description copied from interface: TransactionFeedbackService

Updates the feedback associated to the given transaction as an admin/broker

Specified by:

updateFeedbackFromTransaction in interface TransactionFeedbackService

Throws:

FrameworkException

crateStatisticsQuery

protected DBQuery<?> crateStatisticsQuery(User owner,
                                          ReferenceType type,
                                          DatePeriod period)

Overrides:

crateStatisticsQuery in class BaseReferenceServiceImpl<TransactionFeedback,QTransactionFeedback,TransactionFeedbackDTO,TransactionFeedbackEntryVO,TransactionFeedbackQuery,TransactionFeedbackData,TransactionVO>

createSearchQuery

protected DBQuery<?> createSearchQuery(TransactionFeedbackQuery params)

Overrides:

createSearchQuery in class BaseReferenceServiceImpl<TransactionFeedback,QTransactionFeedback,TransactionFeedbackDTO,TransactionFeedbackEntryVO,TransactionFeedbackQuery,TransactionFeedbackData,TransactionVO>

doRemove

protected void doRemove(TransactionFeedback feedback,
                        boolean flush)

Description copied from class: CRUDServiceImpl

May be overridden in order to perform logical removing, instead of physical removing, or to remove some extra relationships as well

Overrides:

doRemove in class CRUDServiceImpl<TransactionFeedback,QTransactionFeedback,TransactionFeedbackDTO,TransactionFeedbackData,TransactionVO>

getData

protected TransactionFeedbackData getData(TransactionFeedback feedback)

Description copied from class: CRUDServiceImpl

Returns details data for the given entity

Specified by:

getData in class CRUDServiceImpl<TransactionFeedback,QTransactionFeedback,TransactionFeedbackDTO,TransactionFeedbackData,TransactionVO>

onAfterSave

protected void onAfterSave(TransactionFeedback feedback,
                           TransactionFeedback currentCopy,
                           Object dataFromOnBeforeSave)

Description copied from class: CRUDServiceImpl

May be overridden in order to perform custom logic after saving an entity

Overrides:

onAfterSave in class CRUDServiceImpl<TransactionFeedback,QTransactionFeedback,TransactionFeedbackDTO,TransactionFeedbackData,TransactionVO>

onBeforeSave

protected Object onBeforeSave(TransactionFeedback entity,
                              TransactionFeedback currentCopy)

Description copied from class: CRUDServiceImpl

May be overridden in order to perform custom logic before saving an entity. Any returned value will be passed to the CRUDServiceImpl.onAfterSave(BaseEntity, BaseEntity, Object) method

Overrides:

onBeforeSave in class CRUDServiceImpl<TransactionFeedback,QTransactionFeedback,TransactionFeedbackDTO,TransactionFeedbackData,TransactionVO>

ref

protected QReference ref()

Specified by:

ref in class BaseReferenceServiceImpl<TransactionFeedback,QTransactionFeedback,TransactionFeedbackDTO,TransactionFeedbackEntryVO,TransactionFeedbackQuery,TransactionFeedbackData,TransactionVO>

resolveValidator

protected Validator resolveValidator(TransactionFeedbackDTO dto)

Specified by:

resolveValidator in class CRUDServiceImpl<TransactionFeedback,QTransactionFeedback,TransactionFeedbackDTO,TransactionFeedbackData,TransactionVO>

toSearchResultEntry

protected TransactionFeedbackEntryVO toSearchResultEntry(TransactionFeedback feedback)

Overrides:

toSearchResultEntry in class BaseReferenceServiceImpl<TransactionFeedback,QTransactionFeedback,TransactionFeedbackDTO,TransactionFeedbackEntryVO,TransactionFeedbackQuery,TransactionFeedbackData,TransactionVO>