org.kuali.ole.fp.document.web.struts

Class ProcurementCardForm

java.lang.Object

org.apache.struts.action.ActionForm

org.kuali.rice.kns.web.struts.form.pojo.PojoFormBase

org.kuali.rice.kns.web.struts.form.KualiForm

org.kuali.rice.kns.web.struts.form.KualiDocumentFormBase

org.kuali.rice.kns.web.struts.form.KualiTransactionalDocumentFormBase

org.kuali.ole.sys.document.web.struts.FinancialSystemTransactionalDocumentFormBase

org.kuali.ole.sys.web.struts.KualiAccountingDocumentFormBase

org.kuali.ole.fp.document.web.struts.CapitalAssetInformationFormBase

org.kuali.ole.fp.document.web.struts.CapitalAccountingLinesFormBase

org.kuali.ole.fp.document.web.struts.ProcurementCardForm

All Implemented Interfaces:

Serializable, CapitalAssetEditable, org.kuali.rice.kns.web.struts.form.pojo.PojoForm

public class ProcurementCardForm
extends CapitalAccountingLinesFormBase
implements CapitalAssetEditable

This class is the form class for the ProcurementCard document. This method extends the parent KualiTransactionalDocumentFormBase class which contains all of the common form methods and form attributes needed by the Procurment Card document.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.kuali.rice.kns.web.struts.form.KualiForm

org.kuali.rice.kns.web.struts.form.KualiForm.TabState

Field Summary

Fields

Modifier and Type	Field and Description
protected List<CapitalAssetInformation>	capitalAssetInformation
protected List<ProcurementCardTargetAccountingLine>	newTargetLines
protected static long	serialVersionUID
protected static String	TARGET_ACCOUNTING_LINE_GROUP_NAME
protected List<Boolean>	transactionCreditCardNumbersViewStatus

Fields inherited from class org.kuali.ole.fp.document.web.struts.CapitalAccountingLinesFormBase

capitalAccountingLine, createdAssetsControlAmount, distributeEqualAmount, editCreateOrModify, systemControlAmount

Fields inherited from class org.kuali.ole.fp.document.web.struts.CapitalAssetInformationFormBase

LOG, lookedUpCollectionName, lookupResultsBOClassName, lookupResultsSequenceNumber

Fields inherited from class org.kuali.ole.sys.web.struts.KualiAccountingDocumentFormBase

editableAccounts, forcedLookupOptionalFields, hideDetails, newSourceLine, newTargetLine, sourceFile, targetFile

Fields inherited from class org.kuali.rice.kns.web.struts.form.KualiTransactionalDocumentFormBase

forcedReadOnlyFields

Fields inherited from class org.kuali.rice.kns.web.struts.form.KualiDocumentFormBase

adHocActionRequestCodes, attachmentFile, documentActions, editingMode, suppressAllButtons

Fields inherited from class org.kuali.rice.kns.web.struts.form.KualiForm

extraButtons

Fields inherited from class org.kuali.rice.kns.web.struts.form.pojo.PojoFormBase

requiredNonEditableProperties

Fields inherited from class org.apache.struts.action.ActionForm

multipartRequestHandler, servlet

Constructor Summary

Constructors

Constructor and Description
ProcurementCardForm() Constructs a ProcurmentCardForm instance and sets up the appropriately casted document.

Method Summary

Methods

Modifier and Type	Method and Description
void	buildNewTargetAccountingLines(int transactionsCount)
protected AccountingLineAuthorizer	getAccountingLineAuthorizerForDocument()
protected String	getAccountingLineCollectionName()
List<CapitalAssetInformation>	getCapitalAssetInformation() Gets the capitalAssetInformation attribute.
protected String	getDefaultDocumentTypeName()
String	getDisputeURL()
List	getNewTargetLines()
List<Boolean>	getTransactionCreditCardNumbersViewStatus()
void	populate(javax.servlet.http.HttpServletRequest request) Override to accomodate multiple target lines.
protected void	populateTransactionCreditCardNumbersViewStatuses() populates an array, parallel to the ProcurementCardDocument#getTransactionEntries, which holds whether the current user can see the credit card number or not - based on if any of the accounting lines are editable to the user or not...
void	setCapitalAssetInformation(List<CapitalAssetInformation> capitalAssetInformation) Sets the capitalAssetInformation attribute.
void	setNewTargetLines(List newTargetLines)

Methods inherited from class org.kuali.ole.fp.document.web.struts.CapitalAccountingLinesFormBase

getCapitalAccountingLine, getCreatedAssetsControlAmount, getSystemControlAmount, isDistributeEqualAmount, isEditCreateOrModify, setCapitalAccountingLine, setCreatedAssetsControlAmount, setDistributeEqualAmount, setEditCreateOrModify, setSystemControlAmount

Methods inherited from class org.kuali.ole.fp.document.web.struts.CapitalAssetInformationFormBase

