1 /**
2 * Copyright 2005-2012 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;
17
18 /**
19 * Kuali Rice ArcheType Help
20 * <p/>
21 * This is an example of a service interface which contains several implementations.
22 * <p/>
23 * A service interface that calculates the product of two numbers.
24 */
25 public interface ProductService {
26
27 /**
28 * Calculates the product of two {@link Integer Integers} yielding an {@link Integer}. Will not check for overflow.
29 *
30 * @param left an {@link Integer}. cannot be null.
31 * @param right an {@link Integer}. cannot be null.
32 * @return the product of the two passed in {@link Integer Integers}. Will never return null.
33 * @throws IllegalArgumentException if either passed in {@link Integer Integers} are null.
34 */
35 Integer product(Integer left, Integer right);
36 }