1 /*
2 * Copyright 2008 The Kuali Foundation
3 *
4 * Licensed under the Educational Community License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.opensource.org/licenses/ecl2.php
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16 package org.kuali.ole.integration.purap;
17
18 import java.sql.Date;
19 import java.util.List;
20
21
22 /**
23 * Methods needed to interface with a Purchasing/Accounts Payable module
24 */
25 public interface PurchasingAccountsPayableModuleService {
26 /**
27 * Provides the inquiry Url for a purchase order. Used by the PurAp / CAMs document to show user further information about the
28 * PO.
29 *
30 * @param purchaseOrderNumber
31 * @return
32 */
33 public String getPurchaseOrderInquiryUrl(Integer purchaseOrderNumber);
34
35 /**
36 * Adds asset numbers that were created to a Purchase Order that caused the creation.
37 *
38 * @param purchaseOrderNumber
39 * @param authorId
40 * @param noteText
41 */
42 public void addAssignedAssetNumbers(Integer purchaseOrderNumber, String authorId, String noteText);
43
44 /**
45 * Returns a sensitive data record associated with the given code
46 *
47 * @param sensitiveDataCode the code of the sensitive data
48 * @return a record of sensitive data information
49 */
50 public PurchasingAccountsPayableSensitiveData getSensitiveDataByCode(String sensitiveDataCode);
51
52 /**
53 * Returns all sensitive data records known to the module
54 *
55 * @return a List of all sensitive data known to the module
56 */
57 public List<PurchasingAccountsPayableSensitiveData> getAllSensitiveDatas();
58
59 /**
60 * This method...
61 *
62 * @param financialSystemDocumentTypeCode
63 * @return
64 */
65 public boolean isPurchasingBatchDocument(String financialSystemDocumentTypeCode);
66
67 public void handlePurchasingBatchCancels(String documentNumber, String financialSystemDocumentTypeCode, boolean primaryCancel, boolean disbursedPayment);
68
69 public void handlePurchasingBatchPaids(String documentNumber, String financialSystemDocumentTypeCode, Date processDate);
70
71 /**
72 * Returns the string value for the b2b that would be used as part of the urls in the
73 * Actions url column in vendor search for the "shop" link for B2B vendor. If you
74 * don't wish to implement the "shop" feature in OLE then you can set this string to
75 * an empty string.
76 *
77 * @return b2bUrlString
78 */
79 public String getB2BUrlString();
80
81 }