Java Doc for PaymentRequestService.java in  » ERP-CRM-Financial » Kuali-Financial-System » org » kuali » module » purap » service » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Java Source Code / Java Documentation
1. 6.0 JDK Core
2. 6.0 JDK Modules
3. 6.0 JDK Modules com.sun
4. 6.0 JDK Modules com.sun.java
5. 6.0 JDK Modules sun
6. 6.0 JDK Platform
7. Ajax
8. Apache Harmony Java SE
9. Aspect oriented
10. Authentication Authorization
11. Blogger System
12. Build
13. Byte Code
14. Cache
15. Chart
16. Chat
17. Code Analyzer
18. Collaboration
19. Content Management System
20. Database Client
21. Database DBMS
22. Database JDBC Connection Pool
23. Database ORM
24. Development
25. EJB Server geronimo
26. EJB Server GlassFish
27. EJB Server JBoss 4.2.1
28. EJB Server resin 3.1.5
29. ERP CRM Financial
30. ESB
31. Forum
32. GIS
33. Graphic Library
34. Groupware
35. HTML Parser
36. IDE
37. IDE Eclipse
38. IDE Netbeans
39. Installer
40. Internationalization Localization
41. Inversion of Control
42. Issue Tracking
43. J2EE
44. JBoss
45. JMS
46. JMX
47. Library
48. Mail Clients
49. Net
50. Parser
51. PDF
52. Portal
53. Profiler
54. Project Management
55. Report
56. RSS RDF
57. Rule Engine
58. Science
59. Scripting
60. Search Engine
61. Security
62. Sevlet Container
63. Source Control
64. Swing Library
65. Template Engine
66. Test Coverage
67. Testing
68. UML
69. Web Crawler
70. Web Framework
71. Web Mail
72. Web Server
73. Web Services
74. Web Services apache cxf 2.0.1
75. Web Services AXIS2
76. Wiki Engine
77. Workflow Engines
78. XML
79. XML UI
Java
Java Tutorial
Java Open Source
Jar File Download
Java Articles
Java Products
Java by API
Photoshop Tutorials
Maya Tutorials
Flash Tutorials
3ds-Max Tutorials
Illustrator Tutorials
GIMP Tutorials
C# / C Sharp
C# / CSharp Tutorial
C# / CSharp Open Source
ASP.Net
ASP.NET Tutorial
JavaScript DHTML
JavaScript Tutorial
JavaScript Reference
HTML / CSS
HTML CSS Reference
C / ANSI-C
C Tutorial
C++
C++ Tutorial
Ruby
PHP
Python
Python Tutorial
Python Open Source
SQL Server / T-SQL
SQL Server / T-SQL Tutorial
Oracle PL / SQL
Oracle PL/SQL Tutorial
PostgreSQL
SQL / MySQL
MySQL Tutorial
VB.Net
VB.Net Tutorial
Flash / Flex / ActionScript
VBA / Excel / Access / Word
XML
XML Tutorial
Microsoft Office PowerPoint 2007 Tutorial
Microsoft Office Excel 2007 Tutorial
Microsoft Office Word 2007 Tutorial
Java Source Code / Java Documentation » ERP CRM Financial » Kuali Financial System » org.kuali.module.purap.service 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


org.kuali.module.purap.service.PaymentRequestService

All known Subclasses:   org.kuali.module.purap.service.impl.PaymentRequestServiceImpl,
PaymentRequestService
public interface PaymentRequestService extends AccountsPayableDocumentSpecificService(Code)
Defines methods that must be implemented by a PaymentRequestService implementation.




Method Summary
public  voidaddHoldOnPaymentRequest(PaymentRequestDocument document, String note)
     Marks a payment request on hold.
public  booleanautoApprovePaymentRequest(PaymentRequestDocument doc, KualiDecimal defaultMinimumLimit)
     Checks whether the payment request document is eligible for auto approval.
public  booleanautoApprovePaymentRequests()
     Retrieve a list of PREQs that aren't approved, check to see if they match specific requirements, then auto-approve them if possible.
