org.kuali.kfs.fp.document.service
Interface DisbursementVoucherPaymentReasonService

All Known Implementing Classes:

DisbursementVoucherPaymentReasonServiceImpl

public interface DisbursementVoucherPaymentReasonService

define a set of service methods related to payment reason code

Method Summary

List<String>	getPayeeTypesByPaymentReason(String paymentReasonCode) get the payee type codes valid for the given payment reason
PaymentReasonCode	getPaymentReasonByPrimaryId(String paymentReasonCode) get the payment reason with its primary key: the given payment reason code
String	getReserchNonVendorPayLimit() get the payment limit to research non-vendor employee for research payment reason
List<String>	getVendorOwnershipTypesByPaymentReason(String paymentReasonCode) get the vendor owership type codes for the given payment reason code
boolean	isDecedentCompensationPaymentReason(String paymentReasonCode) determine whether the given payment reason is a decedent compensation payment reason
boolean	isMovingPaymentReason(String paymentReasonCode) determine whether the given payment reason is a moving payment reason
boolean	isNonEmployeeTravelPaymentReason(String paymentReasonCode) determine whether the given payment reason is a non-employee travel payment reason
boolean	isPayeeQualifiedForPayment(DisbursementPayee payee, String paymentReasonCode) determine whether the given payee is qualified for the payment with the given reason code
boolean	isPayeeQualifiedForPayment(DisbursementPayee payee, String paymentReasonCode, List<String> payeeTypeCodes) determine whether the given payee is qualified for the payment with the given reason code and the payee type must be in the given payee type code list.
boolean	isPaymentReasonOfType(String typeParameterName, String paymentReasonCode) determine whether the given payment reason is of type that is specified by the given type parameter name.
boolean	isPrepaidTravelPaymentReason(String paymentReasonCode) determine whether the given payment reason is a prepaid travel payment reason
boolean	isResearchPaymentReason(String paymentReasonCode) determine whether the given payment reason is a research payment reason
boolean	isRevolvingFundPaymentReason(String paymentReasonCode) determine whether the given payment reason is a revolving fund payment reason
boolean	isTaxReviewRequired(String paymentReasonCode) determine whether the given payment reason is required for tax review
void	postPaymentReasonCodeUsage(String paymentReasonCode, org.kuali.rice.kns.util.MessageList messageList) post the usage of the given payment reason code into error map

Method Detail

isPayeeQualifiedForPayment

boolean isPayeeQualifiedForPayment(DisbursementPayee payee,
                                   String paymentReasonCode)

determine whether the given payee is qualified for the payment with the given reason code

Parameters:

payee - the given payee

paymentReasonCode - the givne payment reason code

Returns:

true if the given payee is qualified for the payment with the given reason code; otherwise, return false

isPayeeQualifiedForPayment

boolean isPayeeQualifiedForPayment(DisbursementPayee payee,
                                   String paymentReasonCode,
                                   List<String> payeeTypeCodes)

determine whether the given payee is qualified for the payment with the given reason code and the payee type must be in the given payee type code list.

Parameters:

payee - the given payee

paymentReasonCode - the givne payment reason code

payeeTypeCodes - the given payee type codes

Returns:

true if the given payee is qualified for the payment with the given reason code; otherwise, return false

isNonEmployeeTravelPaymentReason

boolean isNonEmployeeTravelPaymentReason(String paymentReasonCode)

determine whether the given payment reason is a non-employee travel payment reason

Parameters:

paymentReasonCode - the givne payment reason code

Returns:

true if the given payment reason is a moving payment reason; otherwise, return false

isMovingPaymentReason

boolean isMovingPaymentReason(String paymentReasonCode)

determine whether the given payment reason is a moving payment reason

Parameters:

paymentReasonCode - the givne payment reason code

Returns:

true if the given payment reason is a moving payment reason; otherwise, return false

isPrepaidTravelPaymentReason

boolean isPrepaidTravelPaymentReason(String paymentReasonCode)

determine whether the given payment reason is a prepaid travel payment reason

Parameters:

paymentReasonCode - the givne payment reason code

Returns:

true if the given payment reason is a prepaid travel payment reason; otherwise, return false

isResearchPaymentReason

boolean isResearchPaymentReason(String paymentReasonCode)

determine whether the given payment reason is a research payment reason

Parameters:

paymentReasonCode - the givne payment reason code

Returns:

true if the given payment reason is a research payment reason; otherwise, return false

isRevolvingFundPaymentReason

boolean isRevolvingFundPaymentReason(String paymentReasonCode)

determine whether the given payment reason is a revolving fund payment reason

Parameters:

paymentReasonCode - the givne payment reason code

Returns:

true if the given payment reason is a revolving fund payment reason; otherwise, return false

isDecedentCompensationPaymentReason

boolean isDecedentCompensationPaymentReason(String paymentReasonCode)

determine whether the given payment reason is a decedent compensation payment reason

Parameters:

paymentReasonCode - the givne payment reason code

Returns:

true if the given payment reason is a decedent compensation payment reason; otherwise, return false

isPaymentReasonOfType

boolean isPaymentReasonOfType(String typeParameterName,
                              String paymentReasonCode)

determine whether the given payment reason is of type that is specified by the given type parameter name. The type parameter must be defined as an application parameter(@see org.kuali.rice.kns.bo.Parameter)

Parameters:

typeParameterName - the given type parameter name

paymentReasonCode - the given reason code

Returns:

true if the given payment reason is of type that is specified by typeParameterName; otherwise, false

getReserchNonVendorPayLimit

String getReserchNonVendorPayLimit()

get the payment limit to research non-vendor employee for research payment reason

Returns:

the payment limit to research non-vendor employee for research payment reason.

getPayeeTypesByPaymentReason

List<String> getPayeeTypesByPaymentReason(String paymentReasonCode)

get the payee type codes valid for the given payment reason

Parameters:

paymentReasonCode - the given payment reason

Returns:

the payee type codes valid for the given payment reason

getPaymentReasonByPrimaryId

PaymentReasonCode getPaymentReasonByPrimaryId(String paymentReasonCode)

get the payment reason with its primary key: the given payment reason code

Parameters:

paymentReasonCode - the given payment reason

Returns:

the payment reason with its primary key: the given payment reason code

postPaymentReasonCodeUsage

void postPaymentReasonCodeUsage(String paymentReasonCode,
                                org.kuali.rice.kns.util.MessageList messageList)

post the usage of the given payment reason code into error map

Parameters:

paymentReasonCode - the given payment reason code

messageList - the message list that will hold the usage of the given payment reason

isTaxReviewRequired

boolean isTaxReviewRequired(String paymentReasonCode)

determine whether the given payment reason is required for tax review

Parameters:

paymentReasonCode - the given payment reason

Returns:

true if the given payment reason is required for tax review; otherwise, false

getVendorOwnershipTypesByPaymentReason

List<String> getVendorOwnershipTypesByPaymentReason(String paymentReasonCode)

get the vendor owership type codes for the given payment reason code

Parameters:

paymentReasonCode - the given payment reason code

Returns:

the vendor owership type codes for the given payment reason code if any; otherwise, null