org.kuali.kfs.sys.service
Interface ElectronicPaymentClaimingDocumentGenerationStrategy

All Known Implementing Classes:

CashControlElectronicPaymentClaimingHelperImpl, DistributionOfIncomeAndExpenseElectronicPaymentClaimingHelperStrategyImpl, ElectronicPaymentClaimingDocumentGenerationStrategyImpl, YearEndDistributionOfIncomeAndExpenseElectronicPaymentClaimingHelperStrategyImpl

public interface ElectronicPaymentClaimingDocumentGenerationStrategy

A set of methods that help the ElectronicPaymentClaimingService turn a list of ElectronicPaymentClaim records into a document used to claim those records.

See Also:

ElectronicPaymentClaimingService, ElectronicPaymentClaim

Method Summary

String	createDocumentFromElectronicPayments(List<ElectronicPaymentClaim> electronicPayments, org.kuali.rice.kim.bo.Person user) Creates a document to claim a given list of ElectronicPaymentClaim records.
String	getClaimingDocumentWorkflowDocumentType() get the workflow document type code of the claiming document
String	getDocumentLabel() Returns the label which will identify the claiming document to users
boolean	isDocumentReferenceValid(String referenceDocumentNumber) Determines whether the given document number would be considered valid by the system that the document this strategy interacts with
boolean	userMayUseToClaim(org.kuali.rice.kim.bo.Person claimingUser) Determines if the given user can use the document wrapped by this ElectronicPaymentClaimingDocumentGenerationStrategy implementaton to claim any ElectronicPaymentClaim records

Method Detail

getDocumentLabel

String getDocumentLabel()

Returns the label which will identify the claiming document to users

Returns:

a label

getClaimingDocumentWorkflowDocumentType

String getClaimingDocumentWorkflowDocumentType()

get the workflow document type code of the claiming document

Returns:

the workflow document type code of the claiming document

userMayUseToClaim

boolean userMayUseToClaim(org.kuali.rice.kim.bo.Person claimingUser)

Determines if the given user can use the document wrapped by this ElectronicPaymentClaimingDocumentGenerationStrategy implementaton to claim any ElectronicPaymentClaim records

Parameters:

claimingUser - the user attempting to claim ElectronicPaymentClaim records with a document

Returns:

true if the user can use this kind of document to claim ElectronicPaymentClaim records, false otherwise

createDocumentFromElectronicPayments

String createDocumentFromElectronicPayments(List<ElectronicPaymentClaim> electronicPayments,
                                            org.kuali.rice.kim.bo.Person user)

Creates a document to claim a given list of ElectronicPaymentClaim records.

Parameters:

electronicPayments - a List of ElectronicPaymentClaim records

user - the user doing the claiming

Returns:

the absolute URL that should be redirected to, so that the user can edit the document

isDocumentReferenceValid

boolean isDocumentReferenceValid(String referenceDocumentNumber)

Determines whether the given document number would be considered valid by the system that the document this strategy interacts with

Parameters:

referenceDocumentNumber - the document number reference to validate

Returns:

true if the document reference is considered valid, false otherwise