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.module.endow.document.service;
017    
018    import org.kuali.kfs.module.endow.businessobject.EndowmentTransactionCode;
019    import org.kuali.kfs.module.endow.businessobject.Security;
020    
021    /**
022     * This class...
023     */
024    public interface EndowmentTransactionDocumentService {
025    
026        /**
027         * This method gets an endowment transaction by the primary key: endowment transaction code
028         * 
029         * @param endowmentTransactionCode
030         * @return the endowment transaction
031         */
032        public String[] getSecurity(String securityID);
033        
034        /**
035         * Check if there is a GLLink record in the EndowmentTransactionCode that the chart code in the record matches the chart code in the KemidGeneralLedgerAccount associated with a KEMID  given the IP indicator info.
036         * @param kemid
037         * @param etranCode
038         * @param ipIndicator
039         * @return true or false
040         */
041        public boolean matchChartBetweenKEMIDAndETranCode(String kemid, String etranCode, String ipIndicator);
042        
043        /**
044         * Check if there is a GLLink record in the EndowmentTransactionCode that the chart code in the record matches the chart code in the GeneralLedgerAccount associated with a Security given the IP indicator info.
045         * 
046         * @param securityID
047         * @param etranCode
048         * @param ipIndicator
049         * @return
050         */
051        public boolean matchChartBetweenSecurityAndETranCode(Security security, String etranCode, String ipIndicator);
052    
053        /**
054         * This method gets security by the primary key: securityId
055         * 
056         * @param securityId
057         * @return String[]
058         */
059        public String[] getSecurityForHoldingHistoryValueAdjustment(String securityId);
060        
061    }