1 /*
2 * The Kuali Financial System, a comprehensive financial management system for higher education.
3 *
4 * Copyright 2005-2014 The Kuali Foundation
5 *
6 * This program is free software: you can redistribute it and/or modify
7 * it under the terms of the GNU Affero General Public License as
8 * published by the Free Software Foundation, either version 3 of the
9 * License, or (at your option) any later version.
10 *
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU Affero General Public License for more details.
15 *
16 * You should have received a copy of the GNU Affero General Public License
17 * along with this program. If not, see <http://www.gnu.org/licenses/>.
18 */
19 package org.kuali.kfs.vnd.service;
20
21 import org.kuali.kfs.vnd.businessobject.CommodityCode;
22
23 /**
24 * This interface defines methods that a Commodity Code Service must provide
25 */
26 public interface CommodityCodeService {
27 /**
28 * Retrieves a commodity code object by its primary key - the purchasing commodity code.
29 *
30 * @param purchasingCommodityCode
31 * @return CommodityCode the commodity code object which has the purchasingCommodityCode
32 * in the input parameter to match its the primary key.
33 */
34 public CommodityCode getByPrimaryId(String purchasingCommodityCode);
35
36 /**
37 * Checks whether the commodity code in wildcard form exists.
38 * For example, if the wildCardCommodityCode in the input parameter is
39 * 100* and the database has commodity code 10023, then this method
40 * will return true. If no matching found then this method returns false.
41 *
42 * @param wildCardCommodityCode The string containing wild card character to be queried to the database.
43 *
44 * @return boolean true if the wildcardCommodityCode exists in the database.
45 */
46 public boolean wildCardCommodityCodeExists(String wildCardCommodityCode);
47 }