1 /**
2 * Copyright 2005-2011 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.proposition;
17
18
19 import org.kuali.rice.core.api.mo.common.Identifiable;
20 import org.kuali.rice.core.api.mo.common.Versioned;
21
22 public interface PropositionParameterContract extends Identifiable, Versioned {
23 /**
24 * This is the Id for the parent proposition.
25 *
26 * <p>
27 * It is the Id of the parent proposition.
28 * </p>
29 * @return Id for parent parameter.
30 */
31 public String getPropId();
32
33
34 /**
35 * This is the value of the proposition parameter
36 *
37 * <p>
38 * It is the value of the parameter
39 * </p>
40 * @return value of the parameter
41 */
42 public String getValue();
43
44 /**
45 * This is the type of the parameter.
46 * Proposition parameters are one of the following types:
47 * Constant Values: numbers, strings, dates, etc.
48 * Terms: data available in the execution environment or provided by a term resolver
49 * Functions: custom functions that resolve to a value,
50 * or standard operators (equals, greater than, less than, ...)
51 *
52 * <p>
53 * It identified the type of the parameter.
54 * </p>
55 * @return the parameter type code. Valid values are C, T, and F.
56 */
57 public String getParameterType();
58
59 /**
60 * This is the sequence number of the proposition parameter.
61 * Proposition parameters are listed in Reverse Polish Notation.
62 * The sequence number (starting with 1) identifies the position of the
63 * parameter in the list.
64 *
65 * @return the sequence number of the proposition parameter
66 */
67 public Integer getSequenceNumber();
68 }