org.kuali.kfs.sys.service.impl
Class ElectronicPaymentClaimingDocumentGenerationStrategyImpl

java.lang.Object
  org.kuali.kfs.sys.service.impl.ElectronicPaymentClaimingDocumentGenerationStrategyImpl

All Implemented Interfaces:

ElectronicPaymentClaimingDocumentGenerationStrategy

public class ElectronicPaymentClaimingDocumentGenerationStrategyImpl
extends Object
implements ElectronicPaymentClaimingDocumentGenerationStrategy

for those cases when admins claim a payment without an associated document

Constructor Summary

ElectronicPaymentClaimingDocumentGenerationStrategyImpl()

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	getDocumentCode()
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
void	setElectronicPaymentClaimingService(ElectronicPaymentClaimingService electronicPaymentClaimingService) Sets the electronicPaymentClaimingService attribute value.
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

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ElectronicPaymentClaimingDocumentGenerationStrategyImpl

public ElectronicPaymentClaimingDocumentGenerationStrategyImpl()

Method Detail

createDocumentFromElectronicPayments

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

Description copied from interface: ElectronicPaymentClaimingDocumentGenerationStrategy

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

Specified by:

createDocumentFromElectronicPayments in interface ElectronicPaymentClaimingDocumentGenerationStrategy

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

See Also:

ElectronicPaymentClaimingDocumentGenerationStrategy.createDocumentFromElectronicPayments(java.util.List, org.kuali.rice.kim.bo.Person)

getDocumentCode

public String getDocumentCode()

See Also:

org.kuali.kfs.sys.service.ElectronicPaymentClaimingDocumentGenerationStrategy#getDocumentCode()

getDocumentLabel

public String getDocumentLabel()

Description copied from interface: ElectronicPaymentClaimingDocumentGenerationStrategy

Returns the label which will identify the claiming document to users

Specified by:

getDocumentLabel in interface ElectronicPaymentClaimingDocumentGenerationStrategy

Returns:

a label

See Also:

ElectronicPaymentClaimingDocumentGenerationStrategy.getDocumentLabel()

getClaimingDocumentWorkflowDocumentType

public String getClaimingDocumentWorkflowDocumentType()

Description copied from interface: ElectronicPaymentClaimingDocumentGenerationStrategy

get the workflow document type code of the claiming document

Specified by:

getClaimingDocumentWorkflowDocumentType in interface ElectronicPaymentClaimingDocumentGenerationStrategy

Returns:

the workflow document type code of the claiming document

See Also:

return null in the case of no document available

isDocumentReferenceValid

public boolean isDocumentReferenceValid(String referenceDocumentNumber)

Description copied from interface: ElectronicPaymentClaimingDocumentGenerationStrategy

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

Specified by:

isDocumentReferenceValid in interface ElectronicPaymentClaimingDocumentGenerationStrategy

Parameters:

referenceDocumentNumber - the document number reference to validate

Returns:

true if the document reference is considered valid, false otherwise

See Also:

ElectronicPaymentClaimingDocumentGenerationStrategy.isDocumentReferenceValid(java.lang.String)

userMayUseToClaim

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

Description copied from interface: ElectronicPaymentClaimingDocumentGenerationStrategy

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

Specified by:

userMayUseToClaim in interface ElectronicPaymentClaimingDocumentGenerationStrategy

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

See Also:

ElectronicPaymentClaimingDocumentGenerationStrategy.userMayUseToClaim(org.kuali.rice.kim.bo.Person)

setElectronicPaymentClaimingService

public void setElectronicPaymentClaimingService(ElectronicPaymentClaimingService electronicPaymentClaimingService)

Sets the electronicPaymentClaimingService attribute value.

Parameters:

electronicPaymentClaimingService - The electronicPaymentClaimingService to set.