org.kuali.kfs.sys.service
Interface ElectronicPaymentClaimingService

All Known Implementing Classes:

ElectronicPaymentClaimingServiceImpl

public interface ElectronicPaymentClaimingService

A service which helps in the claiming of ElectronicPaymentClaim records

Method Summary

void	claimElectronicPayments(List<ElectronicPaymentClaim> payments, String documentNumber) Sets the referenceFinancialDocumentNumber on each of the payments passed in with the given document number and then saves them.
List<String>	constructNoteTextsForClaims(List<ElectronicPaymentClaim> claims) Constructs a List of Notes that detail which ElectronicPaymentClaim records have been claimed by a document
String	createPaymentClaimingDocument(List<ElectronicPaymentClaim> claims, ElectronicPaymentClaimingDocumentGenerationStrategy documentCreationHelper, org.kuali.rice.kim.bo.Person user) Given a List of ElectronicPaymentClaim records and a ElectronicPaymentClaimingDocumentGenerationStrategy document helper implementation, creates a document that will claim; this method should also do the work of "claiming" each of the given ElectronicPaymentClaim records by filling in their referenceFinancialDocumentNumber field.
void	declaimElectronicPaymentClaimsForDocument(org.kuali.rice.kns.document.Document document) Unclaims all ElectronicPaymentClaim records claimed by the given document, by setting the ElectronicPaymentClaim's reference document to null.
List<ElectronicPaymentClaim>	generateElectronicPaymentClaimRecords(AdvanceDepositDocument doc) Returns a list of SAVED electronic payment claims from the lines of an AdvanceDepositDocument
List<ElectronicPaymentClaimingDocumentGenerationStrategy>	getClaimingDocumentChoices(org.kuali.rice.kim.bo.Person user) Returns a list of which document types the given user can claim Electronic Payment Claims with.
boolean	isAuthorizedForClaimingElectronicPayment(org.kuali.rice.kim.bo.Person user, String workflowDocumentTypeName) check whether the given user has permission to claim eletronic payment for the given document type defined in the specified namespace
boolean	representsElectronicFundAccount(AccountingLine accountingLine) Determines if the given accounting line represents an electronic payment

Method Detail

constructNoteTextsForClaims

List<String> constructNoteTextsForClaims(List<ElectronicPaymentClaim> claims)

Constructs a List of Notes that detail which ElectronicPaymentClaim records have been claimed by a document

Parameters:

claims - the ElectronicPaymentClaim record that will be claimed by a document

claimingUser - the user who's actually claiming ElectronicPaymentClaim records

Returns:

a List of Notes that will summarize that claiming.

getClaimingDocumentChoices

List<ElectronicPaymentClaimingDocumentGenerationStrategy> getClaimingDocumentChoices(org.kuali.rice.kim.bo.Person user)

Returns a list of which document types the given user can claim Electronic Payment Claims with.

Parameters:

user - the user attempting to use a document to claim ElectronicPaymentClaim records

Returns:

a list of ElectronicPaymentClaimingDocumentGenerationStrategy document helper implementations

createPaymentClaimingDocument

String createPaymentClaimingDocument(List<ElectronicPaymentClaim> claims,
                                     ElectronicPaymentClaimingDocumentGenerationStrategy documentCreationHelper,
                                     org.kuali.rice.kim.bo.Person user)

Given a List of ElectronicPaymentClaim records and a ElectronicPaymentClaimingDocumentGenerationStrategy document helper implementation, creates a document that will claim; this method should also do the work of "claiming" each of the given ElectronicPaymentClaim records by filling in their referenceFinancialDocumentNumber field.

Parameters:

claims - the List of ElectronicPaymentClaim records to claim with a document

documentCreationHelper - the document helper which will help this method in constructing the claiming document

user - the Person record of the user who is claiming the given electronic payments

Returns:

the URL to redirect to, so the user can edit the document

declaimElectronicPaymentClaimsForDocument

void declaimElectronicPaymentClaimsForDocument(org.kuali.rice.kns.document.Document document)

Unclaims all ElectronicPaymentClaim records claimed by the given document, by setting the ElectronicPaymentClaim's reference document to null.

Parameters:

document - the document that claimed ElectronicPaymentClaims and now needs to give them back

claimElectronicPayments

void claimElectronicPayments(List<ElectronicPaymentClaim> payments,
                             String documentNumber)

Sets the referenceFinancialDocumentNumber on each of the payments passed in with the given document number and then saves them.

Parameters:

payments - a list of payments to claim

docmentNumber - the document number of the claiming document

generateElectronicPaymentClaimRecords

List<ElectronicPaymentClaim> generateElectronicPaymentClaimRecords(AdvanceDepositDocument doc)

Returns a list of SAVED electronic payment claims from the lines of an AdvanceDepositDocument

Parameters:

doc - the document that is generating electronic payment claim records

Returns:

a list of the generated electronic payment claim records

representsElectronicFundAccount

boolean representsElectronicFundAccount(AccountingLine accountingLine)

Determines if the given accounting line represents an electronic payment

Parameters:

accountingLine - the accounting line to check

Returns:

true if the accounting line does represent an electronic payment, false otherwise

isAuthorizedForClaimingElectronicPayment

boolean isAuthorizedForClaimingElectronicPayment(org.kuali.rice.kim.bo.Person user,
                                                 String workflowDocumentTypeName)

check whether the given user has permission to claim eletronic payment for the given document type defined in the specified namespace

Parameters:

user - the given user being checked

namespaceCode - the specified namespace

workflowDocumentTypeName - the workflow document type name of the document being claimed

Returns:

true if the user has permisson to claim electronic payment; otherwise, false