public  DatecalculatePayDate(Date invoiceDate, PaymentTermType terms)
     Calculate based on the terms and calculate a date 10 days from today.
public  voidcalculatePaymentRequest(PaymentRequestDocument pr, boolean updateDiscount)
     Recalculate the payment request.
public  booleancanHoldPaymentRequest(PaymentRequestDocument document, UniversalUser user)
     Determines if a user has permission to put the payment request on hold.
Parameters:
  document - The payment request document to be determined whether the user has permission to put it on hold.
Parameters:
  user - The user whose permission to put the payment request on hold is to be determined.
public  booleancanRemoveHoldPaymentRequest(PaymentRequestDocument document, UniversalUser user)
     Determines if a user has permission to remove a hold on the payment request.
Parameters:
  document - The payment request document to be determined whether the user has permission to remove hold on it.
Parameters:
  user - The user whose permission to remove hold on the payment request is to be determined.
public  booleancanUserRemoveRequestCancelOnPaymentRequest(PaymentRequestDocument document, UniversalUser user)
     Determines if a user has permission to remove a request for cancel on the payment request.
Parameters:
  document - The payment request document to be determined whether the user has permission to remove a request for cancel on it.
Parameters:
  user - The user whose permission to remove a request for cancel on the payment request is to be determined.
public  booleancanUserRequestCancelOnPaymentRequest(PaymentRequestDocument document, UniversalUser user)
     Determines if a user has permission to request cancel on the payment request.
Parameters:
  document - The payment request document to be determined whether the user has permission to request cancel on it.
Parameters:
  user - The user whose permission to request cancel on the payment request is to be determined.
public  voidcancelExtractedPaymentRequest(PaymentRequestDocument paymentRequest, String note)
     Cancels a PREQ that has already been extracted if allowed.
public  voiddeleteSummaryAccounts(Integer purapDocumentIdentifier)
    
public  Iterator<PaymentRequestDocument>getImmediatePaymentRequestsToExtract(String chartCode)
     Get all the payment requests that are immediate and need to be extracted to PDP.
Parameters:
  chartCode - The chart code to be used as one of the criterias to retrieve the payment request documents.
public  PaymentRequestDocumentgetPaymentRequestByDocumentNumber(String documentNumber)
     Obtains the payment request document given the document number.
Parameters:
  documentNumber - The document number to be used to obtain the payment request document.
public  PaymentRequestDocumentgetPaymentRequestById(Integer poDocId)
     Obtains the payment request document given the purapDocumentIdentifier.
Parameters:
  poDocId - The purapDocumentIdentifier of the payment request document to be obtained.
public  Iterator<PaymentRequestDocument>getPaymentRequestToExtractByChart(String chartCode)
     Get all the regular payment requests for a single campus.
Parameters:
  chartCode - The chart code to be used as one of the criterias to retrieve the payment request documents.
public  ListgetPaymentRequestsByPOIdInvoiceAmountInvoiceDate(Integer poId, KualiDecimal invoiceAmount, Date invoiceDate)
     Obtains a list of payment request documents given the purchase order id, the invoice amount and the invoice date.
Parameters:
  poId - The purchase order id used to obtain the payment request documents.
Parameters:
  invoiceAmount - The invoice amount used to obtain the payment request documents.
Parameters:
  invoiceDate - The invoice date used to obtain the payment request documents.
public  List<PaymentRequestDocument>getPaymentRequestsByPurchaseOrderId(Integer poDocId)
     Obtains a list of payment request documents given the purchase order id.
Parameters:
  poDocId - The purchase order id to be used to obtain a list of payment request documents.
public  ListgetPaymentRequestsByVendorNumberInvoiceNumber(Integer vendorHeaderGeneratedIdentifier, Integer vendorDetailAssignedIdentifier, String invoiceNumber)
     Obtains a list of payment request documents given the vendorHeaderGeneratedIdentifier, vendorDetailAssignedIdentifier and the invoice number.
