org.kuali.ole.module.purap.document.service

Interface ReceivingService

All Known Implementing Classes:

OleReceivingServiceImpl, ReceivingServiceImpl

public interface ReceivingService

Method Summary

Methods

Modifier and Type	Method and Description
void	addNoteToReceivingDocument(ReceivingDocument receivingDocument, String note) Adds a note to a receiving document.
void	approveReceivingDocsForPOAmendment() This method iterates all the line item receiving documents with Awaiting Purchase Order Open Status and approves it if the associated PO is available for amedment.
boolean	canCreateCorrectionReceivingDocument(LineItemReceivingDocument rl)
boolean	canCreateCorrectionReceivingDocument(LineItemReceivingDocument rl, String receivingCorrectionDocNumber)
boolean	canCreateLineItemReceivingDocument(Integer poId, String receivingDocumentNumber) Determines if a receiving line document can be created at the time the user requests it.
boolean	canCreateLineItemReceivingDocument(PurchaseOrderDocument po) Determines if a receiving line document can be created at the time the user requests it.
void	completeCorrectionReceivingDocument(ReceivingDocument correctionDocument) This method updates the corrected quantities on the receiving document.
void	completeReceivingDocument(ReceivingDocument receivingDocument) This method deletes unneeded items and updates the totals on the po and does any additional processing based on items i.e.
void	createNoteForReturnedAndDamagedItems(ReceivingDocument recDoc)
List<String>	getCorrectionReceivingDocumentNumbersInProcessForPurchaseOrder(Integer poId, String receivingDocumentNumber) Returns a list of correction receiving documents in process for a purchase order
List<String>	getLineItemReceivingDocumentNumbersInProcessForPurchaseOrder(Integer poId, String receivingDocumentNumber) Returns a list of line item receiving documents in process for a purchase order
List<LineItemReceivingDocument>	getLineItemReceivingDocumentsInFinalForPurchaseOrder(Integer poId) Returns a list of line item receiving documents in final status for a purchase order
String	getReceivingDeliveryCampusCode(PurchaseOrderDocument po) Returns a delivery campus code on a receiving document based on the purchase order passed in.
boolean	hasNewUnorderedItem(LineItemReceivingDocument rlDoc) Checks if there're newly added items in the given LineItemReceivingDocument.
boolean	isLineItemReceivingDocumentGeneratedForPurchaseOrder(Integer poId) Determines if there is at least one receiving line document that has gone to final for a purchase order.
boolean	isPurchaseOrderActiveForLineItemReceivingDocumentCreation(Integer poId) Returns true, if the po is active for receiving document creation
void	populateAndSaveLineItemReceivingDocument(LineItemReceivingDocument rlDoc) A save is done passing the continue purap event so as to call a populate within prepare for save.
void	populateCorrectionReceivingDocument(CorrectionReceivingDocument rcDoc) Populates the receiving correction document.
void	populateCorrectionReceivingFromReceivingLine(CorrectionReceivingDocument rcDoc) Populates a Receiving Correction Document with information from a Receiving Line.
void	populateReceivingLineFromPurchaseOrder(LineItemReceivingDocument rlDoc) Populates a Receiving Line Document with information from a Purchase Order.
HashMap<String,String>	receivingLineDuplicateMessages(LineItemReceivingDocument rlDoc) Checks for duplicate Receiving Line documents and passes back a list of those found where vendor date, packing slip number or bill of lading match on previous receiving line documents by purchase order.

Method Detail

populateReceivingLineFromPurchaseOrder

void populateReceivingLineFromPurchaseOrder(LineItemReceivingDocument rlDoc)

Populates a Receiving Line Document with information from a Purchase Order.

Parameters:

rlDoc -

populateCorrectionReceivingFromReceivingLine

void populateCorrectionReceivingFromReceivingLine(CorrectionReceivingDocument rcDoc)

Populates a Receiving Correction Document with information from a Receiving Line.

Parameters:

rcDoc -

populateAndSaveLineItemReceivingDocument

void populateAndSaveLineItemReceivingDocument(LineItemReceivingDocument rlDoc)
                                              throws org.kuali.rice.kew.api.exception.WorkflowException

A save is done passing the continue purap event so as to call a populate within prepare for save.

Parameters:

rlDoc -

Throws:

org.kuali.rice.kew.api.exception.WorkflowException

populateCorrectionReceivingDocument

void populateCorrectionReceivingDocument(CorrectionReceivingDocument rcDoc)

Populates the receiving correction document.

Parameters:

rcDoc -

canCreateLineItemReceivingDocument

boolean canCreateLineItemReceivingDocument(Integer poId,
                                         String receivingDocumentNumber)
                                           throws RuntimeException

