1 PACKAGE AHL_MC_RULE_PUB AS
2 /* $Header: AHLPMCRS.pls 120.0.12010000.1 2008/11/26 14:16:29 sathapli noship $ */
3 /*#
4 * Package containing public APIs to create, update and delete MC rules.
5 * @rep:scope public
6 * @rep:product AHL
7 * @rep:displayname MC Rules
8 * @rep:lifecycle active
9 * @rep:category BUSINESS_ENTITY AHL_MASTER_CONFIG
10 */
11
12 ------------------------------------------------------------------------------------
13 -- Start of Comments
14 -- Procedure name : Insert_Rule
15 -- Type : Public
16 -- Function : Does user input validation and calls private API Insert_Rule
17 -- Pre-reqs :
18 -- Parameters :
19 --
20 -- Insert_Rule Parameters:
21 -- p_x_rule_rec IN OUT NOCOPY AHL_MC_RULE_PVT.Rule_Rec_Type Required
22 -- p_rule_stmt_tbl IN AHL_MC_RULE_PVT.UI_Rule_Stmt_Tbl_Type Required
23 --
24 -- End of Comments
25
26 /*#
27 * Procedure for creating an MC rule.
28 * @param p_api_version API Version Number.
29 * @param p_init_msg_list Initialize the message stack. Standard API parameter, default value FND_API.G_FALSE
30 * @param p_commit Parameter to decide whether to commit the transaction or not. Standard API parameter, default value FND_API.G_FALSE
31 * @param p_validation_level Validation level. Standard API parameter, default value FND_API.G_VALID_LEVEL_FULL
32 * @param p_module Parameter to indicate from where the API is being called, default value 'JSP'
33 * @param x_return_status API Return status. Standard API parameter.
34 * @param x_msg_count API Return message count, if any. Standard API parameter.
35 * @param x_msg_data API Return message data, if any. Standard API parameter.
36 * @param p_x_rule_rec Rule record of type AHL_MC_RULE_PVT.Rule_Rec_Type
37 * @param p_rule_stmt_tbl Rule statement table as it appears on the UI of type AHL_MC_RULE_PVT.UI_Rule_Stmt_Tbl_Type associated with a rule.
38 * @rep:scope public
39 * @rep:lifecycle active
40 * @rep:displayname Insert Rule
41 */
42 PROCEDURE Insert_Rule (
43 p_api_version IN NUMBER,
44 p_init_msg_list IN VARCHAR2 := FND_API.G_FALSE,
45 p_commit IN VARCHAR2 := FND_API.G_FALSE,
46 p_validation_level IN NUMBER := FND_API.G_VALID_LEVEL_FULL,
47 p_module IN VARCHAR2 := 'JSP',
48 p_rule_stmt_tbl IN AHL_MC_RULE_PVT.UI_Rule_Stmt_Tbl_Type,
49 p_x_rule_rec IN OUT NOCOPY AHL_MC_RULE_PVT.Rule_Rec_Type,
50 x_return_status OUT NOCOPY VARCHAR2,
51 x_msg_count OUT NOCOPY NUMBER,
52 x_msg_data OUT NOCOPY VARCHAR2
53 );
54
55 ------------------------------------------------------------------------------------
56 -- Start of Comments
57 -- Procedure name : Update_Rule
58 -- Type : Public
59 -- Function : Does user input validation and calls private API Update_Rule
60 -- Pre-reqs :
61 -- Parameters :
62 --
63 -- Update_Rule Parameters:
64 -- p_rule_rec IN AHL_MC_RULE_PVT.Rule_Rec_Type Required
65 -- p_rule_stmt_tbl IN AHL_MC_RULE_PVT.UI_Rule_Stmt_Tbl_Type Required
66 --
67 -- End of Comments
68
69 /*#
70 * Procedure for updating an MC rule.
71 * @param p_api_version API Version Number.
72 * @param p_init_msg_list Initialize the message stack. Standard API parameter, default value FND_API.G_FALSE
73 * @param p_commit Parameter to decide whether to commit the transaction or not. Standard API parameter, default value FND_API.G_FALSE
74 * @param p_validation_level Validation level. Standard API parameter, default value FND_API.G_VALID_LEVEL_FULL
75 * @param p_module Parameter to indicate from where the API is being called, default value 'JSP'
76 * @param x_return_status API Return status. Standard API parameter.
77 * @param x_msg_count API Return message count, if any. Standard API parameter.
78 * @param x_msg_data API Return message data, if any. Standard API parameter.
79 * @param p_rule_rec Rule record of type AHL_MC_RULE_PVT.Rule_Rec_Type
80 * @param p_rule_stmt_tbl Rule statement table as it appears on the UI of type AHL_MC_RULE_PVT.UI_Rule_Stmt_Tbl_Type associated with a rule.
81 * @rep:scope public
82 * @rep:lifecycle active
83 * @rep:displayname Update Rule
84 */
85 PROCEDURE Update_Rule (
86 p_api_version IN NUMBER,
87 p_init_msg_list IN VARCHAR2 := FND_API.G_FALSE,
88 p_commit IN VARCHAR2 := FND_API.G_FALSE,
89 p_validation_level IN NUMBER := FND_API.G_VALID_LEVEL_FULL,
90 p_module IN VARCHAR2 := 'JSP',
91 p_rule_rec IN AHL_MC_RULE_PVT.Rule_Rec_Type,
92 p_rule_stmt_tbl IN AHL_MC_RULE_PVT.UI_Rule_Stmt_Tbl_Type,
93 x_return_status OUT NOCOPY VARCHAR2,
94 x_msg_count OUT NOCOPY NUMBER,
95 x_msg_data OUT NOCOPY VARCHAR2
96 );
97
98 ------------------------------------------------------------------------------------
99 -- Start of Comments
100 -- Procedure name : Delete_Rule
101 -- Type : Public
102 -- Function : Does user input validation and calls private API Delete_Rule
103 -- Pre-reqs :
104 -- Parameters :
105 --
106 -- Delete_Rule Parameters:
107 -- p_rule_rec.rule_id IN NUMBER Required
108 -- or
109 -- p_rule_rec.rule_name IN VARCHAR2 Required
110 -- p_rule_rec.mc_header_id IN NUMBER Required
111 -- ( or
112 -- p_rule_rec.mc_name IN VARCHAR2 Required
113 -- p_rule_rec.mc_revision IN NUMBER Required)
114 --
115 -- p_rule_rec.object_version_number IN NUMBER Required
116 --
117 -- End of Comments
118
119 /*#
120 * Procedure for deleting an MC rule.
121 * @param p_api_version API Version Number.
122 * @param p_init_msg_list Initialize the message stack. Standard API parameter, default value FND_API.G_FALSE
123 * @param p_commit Parameter to decide whether to commit the transaction or not. Standard API parameter, default value FND_API.G_FALSE
124 * @param p_validation_level Validation level. Standard API parameter, default value FND_API.G_VALID_LEVEL_FULL
125 * @param x_return_status API Return status. Standard API parameter.
126 * @param x_msg_count API Return message count, if any. Standard API parameter.
127 * @param x_msg_data API Return message data, if any. Standard API parameter.
128 * @param p_rule_rec Rule record of type AHL_MC_RULE_PVT.Rule_Rec_Type
129 * @rep:scope public
130 * @rep:lifecycle active
131 * @rep:displayname Delete Rule
132 */
133 PROCEDURE Delete_Rule (
134 p_api_version IN NUMBER,
135 p_init_msg_list IN VARCHAR2 := FND_API.G_FALSE,
136 p_commit IN VARCHAR2 := FND_API.G_FALSE,
137 p_validation_level IN NUMBER := FND_API.G_VALID_LEVEL_FULL,
138 p_rule_rec IN AHL_MC_RULE_PVT.Rule_Rec_Type,
139 x_return_status OUT NOCOPY VARCHAR2,
140 x_msg_count OUT NOCOPY NUMBER,
141 x_msg_data OUT NOCOPY VARCHAR2
142 );
143
144 ------------------------------------------------------------------------------------------
145 -- Start of Comments
146 -- Procedure name : Copy_Rules_For_MC
147 -- Type : Public
148 -- Function : Does user input validation and calls private API Copy_Rules_For_MC
149 -- Pre-reqs :
150 -- Parameters :
151 --
152 -- Copy_Rules_For_MC Parameters:
153 -- p_from_mc_header_id IN NUMBER Required
154 -- or
155 -- p_to_mc_name IN VARCHAR2 Required
156 -- p_to_revision IN VARCHAR2 Required
157 --
158 -- p_to_mc_header_id IN NUMBER Required
159 -- or
160 -- p_from_mc_name IN VARCHAR2 Required
161 -- p_from_revision IN VARCHAR2 Required
162 --
163 -- End of Comments
164
165 /*#
166 * Procedure for copying all the rules of a source MC to destination MC.
167 * @param p_api_version API Version Number.
168 * @param p_init_msg_list Initialize the message stack. Standard API parameter, default value FND_API.G_FALSE
169 * @param p_commit Parameter to decide whether to commit the transaction or not. Standard API parameter, default value FND_API.G_FALSE
170 * @param p_validation_level Validation level. Standard API parameter, default value FND_API.G_VALID_LEVEL_FULL
171 * @param x_return_status API Return status. Standard API parameter.
172 * @param x_msg_count API Return message count, if any. Standard API parameter.
173 * @param x_msg_data API Return message data, if any. Standard API parameter.
174 * @param p_from_mc_header_id Header id of the source MC.
175 * @param p_from_mc_name Name of the source MC.
176 * @param p_from_revision Revision number of the source MC.
177 * @param p_to_mc_header_id Header id of the destination MC.
178 * @param p_to_mc_name Name of the destination MC.
179 * @param p_to_revision Revision number of the destination MC.
180 * @rep:scope public
181 * @rep:lifecycle active
182 * @rep:displayname Copy Rules for MC
183 */
184 PROCEDURE Copy_Rules_For_MC (
185 p_api_version IN NUMBER,
186 p_init_msg_list IN VARCHAR2 := FND_API.G_FALSE,
187 p_commit IN VARCHAR2 := FND_API.G_FALSE,
188 p_validation_level IN NUMBER := FND_API.G_VALID_LEVEL_FULL,
189 p_from_mc_header_id IN NUMBER,
190 p_to_mc_header_id IN NUMBER,
191 p_from_mc_name IN VARCHAR2,
192 p_from_revision IN VARCHAR2,
193 p_to_mc_name IN VARCHAR2,
194 p_to_revision IN VARCHAR2,
195 x_return_status OUT NOCOPY VARCHAR2,
196 x_msg_count OUT NOCOPY NUMBER,
197 x_msg_data OUT NOCOPY VARCHAR2
198 );
199
203 -- Type : Public
200 --------------------------------------------------------------------------------------------
201 -- Start of Comments
202 -- Procedure name : Delete_Rules_For_MC
204 -- Function : Does user input validation and calls private API Delete_Rules_For_MC
205 -- Pre-reqs :
206 -- Parameters :
207 --
208 -- Delete_Rules_For_MC Parameters:
209 -- p_mc_header_id IN NUMBER Required
210 -- or
211 -- p_mc_name IN VARCHAR2 Required
212 -- p_revision IN VARCHAR2 Required
213 --
214 -- End of Comments
215
216 /*#
217 * Procedure for deleting all the rules of an MC.
218 * @param p_api_version API Version Number.
219 * @param p_init_msg_list Initialize the message stack. Standard API parameter, default value FND_API.G_FALSE
220 * @param p_commit Parameter to decide whether to commit the transaction or not. Standard API parameter, default value FND_API.G_FALSE
221 * @param p_validation_level Validation level. Standard API parameter, default value FND_API.G_VALID_LEVEL_FULL
222 * @param x_return_status API Return status. Standard API parameter.
223 * @param x_msg_count API Return message count, if any. Standard API parameter.
224 * @param x_msg_data API Return message data, if any. Standard API parameter.
225 * @param p_mc_header_id Header id of the MC.
226 * @param p_mc_name Name of the MC.
227 * @param p_revision Revision number of the MC.
228 * @rep:scope public
229 * @rep:lifecycle active
230 * @rep:displayname Delete Rules for MC
231 */
232 PROCEDURE Delete_Rules_For_MC (
233 p_api_version IN NUMBER,
234 p_init_msg_list IN VARCHAR2 := FND_API.G_FALSE,
235 p_commit IN VARCHAR2 := FND_API.G_FALSE,
236 p_validation_level IN NUMBER := FND_API.G_VALID_LEVEL_FULL,
237 p_mc_header_id IN NUMBER,
238 p_mc_name IN VARCHAR2,
239 p_revision IN VARCHAR2,
240 x_return_status OUT NOCOPY VARCHAR2,
241 x_msg_count OUT NOCOPY NUMBER,
242 x_msg_data OUT NOCOPY VARCHAR2
243 );
244
245 -----------------------------------------------------------------------------------------------
246 -- Start of Comments
247 -- Procedure name : Get_Rules_For_Position
248 -- Type : Public
249 -- Function : Does user input validation and calls private API Get_Rules_For_Position
250 -- Pre-reqs :
251 -- Parameters :
252 --
253 -- Get_Rules_For_Position Parameters:
254 -- p_encoded_path IN VARCHAR2 Required
255 --
256 -- p_mc_header_id IN NUMBER Required
257 -- or
258 -- p_mc_name IN VARCHAR2 Required
259 -- p_revision IN VARCHAR2 Required
260 --
261 -- x_rule_tbl OUT AHL_MC_RULE_PVT.Rule_Tbl_Type Required
262 --
263 -- End of Comments
264
265 /*#
266 * Procedure for getting all the rules for an MC position.
267 * @param p_api_version API Version Number.
268 * @param p_init_msg_list Initialize the message stack. Standard API parameter, default value FND_API.G_FALSE
269 * @param p_commit Parameter to decide whether to commit the transaction or not. Standard API parameter, default value FND_API.G_FALSE
270 * @param p_validation_level Validation level. Standard API parameter, default value FND_API.G_VALID_LEVEL_FULL
271 * @param x_return_status API Return status. Standard API parameter.
272 * @param x_msg_count API Return message count, if any. Standard API parameter.
273 * @param x_msg_data API Return message data, if any. Standard API parameter.
274 * @param p_encoded_path Path position of the MC position.
275 * @param p_mc_header_id Header id of the MC.
276 * @param p_mc_name Name of the MC.
277 * @param p_revision Revision number of the MC.
278 * @param x_rule_tbl Rule record of type AHL_MC_RULE_PVT.Rule_Rec_Type
279 * @rep:scope public
280 * @rep:lifecycle active
281 * @rep:displayname Get Rules for position
282 */
283 PROCEDURE Get_Rules_For_Position (
284 p_api_version IN NUMBER,
285 p_init_msg_list IN VARCHAR2 := FND_API.G_FALSE,
286 p_commit IN VARCHAR2 := FND_API.G_FALSE,
287 p_validation_level IN NUMBER := FND_API.G_VALID_LEVEL_FULL,
288 p_mc_header_id IN NUMBER,
289 p_encoded_path IN VARCHAR2,
290 p_mc_name IN VARCHAR2,
291 p_revision IN VARCHAR2,
292 x_rule_tbl OUT NOCOPY AHL_MC_RULE_PVT.Rule_Tbl_Type,
293 x_return_status OUT NOCOPY VARCHAR2,
294 x_msg_count OUT NOCOPY NUMBER,
295 x_msg_data OUT NOCOPY VARCHAR2
296 );
297
298 End AHL_MC_RULE_PUB;
[Home] [Help]