org.kuali.kfs.module.purap.document
Class LineItemReceivingDocument

java.lang.Object
  org.kuali.rice.kns.bo.BusinessObjectBase
      org.kuali.rice.kns.bo.PersistableBusinessObjectBase
          org.kuali.rice.kns.document.DocumentBase
              org.kuali.rice.kns.document.TransactionalDocumentBase
                  org.kuali.kfs.sys.document.FinancialSystemTransactionalDocumentBase
                      org.kuali.kfs.module.purap.document.ReceivingDocumentBase
                          org.kuali.kfs.module.purap.document.LineItemReceivingDocument

All Implemented Interfaces:

Serializable, org.apache.ojb.broker.PersistenceBrokerAware, PurapItemOperations, ReceivingDocument, FinancialSystemTransactionalDocument, org.kuali.rice.kns.bo.BusinessObject, org.kuali.rice.kns.bo.PersistableBusinessObject, org.kuali.rice.kns.document.Document, org.kuali.rice.kns.document.SessionDocument, org.kuali.rice.kns.document.TransactionalDocument

public class LineItemReceivingDocument
extends ReceivingDocumentBase

Author:

Kuali Nervous System Team (kualidev@oncourse.iu.edu)

See Also:

Serialized Form

Field Summary

protected List<LineItemReceivingItem>

items

Fields inherited from class org.kuali.kfs.module.purap.document.ReceivingDocumentBase

accountsPayablePurchasingDocumentLinkIdentifier, alternateVendorDetailAssignedIdentifier, alternateVendorHeaderGeneratedIdentifier, alternateVendorName, alternateVendorNumber, carrier, carrierCode, deliveryBuildingCode, deliveryBuildingLine1Address, deliveryBuildingLine2Address, deliveryBuildingName, deliveryBuildingOtherIndicator, deliveryBuildingRoomNumber, deliveryCampus, deliveryCampusCode, deliveryCityName, deliveryCountryCode, deliveryInstructionText, deliveryPostalCode, deliveryRequiredDate, deliveryRequiredDateReason, deliveryRequiredDateReasonCode, deliveryStateCode, deliveryToEmailAddress, deliveryToName, deliveryToPhoneNumber, lineItemReceivingStatus, lineItemReceivingStatusCode, lineItemReceivingStatusDescription, purchaseOrderDocument, purchaseOrderIdentifier, relatedViews, sensitive, shipmentBillOfLadingNumber, shipmentPackingSlipNumber, shipmentReceivedDate, shipmentReferenceNumber, vendorAddressGeneratedIdentifier, vendorCityName, vendorCountry, vendorCountryCode, vendorDetail, vendorDetailAssignedIdentifier, vendorHeaderGeneratedIdentifier, vendorLine1Address, vendorLine2Address, vendorName, vendorNumber, vendorPostalCode, vendorStateCode

Fields inherited from class org.kuali.kfs.sys.document.FinancialSystemTransactionalDocumentBase

documentHeader, LOG

Fields inherited from class org.kuali.rice.kns.document.DocumentBase

documentBusinessObject, documentNumber

Fields inherited from class org.kuali.rice.kns.bo.PersistableBusinessObjectBase

extension, versionNumber

Constructor Summary

LineItemReceivingDocument()
Default constructor.

Method Summary

void	addItem(LineItemReceivingItem item)
boolean	answerSplitNodeQuestion(String nodeName) Provides answers to the following splits: RelatesToOutstandingTransactions
List	buildListOfDeletionAwareLists()
void	clearInitFields(boolean fromPurchaseOrder) Perform logic needed to clear the initial fields on a Receiving Line Document
void	deleteItem(int lineNum)
void	doRouteLevelChange(org.kuali.rice.kew.dto.DocumentRouteLevelChangeDTO change)
void	doRouteStatusChange(org.kuali.rice.kew.dto.DocumentRouteStatusChangeDTO statusChangeEvent) This is the default implementation which checks for a different workflow statuses, and updates the Kuali status accordingly.
LineItemReceivingItem	getItem(int pos)
Class	getItemClass()
List	getItems()
org.kuali.rice.kns.util.KualiDecimal	getTotalItemReceivedGivenLineNumber(Integer lineNumber)
void	initiateDocument()
protected boolean	isAwaitingPurchaseOrderOpen()
protected void	populateDocumentDescription(PurchaseOrderDocument poDocument)
void	populateReceivingLineFromPurchaseOrder(PurchaseOrderDocument po)
void	prepareForSave(org.kuali.rice.kns.rule.event.KualiDocumentEvent event)
void	setItems(List items)
protected LinkedHashMap	toStringMapper()

