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.rice.krms.api.repository.function;
17
18 import org.kuali.rice.core.api.mo.common.Identifiable;
19 import org.kuali.rice.core.api.mo.common.Versioned;
20
21 /**
22 * Defines the contract for a function parameter definition. A function
23 * parameter definition helps to define the "signature" of a
24 * {@link FunctionDefinitionContract} by defining the name and type of an
25 * expected parameter to the function.
26 *
27 * @author Kuali Rice Team (rice.collab@kuali.org)
28 *
29 */
30 public interface FunctionParameterDefinitionContract extends Versioned, Identifiable {
31
32 /**
33 * Returns the name of this parameters. All parameters have a name and this
34 * value can never be null or blank. The parameter name must be unique
35 * within a given function definition.
36 *
37 * @return the name of this function parameter definition
38 */
39 String getName();
40
41 /**
42 * Returns the description of this parameter. The description is intended
43 * to provide more information about a parameter and it's appropriate
44 * usage. The description is optional and will be null if a
45 * description is not defined.
46 *
47 * @return the description of this function parameter definition, or null
48 * if this parameter has no description
49 */
50 String getDescription();
51
52 /**
53 * Returns the type of this function parameter. This can be one of a set
54 * of "built-in" data types or a custom data type represented as a fully
55 * qualified java class name. All parameters must have a valid type so
56 * this method should never return null or blank.
57 *
58 * @return the type of this function parameter definition
59 */
60 String getParameterType();
61
62 /**
63 * Returns the ID of the function to which this parameter is associated.
64 *
65 * @return the ID of the corresponding function
66 */
67 String getFunctionId();
68
69 /**
70 * This is the sequence number of the function parameter.
71 * The sequence number identifies the position of the
72 * parameter in the function list.
73 *
74 * @return the sequence number of the function parameter
75 */
76 public Integer getSequenceNumber();
77 }