org.kuali.ole.module.purap.document

Class LineItemReceivingDocument

java.lang.Object

org.kuali.rice.krad.bo.BusinessObjectBase

org.kuali.rice.krad.bo.PersistableBusinessObjectBase

org.kuali.rice.krad.document.DocumentBase

org.kuali.rice.krad.document.TransactionalDocumentBase

org.kuali.ole.sys.document.FinancialSystemTransactionalDocumentBase

org.kuali.ole.module.purap.document.ReceivingDocumentBase

org.kuali.ole.module.purap.document.LineItemReceivingDocument

All Implemented Interfaces:

Serializable, org.apache.ojb.broker.PersistenceBrokerAware, PurapItemOperations, ReceivingDocument, FinancialSystemDocument, FinancialSystemTransactionalDocument, org.kuali.rice.core.api.mo.common.GloballyUnique, org.kuali.rice.core.api.mo.common.Versioned, org.kuali.rice.core.api.mo.ModelObjectBasic, org.kuali.rice.krad.bo.BusinessObject, org.kuali.rice.krad.bo.PersistableBusinessObject, org.kuali.rice.krad.document.Document, org.kuali.rice.krad.document.SessionDocument, org.kuali.rice.krad.document.TransactionalDocument

Direct Known Subclasses:

OleLineItemReceivingDocument

public class LineItemReceivingDocument
extends ReceivingDocumentBase

Author:

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

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected List<LineItemReceivingItem>	items

Fields inherited from class org.kuali.ole.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, 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.ole.sys.document.FinancialSystemTransactionalDocumentBase

UPDATE_TOTAL_AMOUNT_IN_POST_PROCESSING_PARAMETER_NAME

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

documentHeader, documentNumber

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

extension, versionNumber

Constructor Summary

Constructors

Constructor and Description
LineItemReceivingDocument() Default constructor.

Method Summary

Methods