Methods inherited from class org.kuali.kfs.module.purap.document.ReceivingDocumentBase

appSpecificRouteDocumentToUser, getAccountsPayablePurchasingDocumentLinkIdentifier, getAlternateVendorDetailAssignedIdentifier, getAlternateVendorHeaderGeneratedIdentifier, getAlternateVendorName, getAlternateVendorNumber, getCarrier, getCarrierCode, getCreateDateForResult, getCurrentRouteNodeName, getDeliveryBuildingCode, getDeliveryBuildingLine1Address, getDeliveryBuildingLine2Address, getDeliveryBuildingName, getDeliveryBuildingRoomNumber, getDeliveryCampus, getDeliveryCampusCode, getDeliveryCityName, getDeliveryCountryCode, getDeliveryCountryName, getDeliveryInstructionText, getDeliveryPostalCode, getDeliveryRequiredDate, getDeliveryRequiredDateReason, getDeliveryRequiredDateReasonCode, getDeliveryStateCode, getDeliveryToEmailAddress, getDeliveryToName, getDeliveryToPhoneNumber, getDocumentTitleForResult, getIsATypeOfPODoc, getIsATypeOfPurAPRecDoc, getIsATypeOfPurDoc, getIsPODoc, getIsReqsDoc, getLineItemReceivingStatus, getLineItemReceivingStatusCode, getLineItemReceivingStatusDescription, getNeedWarningRelatedPOs, getPurchaseOrderDocument, getPurchaseOrderIdentifier, getRelatedViews, getShipmentBillOfLadingNumber, getShipmentPackingSlipNumber, getShipmentReceivedDate, getShipmentReferenceNumber, getVendorAddressGeneratedIdentifier, getVendorCityName, getVendorCountry, getVendorCountryCode, getVendorDetail, getVendorDetailAssignedIdentifier, getVendorHeaderGeneratedIdentifier, getVendorLine1Address, getVendorLine2Address, getVendorName, getVendorNumber, getVendorPostalCode, getVendorStateCode, getWorkflowStatusForResult, isBoNotesSupport, isDeliveryBuildingOtherIndicator, isSensitive, setAccountsPayablePurchasingDocumentLinkIdentifier, setAlternateVendorDetailAssignedIdentifier, setAlternateVendorHeaderGeneratedIdentifier, setAlternateVendorName, setAlternateVendorNumber, setCarrier, setCarrierCode, setDeliveryBuildingCode, setDeliveryBuildingLine1Address, setDeliveryBuildingLine2Address, setDeliveryBuildingName, setDeliveryBuildingOtherIndicator, setDeliveryBuildingRoomNumber, setDeliveryCampus, setDeliveryCampusCode, setDeliveryCityName, setDeliveryCountryCode, setDeliveryInstructionText, setDeliveryPostalCode, setDeliveryRequiredDate, setDeliveryRequiredDateReason, setDeliveryRequiredDateReasonCode, setDeliveryStateCode, setDeliveryToEmailAddress, setDeliveryToName, setDeliveryToPhoneNumber, setLineItemReceivingStatus, setLineItemReceivingStatusCode, setLineItemReceivingStatusDescription, setPurchaseOrderDocument, setPurchaseOrderIdentifier, setRelatedViews, setShipmentBillOfLadingNumber, setShipmentPackingSlipNumber, setShipmentReceivedDate, setShipmentReferenceNumber, setVendorAddressGeneratedIdentifier, setVendorCityName, setVendorCountry, setVendorCountryCode, setVendorDetail, setVendorDetailAssignedIdentifier, setVendorHeaderGeneratedIdentifier, setVendorLine1Address, setVendorLine2Address, setVendorName, setVendorNumber, setVendorPostalCode, setVendorStateCode

