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

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

All Implemented Interfaces:

ElectronicFundTransferActionHelper

public class ElectronicFundTransferClaimActionHelper
extends Object
implements ElectronicFundTransferActionHelper

An Electronic Funds Transfer action which claims the electronic payment claims in a form and redirects to the claiming document.

Field Summary

protected static String	ACTION_NAME
protected static String	BASIC_FORWARD
protected static String	CHOSEN_DOCUMENT_PROPERTY
protected static String	CLAIM_PROPERTY
protected static String	HAS_DOCUMENTATION_PROPERTY
protected static String	PORTAL_FORWARD

Constructor Summary

ElectronicFundTransferClaimActionHelper()

Method Summary

protected boolean	checkChosenDocumentType(String chosenDoc) Verifies that the chosenElectronicPaymentClaimingDocumentCode has been filled in.
protected Set<String>	generatePreClaimedByCheckboxSet(List<ElectronicPaymentClaimClaimedHelper> checkboxHelpers) Uses the list of checked pre-claimed checkbox helpers to create a Set of representations of electronic payment claim records that were marked as "pre-claimed"
protected ElectronicPaymentClaimingDocumentGenerationStrategy	getRequestedClaimingHelper(String chosenDoc, List<ElectronicPaymentClaimingDocumentGenerationStrategy> availableClaimingDocs, org.kuali.rice.kim.bo.Person currentUser) Using user entered form values, determines which of the available ElectronicPaymentClaimingDocumentGenerationStrategy implementations to use.
protected boolean	handleDocumentationForClaim(String hasDocumentation) Checks that the user was able to answer the "has documentation?" question correctly
protected List<ElectronicPaymentClaim>	handlePreClaimedRecords(List<ElectronicPaymentClaim> claims, Set<String> preClaimedByCheckbox, List<ElectronicPaymentClaimingDocumentGenerationStrategy> documentGenerationStrategies) Administrative users can fill in a field that says that a given electronic payment claim has already been claimed by another document.
org.apache.struts.action.ActionForward	performAction(ElectronicFundTransferForm form, org.apache.struts.action.ActionMapping mapping, Map paramMap, String basePath) Claims the ElectronicPaymentClaim records with a document and then redirects to that docment.
void	setBusinessObjectService(org.kuali.rice.kns.service.BusinessObjectService boService) Sets the boService attribute value.
void	setDataDictonaryService(org.kuali.rice.kns.service.DataDictionaryService ddService) Sets the ddService attribute value.
void	setDocumentService(org.kuali.rice.kns.service.DocumentService documentService) Sets the documentService attribute value.
void	setElectronicPaymentClaimingService(ElectronicPaymentClaimingService electronicPaymentClaimingService) Sets the electronicPaymentClaimingService attribute value.

Methods inherited from class java.lang.Object

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

Field Detail

ACTION_NAME

protected static final String ACTION_NAME

See Also:

Constant Field Values

CHOSEN_DOCUMENT_PROPERTY

protected static final String CHOSEN_DOCUMENT_PROPERTY

See Also:

Constant Field Values

CLAIM_PROPERTY

protected static final String CLAIM_PROPERTY

See Also:

Constant Field Values

HAS_DOCUMENTATION_PROPERTY

protected static final String HAS_DOCUMENTATION_PROPERTY

See Also:

Constant Field Values

BASIC_FORWARD

protected static final String BASIC_FORWARD

See Also:

Constant Field Values

PORTAL_FORWARD

protected static final String PORTAL_FORWARD

See Also:

Constant Field Values

Constructor Detail

ElectronicFundTransferClaimActionHelper

public ElectronicFundTransferClaimActionHelper()

Method Detail

performAction

public org.apache.struts.action.ActionForward performAction(ElectronicFundTransferForm form,
                                                            org.apache.struts.action.ActionMapping mapping,
                                                            Map paramMap,
                                                            String basePath)

Claims the ElectronicPaymentClaim records with a document and then redirects to that docment.

