1 PACKAGE FUN_RULE_CRIT_PARAMS_PUB AS
2 /*$Header: FUNXTMRULRCPPUS.pls 120.3 2006/01/10 12:17:26 ammishra noship $ */
3 /*#
4 * This package contains the public APIs for Criteria Parameters for Rules objects.
5 * @rep:scope internal
6 * @rep:product FUN
7 * @rep:displayname Rules Engine:Rules Criteria Parameters Definition
8 * @rep:category BUSINESS_ENTITY FUN_RULE_CRIT_PARAMS_B
9 * @rep:lifecycle active
10 */
11
12 --------------------------------------
13 -- declaration of record type
14 --------------------------------------
15
16 TYPE rule_crit_params_rec_type IS RECORD (
17 criteria_param_id NUMBER(15),
18 rule_object_id NUMBER(15),
19 param_name VARCHAR2(30),
20 user_param_name VARCHAR2(50),
21 description VARCHAR2(240),
22 tiptext VARCHAR2(240),
23 data_type VARCHAR2(30),
24 flex_value_set_id NUMBER(15),
25 creation_date DATE,
26 created_by NUMBER(15),
27 last_update_date DATE,
28 last_updated_by NUMBER(15),
29 last_update_login NUMBER(15),
30 created_by_module VARCHAR2(150)
31 );
32
33
34 --------------------------------------
35 -- declaration of public procedures and functions
36 --------------------------------------
37
38 /**
39 * Use this routine to create a Criteria Parameters for a Rule Object and
40 * its related information.With this API you can create a record in the
41 * FUN_RULE_CRIT_PARAMS_* table.
42 * @rep:scope internal
43 * @rep:lifecycle active
44 * @rep:displayname Create Criteria parameter for a Rule Object.
45 *
46 * @param p_init_msg_list Initialize message stack if it is set to FND_API.G_TRUE. Default is FND_API.G_FALSE.
47 * @param p_rule_crit_param_rec Rule Criteria parameter record.
48 * @param x_criteria_param_id Internal identifier for the Rule Criteria parameter
49 * @param x_return_status Return status after the call.
50 * @param x_msg_count Number of messages in message stack.
51 * @param x_msg_data Message text if x_msg_count is 1.
52 *
53 * @rep:comment 10-Sep-2004 Amulya Mishra Created
54 */
55
56 PROCEDURE create_rule_crit_param(
57 p_init_msg_list IN VARCHAR2 := FND_API.G_FALSE,
58 p_rule_crit_param_rec IN RULE_CRIT_PARAMS_REC_TYPE,
59 x_criteria_param_id OUT NOCOPY NUMBER,
60 x_return_status OUT NOCOPY VARCHAR2,
61 x_msg_count OUT NOCOPY NUMBER,
62 x_msg_data OUT NOCOPY VARCHAR2
63 );
64
65 /**
66 * Use this routine to create duplicate Criteria Parameters for a Rule Object and
67 * its related information.With this API you can create a record in the
68 * FUN_RULE_CRIT_PARAMS_* table.
69 * @rep:scope internal
70 * @rep:lifecycle active
71 * @rep:displayname Create Duplicate Criteria parameters for a Rule Object.
72 *
73 * @param p_init_msg_list Initialize message stack if it is set to FND_API.G_TRUE. Default is FND_API.G_FALSE.
74 * @param p_from_rule_object_id Rule Object Id from which you need to create parameters.
75 * @param p_to_rule_object_id Rule Object Id For/To which you need to create parameters from p_from_rule_object_id.
76 * @param x_return_status Return status after the call.
77 * @param x_msg_count Number of messages in message stack.
78 * @param x_msg_data Message text if x_msg_count is 1.
79 *
80 * @rep:comment 27-Dec-2005 Amulya Mishra Created
81 */
82
83 PROCEDURE create_dup_rule_crit_params(
84 p_init_msg_list IN VARCHAR2 := FND_API.G_FALSE,
85 p_from_rule_object_id IN NUMBER,
86 p_to_rule_object_id IN NUMBER,
87 x_return_status OUT NOCOPY VARCHAR2,
88 x_msg_count OUT NOCOPY NUMBER,
89 x_msg_data OUT NOCOPY VARCHAR2
90 );
91
92 /**
93 * Use this routine to update a rule criteria parameter. The API updates records in the
94 * FUN_RULE_CRIT_PARAMS table.
95 * @rep:scope internal
96 * @rep:lifecycle active
97 * @rep:displayname Update Rule Criteria parameter.
98 * @rep:businessevent
99 * @rep:doccd
100 * @param p_init_msg_list Initialize message stack if it is set to FND_API.G_TRUE. Default is FND_API.G_FALSE.
101 * @param p_rule_crit_param_rec Rule Criteria parameter record.
102 * @param p_object_version_number Record version number
103 * @param x_return_status Return status after the call.
104 * @param x_msg_count Number of messages in message stack.
105 * @param x_msg_data Message text if x_msg_count is 1.
106 *
107 * @rep:comment 10-Sep-2004 Amulya Mishra Created
108
109 */
110 PROCEDURE update_rule_crit_param(
111 p_init_msg_list IN VARCHAR2 := FND_API.G_FALSE,
112 p_rule_crit_param_rec IN RULE_CRIT_PARAMS_REC_TYPE,
113 p_object_version_number IN OUT NOCOPY NUMBER,
114 x_return_status OUT NOCOPY VARCHAR2,
115 x_msg_count OUT NOCOPY NUMBER,
116 x_msg_data OUT NOCOPY VARCHAR2
117 );
118
119
120 /**
121 * Gets Rule Criteria parameter record.
122 *
123 * @rep:scope internal
124 * @rep:lifecycle active
125 * @rep:displayname Retrieve Rule C riteria parameter Record.
126 *
127 * @param p_init_msg_list Initialize message stack if it is set to FND_API.G_TRUE. Default is FND_API.G_FALSE.
128 * @param p_rule_object_id Internal Identifier of Rule Object.
129 * @param p_param_name Criteria Parameter Name.
130 * @param x_rule_crit_param_rec Rule Criteria Parameter record.
131 * @param x_return_status Return status after the call.
132 * @param x_msg_count Number of messages in message stack.
133 * @param x_msg_data Message text if x_msg_count is 1.
134 *
135 * @rep:comment 10-Sep-2004 Amulya Mishra Created
136 */
137
138 PROCEDURE get_rule_crit_param_rec (
139 p_init_msg_list IN VARCHAR2 := FND_API.G_FALSE,
140 p_rule_object_id IN NUMBER,
141 p_param_name IN VARCHAR2,
142 x_rule_crit_param_rec OUT NOCOPY RULE_CRIT_PARAMS_REC_TYPE,
143 x_return_status OUT NOCOPY VARCHAR2,
144 x_msg_count OUT NOCOPY NUMBER,
145 x_msg_data OUT NOCOPY VARCHAR2
146 );
147
148
149 /**
150 * Use this routine to delete a user customizable rule object. The API deletes records in the
151 * FUN_RULE_CRIT_PARAMS table.
152 *
153 * @rep:scope internal
154 * @rep:lifecycle active
155 * @rep:displayname Delete Rule Criteria parameter.
156 *
157 * @param p_init_msg_list Initialize message stack if it is set to FND_API.G_TRUE. Default is FND_API.G_FALSE.
158 * @param p_criteria_param_id Internal Identifier For Criteria parameter.
159 * @param x_return_status Return status after the call.
160 * @param x_msg_count Number of messages in message stack.
161 * @param x_msg_data Message text if x_msg_count is 1.
162 *
163 * @rep:comment 10-Sep-2004 Amulya Mishra Created
164 */
165
166 PROCEDURE delete_rule_crit_param(
167 p_init_msg_list IN VARCHAR2 := FND_API.G_FALSE,
168 p_criteria_param_id IN NUMBER,
169 x_return_status OUT NOCOPY VARCHAR2,
170 x_msg_count OUT NOCOPY NUMBER,
171 x_msg_data OUT NOCOPY VARCHAR2
172 );
173
174 END FUN_RULE_CRIT_PARAMS_PUB;
[Home] [Help]