Methods inherited from class org.kuali.kfs.sys.document.FinancialSystemTransactionalDocumentBase

getDocumentHeader, prepareForSave, processAfterRetrieve, setDocumentHeader, toErrorCorrection

Methods inherited from class org.kuali.rice.kns.document.TransactionalDocumentBase

getAllowsCopy, isSessionDocument

Methods inherited from class org.kuali.rice.kns.document.DocumentBase

addCopyErrorDocumentNote, addPessimisticLock, afterLookup, afterWorkflowEngineProcess, beforeWorkflowEngineProcess, createPropertySerializabilityEvaluator, doActionTaken, generateSaveEvents, getAdHocRoutePersons, getAdHocRouteWorkgroups, getBasePathToDocumentDuringSerialization, getCustomLockDescriptor, getDocumentBusinessObject, getDocumentNumber, getDocumentPropertySerizabilityEvaluator, getDocumentTitle, getLockClearningMethodNames, getNonLockingActionTakenCodes, getPessimisticLocks, getWorkflowEngineDocumentIdsToLock, getXmlForRouteReport, logErrors, populateDocumentForRouting, postProcessSave, refresh, refreshIfEmpty, refreshPessimisticLocks, refreshReferenceObject, serializeDocumentToXml, setAdHocRoutePersons, setAdHocRouteWorkgroups, setDocumentNumber, setNewDocumentHeader, setPessimisticLocks, toCopy, toString, toStringBuilder, useCustomLockDescriptors, validateBusinessRules, wrapDocumentWithMetadataForXmlSerialization

Methods inherited from class org.kuali.rice.kns.bo.PersistableBusinessObjectBase

addNote, afterDelete, afterInsert, afterUpdate, beforeDelete, beforeInsert, beforeInsert, beforeUpdate, beforeUpdate, deleteNote, getAttachmentService, getBoNote, getBoNotes, getExtension, getNoteService, getObjectId, getPersistenceService, getPersistenceStructureService, getVersionNumber, isAutoIncrementSet, isNewCollectionRecord, linkEditableUserFields, refreshNonUpdateableReferences, setAutoIncrementSet, setBoNotes, setExtension, setNewCollectionRecord, setObjectId, setVersionNumber, supportsBoNotes

Methods inherited from class org.kuali.rice.kns.bo.BusinessObjectBase

prepareForWorkflow

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.kuali.rice.kns.document.Document

addPessimisticLock, afterWorkflowEngineProcess, beforeWorkflowEngineProcess, doActionTaken, generateSaveEvents, getAdHocRoutePersons, getAdHocRouteWorkgroups, getAllowsCopy, getBasePathToDocumentDuringSerialization, getCustomLockDescriptor, getDocumentBusinessObject, getDocumentHeader, getDocumentNumber, getDocumentPropertySerizabilityEvaluator, getDocumentTitle, getLockClearningMethodNames, getPessimisticLocks, getWorkflowEngineDocumentIdsToLock, getXmlForRouteReport, populateDocumentForRouting, postProcessSave, prepareForSave, processAfterRetrieve, refreshPessimisticLocks, serializeDocumentToXml, setAdHocRoutePersons, setAdHocRouteWorkgroups, setDocumentHeader, setDocumentNumber, useCustomLockDescriptors, validateBusinessRules, wrapDocumentWithMetadataForXmlSerialization

Methods inherited from interface org.kuali.rice.kns.bo.PersistableBusinessObject

addNote, deleteNote, getBoNote, getBoNotes, getExtension, getObjectId, getVersionNumber, isNewCollectionRecord, linkEditableUserFields, refreshNonUpdateableReferences, refreshReferenceObject, setAutoIncrementSet, setExtension, setNewCollectionRecord, setObjectId, setVersionNumber

