org.kuali.kfs.module.ar.document.service.impl
Class CashControlElectronicPaymentClaimingHelperImpl

java.lang.Object
  org.kuali.kfs.module.ar.document.service.impl.CashControlElectronicPaymentClaimingHelperImpl

All Implemented Interfaces:

ElectronicPaymentClaimingDocumentGenerationStrategy

public class CashControlElectronicPaymentClaimingHelperImpl
extends Object
implements ElectronicPaymentClaimingDocumentGenerationStrategy

Field Summary

protected static String	CC_WORKFLOW_DOCUMENT_TYPE
protected static String	URL_DOC_TYPE
protected static String	URL_MIDDLE
protected static String	URL_PREFIX
protected static String	URL_SUFFIX

Constructor Summary

CashControlElectronicPaymentClaimingHelperImpl()

Method Summary

protected void	addCashControlDetailsToDocument(CashControlDocument document, List<ElectronicPaymentClaim> electronicPayments) This method adds new cash control details to the cash control document based on the list of electronic payments.
protected void	addDescriptionToDocument(CashControlDocument document) This method add a description to the cash control document
protected void	addNotesToDocument(CashControlDocument claimingDoc, List<ElectronicPaymentClaim> claims, org.kuali.rice.kim.bo.Person user) This method adds notes to the cash control document
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
protected String	getURLForDocument(CashControlDocument doc) Builds the URL that can be used to redirect to the correct document
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	setCashControlDocumentService(CashControlDocumentService cashControlDocumentService) This method sets cashControlDocumentService value
void	setDataDictionaryService(org.kuali.rice.kns.service.DataDictionaryService dataDictionaryService) This method sets dataDictionaryService value
void	setDocumentService(org.kuali.rice.kns.service.DocumentService documentService) This method sets document service value
void	setElectronicPaymentClaimingService(ElectronicPaymentClaimingService electronicPaymentClaimingService) This method sets electronicPaymentClaimingService value
void	setKualiConfigurationService(org.kuali.rice.kns.service.KualiConfigurationService kualiConfigurationService) This method sets kualiConfigurationService
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

Field Detail

CC_WORKFLOW_DOCUMENT_TYPE

protected static final String CC_WORKFLOW_DOCUMENT_TYPE

See Also:

Constant Field Values

URL_PREFIX

protected static final String URL_PREFIX

See Also:

Constant Field Values

URL_MIDDLE

protected static final String URL_MIDDLE

See Also:

Constant Field Values

URL_SUFFIX

protected static final String URL_SUFFIX

See Also:

Constant Field Values

URL_DOC_TYPE

protected static final String URL_DOC_TYPE

See Also:

Constant Field Values

Constructor Detail

CashControlElectronicPaymentClaimingHelperImpl

public CashControlElectronicPaymentClaimingHelperImpl()

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)

addDescriptionToDocument

protected void addDescriptionToDocument(CashControlDocument document)

This method add a description to the cash control document

Parameters:

document - the cash control document

addNotesToDocument

protected void addNotesToDocument(CashControlDocument claimingDoc,
                                  List<ElectronicPaymentClaim> claims,
                                  org.kuali.rice.kim.bo.Person user)

This method adds notes to the cash control document

Parameters:

claimingDoc - the cash control document

claims - the list of electronic payments being claimed

user - the current user

addCashControlDetailsToDocument

protected void addCashControlDetailsToDocument(CashControlDocument document,
                                               List<ElectronicPaymentClaim> electronicPayments)
                                        throws org.kuali.rice.kew.exception.WorkflowException

This method adds new cash control details to the cash control document based on the list of electronic payments.

Parameters:

document - cash control document

electronicPayments - the electronic payments to be claimed

Throws:

org.kuali.rice.kew.exception.WorkflowException - workflow exception

getURLForDocument

protected String getURLForDocument(CashControlDocument doc)

Builds the URL that can be used to redirect to the correct document

Parameters:

doc - the document to build the URL for

Returns:

the relative URL to redirect to

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 name CashControlDocument workflow document type

See Also:

ElectronicPaymentClaimingDocumentGenerationStrategy.getClaimingDocumentWorkflowDocumentType()

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()

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)

setCashControlDocumentService

public void setCashControlDocumentService(CashControlDocumentService cashControlDocumentService)

This method sets cashControlDocumentService value

Parameters:

cashControlDocumentService -

setDocumentService

public void setDocumentService(org.kuali.rice.kns.service.DocumentService documentService)

This method sets document service value

Parameters:

documentService -

setElectronicPaymentClaimingService

public void setElectronicPaymentClaimingService(ElectronicPaymentClaimingService electronicPaymentClaimingService)

This method sets electronicPaymentClaimingService value

Parameters:

electronicPaymentClaimingService -

setDataDictionaryService

public void setDataDictionaryService(org.kuali.rice.kns.service.DataDictionaryService dataDictionaryService)

This method sets dataDictionaryService value

Parameters:

dataDictionaryService -

setKualiConfigurationService

public void setKualiConfigurationService(org.kuali.rice.kns.service.KualiConfigurationService kualiConfigurationService)

This method sets kualiConfigurationService

Parameters:

kualiConfigurationService -