org.cyclos.services.users

Interface PaymentFeedbackService

All Superinterfaces:

CRUDService<PaymentFeedbackDTO,PaymentFeedbackData,java.lang.Long>, Service

All Known Subinterfaces:

PaymentFeedbackServiceLocal

public interface PaymentFeedbackService
extends CRUDService<PaymentFeedbackDTO,PaymentFeedbackData,java.lang.Long>

Service interface for transaction feedbacks

Author:

agonzalez

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.Long	comment(java.lang.Long transactionId, ReferenceLevel level, java.lang.String comment) Creates or edits the comments for the feedback of the given payment (be it a transfer os scheduled payment)
PaymentFeedbackVO	getPaymentFeedback(java.lang.Long transactionId) Returns the payment feedback related to the given payment id
PaymentFeedbackSearchData	getSearchData(PaymentFeedbackQuery query) Returns data used for search, like results and statistics
ReferenceStatisticsVO	getStatistics(PaymentFeedbackQuery query) Returns references statistics according to the given query
java.util.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.
java.lang.Long	reply(java.lang.Long transactionId, java.lang.String replyComments) Creates or edits the comments for the feedback of the given payment (be it a transfer os scheduled payment)
Page<PaymentFeedbackVO>	search(PaymentFeedbackQuery query) Searches for transfers feedbacks according to the given query
Page<TransactionVO>	searchPaymentsAwaitingFeedback(PaymentsAwaitingFeedbackQuery paymentAwaitingFeedbackQuery) Searches for payments awaiting feedback by the given user

Methods inherited from interface org.cyclos.services.CRUDService

getData, getDataForNew, load, remove, removeAll, save

Method Detail

comment

java.lang.Long comment(java.lang.Long transactionId,
                     ReferenceLevel level,
                     java.lang.String comment)
                       throws FrameworkException,
                              IllegalActionException

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

Throws:

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

FrameworkException

getPaymentFeedback

PaymentFeedbackVO getPaymentFeedback(java.lang.Long transactionId)
                                     throws FrameworkException

Returns the payment feedback related to the given payment id

Throws:

FrameworkException

getSearchData

PaymentFeedbackSearchData getSearchData(PaymentFeedbackQuery query)
                                        throws FrameworkException

Returns data used for search, like results and statistics

Throws:

FrameworkException

getStatistics

ReferenceStatisticsVO getStatistics(PaymentFeedbackQuery query)
                                    throws FrameworkException

Returns references statistics according to the given query

Throws:

FrameworkException

listIgnoredUsers

java.util.List<UserVO> listIgnoredUsers()
                                        throws FrameworkException

Returns all users ignored for feedbacks for the logged user

Throws:

FrameworkException

markAsIgnored

boolean markAsIgnored(UserLocatorVO locator,
                    boolean ignored)
                      throws FrameworkException

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

Returns:

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

Throws:

FrameworkException

reply

java.lang.Long reply(java.lang.Long transactionId,
                   java.lang.String replyComments)
                     throws FrameworkException,
                            IllegalActionException

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

Throws:

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

FrameworkException

search

Page<PaymentFeedbackVO> search(PaymentFeedbackQuery query)
                               throws FrameworkException

Searches for transfers feedbacks according to the given query

Throws:

FrameworkException

searchPaymentsAwaitingFeedback

Page<TransactionVO> searchPaymentsAwaitingFeedback(PaymentsAwaitingFeedbackQuery paymentAwaitingFeedbackQuery)
                                                   throws FrameworkException

Searches for payments awaiting feedback by the given user

Throws:

FrameworkException