org.kuali.ole.module.purap.document.web.struts

Class LineItemReceivingForm

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.module.purap.document.web.struts.ReceivingFormBase

org.kuali.ole.module.purap.document.web.struts.LineItemReceivingForm

All Implemented Interfaces:

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

Direct Known Subclasses:

OleLineItemReceivingForm

public class LineItemReceivingForm
extends ReceivingFormBase

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 boolean	fromPurchaseOrder
protected Boolean	hideAddUnorderedItem
protected LineItemReceivingItem	newLineItemReceivingItemLine
protected Integer	purchaseOrderId

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
LineItemReceivingForm() Constructs a LineItemReceivingForm instance and sets up the appropriately casted document.

Method Summary

Methods

Modifier and Type	Method and Description
protected boolean	canCreateCorrection()
protected Map<String,org.kuali.rice.kns.web.ui.ExtraButton>	createButtonsMap() Creates a MAP for all the buttons to appear on the Receiving Line Form, and sets the attributes of these buttons.
LineItemReceivingItem	getAndResetNewReceivingItemLine() Returns the new Receiving Item Line and resets it to null.
protected String	getDefaultDocumentTypeName()
List<org.kuali.rice.kns.web.ui.ExtraButton>	getExtraButtons() Override the superclass method to add appropriate buttons for LineItemReceivingDocument.
Boolean	getHideAddUnorderedItem()
LineItemReceivingDocument	getLineItemReceivingDocument()
LineItemReceivingItem	getNewLineItemReceivingItemLine()
Integer	getPurchaseOrderId()
boolean	isAbleToShowClearAndLoadQtyButtons() Indicates if the clear and load quantity buttons can be shown, according to the value of a system parameter.
boolean	isFromPurchaseOrder()
void	populateHeaderFields(org.kuali.rice.kew.api.WorkflowDocument workflowDocument) This method is used to populate the list of header field objects (see KualiForm.getDocInfo()) displayed on the Kuali document form display pages.
void	setFromPurchaseOrder(boolean fromPurchaseOrder)
void	setHideAddUnorderedItem(Boolean hideAddUnorderedItem)
void	setLineItemReceivingDocument(LineItemReceivingDocument lineItemReceivingDocument)
void	setNewLineItemReceivingItemLine(LineItemReceivingItem newLineItemReceivingItemLine)
void	setPurchaseOrderId(Integer purchaseOrderId)
LineItemReceivingItem	setupNewLineItemReceivingItemLine()
LineItemReceivingItem	setupNewReceivingItemLine() This method should be overriden (or see accountingLines for an alternate way of doing this with newInstance)
boolean	shouldGiveAddUnorderedItemWarning() Indicates if a warning should be given when users click "add unordered item" button, according to the system parameter.

Methods inherited from class org.kuali.ole.module.purap.document.web.struts.ReceivingFormBase

isStateFinal

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

extendDocInfoToThreeColumns, generateErrorCorrectionButton

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

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

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

addRequiredNonEditableProperties, buildHtmlLink, customInitMaxUploadSizes, 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, getRefreshCaller, 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

purchaseOrderId

protected Integer purchaseOrderId

newLineItemReceivingItemLine

protected LineItemReceivingItem newLineItemReceivingItemLine

fromPurchaseOrder

protected boolean fromPurchaseOrder

hideAddUnorderedItem

protected Boolean hideAddUnorderedItem

Constructor Detail

LineItemReceivingForm

public LineItemReceivingForm()

Constructs a LineItemReceivingForm instance and sets up the appropriately casted document.

Method Detail

getDefaultDocumentTypeName

protected String getDefaultDocumentTypeName()

Overrides:

getDefaultDocumentTypeName in class KualiDocumentFormBase

getLineItemReceivingDocument

public LineItemReceivingDocument getLineItemReceivingDocument()

setLineItemReceivingDocument

public void setLineItemReceivingDocument(LineItemReceivingDocument lineItemReceivingDocument)

getPurchaseOrderId

public Integer getPurchaseOrderId()

setPurchaseOrderId

public void setPurchaseOrderId(Integer purchaseOrderId)

setupNewLineItemReceivingItemLine

public LineItemReceivingItem setupNewLineItemReceivingItemLine()

getNewLineItemReceivingItemLine

public LineItemReceivingItem getNewLineItemReceivingItemLine()

setNewLineItemReceivingItemLine

public void setNewLineItemReceivingItemLine(LineItemReceivingItem newLineItemReceivingItemLine)

populateHeaderFields

public void populateHeaderFields(org.kuali.rice.kew.api.WorkflowDocument workflowDocument)

Description copied from class: KualiDocumentFormBase

This method is used to populate the list of header field objects (see KualiForm.getDocInfo()) displayed on the Kuali document form display pages.

Overrides:

populateHeaderFields in class FinancialSystemTransactionalDocumentFormBase

Parameters:

workflowDocument - - the workflow document of the document being displayed (null is allowed)

See Also:

KRAD Conversion: Customizing the header fields - Uses data dictionary

getExtraButtons

public List<org.kuali.rice.kns.web.ui.ExtraButton> getExtraButtons()

Override the superclass method to add appropriate buttons for LineItemReceivingDocument.

Overrides:

getExtraButtons in class FinancialSystemTransactionalDocumentFormBase

See Also:

KualiForm.getExtraButtons()

canCreateCorrection

protected boolean canCreateCorrection()

createButtonsMap

protected Map<String,org.kuali.rice.kns.web.ui.ExtraButton> createButtonsMap()

Creates a MAP for all the buttons to appear on the Receiving Line Form, and sets the attributes of these buttons.

Returns:

the button map created.

getAndResetNewReceivingItemLine

public LineItemReceivingItem getAndResetNewReceivingItemLine()

Returns the new Receiving Item Line and resets it to null.

Returns:

the new Receiving Item Line.

setupNewReceivingItemLine

public LineItemReceivingItem setupNewReceivingItemLine()

This method should be overriden (or see accountingLines for an alternate way of doing this with newInstance)

isAbleToShowClearAndLoadQtyButtons

public boolean isAbleToShowClearAndLoadQtyButtons()

Indicates if the clear and load quantity buttons can be shown, according to the value of a system parameter.

Returns:

shouldGiveAddUnorderedItemWarning

public boolean shouldGiveAddUnorderedItemWarning()

Indicates if a warning should be given when users click "add unordered item" button, according to the system parameter.

Returns:

true if the parameter says YES; otherwise faluse.

isFromPurchaseOrder

public boolean isFromPurchaseOrder()

setFromPurchaseOrder

public void setFromPurchaseOrder(boolean fromPurchaseOrder)

getHideAddUnorderedItem

public Boolean getHideAddUnorderedItem()

setHideAddUnorderedItem

public void setHideAddUnorderedItem(Boolean hideAddUnorderedItem)