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.vnd.service;
017    
018    import org.kuali.kfs.vnd.businessobject.CommodityCode;
019    
020    /**
021     * This interface defines methods that a Commodity Code Service must provide
022     */
023    public interface CommodityCodeService {
024        /**
025         * Retrieves a commodity code object by its primary key - the purchasing commodity code.
026         * 
027         * @param  purchasingCommodityCode
028         * @return CommodityCode the commodity code object which has the purchasingCommodityCode
029         *         in the input parameter to match its the primary key.
030         */
031        public CommodityCode getByPrimaryId(String purchasingCommodityCode);
032    
033        /**
034         * Checks whether the commodity code in wildcard form exists.
035         * For example, if the wildCardCommodityCode in the input parameter is
036         * 100* and the database has commodity code 10023, then this method 
037         * will return true. If no matching found then this method returns false.
038         * 
039         * @param wildCardCommodityCode The string containing wild card character to be queried to the database.
040         * 
041         * @return boolean true if the wildcardCommodityCode exists in the database.
042         */
043        public boolean wildCardCommodityCodeExists(String wildCardCommodityCode);
044    }