Methods inherited from interface org.kuali.rice.kns.bo.BusinessObject

prepareForWorkflow, refresh

Methods inherited from interface org.apache.ojb.broker.PersistenceBrokerAware

afterDelete, afterInsert, afterLookup, afterUpdate, beforeDelete, beforeInsert, beforeUpdate

Field Detail

items

protected List<LineItemReceivingItem> items

Constructor Detail

LineItemReceivingDocument

public LineItemReceivingDocument()

Default constructor.

Method Detail

initiateDocument

public void initiateDocument()

Overrides:

initiateDocument in class ReceivingDocumentBase

populateReceivingLineFromPurchaseOrder

public void populateReceivingLineFromPurchaseOrder(PurchaseOrderDocument po)

clearInitFields

public void clearInitFields(boolean fromPurchaseOrder)

Perform logic needed to clear the initial fields on a Receiving Line Document

prepareForSave

public void prepareForSave(org.kuali.rice.kns.rule.event.KualiDocumentEvent event)

Specified by:

prepareForSave in interface org.kuali.rice.kns.document.Document

Overrides:

prepareForSave in class org.kuali.rice.kns.document.DocumentBase

doRouteStatusChange

public void doRouteStatusChange(org.kuali.rice.kew.dto.DocumentRouteStatusChangeDTO statusChangeEvent)

Description copied from class: FinancialSystemTransactionalDocumentBase

This is the default implementation which checks for a different workflow statuses, and updates the Kuali status accordingly.

Specified by:

doRouteStatusChange in interface org.kuali.rice.kns.document.Document

Overrides:

doRouteStatusChange in class ReceivingDocumentBase

See Also:

org.kuali.rice.kns.document.Document#doRouteStatusChange()

doRouteLevelChange

public void doRouteLevelChange(org.kuali.rice.kew.dto.DocumentRouteLevelChangeDTO change)

Specified by:

doRouteLevelChange in interface org.kuali.rice.kns.document.Document

Overrides:

doRouteLevelChange in class org.kuali.rice.kns.document.DocumentBase

toStringMapper

protected LinkedHashMap toStringMapper()

Overrides:

toStringMapper in class org.kuali.rice.kns.document.DocumentBase

See Also:

BusinessObjectBase.toStringMapper()

getItemClass

public Class getItemClass()

Specified by:

getItemClass in interface PurapItemOperations

Specified by:

getItemClass in class ReceivingDocumentBase

getItems

public List getItems()

setItems

public void setItems(List items)

getItem

public LineItemReceivingItem getItem(int pos)

addItem

public void addItem(LineItemReceivingItem item)

deleteItem

public void deleteItem(int lineNum)

populateDocumentDescription

protected void populateDocumentDescription(PurchaseOrderDocument poDocument)

isAwaitingPurchaseOrderOpen

protected boolean isAwaitingPurchaseOrderOpen()

answerSplitNodeQuestion

public boolean answerSplitNodeQuestion(String nodeName)
                                throws UnsupportedOperationException

Provides answers to the following splits: RelatesToOutstandingTransactions

Specified by:

answerSplitNodeQuestion in interface FinancialSystemTransactionalDocument

Overrides:

answerSplitNodeQuestion in class FinancialSystemTransactionalDocumentBase

Throws:

UnsupportedOperationException

See Also:

FinancialSystemTransactionalDocumentBase.answerSplitNodeQuestion(java.lang.String)

buildListOfDeletionAwareLists

public List buildListOfDeletionAwareLists()

Specified by:

buildListOfDeletionAwareLists in interface org.kuali.rice.kns.bo.PersistableBusinessObject

Overrides:

buildListOfDeletionAwareLists in class org.kuali.rice.kns.bo.PersistableBusinessObjectBase

getTotalItemReceivedGivenLineNumber

public org.kuali.rice.kns.util.KualiDecimal getTotalItemReceivedGivenLineNumber(Integer lineNumber)