|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface PurchaseOrderService
Defines methods that must be implemented by classes providing a PurchaseOrderService.
Method Summary | |
---|---|
boolean |
autoCloseFullyDisencumberedOrders()
This gets a list of Purchase Orders in Open status and checks to see if their line item encumbrances are all fully disencumbered and if so then the Purchase Order is closed and notes added to indicate the change occurred in batch |
boolean |
autoCloseRecurringOrders()
- PO status is OPEN - Recurring payment type code is not null - Vendor Choice is not Sub-Contract - PO End Date <= parm date (comes from system parameter) - Verify that the system parameter date entered is not greater than the current date minus three months. |
boolean |
canAmendPurchaseOrder(PurchaseOrderDocument purchaseOrder)
Determines whether to display the amend button for the purchase order document. |
boolean |
canHoldPayment(PurchaseOrderDocument purchaseOrder)
Determines whether to display the amend and payment hold buttons for the purchase order document. |
HashMap<String,List<PurchaseOrderItem>> |
categorizeItemsForSplit(List<PurchaseOrderItem> items)
Used to provide sublists of the list of the original PO's items according to whether they are marked to be moved or not. |
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. |
void |
completePurchaseOrderAmendment(PurchaseOrderDocument po)
|
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. |
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. |
PurchaseOrderSplitDocument |
createAndSavePurchaseOrderSplitDocument(List<PurchaseOrderItem> newPOItems,
PurchaseOrderDocument currentDocument,
boolean copyNotes,
String splitNoteText)
Creates and saves a Purchase Order Split document based on the old PO document, and the items from that PO that the new Split PO is to contain. |
void |
createAutomaticPurchaseOrderDocument(RequisitionDocument reqDocument)
Creates an automatic purchase order document using the given requisition document |
PurchaseOrderDocument |
createPurchaseOrderDocument(RequisitionDocument reqDocument,
String newSessionUserId,
Integer contractManagerCode)
Creates a PurchaseOrderDocument from given RequisitionDocument. |
PurchaseOrderDocument |
getCurrentPurchaseOrder(Integer id)
Obtains the purchase order document whose current indicator is true, given a purchase order id which is the purapDocumentIdentifier. |
org.kuali.rice.kns.util.KualiDecimal |
getInternalPurchasingDollarLimit(PurchaseOrderDocument po)
Obtains the internal purchasing dollar limit amount for a purchase order document. |
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. |
List<PurchaseOrderDocument> |
getPendingPurchaseOrderFaxes()
This method gets all the Purchase orders that are waiting for faxing |
PurchaseOrderDocument |
getPurchaseOrderByDocumentNumber(String documentNumber)
Obtains the purchase order document given the document number. |
ArrayList<org.kuali.rice.kns.bo.Note> |
getPurchaseOrderNotes(Integer id)
Obtains all the notes that belong to this purchase order given the purchase order id. |
ArrayList<PurchaseOrderQuoteStatus> |
getPurchaseOrderQuoteStatusCodes()
|
boolean |
hasNewUnorderedItem(PurchaseOrderDocument po)
Checks the item list for newly added unordered items. |
boolean |
isNewItemForAmendment(PurchaseOrderItem poItem)
Determines if a purchase order item is newly added on the Purchase Order Amendment Document. |
boolean |
isNewUnorderedItem(PurchaseOrderItem poItem)
Determines if a purchase order item is new unordered item. |
boolean |
isPurchaseOrderOpenForProcessing(Integer poId)
|
boolean |
isPurchaseOrderOpenForProcessing(PurchaseOrderDocument purchaseOrderDocument)
|
void |
performPrintPurchaseOrderPDFOnly(String documentNumber,
ByteArrayOutputStream baosPDF)
Generates and displays the purchase order pdf by invoking the generatePurchaseOrderPdf method of the PrintService. |
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. |
void |
performPurchaseOrderPreviewPrinting(String documentNumber,
ByteArrayOutputStream baosPDF)
Creates and displays the pdf document for the purchase order with a draft watermark |
PurchaseOrderVendorQuote |
populateQuoteWithVendor(Integer headerId,
Integer detailId,
String documentNumber)
Creates a PurchaseOrderVendorQuote based on the data on the selected vendor and the document number. |
boolean |
printPurchaseOrderQuotePDF(PurchaseOrderDocument po,
PurchaseOrderVendorQuote povq,
ByteArrayOutputStream baosPDF)
|
boolean |
printPurchaseOrderQuoteRequestsListPDF(String documentNumber,
ByteArrayOutputStream baosPDF)
|
void |
processACMReq(ContractManagerAssignmentDocument acmDoc)
This method takes care of creating PurchaseOrderDocuments from a list of Requisitions on an ACM |
void |
retransmitB2BPurchaseOrder(PurchaseOrderDocument po)
|
void |
retransmitPurchaseOrderPDF(PurchaseOrderDocument po,
ByteArrayOutputStream baosPDF)
Generates and displays the purchase order retransmit pdf by invoking the generatePurchaseOrderPdfForRetransmission method of the PrintService. |
List<PurchasingCapitalAssetItem> |
retrieveCapitalAssetItemsForIndividual(Integer poId)
Return a list of PurchasingCapitalAssetItems where each item would have a CapitalAssetSystem. |
CapitalAssetSystem |
retrieveCapitalAssetSystemForOneSystem(Integer poId)
Return a CapitalAssetSystem which provides the capital asset information such as asset numbers and asset type. |
List<CapitalAssetSystem> |
retrieveCapitalAssetSystemsForMultipleSystem(Integer poId)
Return a list of CapitalAssetSystems which provide the capital asset information such as asset numbers and asset type. |
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. |
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. |
void |
setCurrentAndPendingIndicatorsForCancelledRemoveHoldPODocuments(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 |
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. |
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. |
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. |
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. |
void |
setReceivingRequiredIndicatorForPurchaseOrder(PurchaseOrderDocument po)
Performs a threshold check on the purchase order to determine if any attribute on the purchase order falls within a defined threshold. |
void |
updateVendorCommodityCode(PurchaseOrderDocument po)
If there are commodity codes on the items on the PurchaseOrderDocument that haven't existed yet on the vendor that the PurchaseOrderDocument is using, then we will spawn a new VendorDetailMaintenanceDocument automatically to update the vendor with the commodity codes that aren't already existing on the vendor. |
VendorDetail |
updateVendorWithMissingCommodityCodesIfNecessary(PurchaseOrderDocument po)
Check whether each of the items contain commodity code, if so then loop through the vendor commodity codes on the vendor to find out whether the commodity code on the item has existed on the vendor. |
Methods inherited from interface org.kuali.kfs.module.purap.document.service.PurchasingDocumentSpecificService |
---|
createCamsItem, createCapitalAssetSystem |
Method Detail |
---|
boolean isPurchaseOrderOpenForProcessing(Integer poId)
boolean isPurchaseOrderOpenForProcessing(PurchaseOrderDocument purchaseOrderDocument)
void createAutomaticPurchaseOrderDocument(RequisitionDocument reqDocument)
reqDocument
- The requisition document that this method will use to create the Automated Purchase Order (APO).PurchaseOrderDocument createPurchaseOrderDocument(RequisitionDocument reqDocument, String newSessionUserId, Integer contractManagerCode)
reqDocument
- The requisition document that this method will use to create the purchase order.newSessionUserId
- The session user id that we'll use to invoke the performLogicWithFakedUserSession method of
PurapService.contractManagerCode
- The contract manager code that we'll need to set on the purchase order.
PurchaseOrderDocument createAndSavePotentialChangeDocument(String documentNumber, String docType, String newDocumentStatusCode)
documentNumber
- The document number of the existing purchase order document from which we try to create a new change
document.docType
- The document type of the new change document.newDocumentStatusCode
- The status code that we want to set on the existing purchase order document after the new change
document is created.
PurchaseOrderDocument createAndRoutePotentialChangeDocument(String documentNumber, String docType, String annotation, List adhocRoutingRecipients, String newDocumentStatusCode)
- documentNumber
- The document number of the existing purchase order document from which we try to create a new change
document.docType
- The document type of the new change document.annotation
- The annotation that we'll use to invoke the routeDocument method of DocumentService.adhocRoutingRecipients
- The adhocRoutingRecipients that we'll use to invoke the routeDocument method of
DocumentService.newDocumentStatusCode
- The status code that we want to set on the existing purchase order document after the new change
document is created.
PurchaseOrderSplitDocument createAndSavePurchaseOrderSplitDocument(List<PurchaseOrderItem> newPOItems, PurchaseOrderDocument currentDocument, boolean copyNotes, String splitNoteText)
newPOItems
- The ListcurrentDocument
- The original PurchaseOrderDocumentcopyNotes
- A boolean. True if notes are to be copied from the old document to the new.splitNoteText
- A String containing the text of the note to be added to the old document.
org.kuali.rice.kns.util.KualiDecimal getInternalPurchasingDollarLimit(PurchaseOrderDocument po)
po
- The purchase order document for which this method is obtaining the internal purchasing dollar limit.
boolean printPurchaseOrderQuoteRequestsListPDF(String documentNumber, ByteArrayOutputStream baosPDF)
boolean printPurchaseOrderQuotePDF(PurchaseOrderDocument po, PurchaseOrderVendorQuote povq, ByteArrayOutputStream baosPDF)
void performPurchaseOrderFirstTransmitViaPrinting(String documentNumber, ByteArrayOutputStream baosPDF)
documentNumber
- The document number of the purchase order document that we want to perform the first transmit.baosPDF
- The ByteArrayOutputStream object that was passed in from the struts action so that we could display the pdf on
the browser.void performPurchaseOrderPreviewPrinting(String documentNumber, ByteArrayOutputStream baosPDF)
documentNumber
- The document number of the purchase order document that we want to perform the first transmit.baosPDF
- The ByteArrayOutputStream object that was passed in from the struts action so that we could display the pdf on
the browser.void performPrintPurchaseOrderPDFOnly(String documentNumber, ByteArrayOutputStream baosPDF)
documentNumber
- The document number of the purchase order document that we want to print the pdf.baosPDF
- The ByteArrayOutputStream object that we'll use to display the pdf on the browser.void retransmitPurchaseOrderPDF(PurchaseOrderDocument po, ByteArrayOutputStream baosPDF)
po
- The purchase order document to be retransmitted.baosPDF
- The ByteArrayOutputStream object that we'll use to display the pdf on the browser.void completePurchaseOrder(PurchaseOrderDocument po)
po
- The newly approved purchase order document that we want to complete.void retransmitB2BPurchaseOrder(PurchaseOrderDocument po)
void completePurchaseOrderAmendment(PurchaseOrderDocument po)
PurchaseOrderDocument getCurrentPurchaseOrder(Integer id)
id
- The po id (purapDocumentIdentifier) that we'll use to retrieve the current purchase order document.
PurchaseOrderDocument getPurchaseOrderByDocumentNumber(String documentNumber)
documentNumber
- The document number of the purchase order that we want to retrieve.
void setCurrentAndPendingIndicatorsForApprovedPODocuments(PurchaseOrderDocument newPO)
newPO
- The new purchase order document that has been approved.void setCurrentAndPendingIndicatorsForDisapprovedChangePODocuments(PurchaseOrderDocument newPO)
newPO
- The new purchase order document that has been disapproved.void setCurrentAndPendingIndicatorsForCancelledChangePODocuments(PurchaseOrderDocument newPO)
newPO
- The new purchase order document that has been canceled.void setCurrentAndPendingIndicatorsForCancelledReopenPODocuments(PurchaseOrderDocument newPO)
newPO
- The new purchase order reopen document that has been canceled.void setCurrentAndPendingIndicatorsForDisapprovedReopenPODocuments(PurchaseOrderDocument newPO)
newPO
- The new purchase order reopen document that has been disapproved.void setCurrentAndPendingIndicatorsForCancelledRemoveHoldPODocuments(PurchaseOrderDocument newPO)
newPO
- The new purchase order remove hold document that has been canceled.void setCurrentAndPendingIndicatorsForDisapprovedRemoveHoldPODocuments(PurchaseOrderDocument newPO)
newPO
- The new purchase order remove hold document that has been disapproved.PurchaseOrderDocument getOldestPurchaseOrder(PurchaseOrderDocument po, PurchaseOrderDocument documentBusinessObject)
po
- The current purchase order object from which we want to obtain the oldest purchase order.documentBusinessObject
- The documentBusinessObject of the current purchase order object.
ArrayList<org.kuali.rice.kns.bo.Note> getPurchaseOrderNotes(Integer id)
id
- The purchase order id (purapDocumentIdentifier).
ArrayList<PurchaseOrderQuoteStatus> getPurchaseOrderQuoteStatusCodes()
void setReceivingRequiredIndicatorForPurchaseOrder(PurchaseOrderDocument po)
po
- void updateVendorCommodityCode(PurchaseOrderDocument po)
po
- The PurchaseOrderDocument containing the vendor that we want to update.boolean hasNewUnorderedItem(PurchaseOrderDocument po)
po
-
VendorDetail updateVendorWithMissingCommodityCodesIfNecessary(PurchaseOrderDocument po)
po
- The PurchaseOrderDocument containing the vendor that we want to update.
boolean isNewUnorderedItem(PurchaseOrderItem poItem)
poItem
-
boolean isNewItemForAmendment(PurchaseOrderItem poItem)
poItem
-
HashMap<String,List<PurchaseOrderItem>> categorizeItemsForSplit(List<PurchaseOrderItem> items)
items
- A ListPurchaseOrderVendorQuote populateQuoteWithVendor(Integer headerId, Integer detailId, String documentNumber)
headerId
- The vendorHeaderGeneratedIdentifier of the selected vendor.detailId
- The vendorDetailAssignedIdentifier of the selected vendor.documentNumber
- The documentNumber of the PurchaseOrderDocument containing this quote.
void processACMReq(ContractManagerAssignmentDocument acmDoc)
acmDoc
- An assign a contract manager documentboolean autoCloseFullyDisencumberedOrders()
boolean autoCloseRecurringOrders()
List<PurchasingCapitalAssetItem> retrieveCapitalAssetItemsForIndividual(Integer poId)
poId
- Purchase Order ID used to retrieve the asset information for the current PO
CapitalAssetSystem retrieveCapitalAssetSystemForOneSystem(Integer poId)
poId
- Purchase Order ID used to retrieve the asset information for the current PO
List<CapitalAssetSystem> retrieveCapitalAssetSystemsForMultipleSystem(Integer poId)
poId
- Purchase Order ID used to retrieve the asset information for the current PO
List<PurchaseOrderDocument> getPendingPurchaseOrderFaxes()
boolean canAmendPurchaseOrder(PurchaseOrderDocument purchaseOrder)
boolean canHoldPayment(PurchaseOrderDocument purchaseOrder)
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |