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