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

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.BulkReceivingDocument

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 BulkReceivingDocument
extends ReceivingDocumentBase

See Also:

Serialized Form

Field Summary

protected VendorDetail	alternateVendorDetail
protected String	deliveryAdditionalInstructionText
protected String	deliveryCampusName
protected Integer	goodsDeliveredVendorDetailAssignedIdentifier
protected Integer	goodsDeliveredVendorHeaderGeneratedIdentifier Goods delivered vendor
protected String	goodsDeliveredVendorName Not persisted in DB
protected String	goodsDeliveredVendorNumber
protected String	institutionContactEmailAddress
protected String	institutionContactName
protected String	institutionContactPhoneNumber
protected static org.apache.log4j.Logger	LOG
protected Integer	noOfCartons
protected String	preparerPersonName
protected String	preparerPersonPhoneNumber
protected String	requestorPersonEmailAddress
protected String	requestorPersonName
protected String	requestorPersonPhoneNumber
protected String	shipmentWeight
protected String	trackingNumber
protected String	vendorAddressInternationalProvinceName
protected String	vendorContact
protected String	vendorNoteText

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

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

BulkReceivingDocument()

Method Summary

void	clearInitFields() Perform logic needed to clear the initial fields on a Receiving Line Document
VendorDetail	getAlternateVendorDetail()
String	getDeliveryAdditionalInstructionText()
String	getDeliveryCampusName()
String	getDeliveryCountryName()
Integer	getGoodsDeliveredVendorDetailAssignedIdentifier()
Integer	getGoodsDeliveredVendorHeaderGeneratedIdentifier()
String	getGoodsDeliveredVendorName()
String	getGoodsDeliveredVendorNumber()
String	getInstitutionContactEmailAddress()
String	getInstitutionContactName()
String	getInstitutionContactPhoneNumber()
<T> T	getItem(int pos) It's not needed to implement PurapItemOperations methods in this class since bulk receiving doesn't support items.
Class	getItemClass() It's not needed to implement this method in this class since bulk receiving doesn't support items.
List	getItems() It's not needed to implement PurapItemOperations methods in this class since bulk receiving doesn't support items.
Integer	getNoOfCartons()
String	getPreparerPersonName()
String	getPreparerPersonPhoneNumber()
String	getRequestorPersonEmailAddress()
String	getRequestorPersonName()
String	getRequestorPersonPhoneNumber()
String	getShipmentWeight()
String	getTrackingNumber()
String	getVendorAddressInternationalProvinceName()
String	getVendorContact()
String	getVendorNoteText()
String	getWorkflowStatusForResult()
void	initiateDocument()
boolean	isBoNotesSupport()
void	populateBulkReceivingFromPurchaseOrder(PurchaseOrderDocument po)
protected void	populateDocumentDescription(PurchaseOrderDocument poDocument)
protected void	populateVendorDetails()
void	prepareForSave(org.kuali.rice.kns.rule.event.KualiDocumentEvent event)
void	processAfterRetrieve() This is the default implementation which ensures that document note attachment references are loaded.
void	setAlternateVendorDetail(VendorDetail alternateVendorDetail)
void	setDeliveryAdditionalInstructionText(String deliveryAdditionalInstructionText)
void	setDeliveryCampusName(String deliveryCampusName)
void	setGoodsDeliveredVendorDetailAssignedIdentifier(Integer goodsDeliveredVendorDetailAssignedIdentifier)
void	setGoodsDeliveredVendorHeaderGeneratedIdentifier(Integer goodsDeliveredVendorHeaderGeneratedIdentifier)
void	setGoodsDeliveredVendorName(String goodsDeliveredVendorName)
void	setGoodsDeliveredVendorNumber(String goodsDeliveredVendorNumber)
void	setInstitutionContactEmailAddress(String institutionContactEmailAddress)
void	setInstitutionContactName(String institutionContactName)
void	setInstitutionContactPhoneNumber(String institutionContactPhoneNumber)
void	setItems(List items) It's not needed to implement PurapItemOperations methods in this class since bulk receiving doesn't support items.
void	setNoOfCartons(Integer noOfCartons)
void	setPreparerPersonName(String preparerPersonName)
void	setPreparerPersonPhoneNumber(String preparerPersonPhoneNumber)
void	setRequestorPersonEmailAddress(String requestorPersonEmailAddress)
void	setRequestorPersonName(String requestorPersonName)
void	setRequestorPersonPhoneNumber(String requestorPersonPhoneNumber)
void	setShipmentWeight(String shipmentWeight)
void	setTrackingNumber(String trackingNumber)
void	setVendorAddressInternationalProvinceName(String vendorAddressInternationalProvinceName)
void	setVendorContact(String vendorContact)
void	setVendorNoteText(String vendorNoteText)
protected LinkedHashMap	toStringMapper()

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

