| org.kuali.module.purap.service.PurchaseOrderService
All known Subclasses: org.kuali.module.purap.service.impl.PurchaseOrderServiceImpl,
PurchaseOrderService | public interface PurchaseOrderService (Code) | | Defines methods that must be implemented by classes providing a PurchaseOrderService.
|
Method Summary | |
public void | completePurchaseOrder(PurchaseOrderDocument po) Performs the steps needed to complete the newly approved purchase order document, which consists of setting the current and
pending indicators for the purchase order document and if the status is not pending transmission, then calls the
attemptsSetupOfInitialOpenOfDocument to set the statuses, the initial open date and save the document. | public PurchaseOrderDocument | createAndRoutePotentialChangeDocument(String documentNumber, String docType, String annotation, List adhocRoutingRecipients, String newDocumentStatusCode) Creates and routes the purchase order change document (for example, PurchaseOrderCloseDocument) based on an existing purchase
order document.
Parameters: documentNumber - The document number of the existing purchase order document from which we try to create a new changedocument. Parameters: docType - The document type of the new change document. Parameters: annotation - The annotation that we'll use to invoke the routeDocument method of DocumentService. Parameters: adhocRoutingRecipients - The adhocRoutingRecipients that we'll use to invoke the routeDocument method ofDocumentService. Parameters: newDocumentStatusCode - The status code that we want to set on the existing purchase order document after the new changedocument is created. | public PurchaseOrderDocument | createAndSavePotentialChangeDocument(String documentNumber, String docType, String newDocumentStatusCode) Creates and saves the purchase order change document (for example, PurchaseOrderAmendmentDocument) based on an existing
purchase order document.
Parameters: documentNumber - The document number of the existing purchase order document from which we try to create a new changedocument. Parameters: docType - The document type of the new change document. Parameters: newDocumentStatusCode - The status code that we want to set on the existing purchase order document after the new changedocument is created. | public void | createAutomaticPurchaseOrderDocument(RequisitionDocument reqDocument) | public PurchaseOrderDocument | createPurchaseOrderDocument(RequisitionDocument reqDocument, String newSessionUserId, Integer contractManagerCode) Creates a PurchaseOrderDocument from given RequisitionDocument. | public PurchaseOrderDocument | getCurrentPurchaseOrder(Integer id) Obtains the purchase order document whose current indicator is true, given a purchase order id which is the
purapDocumentIdentifier.
Parameters: id - The po id (purapDocumentIdentifier) that we'll use to retrieve the current purchase order document. | public KualiDecimal | getInternalPurchasingDollarLimit(PurchaseOrderDocument po) Obtains the internal purchasing dollar limit amount for a purchase order document.
Parameters: po - The purchase order document for which this method is obtaining the internal purchasing dollar limit. | public PurchaseOrderDocument | getOldestPurchaseOrder(PurchaseOrderDocument po, PurchaseOrderDocument documentBusinessObject) Obtains the oldest purchase order given the purchase order object to be used to search, then calls the updateNotes method to
set the notes on the oldest purchase order and finally return the oldest purchase order.
Parameters: po - The current purchase order object from which we want to obtain the oldest purchase order. Parameters: documentBusinessObject - The documentBusinessObject of the current purchase order object. | public PurchaseOrderDocument | getPurchaseOrderByDocumentNumber(String documentNumber) Obtains the purchase order document given the document number.
Parameters: documentNumber - The document number of the purchase order that we want to retrieve. | public ArrayList<Note> | getPurchaseOrderNotes(Integer id) Obtains all the notes that belong to this purchase order given the purchase order id.
Parameters: id - The purchase order id (purapDocumentIdentifier). | public ArrayList<PurchaseOrderQuoteStatus> | getPurchaseOrderQuoteStatusCodes() | public void | performPrintPurchaseOrderPDFOnly(String documentNumber, ByteArrayOutputStream baosPDF) Generates and displays the purchase order pdf by invoking the generatePurchaseOrderPdf method of the PrintService. | public void | performPurchaseOrderFirstTransmitViaPrinting(String documentNumber, ByteArrayOutputStream baosPDF) Creates and displays the pdf document for the purchase order, sets the transmit dates, calls the
takeAllActionsForGivenCriteria method in PurApWorkflowIntegrationService to perform all the workflow related steps that are
necessary as part of the document initial print transmission and then performs the setup of initial of open document of the
purchase order. | public boolean | printPurchaseOrderQuotePDF(PurchaseOrderDocument po, PurchaseOrderVendorQuote povq, ByteArrayOutputStream baosPDF) | public boolean | printPurchaseOrderQuoteRequestsListPDF(PurchaseOrderDocument po, ByteArrayOutputStream baosPDF) | public void | retransmitPurchaseOrderPDF(PurchaseOrderDocument po, ByteArrayOutputStream baosPDF) Generates and displays the purchase order retransmit pdf by invoking the generatePurchaseOrderPdfForRetransmission method of
the PrintService. | public void | saveDocumentNoValidation(PurchaseOrderDocument document) Saves the document without doing validation by invoking the saveDocument method of documentService. | public void | setCurrentAndPendingIndicatorsForApprovedPODocuments(PurchaseOrderDocument newPO) Sets the current and pending indicators of the new purchase order and the old purchase order as well as its status, then save
the purchase order. | public void | setCurrentAndPendingIndicatorsForCancelledChangePODocuments(PurchaseOrderDocument newPO) Sets the current and pending indicators of the new purchase order and the old purchase order as well as their statuses, then
save the purchase order. | public void | setCurrentAndPendingIndicatorsForCancelledRemoveHoldPODocuments(PurchaseOrderDocument newPO) | public void | setCurrentAndPendingIndicatorsForCancelledReopenPODocuments(PurchaseOrderDocument newPO) Sets the current and pending indicators of the new purchase order and the old purchase order as well as their statuses, then
save the purchase order. | public void | setCurrentAndPendingIndicatorsForDisapprovedChangePODocuments(PurchaseOrderDocument newPO) Sets the current and pending indicators of the new purchase order and the old purchase order as well as their statuses, then
save the purchase order. | public void | setCurrentAndPendingIndicatorsForDisapprovedRemoveHoldPODocuments(PurchaseOrderDocument newPO) Sets the current and pending indicators of the new purchase order and the old purchase order as well as their statuses, then
save the purchase order. | public void | setCurrentAndPendingIndicatorsForDisapprovedReopenPODocuments(PurchaseOrderDocument newPO) Sets the current and pending indicators of the new purchase order and the old purchase order as well as their statuses, then
save the purchase order. | public void | setupDocumentForPendingFirstTransmission(PurchaseOrderDocument po, boolean hasActionRequestForDocumentTransmission) Update the purchase order document with the appropriate status for pending first transmission if the transmission method code
is PRINT, or set the purchase order status to OPEN, set the initial open date and save the purchase order if the transmission
method code is not PRINT and the hasActionRequestForDocumentTransmission is false. |
completePurchaseOrder | public void completePurchaseOrder(PurchaseOrderDocument po)(Code) | | Performs the steps needed to complete the newly approved purchase order document, which consists of setting the current and
pending indicators for the purchase order document and if the status is not pending transmission, then calls the
attemptsSetupOfInitialOpenOfDocument to set the statuses, the initial open date and save the document.
Parameters: po - The newly approved purchase order document that we want to complete. |
createAndRoutePotentialChangeDocument | public PurchaseOrderDocument createAndRoutePotentialChangeDocument(String documentNumber, String docType, String annotation, List adhocRoutingRecipients, String newDocumentStatusCode)(Code) | | Creates and routes the purchase order change document (for example, PurchaseOrderCloseDocument) based on an existing purchase
order document.
Parameters: documentNumber - The document number of the existing purchase order document from which we try to create a new changedocument. Parameters: docType - The document type of the new change document. Parameters: annotation - The annotation that we'll use to invoke the routeDocument method of DocumentService. Parameters: adhocRoutingRecipients - The adhocRoutingRecipients that we'll use to invoke the routeDocument method ofDocumentService. Parameters: newDocumentStatusCode - The status code that we want to set on the existing purchase order document after the new changedocument is created. The resulting new purchase order change document created by this method. |
createAndSavePotentialChangeDocument | public PurchaseOrderDocument createAndSavePotentialChangeDocument(String documentNumber, String docType, String newDocumentStatusCode)(Code) | | Creates and saves the purchase order change document (for example, PurchaseOrderAmendmentDocument) based on an existing
purchase order document.
Parameters: documentNumber - The document number of the existing purchase order document from which we try to create a new changedocument. Parameters: docType - The document type of the new change document. Parameters: newDocumentStatusCode - The status code that we want to set on the existing purchase order document after the new changedocument is created. The resulting new purchase order change document created by this method. |
createAutomaticPurchaseOrderDocument | public void createAutomaticPurchaseOrderDocument(RequisitionDocument reqDocument)(Code) | | Creates an automatic purchase order document using the given requisition document
Parameters: reqDocument - The requisition document that this method will use to create the Automated Purchase Order (APO). |
createPurchaseOrderDocument | public PurchaseOrderDocument createPurchaseOrderDocument(RequisitionDocument reqDocument, String newSessionUserId, Integer contractManagerCode)(Code) | | Creates a PurchaseOrderDocument from given RequisitionDocument. Both documents need to be saved after this method is called.
Parameters: reqDocument - The requisition document that this method will use to create the purchase order. Parameters: newSessionUserId - The session user id that we'll use to invoke the performLogicWithFakedUserSession method ofPurapService. Parameters: contractManagerCode - The contract manager code that we'll need to set on the purchase order. The purchase order document object that is created by this method. |
getCurrentPurchaseOrder | public PurchaseOrderDocument getCurrentPurchaseOrder(Integer id)(Code) | | Obtains the purchase order document whose current indicator is true, given a purchase order id which is the
purapDocumentIdentifier.
Parameters: id - The po id (purapDocumentIdentifier) that we'll use to retrieve the current purchase order document. The current purchase order document (the po whose current indicator is true). |
getInternalPurchasingDollarLimit | public KualiDecimal getInternalPurchasingDollarLimit(PurchaseOrderDocument po)(Code) | | Obtains the internal purchasing dollar limit amount for a purchase order document.
Parameters: po - The purchase order document for which this method is obtaining the internal purchasing dollar limit. The internal purchasing dollar limit for the given purchase order document. |
getOldestPurchaseOrder | public PurchaseOrderDocument getOldestPurchaseOrder(PurchaseOrderDocument po, PurchaseOrderDocument documentBusinessObject)(Code) | | Obtains the oldest purchase order given the purchase order object to be used to search, then calls the updateNotes method to
set the notes on the oldest purchase order and finally return the oldest purchase order.
Parameters: po - The current purchase order object from which we want to obtain the oldest purchase order. Parameters: documentBusinessObject - The documentBusinessObject of the current purchase order object. The oldest purchase order whose purchase order id is the same as the current purchase order's id. |
getPurchaseOrderByDocumentNumber | public PurchaseOrderDocument getPurchaseOrderByDocumentNumber(String documentNumber)(Code) | | Obtains the purchase order document given the document number.
Parameters: documentNumber - The document number of the purchase order that we want to retrieve. The purchase order document whose document number is the given document number. |
getPurchaseOrderNotes | public ArrayList<Note> getPurchaseOrderNotes(Integer id)(Code) | | Obtains all the notes that belong to this purchase order given the purchase order id.
Parameters: id - The purchase order id (purapDocumentIdentifier). The list of notes that belong to this purchase order. |
performPrintPurchaseOrderPDFOnly | public void performPrintPurchaseOrderPDFOnly(String documentNumber, ByteArrayOutputStream baosPDF)(Code) | | Generates and displays the purchase order pdf by invoking the generatePurchaseOrderPdf method of the PrintService.
Parameters: documentNumber - The document number of the purchase order document that we want to print the pdf. Parameters: baosPDF - The ByteArrayOutputStream object that we'll use to display the pdf on the browser. |
performPurchaseOrderFirstTransmitViaPrinting | public void performPurchaseOrderFirstTransmitViaPrinting(String documentNumber, ByteArrayOutputStream baosPDF)(Code) | | Creates and displays the pdf document for the purchase order, sets the transmit dates, calls the
takeAllActionsForGivenCriteria method in PurApWorkflowIntegrationService to perform all the workflow related steps that are
necessary as part of the document initial print transmission and then performs the setup of initial of open document of the
purchase order.
Parameters: documentNumber - The document number of the purchase order document that we want to perform the first transmit. Parameters: baosPDF - The ByteArrayOutputStream object that was passed in from the struts action so that we could display the pdf onthe browser. |
retransmitPurchaseOrderPDF | public void retransmitPurchaseOrderPDF(PurchaseOrderDocument po, ByteArrayOutputStream baosPDF)(Code) | | Generates and displays the purchase order retransmit pdf by invoking the generatePurchaseOrderPdfForRetransmission method of
the PrintService.
Parameters: po - The purchase order document to be retransmitted. Parameters: baosPDF - The ByteArrayOutputStream object that we'll use to display the pdf on the browser. |
saveDocumentNoValidation | public void saveDocumentNoValidation(PurchaseOrderDocument document)(Code) | | Saves the document without doing validation by invoking the saveDocument method of documentService.
Parameters: document - The purchase order document to be saved. |
setCurrentAndPendingIndicatorsForApprovedPODocuments | public void setCurrentAndPendingIndicatorsForApprovedPODocuments(PurchaseOrderDocument newPO)(Code) | | Sets the current and pending indicators of the new purchase order and the old purchase order as well as its status, then save
the purchase order.
Parameters: newPO - The new purchase order document that has been approved. |
setCurrentAndPendingIndicatorsForCancelledChangePODocuments | public void setCurrentAndPendingIndicatorsForCancelledChangePODocuments(PurchaseOrderDocument newPO)(Code) | | Sets the current and pending indicators of the new purchase order and the old purchase order as well as their statuses, then
save the purchase order.
Parameters: newPO - The new purchase order document that has been canceled. |
setCurrentAndPendingIndicatorsForCancelledRemoveHoldPODocuments | public void setCurrentAndPendingIndicatorsForCancelledRemoveHoldPODocuments(PurchaseOrderDocument newPO)(Code) | | Sets the current and pending indicators of the new purchase order and the old purchase order as well as their statuses, then
save the purchase order
Parameters: newPO - The new purchase order remove hold document that has been canceled. |
setCurrentAndPendingIndicatorsForCancelledReopenPODocuments | public void setCurrentAndPendingIndicatorsForCancelledReopenPODocuments(PurchaseOrderDocument newPO)(Code) | | Sets the current and pending indicators of the new purchase order and the old purchase order as well as their statuses, then
save the purchase order.
Parameters: newPO - The new purchase order reopen document that has been canceled. |
setCurrentAndPendingIndicatorsForDisapprovedChangePODocuments | public void setCurrentAndPendingIndicatorsForDisapprovedChangePODocuments(PurchaseOrderDocument newPO)(Code) | | Sets the current and pending indicators of the new purchase order and the old purchase order as well as their statuses, then
save the purchase order.
Parameters: newPO - The new purchase order document that has been disapproved. |
setCurrentAndPendingIndicatorsForDisapprovedRemoveHoldPODocuments | public void setCurrentAndPendingIndicatorsForDisapprovedRemoveHoldPODocuments(PurchaseOrderDocument newPO)(Code) | | Sets the current and pending indicators of the new purchase order and the old purchase order as well as their statuses, then
save the purchase order.
Parameters: newPO - The new purchase order remove hold document that has been disapproved. |
setCurrentAndPendingIndicatorsForDisapprovedReopenPODocuments | public void setCurrentAndPendingIndicatorsForDisapprovedReopenPODocuments(PurchaseOrderDocument newPO)(Code) | | Sets the current and pending indicators of the new purchase order and the old purchase order as well as their statuses, then
save the purchase order.
Parameters: newPO - The new purchase order reopen document that has been disapproved. |
setupDocumentForPendingFirstTransmission | public void setupDocumentForPendingFirstTransmission(PurchaseOrderDocument po, boolean hasActionRequestForDocumentTransmission)(Code) | | Update the purchase order document with the appropriate status for pending first transmission if the transmission method code
is PRINT, or set the purchase order status to OPEN, set the initial open date and save the purchase order if the transmission
method code is not PRINT and the hasActionRequestForDocumentTransmission is false.
Parameters: po - The purchase order document whose status to be updated. Parameters: hasActionRequestForDocumentTransmission - boolean true if this purchase order has action request for documenttransmission. |
|
|