addRequiredNonEditableProperties, getLookedUpCollectionName, getLookupResultsBOClassName, getLookupResultsSequenceNumber, getRefreshCaller, setLookedUpCollectionName, setLookupResultsBOClassName, setLookupResultsSequenceNumber

Methods inherited from class org.kuali.ole.sys.web.struts.KualiAccountingDocumentFormBase

createNewSourceAccountingLine, createNewTargetAccountingLine, customInitMaxUploadSizes, getAccountingLineImportInstructionsUrl, getCurrencyFormattedSourceTotal, getCurrencyFormattedTargetTotal, getEditableAccounts, getExcludedmethodToCall, getFinancialDocument, getForcedLookupOptionalFields, getHideDetails, getNewSourceLine, getNewTargetLine, getSourceFile, getTargetFile, harvestAccountingLines, isHideDetails, populateAccountingLine, populateAccountingLines, populateAccountingLinesForResponse, populateSourceAccountingLine, populateTargetAccountingLine, repopulateOverrides, setEditableAccounts, setForcedLookupOptionalFields, setHideDetails, setNewSourceLine, setNewTargetLine, setSourceFile, setTargetFile, shouldMethodToCallParameterBeUsed

Methods inherited from class org.kuali.ole.sys.document.web.struts.FinancialSystemTransactionalDocumentFormBase

extendDocInfoToThreeColumns, generateErrorCorrectionButton, getExtraButtons, populateHeaderFields

Methods inherited from class org.kuali.rice.kns.web.struts.form.KualiTransactionalDocumentFormBase

discoverDocumentTypeName, formatReversalDate, getForcedReadOnlyFields, getTransactionalDocument, instantiateTransactionalDocumentByDocumentTypeName, populateEmptyMultiSelect, populateFalseCheckboxes, populationSpecialEmptyFields, setForcedReadOnlyFields

Methods inherited from class org.kuali.rice.kns.web.struts.form.KualiDocumentFormBase

buildHtmlLink, getActionRequests, getActionRequestsRequiringApproval, getAdditionalScriptFile, getAdditionalScriptFiles, getAdHocActionRequestCodes, getAdHocRoutePerson, getAdHocRoutePersons, getAdHocRouteWorkgroup, getAdHocRouteWorkgroups, getAnnotation, getAttachmentFile, getBoNotes, getCommand, getDocId, getDocNum, getDocTypeName, getDocument, getDocumentActions, getDocumentHandlerUrl, getEditingMode, getFormKey, getInitiator, getInitiatorNetworkId, getMessageMapFromPreviousRequest, getNewAdHocRoutePerson, getNewAdHocRouteWorkgroup, getNewNote, getPersonInquiryUrlLink, getSelectedActionRequests, getStandardHeaderFields, getSuperUserAnnotation, getWorkflowDocument, hasDocumentId, initializeHeaderNavigationTabs, instantiateDocument, isDocumentEnRoute, isFormDocumentInitialized, isHasWorkflowDocument, isReturnToActionList, isStateAllowsApproveOrDisapprove, isStateAllowsApproveSingleActionRequest, isStateInitiatedFinalCancelled, isStateProcessedOrDisapproved, isSuperUserActionAvaliable, isSuperUserApproveDocumentAuthorized, isSuperUserApproveSingleActionRequestAuthorized, isSuperUserAuthorized, isSuperUserDisapproveDocumentAuthorized, isSuppressAllButtons, isUserDocumentInitiator, reset, setActionRequests, setAdditionalScriptFile, setAdditionalScriptFiles, setAdHocActionRequestCodes, setAdHocRoutePersons, setAdHocRouteWorkgroups, setAnnotation, setAttachmentFile, setBoNotes, setCommand, setDerivedValuesOnForm, setDocId, setDocNum, setDocTypeName, setDocument, setDocumentActions, setEditingMode, setFormKey, setMessageMapFromPreviousRequest, setNewAdHocRoutePerson, setNewAdHocRouteWorkgroup, setNewNote, setReturnToActionList, setSelectedActionRequests, setSuperUserAnnotation, setSuppressAllButtons, shouldPropertyBePopulatedInForm, validate

Methods inherited from class org.kuali.rice.kns.web.struts.form.KualiForm

clearEditablePropertyInformation, getActionFormUtilMap, getAnchor, getBackLocation, getCurrentTabIndex, getDisplayedErrors, getDisplayedInfo, getDisplayedWarnings, getDocInfo, getExtraButton, getFieldNameToFocusOnAfterSubmit, getHeaderNavigationTabs, getMethodToCall, getNavigationCss, getNextArbitrarilyHighIndex, getNumColumns, getTabState, getTabStates, incrementTabIndex, isFieldLevelHelpEnabled, populateBackLocation, populateFieldLevelHelpEnabled, reset, retrieveFormValueForLookupInquiryParameters, setActionFormUtilMap, setAnchor, setBackLocation, setCurrentTabIndex, setDocInfo, setExtraButton, setExtraButtons, setFieldLevelHelpEnabled, setFieldNameToFocusOnAfterSubmit, setHeaderNavigationTabs, setMethodToCall, setNavigationCss, setNumColumns, setRefreshCaller, setTabStates