Determines if a receiving line document can be created at the time the user requests it. This version looks up the current purchase order by po id and also excludes the current receiving document from the check.

Parameters:

poId -

receivingDocumentNumber -

Returns:

Throws:

RuntimeException

canCreateLineItemReceivingDocument

boolean canCreateLineItemReceivingDocument(PurchaseOrderDocument po)
                                           throws RuntimeException

Determines if a receiving line document can be created at the time the user requests it. This version requires the purchase order being evaluated to be passed in.

Parameters:

po -

Returns:

Throws:

RuntimeException

canCreateCorrectionReceivingDocument

boolean canCreateCorrectionReceivingDocument(LineItemReceivingDocument rl)
                                             throws RuntimeException

Parameters:

rl -

Returns:

Throws:

RuntimeException

canCreateCorrectionReceivingDocument

boolean canCreateCorrectionReceivingDocument(LineItemReceivingDocument rl,
                                           String receivingCorrectionDocNumber)
                                             throws RuntimeException

Parameters:

rl -

receivingCorrectionDocNumber -

Returns:

Throws:

RuntimeException

receivingLineDuplicateMessages

HashMap<String,String> receivingLineDuplicateMessages(LineItemReceivingDocument rlDoc)

Checks for duplicate Receiving Line documents and passes back a list of those found where vendor date, packing slip number or bill of lading match on previous receiving line documents by purchase order.

Parameters:

rlDoc -

Returns:

completeReceivingDocument

void completeReceivingDocument(ReceivingDocument receivingDocument)

This method deletes unneeded items and updates the totals on the po and does any additional processing based on items i.e. FYI etc

Parameters:

receivingDocument - receiving document

completeCorrectionReceivingDocument

void completeCorrectionReceivingDocument(ReceivingDocument correctionDocument)

This method updates the corrected quantities on the receiving document.

Parameters:

receivingDocument - receivingCorrectionDocument

addNoteToReceivingDocument

void addNoteToReceivingDocument(ReceivingDocument receivingDocument,
                              String note)
                                throws Exception

Adds a note to a receiving document.

Parameters:

receivingDocument -

note -

Throws:

Exception

getReceivingDeliveryCampusCode

String getReceivingDeliveryCampusCode(PurchaseOrderDocument po)

Returns a delivery campus code on a receiving document based on the purchase order passed in.

Parameters:

po -

Returns:

isLineItemReceivingDocumentGeneratedForPurchaseOrder

boolean isLineItemReceivingDocumentGeneratedForPurchaseOrder(Integer poId)
                                                             throws RuntimeException

Determines if there is at least one receiving line document that has gone to final for a purchase order.

Parameters:

poId -

Returns:

Throws:

RuntimeException

createNoteForReturnedAndDamagedItems

void createNoteForReturnedAndDamagedItems(ReceivingDocument recDoc)

approveReceivingDocsForPOAmendment

void approveReceivingDocsForPOAmendment()

This method iterates all the line item receiving documents with Awaiting Purchase Order Open Status and approves it if the associated PO is available for amedment.

getLineItemReceivingDocumentNumbersInProcessForPurchaseOrder

List<String> getLineItemReceivingDocumentNumbersInProcessForPurchaseOrder(Integer poId,
                                                                        String receivingDocumentNumber)

Returns a list of line item receiving documents in process for a purchase order

Parameters:

receivingDocumentNumber -

Returns:

getLineItemReceivingDocumentsInFinalForPurchaseOrder

List<LineItemReceivingDocument> getLineItemReceivingDocumentsInFinalForPurchaseOrder(Integer poId)

Returns a list of line item receiving documents in final status for a purchase order

Parameters:

receivingDocumentNumber -

Returns:

getCorrectionReceivingDocumentNumbersInProcessForPurchaseOrder

List<String> getCorrectionReceivingDocumentNumbersInProcessForPurchaseOrder(Integer poId,
                                                                          String receivingDocumentNumber)

Returns a list of correction receiving documents in process for a purchase order

Parameters:

poId -

receivingDocumentNumber -

Returns:

isPurchaseOrderActiveForLineItemReceivingDocumentCreation

boolean isPurchaseOrderActiveForLineItemReceivingDocumentCreation(Integer poId)

Returns true, if the po is active for receiving document creation

hasNewUnorderedItem

boolean hasNewUnorderedItem(LineItemReceivingDocument rlDoc)

Checks if there're newly added items in the given LineItemReceivingDocument.

Parameters:

rlDoc - the given LineItemReceivingDocument

Returns:

true if there're newly added (unordered) items; false otherwise.