001    /*
002     * Copyright 2011 The Kuali Foundation.
003     * 
004     * Licensed under the Educational Community License, Version 2.0 (the "License");
005     * you may not use this file except in compliance with the License.
006     * You may obtain a copy of the License at
007     * 
008     * http://www.opensource.org/licenses/ecl2.php
009     * 
010     * Unless required by applicable law or agreed to in writing, software
011     * distributed under the License is distributed on an "AS IS" BASIS,
012     * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013     * See the License for the specific language governing permissions and
014     * limitations under the License.
015     */
016    package org.kuali.kfs.integration.purap;
017    
018    import java.sql.Date;
019    import java.util.List;
020    
021    
022    /**
023     * Methods needed to interface with a Purchasing/Accounts Payable module
024     */
025    public interface PurchasingAccountsPayableModuleService {
026        /**
027         * Provides the inquiry Url for a purchase order. Used by the PurAp / CAMs document to show user further information about the
028         * PO.
029         * 
030         * @param purchaseOrderNumber
031         * @return
032         */
033        public String getPurchaseOrderInquiryUrl(Integer purchaseOrderNumber);
034    
035        /**
036         * Adds asset numbers that were created to a Purchase Order that caused the creation.
037         * 
038         * @param purchaseOrderNumber
039         * @param authorId
040         * @param noteText
041         */
042        public void addAssignedAssetNumbers(Integer purchaseOrderNumber, String authorId, String noteText);
043    
044        /**
045         * Returns a sensitive data record associated with the given code
046         * 
047         * @param sensitiveDataCode the code of the sensitive data
048         * @return a record of sensitive data information
049         */
050        public PurchasingAccountsPayableSensitiveData getSensitiveDataByCode(String sensitiveDataCode);
051    
052        /**
053         * Returns all sensitive data records known to the module
054         * 
055         * @return a List of all sensitive data known to the module
056         */
057        public List<PurchasingAccountsPayableSensitiveData> getAllSensitiveDatas();
058    
059        /**
060         * This method...
061         * 
062         * @param financialSystemDocumentTypeCode
063         * @return
064         */
065        public boolean isPurchasingBatchDocument(String financialSystemDocumentTypeCode);
066    
067        public void handlePurchasingBatchCancels(String documentNumber, String financialSystemDocumentTypeCode, boolean primaryCancel, boolean disbursedPayment);
068    
069        public void handlePurchasingBatchPaids(String documentNumber, String financialSystemDocumentTypeCode, Date processDate);
070    
071        /**
072         * Returns the string value for the b2b that would be used as part of the urls in the
073         * Actions url column in vendor search for the "shop" link for B2B vendor. If you 
074         * don't wish to implement the "shop" feature in KFS then you can set this string to
075         * an empty string.
076         * 
077         * @return b2bUrlString
078         */
079        public String getB2BUrlString();
080        
081    }