Specified by:

performAction in interface ElectronicFundTransferActionHelper

Parameters:

form - the form that the action is to perform on

mapping - the action mappings to return to

basePath - the basePath of the request

Returns:

the ActionForward that represents where the controller should next redirect to

See Also:

org.kuali.kfs.sys.service.ElectronicFundTransferActionHelper#performAction(org.kuali.rice.kns.web.struts.form.KualiForm, org.apache.struts.action.ActionMapping)

checkChosenDocumentType

protected boolean checkChosenDocumentType(String chosenDoc)

Verifies that the chosenElectronicPaymentClaimingDocumentCode has been filled in.

Parameters:

chosenDoc - the value of chosenElectronicPaymentClaimingDocumentCode from the form

Returns:

true if the validation resulted in no errors, false if otherwise

getRequestedClaimingHelper

protected ElectronicPaymentClaimingDocumentGenerationStrategy getRequestedClaimingHelper(String chosenDoc,
                                                                                         List<ElectronicPaymentClaimingDocumentGenerationStrategy> availableClaimingDocs,
                                                                                         org.kuali.rice.kim.bo.Person currentUser)

Using user entered form values, determines which of the available ElectronicPaymentClaimingDocumentGenerationStrategy implementations to use.

Parameters:

chosenDoc - the document type code for the doc that the user selected

availableClaimingDocs - a List of ElectronicPaymentClaimingDocumentGenerationStrategy implementations that can be used by the given user

currentUser - the currently logged in user

Returns:

an ElectronicPaymentClaimingDocumentGenerationStrategy helper to use to create the document

Throws:

org.kuali.rice.kns.exception.AuthorizationException - thrown if the user entered an invalid or unusable ElectronicPaymentClaimingDocumentGenerationStrategy code

handlePreClaimedRecords

protected List<ElectronicPaymentClaim> handlePreClaimedRecords(List<ElectronicPaymentClaim> claims,
                                                               Set<String> preClaimedByCheckbox,
                                                               List<ElectronicPaymentClaimingDocumentGenerationStrategy> documentGenerationStrategies)

Administrative users can fill in a field that says that a given electronic payment claim has already been claimed by another document. This method traverses through the list of electronic payment claims, checks if it is pre-claimed, and saves it if it is pre-claimed

Parameters:

claims - the list of electronic payment claims

Returns:

the list of electronic payment claims with all pre-claimed records removed

generatePreClaimedByCheckboxSet

protected Set<String> generatePreClaimedByCheckboxSet(List<ElectronicPaymentClaimClaimedHelper> checkboxHelpers)

Uses the list of checked pre-claimed checkbox helpers to create a Set of representations of electronic payment claim records that were marked as "pre-claimed"

Parameters:

checkboxHelpers - the list of checked ElectronicPaymentClaimClaimedHelpers from the form

Returns:

a Set of electronic payment claim representations for records that have been reclaimed

handleDocumentationForClaim

protected boolean handleDocumentationForClaim(String hasDocumentation)

Checks that the user was able to answer the "has documentation?" question correctly

Parameters:

hasDocumentation - the user's response to the "has documentation" question

Returns:

true if the user was able to successfully answer this question, false otherwise

setDataDictonaryService

public void setDataDictonaryService(org.kuali.rice.kns.service.DataDictionaryService ddService)

Sets the ddService attribute value.

Parameters:

ddService - The ddService to set.

setElectronicPaymentClaimingService

public void setElectronicPaymentClaimingService(ElectronicPaymentClaimingService electronicPaymentClaimingService)

Sets the electronicPaymentClaimingService attribute value.

Parameters:

electronicPaymentClaimingService - The electronicPaymentClaimingService to set.

setBusinessObjectService

public void setBusinessObjectService(org.kuali.rice.kns.service.BusinessObjectService boService)

Sets the boService attribute value.

Parameters:

boService - The boService to set.

setDocumentService

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

Sets the documentService attribute value.

Parameters:

documentService - The documentService to set.