appSpecificRouteDocumentToUser, doRouteStatusChange, getAccountsPayablePurchasingDocumentLinkIdentifier, getAlternateVendorDetailAssignedIdentifier, getAlternateVendorHeaderGeneratedIdentifier, getAlternateVendorName, getAlternateVendorNumber, getCarrier, getCarrierCode, getCreateDateForResult, getCurrentRouteNodeName, getDeliveryBuildingCode, getDeliveryBuildingLine1Address, getDeliveryBuildingLine2Address, getDeliveryBuildingName, getDeliveryBuildingRoomNumber, getDeliveryCampus, getDeliveryCampusCode, getDeliveryCityName, getDeliveryCountryCode, 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, 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

answerSplitNodeQuestion, getDocumentHeader, prepareForSave, 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, doRouteLevelChange, 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, buildListOfDeletionAwareLists, 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, doRouteLevelChange, generateSaveEvents, getAdHocRoutePersons, getAdHocRouteWorkgroups, getAllowsCopy, getBasePathToDocumentDuringSerialization, getCustomLockDescriptor, getDocumentBusinessObject, getDocumentHeader, getDocumentNumber, getDocumentPropertySerizabilityEvaluator, getDocumentTitle, getLockClearningMethodNames, getPessimisticLocks, getWorkflowEngineDocumentIdsToLock, getXmlForRouteReport, populateDocumentForRouting, postProcessSave, prepareForSave, refreshPessimisticLocks, serializeDocumentToXml, setAdHocRoutePersons, setAdHocRouteWorkgroups, setDocumentHeader, setDocumentNumber, useCustomLockDescriptors, validateBusinessRules, wrapDocumentWithMetadataForXmlSerialization

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

addNote, buildListOfDeletionAwareLists, 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

LOG

protected static final org.apache.log4j.Logger LOG

shipmentWeight

protected String shipmentWeight

noOfCartons

protected Integer noOfCartons

trackingNumber

protected String trackingNumber

vendorAddressInternationalProvinceName

protected String vendorAddressInternationalProvinceName

vendorNoteText

protected String vendorNoteText

goodsDeliveredVendorHeaderGeneratedIdentifier

protected Integer goodsDeliveredVendorHeaderGeneratedIdentifier

Goods delivered vendor

goodsDeliveredVendorDetailAssignedIdentifier

protected Integer goodsDeliveredVendorDetailAssignedIdentifier

goodsDeliveredVendorNumber

protected String goodsDeliveredVendorNumber

deliveryAdditionalInstructionText

protected String deliveryAdditionalInstructionText

requestorPersonName

protected String requestorPersonName

requestorPersonPhoneNumber

protected String requestorPersonPhoneNumber

requestorPersonEmailAddress

protected String requestorPersonEmailAddress

preparerPersonName

protected String preparerPersonName

preparerPersonPhoneNumber

protected String preparerPersonPhoneNumber

deliveryCampusName

protected String deliveryCampusName

institutionContactName

protected String institutionContactName

institutionContactPhoneNumber

protected String institutionContactPhoneNumber

institutionContactEmailAddress

protected String institutionContactEmailAddress

alternateVendorDetail

protected VendorDetail alternateVendorDetail

goodsDeliveredVendorName

protected String goodsDeliveredVendorName

Not persisted in DB

vendorContact

protected String vendorContact

Constructor Detail

BulkReceivingDocument

public BulkReceivingDocument()

Method Detail

initiateDocument

public void initiateDocument()

Overrides:

initiateDocument in class ReceivingDocumentBase

populateBulkReceivingFromPurchaseOrder

public void populateBulkReceivingFromPurchaseOrder(PurchaseOrderDocument po)

populateVendorDetails

protected void populateVendorDetails()

clearInitFields

public void clearInitFields()

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

processAfterRetrieve

public void processAfterRetrieve()

Description copied from class: FinancialSystemTransactionalDocumentBase

This is the default implementation which ensures that document note attachment references are loaded.

Specified by:

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

Overrides:

processAfterRetrieve in class FinancialSystemTransactionalDocumentBase

See Also:

Document.processAfterRetrieve()

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

populateDocumentDescription

protected void populateDocumentDescription(PurchaseOrderDocument poDocument)

getDeliveryCountryName

public String getDeliveryCountryName()

Specified by:

getDeliveryCountryName in interface ReceivingDocument

Overrides:

getDeliveryCountryName in class ReceivingDocumentBase

getGoodsDeliveredVendorNumber

public String getGoodsDeliveredVendorNumber()

setGoodsDeliveredVendorNumber

public void setGoodsDeliveredVendorNumber(String goodsDeliveredVendorNumber)

getNoOfCartons

public Integer getNoOfCartons()

setNoOfCartons

public void setNoOfCartons(Integer noOfCartons)

getVendorContact

public String getVendorContact()

setVendorContact

public void setVendorContact(String vendorContact)

getAlternateVendorDetail