Parameters:
  vendorHeaderGeneratedIdentifier - The vendorHeaderGeneratedIdentifier used to obtain the payment request documents.
Parameters:
  vendorDetailAssignedIdentifier - The vendorDetailAssignedIdentifier used to obtain the payment request documents.
Parameters:
  invoiceNumber - The invoice number used to obtain the payment request documents.
public  Iterator<PaymentRequestDocument>getPaymentRequestsToExtract()
     Get all the payment requests that need to be extracted.
public  Iterator<PaymentRequestDocument>getPaymentRequestsToExtractByCM(String campusCode, CreditMemoDocument cmd)
     Get all the payment requests that match a credit memo.
Parameters:
  cmd - The credit memo document to be used to obtain the payment requests.
public  Iterator<PaymentRequestDocument>getPaymentRequestsToExtractByVendor(String campusCode, VendorGroupingHelper vendor)
     Get all the payment requests that match a vendor.
public  Iterator<PaymentRequestDocument>getPaymentRequestsToExtractSpecialPayments(String chartCode)
     Get all the special payment requests for a single chart that need to be extracted.
Parameters:
  chartCode - The chart code to be used as one of the criterias to retrieve the payment request documents.
public  booleanhasDiscountItem(PaymentRequestDocument preq)
     This method specifies whether the payment request document has a discount item.
Parameters:
  preq - The payment request document to be verified whether it has a discount item.
public  booleanisExtracted(PaymentRequestDocument document)
     Returns true if the payment request has been extracted
Parameters:
  document - The payment request document to be determined whether it is extracted.
public  booleanisInvoiceDateAfterToday(Date invoiceDate)
     Determines whether the invoice date is after today.
Parameters:
  invoiceDate - The invoice date to be determined whether it's after today.
public  voidmarkPaid(PaymentRequestDocument pr, Date processDate)
     Mark a payment request as being paid and set the payment request's paid date as the processDate.
public  HashMap<String, String>paymentRequestDuplicateMessages(PaymentRequestDocument document)
     Performs the processing to check whether the payment request is a duplicate and if so, adds the information about the type of duplication into the resulting HashMap to be returned by this method.
Parameters:
  document - The payment request document to be processed/checked for duplicates.
public  voidpopulateAndSavePaymentRequest(PaymentRequestDocument preq)
     Populate and save payment request.
public  voidpopulatePaymentRequest(PaymentRequestDocument preq)
     Populate payment request.
public  voidremoveHoldOnPaymentRequest(PaymentRequestDocument document, String note)
     Removes a hold on a payment request.
public  voidremoveRequestCancelOnPaymentRequest(PaymentRequestDocument document, String note)
     Removes a request cancel on payment request.
public  voidrequestCancelOnPaymentRequest(PaymentRequestDocument document, String note)
     Marks a payment request as requested to be canceled.
public  voidresetExtractedPaymentRequest(PaymentRequestDocument paymentRequest, String note)
     Resets a Payment Request that had an associated Payment Request or Credit Memo cancelled externally.
public  voidsaveDocumentWithoutValidation(PaymentRequestDocument paymentRequestDocument)
     Persists the payment request without business rule checks.



Method Detail
addHoldOnPaymentRequest
public void addHoldOnPaymentRequest(PaymentRequestDocument document, String note) throws Exception(Code)
Marks a payment request on hold.
Parameters:
  document - The payment request document to be marked as on hold.
Parameters:
  note - The note to be added to the payment request document while being marked as on hold.
throws:
  Exception -



autoApprovePaymentRequest
public boolean autoApprovePaymentRequest(PaymentRequestDocument doc, KualiDecimal defaultMinimumLimit)(Code)
Checks whether the payment request document is eligible for auto approval. If so, then updates the status of the document to auto approved and calls the documentService to blanket approve the document, then returns false. If the document is not eligible for auto approval then returns true.
Parameters:
  doc - The payment request document to be auto approved.
