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.sys.service;
017    
018    import org.kuali.kfs.sys.businessobject.Bank;
019    
020    /**
021     * This service interface defines methods that a BankService implementation must provide.
022     */
023    public interface BankService {
024    
025        /**
026         * Retrieves a bank object who's primary id matches the values provided.
027         * 
028         * @param bankCode The bank code to be looked up by.
029         * @return A Bank object with a matching primary id.
030         */
031        public Bank getByPrimaryId(String bankCode);
032        
033        /**
034         * Retrieves the default bank code for the given document type from system parameter. 
035         * .
036         * @param documentClass <code>Class</code> for the document type
037         * @return <code>Bank</code> object retrieved by default bank code
038         */
039        public Bank getDefaultBankByDocType(Class documentClass);
040        
041        /**
042         * Retrieves the default bank code for the given document type from system parameter. 
043         * .
044         * @param documentTypeCode the document type code
045         * @return <code>Bank</code> object retrieved by default bank code
046         */
047        public Bank getDefaultBankByDocType(String documentTypeCode);
048        
049        /**
050         * Determines if the bank specification is enabled in the system by system parameter.
051         * 
052         * @return true if specification is enabled
053         */
054        public boolean isBankSpecificationEnabled();
055    }