Methods inherited from class org.kuali.rice.kns.web.struts.form.pojo.PojoFormBase

addMaxUploadSize, cacheUnconvertedValue, copyPopulateEditablePropertiesToActionEditableProperties, formatterClassForKeypath, formatValue, getActionEditablePropertiesGuid, getEditableProperties, getFormatter, getFormatterTypes, getIsNewForm, getMaxUploadSizes, getMethodToCallsToBypassSessionRetrievalForGETRequests, getParameter, getParameterValues, getPopulateEditableProperties, getPopulateEditablePropertiesGuid, getPropertyType, getRequiredNonEditableProperties, getStrutsActionMappingScope, getUnconvertedValues, getUnknownKeys, initMaxUploadSizes, isPropertyEditable, isPropertyNonEditableButRequired, populateForProperty, postprocessRequestParameters, processValidationFail, registerEditableProperty, registerIsNewForm, registerRequiredNonEditableProperty, registerStrutsActionMappingScope, setActionEditablePropertiesGuid, setFormatterType, setFormatterTypes, setPopulateEditablePropertiesGuid, setUnconvertedValues

Methods inherited from class org.apache.struts.action.ActionForm

getMultipartRequestHandler, getServlet, getServletWrapper, setMultipartRequestHandler, setServlet, validate

Methods inherited from class java.lang.Object

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

Field Detail

serialVersionUID

protected static final long serialVersionUID

See Also:

Constant Field Values

newTargetLines

protected List<ProcurementCardTargetAccountingLine> newTargetLines

transactionCreditCardNumbersViewStatus

protected List<Boolean> transactionCreditCardNumbersViewStatus

TARGET_ACCOUNTING_LINE_GROUP_NAME

protected static final String TARGET_ACCOUNTING_LINE_GROUP_NAME

See Also:

Constant Field Values

capitalAssetInformation

protected List<CapitalAssetInformation> capitalAssetInformation

Constructor Detail

ProcurementCardForm

public ProcurementCardForm()

Constructs a ProcurmentCardForm instance and sets up the appropriately casted document. Also, the newSourceLine needs to be the extended ProcurementCardSourceAccountingLine, for the additional trans line nbr.

Method Detail

populate

public void populate(javax.servlet.http.HttpServletRequest request)

Override to accomodate multiple target lines.

Specified by:

populate in interface org.kuali.rice.kns.web.struts.form.pojo.PojoForm

Overrides:

populate in class KualiAccountingDocumentFormBase

See Also:

org.kuali.rice.kns.web.struts.pojo.PojoForm#populate(javax.servlet.http.HttpServletRequest)

buildNewTargetAccountingLines

public void buildNewTargetAccountingLines(int transactionsCount)

getDefaultDocumentTypeName

protected String getDefaultDocumentTypeName()

Overrides:

getDefaultDocumentTypeName in class KualiDocumentFormBase

getDisputeURL

public String getDisputeURL()

Returns:

The retreived APC string used for the dispute url.

getNewTargetLines

public List getNewTargetLines()

Returns:

Returns the newTargetLines.

setNewTargetLines

public void setNewTargetLines(List newTargetLines)

Parameters:

newTargetLines - The newTargetLines to set.

getCapitalAssetInformation

public List<CapitalAssetInformation> getCapitalAssetInformation()

Description copied from interface: CapitalAssetEditable

Gets the capitalAssetInformation attribute.

Specified by:

getCapitalAssetInformation in interface CapitalAssetEditable

Returns:

Returns the capitalAssetInformation.

See Also:

CapitalAssetEditable.getCapitalAssetInformation()

setCapitalAssetInformation

public void setCapitalAssetInformation(List<CapitalAssetInformation> capitalAssetInformation)

Description copied from interface: CapitalAssetEditable

Sets the capitalAssetInformation attribute.

Specified by:

setCapitalAssetInformation in interface CapitalAssetEditable

See Also:

org.kuali.ole.fp.document.CapitalAssetEditable#setCapitalAssetInformation(org.kuali.ole.fp.businessobject.CapitalAssetInformation)

getTransactionCreditCardNumbersViewStatus

public List<Boolean> getTransactionCreditCardNumbersViewStatus()

Returns:

an array, parallel to the ProcurementCardDocument#getTransactionEntries, which holds whether the current user can see the credit card number or not

populateTransactionCreditCardNumbersViewStatuses

protected void populateTransactionCreditCardNumbersViewStatuses()

populates an array, parallel to the ProcurementCardDocument#getTransactionEntries, which holds whether the current user can see the credit card number or not - based on if any of the accounting lines are editable to the user or not...

getAccountingLineAuthorizerForDocument

protected AccountingLineAuthorizer getAccountingLineAuthorizerForDocument()

Returns:

the accounting line authorizer for the target lines of this document

getAccountingLineCollectionName

protected String getAccountingLineCollectionName()

Returns:

the name of the accounting line collection for the permission check