Parameters:
  defaultMinimumLimit - The default minimum limit amount to be used in determining the eligibility of the document to be auto approved. boolean true if the payment request document is not eligible for auto approval.



autoApprovePaymentRequests
public boolean autoApprovePaymentRequests()(Code)
Retrieve a list of PREQs that aren't approved, check to see if they match specific requirements, then auto-approve them if possible. boolean true if the auto approval of payment requests has at least one error.



calculatePayDate
public Date calculatePayDate(Date invoiceDate, PaymentTermType terms)(Code)
Calculate based on the terms and calculate a date 10 days from today. Pick the one that is the farthest out. We always calculate the discount date, if there is one.
Parameters:
  invoiceDate - The invoice date to be used in the pay date calculation.
Parameters:
  terms - The payment term type to be used in the pay date calculation. The resulting pay date given the invoice date and the terms.



calculatePaymentRequest
public void calculatePaymentRequest(PaymentRequestDocument pr, boolean updateDiscount)(Code)
Recalculate the payment request.
Parameters:
  pr - The payment request document to be calculated.
Parameters:
  updateDiscount - boolean true if we also want to calculate the discount items for the payment request.



canHoldPaymentRequest
public boolean canHoldPaymentRequest(PaymentRequestDocument document, UniversalUser user)(Code)
Determines if a user has permission to put the payment request on hold.
Parameters:
  document - The payment request document to be determined whether the user has permission to put it on hold.
Parameters:
  user - The user whose permission to put the payment request on hold is to be determined. boolean true if the user has permission to put the payment request on hold.



canRemoveHoldPaymentRequest
public boolean canRemoveHoldPaymentRequest(PaymentRequestDocument document, UniversalUser user)(Code)
Determines if a user has permission to remove a hold on the payment request.
Parameters:
  document - The payment request document to be determined whether the user has permission to remove hold on it.
Parameters:
  user - The user whose permission to remove hold on the payment request is to be determined. boolean true if the user has permission to remove hold on the payment request.



canUserRemoveRequestCancelOnPaymentRequest
public boolean canUserRemoveRequestCancelOnPaymentRequest(PaymentRequestDocument document, UniversalUser user)(Code)
Determines if a user has permission to remove a request for cancel on the payment request.
Parameters:
  document - The payment request document to be determined whether the user has permission to remove a request for cancel on it.
Parameters:
  user - The user whose permission to remove a request for cancel on the payment request is to be determined. boolean true if the user has permission to remove a request for cancel on the payment request.



canUserRequestCancelOnPaymentRequest
public boolean canUserRequestCancelOnPaymentRequest(PaymentRequestDocument document, UniversalUser user)(Code)
Determines if a user has permission to request cancel on the payment request.
Parameters:
  document - The payment request document to be determined whether the user has permission to request cancel on it.
Parameters:
  user - The user whose permission to request cancel on the payment request is to be determined. boolean true if the user has permission to request cancel on the payment request.



cancelExtractedPaymentRequest
public void cancelExtractedPaymentRequest(PaymentRequestDocument paymentRequest, String note)(Code)
Cancels a PREQ that has already been extracted if allowed.
Parameters:
  paymentRequest - The extracted payment request document to be canceled.
Parameters:
  note - The note to be added to the payment request document.



deleteSummaryAccounts
public void deleteSummaryAccounts(Integer purapDocumentIdentifier)(Code)
Deletes the payment request summary accounts by purapDocumentIdentifier
Parameters:
  purapDocumentIdentifier - The purapDocumentIdentifier of the payment request document whose summary accounts are to be deleted.



getImmediatePaymentRequestsToExtract
public Iterator<PaymentRequestDocument> getImmediatePaymentRequestsToExtract(String chartCode)(Code)
Get all the payment requests that are immediate and need to be extracted to PDP.
Parameters:
  chartCode - The chart code to be used as one of the criterias to retrieve the payment request documents. The iterator of the list of the resulting payment request documents returned by the paymentRequestDao.