Modifier and Type	Method and Description
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.framework.postprocessor.DocumentRouteLevelChange change) This is the default implementation which, if parameter KFS-SYS / Document / UPDATE_TOTAL_AMOUNT_IN_POST_PROCESSING_IND is on, updates the document and resaves if needed
void	doRouteStatusChange(org.kuali.rice.kew.framework.postprocessor.DocumentRouteStatusChange 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()
static OlePurapService	getOlePurapService()
org.kuali.rice.core.api.util.type.KualiDecimal	getTotalItemReceivedGivenLineNumber(Integer lineNumber)
void	initiateDocument()
protected boolean	isRelatesToOutstandingTransactionsRequired()
protected void	populateDocumentDescription(PurchaseOrderDocument poDocument)
void	populateReceivingLineFromPurchaseOrder(PurchaseOrderDocument po)
void	prepareForSave(org.kuali.rice.krad.rules.rule.event.KualiDocumentEvent event)
void	setItems(List items)
protected LinkedHashMap	toStringMapper_RICE20_REFACTORME()

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

appSpecificRouteDocumentToUser, getAccountsPayablePurchasingDocumentLinkIdentifier, getAlternateVendorDetailAssignedIdentifier, getAlternateVendorHeaderGeneratedIdentifier, getAlternateVendorName, getAlternateVendorNumber, getAppDocStatus, 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, getLicenseURL, getNeedWarningRelatedPOs, getNoteType, getPurchaseOrderDocument, getPurchaseOrderIdentifier, getRelatedViews, getShipmentBillOfLadingNumber, getShipmentPackingSlipNumber, getShipmentReceivedDate, getShipmentReferenceNumber, getVendorAddressGeneratedIdentifier, getVendorCityName, getVendorCountry, getVendorCountryCode, getVendorDetail, getVendorDetailAssignedIdentifier, getVendorHeaderGeneratedIdentifier, getVendorLine1Address, getVendorLine2Address, getVendorName, getVendorNumber, getVendorPostalCode, getVendorStateCode, getWorkflowStatusForResult, isBoNotesSupport, isDeliveryBuildingOtherIndicator, isDeliveryFlag, isNotesAndAttachmentFlag, isOverviewFlag, isRelatedDocumentsFlag, isRouteLogFlag, isSensitive, isTitlesFlag, isVendorFlag, setAccountsPayablePurchasingDocumentLinkIdentifier, setAlternateVendorDetailAssignedIdentifier, setAlternateVendorHeaderGeneratedIdentifier, setAlternateVendorName, setAlternateVendorNumber, setAppDocStatus, setCarrier, setCarrierCode, setDeliveryBuildingCode, setDeliveryBuildingLine1Address, setDeliveryBuildingLine2Address, setDeliveryBuildingName, setDeliveryBuildingOtherIndicator, setDeliveryBuildingRoomNumber, setDeliveryCampus, setDeliveryCampusCode, setDeliveryCityName, setDeliveryCountryCode, setDeliveryFlag, setDeliveryInstructionText, setDeliveryPostalCode, setDeliveryRequiredDate, setDeliveryRequiredDateReason, setDeliveryRequiredDateReasonCode, setDeliveryStateCode, setDeliveryToEmailAddress, setDeliveryToName, setDeliveryToPhoneNumber, setNotesAndAttachmentFlag, setOverviewFlag, setPurchaseOrderDocument, setPurchaseOrderIdentifier, setRelatedDocumentsFlag, setRelatedViews, setRouteLogFlag, setShipmentBillOfLadingNumber, setShipmentPackingSlipNumber, setShipmentReceivedDate, setShipmentReferenceNumber, setTitlesFlag, setVendorAddressGeneratedIdentifier, setVendorCityName, setVendorCountry, setVendorCountryCode, setVendorDetail, setVendorDetailAssignedIdentifier, setVendorFlag, setVendorHeaderGeneratedIdentifier, setVendorLine1Address, setVendorLine2Address, setVendorName, setVendorNumber, setVendorPostalCode, setVendorStateCode

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

getApplicationDocumentStatus, getBusinessObjectService, getFinancialSystemDocumentHeader, getFinancialSystemDocumentService, getParameterService, prepareForSave, processAfterRetrieve, setApplicationDocumentStatus, setDocumentHeader, toCopy, toErrorCorrection, updateAndSaveAppDocStatus

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

getAllowsCopy, isSessionDocument

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

addCopyErrorDocumentNote, addNote, addPessimisticLock, afterActionTaken, afterWorkflowEngineProcess, beforeWorkflowEngineProcess, createPropertySerializabilityEvaluator, doActionTaken, generateSaveEvents, getAdHocRoutePersons, getAdHocRouteWorkgroups, getAttachmentService, getBasePathToDocumentDuringSerialization, getCustomLockDescriptor, getDocumentHeader, getDocumentNumber, getDocumentPropertySerizabilityEvaluator, getDocumentTitle, getLockClearningMethodNames, getNonLockingActionTakenCodes, getNote, getNotes, getNoteService, getNoteTarget, getPessimisticLocks, getWorkflowEngineDocumentIdsToLock, getXmlForRouteReport, logErrors, populateDocumentForRouting, postLoad, postProcessSave, refresh, refreshIfEmpty, refreshPessimisticLocks, refreshReferenceObject, removeNote, serializeDocumentToXml, setAdHocRoutePersons, setAdHocRouteWorkgroups, setDocumentNumber, setNewDocumentHeader, setNotes, setPessimisticLocks, useCustomLockDescriptors, validateBusinessRules, wrapDocumentWithMetadataForXmlSerialization

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

afterDelete, afterInsert, afterLookup, afterUpdate, beforeDelete, beforeInsert, beforeUpdate, getExtension, getObjectId, getPersistenceService, getPersistenceStructureService, getVersionNumber, isNewCollectionRecord, linkEditableUserFields, postPersist, postRemove, postUpdate, prePersist, preRemove, preUpdate, refreshNonUpdateableReferences, setExtension, setNewCollectionRecord, setObjectId, setVersionNumber

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

toString

Methods inherited from class java.lang.Object

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

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

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

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

getExtension, isNewCollectionRecord, linkEditableUserFields, refreshNonUpdateableReferences, refreshReferenceObject, setExtension, setNewCollectionRecord, setObjectId, setVersionNumber

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

refresh

Methods inherited from interface org.kuali.rice.core.api.mo.ModelObjectBasic

toString

Methods inherited from interface org.kuali.rice.core.api.mo.common.Versioned

getVersionNumber

Methods inherited from interface org.kuali.rice.core.api.mo.common.GloballyUnique

getObjectId

Field Detail

items

protected List<LineItemReceivingItem> items

Constructor Detail

LineItemReceivingDocument

public LineItemReceivingDocument()

Default constructor.

Method Detail

getOlePurapService

public static OlePurapService getOlePurapService()

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.krad.rules.rule.event.KualiDocumentEvent event)

Specified by:

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

Overrides:

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

doRouteStatusChange

public void doRouteStatusChange(org.kuali.rice.kew.framework.postprocessor.DocumentRouteStatusChange 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.krad.document.Document

Overrides:

doRouteStatusChange in class ReceivingDocumentBase

See Also:

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

doRouteLevelChange

public void doRouteLevelChange(org.kuali.rice.kew.framework.postprocessor.DocumentRouteLevelChange change)

Description copied from class: FinancialSystemTransactionalDocumentBase

This is the default implementation which, if parameter KFS-SYS / Document / UPDATE_TOTAL_AMOUNT_IN_POST_PROCESSING_IND is on, updates the document and resaves if needed

Specified by:

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

Overrides:

doRouteLevelChange in class FinancialSystemTransactionalDocumentBase

See Also:

org.kuali.rice.kns.document.DocumentBase#doRouteLevelChange(org.kuali.rice.kew.dto.DocumentRouteLevelChangeDTO)

toStringMapper_RICE20_REFACTORME

protected LinkedHashMap toStringMapper_RICE20_REFACTORME()

See Also:

org.kuali.rice.krad.bo.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)

isRelatesToOutstandingTransactionsRequired

protected boolean isRelatesToOutstandingTransactionsRequired()

answerSplitNodeQuestion

public boolean answerSplitNodeQuestion(String nodeName)
                                throws UnsupportedOperationException

Provides answers to the following splits: RelatesToOutstandingTransactions

Specified by:

answerSplitNodeQuestion in interface FinancialSystemDocument

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.krad.bo.PersistableBusinessObject

Overrides:

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

getTotalItemReceivedGivenLineNumber

public org.kuali.rice.core.api.util.type.KualiDecimal getTotalItemReceivedGivenLineNumber(Integer lineNumber)