1 /*
2 * Copyright 2005-2008 The Kuali Foundation
3 *
4 * Licensed under the Educational Community License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.opensource.org/licenses/ecl2.php
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16 package org.kuali.ole.vnd.service;
17
18 import org.kuali.ole.vnd.businessobject.CommodityCode;
19
20 /**
21 * This interface defines methods that a Commodity Code Service must provide
22 */
23 public interface CommodityCodeService {
24 /**
25 * Retrieves a commodity code object by its primary key - the purchasing commodity code.
26 *
27 * @param purchasingCommodityCode
28 * @return CommodityCode the commodity code object which has the purchasingCommodityCode
29 * in the input parameter to match its the primary key.
30 */
31 public CommodityCode getByPrimaryId(String purchasingCommodityCode);
32
33 /**
34 * Checks whether the commodity code in wildcard form exists.
35 * For example, if the wildCardCommodityCode in the input parameter is
36 * 100* and the database has commodity code 10023, then this method
37 * will return true. If no matching found then this method returns false.
38 *
39 * @param wildCardCommodityCode The string containing wild card character to be queried to the database.
40 *
41 * @return boolean true if the wildcardCommodityCode exists in the database.
42 */
43 public boolean wildCardCommodityCodeExists(String wildCardCommodityCode);
44 }