getPaymentRequestByDocumentNumber
public PaymentRequestDocument getPaymentRequestByDocumentNumber(String documentNumber)(Code)
Obtains the payment request document given the document number.
Parameters:
  documentNumber - The document number to be used to obtain the payment request document. The payment request document whose document number matches with the given input parameter.



getPaymentRequestById
public PaymentRequestDocument getPaymentRequestById(Integer poDocId)(Code)
Obtains the payment request document given the purapDocumentIdentifier.
Parameters:
  poDocId - The purapDocumentIdentifier of the payment request document to be obtained. The payment request document whose purapDocumentIdentifier matches with the input parameter.



getPaymentRequestToExtractByChart
public Iterator<PaymentRequestDocument> getPaymentRequestToExtractByChart(String chartCode)(Code)
Get all the regular payment requests for a single campus.
Parameters:
  chartCode - The chart code to be used as one of the criterias to retrieve the payment request documents. The iterator of the resulting payment request documents returned by the paymentRequestDao.



getPaymentRequestsByPOIdInvoiceAmountInvoiceDate
public List getPaymentRequestsByPOIdInvoiceAmountInvoiceDate(Integer poId, KualiDecimal invoiceAmount, Date invoiceDate)(Code)
Obtains a list of payment request documents given the purchase order id, the invoice amount and the invoice date.
Parameters:
  poId - The purchase order id used to obtain the payment request documents.
Parameters:
  invoiceAmount - The invoice amount used to obtain the payment request documents.
Parameters:
  invoiceDate - The invoice date used to obtain the payment request documents. The List of payment request documents that match the given criterias (purchase order id, invoice amount and invoice date).



getPaymentRequestsByPurchaseOrderId
public List<PaymentRequestDocument> getPaymentRequestsByPurchaseOrderId(Integer poDocId)(Code)
Obtains a list of payment request documents given the purchase order id.
Parameters:
  poDocId - The purchase order id to be used to obtain a list of payment request documents. The List of payment request documents given the purchase order id.



getPaymentRequestsByVendorNumberInvoiceNumber
public List getPaymentRequestsByVendorNumberInvoiceNumber(Integer vendorHeaderGeneratedIdentifier, Integer vendorDetailAssignedIdentifier, String invoiceNumber)(Code)
Obtains a list of payment request documents given the vendorHeaderGeneratedIdentifier, vendorDetailAssignedIdentifier and the invoice number.
Parameters:
  vendorHeaderGeneratedIdentifier - The vendorHeaderGeneratedIdentifier used to obtain the payment request documents.
Parameters:
  vendorDetailAssignedIdentifier - The vendorDetailAssignedIdentifier used to obtain the payment request documents.
Parameters:
  invoiceNumber - The invoice number used to obtain the payment request documents. The List of payment request documents that match the given criterias.



getPaymentRequestsToExtract
public Iterator<PaymentRequestDocument> getPaymentRequestsToExtract()(Code)
Get all the payment requests that need to be extracted. The iterator of the resulting payment request documents returned by the paymentRequestDao.



getPaymentRequestsToExtractByCM
public Iterator<PaymentRequestDocument> getPaymentRequestsToExtractByCM(String campusCode, CreditMemoDocument cmd)(Code)
Get all the payment requests that match a credit memo.
Parameters:
  cmd - The credit memo document to be used to obtain the payment requests. The iterator of the resulting payment request documents returned by the paymentRequestDao.



getPaymentRequestsToExtractByVendor
public Iterator<PaymentRequestDocument> getPaymentRequestsToExtractByVendor(String campusCode, VendorGroupingHelper vendor)(Code)
Get all the payment requests that match a vendor.
Parameters:
  vendor - The iterator of the resulting payment request documents returned by the paymentRequestDao.