public VendorDetail getAlternateVendorDetail()

setAlternateVendorDetail

public void setAlternateVendorDetail(VendorDetail alternateVendorDetail)

getShipmentWeight

public String getShipmentWeight()

setShipmentWeight

public void setShipmentWeight(String shipmentWeight)

getGoodsDeliveredVendorName

public String getGoodsDeliveredVendorName()

setGoodsDeliveredVendorName

public void setGoodsDeliveredVendorName(String goodsDeliveredVendorName)

getVendorAddressInternationalProvinceName

public String getVendorAddressInternationalProvinceName()

setVendorAddressInternationalProvinceName

public void setVendorAddressInternationalProvinceName(String vendorAddressInternationalProvinceName)

getDeliveryCampusName

public String getDeliveryCampusName()

setDeliveryCampusName

public void setDeliveryCampusName(String deliveryCampusName)

getRequestorPersonName

public String getRequestorPersonName()

setRequestorPersonName

public void setRequestorPersonName(String requestorPersonName)

getRequestorPersonPhoneNumber

public String getRequestorPersonPhoneNumber()

setRequestorPersonPhoneNumber

public void setRequestorPersonPhoneNumber(String requestorPersonPhoneNumber)

getPreparerPersonName

public String getPreparerPersonName()

setPreparerPersonName

public void setPreparerPersonName(String preparerPersonName)

getPreparerPersonPhoneNumber

public String getPreparerPersonPhoneNumber()

setPreparerPersonPhoneNumber

public void setPreparerPersonPhoneNumber(String preparerPersonPhoneNumber)

getTrackingNumber

public String getTrackingNumber()

setTrackingNumber

public void setTrackingNumber(String trackingNumber)

getVendorNoteText

public String getVendorNoteText()

setVendorNoteText

public void setVendorNoteText(String vendorNoteText)

getRequestorPersonEmailAddress

public String getRequestorPersonEmailAddress()

setRequestorPersonEmailAddress

public void setRequestorPersonEmailAddress(String requestorPersonEmailAddress)

getInstitutionContactEmailAddress

public String getInstitutionContactEmailAddress()

setInstitutionContactEmailAddress

public void setInstitutionContactEmailAddress(String institutionContactEmailAddress)

getInstitutionContactName

public String getInstitutionContactName()

setInstitutionContactName

public void setInstitutionContactName(String institutionContactName)

getInstitutionContactPhoneNumber

public String getInstitutionContactPhoneNumber()

setInstitutionContactPhoneNumber

public void setInstitutionContactPhoneNumber(String institutionContactPhoneNumber)

getDeliveryAdditionalInstructionText

public String getDeliveryAdditionalInstructionText()

setDeliveryAdditionalInstructionText

public void setDeliveryAdditionalInstructionText(String deliveryAdditionalInstructionText)

getGoodsDeliveredVendorDetailAssignedIdentifier

public Integer getGoodsDeliveredVendorDetailAssignedIdentifier()

setGoodsDeliveredVendorDetailAssignedIdentifier

public void setGoodsDeliveredVendorDetailAssignedIdentifier(Integer goodsDeliveredVendorDetailAssignedIdentifier)

getGoodsDeliveredVendorHeaderGeneratedIdentifier

public Integer getGoodsDeliveredVendorHeaderGeneratedIdentifier()

setGoodsDeliveredVendorHeaderGeneratedIdentifier

public void setGoodsDeliveredVendorHeaderGeneratedIdentifier(Integer goodsDeliveredVendorHeaderGeneratedIdentifier)

isBoNotesSupport

public boolean isBoNotesSupport()

Specified by:

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

Overrides:

isBoNotesSupport in class ReceivingDocumentBase

toStringMapper

protected LinkedHashMap toStringMapper()

Overrides:

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

getWorkflowStatusForResult

public String getWorkflowStatusForResult()

Overrides:

getWorkflowStatusForResult in class ReceivingDocumentBase

getItemClass

public Class getItemClass()

It's not needed to implement this method in this class since bulk receiving doesn't support items. Calling this method will throw an UnsupportedOperationException

Specified by:

getItemClass in interface PurapItemOperations

Specified by:

getItemClass in class ReceivingDocumentBase

Throws:

UnsupportedOperationException

getItem

public <T> T getItem(int pos)

It's not needed to implement PurapItemOperations methods in this class since bulk receiving doesn't support items. Calling this method will throw an UnsupportedOperationException

Throws:

UnsupportedOperationException

getItems

public List getItems()

It's not needed to implement PurapItemOperations methods in this class since bulk receiving doesn't support items. Calling this method will throw an UnsupportedOperationException

Throws:

UnsupportedOperationException

setItems

public void setItems(List items)

It's not needed to implement PurapItemOperations methods in this class since bulk receiving doesn't support items. Calling this method will throw an UnsupportedOperationException

Throws:

UnsupportedOperationException