getPaymentRequestsToExtractSpecialPayments
public Iterator<PaymentRequestDocument> getPaymentRequestsToExtractSpecialPayments(String chartCode)(Code)
Get all the special payment requests for a single chart that need to be extracted.
Parameters:
  chartCode - The chart code to be used as one of the criterias to retrieve the payment request documents. The iterator of the resulting payment request documents returned by the paymentRequestDao.



hasDiscountItem
public boolean hasDiscountItem(PaymentRequestDocument preq)(Code)
This method specifies whether the payment request document has a discount item.
Parameters:
  preq - The payment request document to be verified whether it has a discount item. boolean true if the payment request document has at least one discount item.



isExtracted
public boolean isExtracted(PaymentRequestDocument document)(Code)
Returns true if the payment request has been extracted
Parameters:
  document - The payment request document to be determined whether it is extracted. boolean true if the payment request document is extracted.



isInvoiceDateAfterToday
public boolean isInvoiceDateAfterToday(Date invoiceDate)(Code)
Determines whether the invoice date is after today.
Parameters:
  invoiceDate - The invoice date to be determined whether it's after today. boolean true if the given invoice date is after today.



markPaid
public void markPaid(PaymentRequestDocument pr, Date processDate)(Code)
Mark a payment request as being paid and set the payment request's paid date as the processDate.
Parameters:
  pr - The payment request document to be marked as paid and paid date to be set.
Parameters:
  processDate - The date to be set as the payment request's paid date.



paymentRequestDuplicateMessages
public HashMap<String, String> paymentRequestDuplicateMessages(PaymentRequestDocument document)(Code)
Performs the processing to check whether the payment request is a duplicate and if so, adds the information about the type of duplication into the resulting HashMap to be returned by this method.
Parameters:
  document - The payment request document to be processed/checked for duplicates. The HashMap containing "PREQDuplicateInvoice" as the key and the stringdescribing the types of duplication as the value.



populateAndSavePaymentRequest
public void populateAndSavePaymentRequest(PaymentRequestDocument preq) throws WorkflowException(Code)
Populate and save payment request.
Parameters:
  preq - The payment request document to be populated and saved.



populatePaymentRequest
public void populatePaymentRequest(PaymentRequestDocument preq)(Code)
Populate payment request.
Parameters:
  preq - The payment request document to be populated.



removeHoldOnPaymentRequest
public void removeHoldOnPaymentRequest(PaymentRequestDocument document, String note) throws Exception(Code)
Removes a hold on a payment request.
Parameters:
  document - The payment request document whose hold is to be removed.
Parameters:
  note - The note to be added to the payment request document while its hold is being removed.
throws:
  Exception -



removeRequestCancelOnPaymentRequest
public void removeRequestCancelOnPaymentRequest(PaymentRequestDocument document, String note) throws Exception(Code)
Removes a request cancel on payment request.
Parameters:
  document - The payment request document to be used for request cancel.
Parameters:
  note - The note to be added to the payment request document upon the removal of the request cancel.
throws:
  Exception -



requestCancelOnPaymentRequest
public void requestCancelOnPaymentRequest(PaymentRequestDocument document, String note) throws Exception(Code)
Marks a payment request as requested to be canceled.
Parameters:
  document - The payment request document to be marked as requested to be canceled.
Parameters:
  note - The note to be added to the payment request document while being marked as requested to be canceled.
throws:
  Exception -



resetExtractedPaymentRequest
public void resetExtractedPaymentRequest(PaymentRequestDocument paymentRequest, String note)(Code)
Resets a Payment Request that had an associated Payment Request or Credit Memo cancelled externally.
Parameters:
  paymentRequest - The extracted payment request document to be resetted.
Parameters:
  note - The note to be added to the payment request document upon its reset.



saveDocumentWithoutValidation
public void saveDocumentWithoutValidation(PaymentRequestDocument paymentRequestDocument)(Code)
Persists the payment request without business rule checks.
Parameters:
  paymentRequestDocument - - payment request document to save.



www.java2java.com | Contact Us
Copyright 2009 - 12 Demo Source and Support. All rights reserved.
All other trademarks are property of their respective owners.