1 package HZ_PREFERENCE_PUB AS
2 /*$Header: ARHPREFS.pls 120.2 2005/06/16 21:14:27 jhuang noship $ */
3
4 TYPE ref_cursor_typ IS REF CURSOR;
5
6
7 ----------------------------------------------------------------
8 -- API name : Contains_Preference
9 -- TYPE : Public
10 -- FUNCTION : Determines whether a particular preference
11 -- (not a particular value) has been set
12 --
13 -- Parameters:
14 -- IN : p_party_id IN NUMBER (required)
15 -- Party on which the preference should be checked
16 --
17 -- p_category IN VARCHAR2(required)
18 -- Preference category for identifying a particular
19 -- preference
20 --
21 -- p_preference_code IN VARCHAR2 (required)
22 -- Preference to check
23 --
24 -- OUT NOCOPY :
25 -- RETURNs 1 byte result code:
26 -- 'Y' preference has been set.
27 -- 'N' not exist.
28 -- 'E' Error
29 -- 'U' Unexpected Error
30 --
31 -- If 'E' or 'U' is returned, there will be an
32 -- error message on the FND_MESSAGE stack which
33 -- can be retrieved with FND_MESSAGE.GET_ENCODED()
34 --
35 -- Notes : This just checks for presence of given preference
36 -- for any value.
37 --
38 ---------------------------------------------------------------
39 FUNCTION Contains_Preference(
40 p_party_id NUMBER
41 , p_category VARCHAR2
42 , p_preference_code VARCHAR2
43 ) RETURN VARCHAR2;
44
45
46 ----------------------------------------------------------------
47 -- API name : Contains_Value
48 -- TYPE : Public
49 -- FUNCTION : Determines whether a particular preference value
50 -- has been set
51 --
52 -- Parameters:
53 -- IN : p_party_id IN NUMBER (required)
54 -- Party on which the preference should be checked
55 --
56 -- p_category IN VARCHAR2(required)
57 -- Preference category for identifying a particular
58 -- preference
59 --
60 -- p_preference_code IN VARCHAR2 (required)
61 -- Preference code for identifying a particular
62 -- preference
63 --
64 -- p_value_varchar2 IN VARCHAR2 (optional)
65 -- value to be checked
66 --
67 -- p_value_number IN NUMBER (optional)
68 -- value to be checked
69 --
70 -- p_value_date IN DATE (optional)
71 -- value to be checked
72 --
73 -- OUT NOCOPY :
74 -- RETURNs 1 byte result code:
75 -- 'Y' preference value exists.
76 -- 'N' not exist.
77 -- 'E' Error
78 -- 'U' Unexpected Error
79 --
80 -- If 'E' or 'U' is returned, there will be an
81 -- error message on the FND_MESSAGE stack which
82 -- can be retrieved with FND_MESSAGE.GET_ENCODED()
83 --
84 -- Notes : One of the parameters: p_value_varchar2,
85 -- p_value_number, p_value_date must be passed
86 --
87 ---------------------------------------------------------------
88 FUNCTION Contains_Value(
89 p_party_id NUMBER
90 , p_category VARCHAR2
91 , p_preference_code VARCHAR2
92 , p_value_varchar2 VARCHAR2 := FND_API.G_MISS_CHAR
93 , p_value_number NUMBER := FND_API.G_MISS_NUM
94 , p_value_date DATE := FND_API.G_MISS_DATE
95 ) RETURN VARCHAR2;
96
97
98 ----------------------------------------------------------------
99 -- API name : Add
100 -- TYPE : Public
101 -- FUNCTION : Add a preference value for a party.
102 -- For a single value preference, add if the
103 -- preference has not been defined.
104 -- For a multiple value preference, add if the
105 -- preference value has not been defined.
106 --
107 -- Parameters:
108 -- IN : p_party_id IN NUMBER (required)
109 -- Party on which the preference value will be added
110 --
111 -- p_category IN VARCHAR2(required)
112 -- Preference category for identifying a particular
113 -- preference
114 --
115 -- p_preference_code IN VARCHAR2 (required)
116 -- Preference code for identifying a particular
117 -- preference
118 --
119 -- p_value_varchar2 IN VARCHAR2 (optional)
120 -- Value to be addded
121 --
122 -- p_value_number IN NUMBER (optional)
123 -- Value to be added
124 --
125 -- p_value_date IN DATE (optional)
126 -- Value to be added
127 --
128 -- p_value_name IN VARCHAR2 (optional)
129 -- User-defined name for a preference value
130 --
131 -- p_additional_value[1-5] IN VARCHAR2 (optional)
132 -- Additional values for a particular preference value
133 --
134 -- OUT NOCOPY :
135 -- x_return_status 1 byte result code:
136 -- 'S' Success
137 -- 'E' Error
138 -- 'U' Unexpected Error
139 --
140 -- x_msg_count
141 -- Number of messages in message stack
142 -- If 'E' or 'U' is returned, there will be an
143 -- error message on the FND_MESSAGE stack which
144 -- can be retrieved with FND_MESSAGE.GET_ENCODED()
145 --
146 -- x_msg_data
147 -- The first message in the FND_MESSAGE stack
148 --
149 -- x_object_version_number
150 -- Version number of the record created
151 --
152 -- Notes :
153 --
154 --
155 ---------------------------------------------------------------
156 PROCEDURE Add(
157 p_party_id NUMBER
158 , p_category VARCHAR2
159 , p_preference_code VARCHAR2
160 , p_value_varchar2 VARCHAR2 := FND_API.G_MISS_CHAR
161 , p_value_number NUMBER := FND_API.G_MISS_NUM
162 , p_value_date DATE := FND_API.G_MISS_DATE
163 , p_value_name VARCHAR2 := FND_API.G_MISS_CHAR
164 , p_module VARCHAR2 := FND_API.G_MISS_CHAR
165 , p_additional_value1 VARCHAR2 := FND_API.G_MISS_CHAR
166 , p_additional_value2 VARCHAR2 := FND_API.G_MISS_CHAR
167 , p_additional_value3 VARCHAR2 := FND_API.G_MISS_CHAR
168 , p_additional_value4 VARCHAR2 := FND_API.G_MISS_CHAR
169 , p_additional_value5 VARCHAR2 := FND_API.G_MISS_CHAR
170 , x_return_status OUT NOCOPY VARCHAR2
171 , x_msg_count OUT NOCOPY NUMBER
172 , x_msg_data OUT NOCOPY VARCHAR2
173 , x_object_version_number OUT NOCOPY NUMBER
174 );
175
176
177 ----------------------------------------------------------------
178 -- API name : Put
179 -- TYPE : Public
180 -- FUNCTION : Ensure a preference value set for a party.
181 -- For a single value preference, the value will
182 -- be added if the preference has not been set.
183 -- The existing value can be updated if
184 -- a preference already exists
185 -- For a multiple value preference, the value will
186 -- be added if the preference value does not exist.
187 -- The information related to the existing preference
188 -- value can be updated if a preference value
189 -- already exists
190 -- Parameters:
191 -- IN : p_party_id IN NUMBER (required)
192 -- Party on which the preference value will be added
193 --
194 -- p_category IN VARCHAR2(required)
195 -- Preference category for identifying a particular
196 -- preference
197 --
198 -- p_preference_code IN VARCHAR2 (required)
199 -- Preference code for identifying a particular
200 -- preference
201 --
202 -- p_value_varchar2 IN VARCHAR2 (optional)
203 -- Value to be addded
204 --
205 -- p_value_number IN NUMBER (optional)
206 -- Value to be added
207 --
208 -- p_value_date IN DATE (optional)
209 -- Value to be added
210 --
211 -- p_value_name IN VARCHAR2 (optional)
212 -- User-defined name for a preference value
213 --
214 -- p_ additional_value[1-5] IN VARCHAR2 (optional)
215 -- Additional values for a particular preference value
216 --
217 -- OUT NOCOPY :
218 -- x_return_status 1 byte result code:
219 -- 'S' Success
220 -- 'E' Error
221 -- 'U' Unexpected Error
222 --
223 -- x_msg_count
224 -- Number of messages in message stack
225 -- If 'E' or 'U' is returned, there will be an
226 -- error message on the FND_MESSAGE stack which
227 -- can be retrieved with FND_MESSAGE.GET_ENCODED()
228 -- x_msg_data
229 -- The first message in the FND_MESSAGE stack
230 --
231 -- IN OUT NOCOPY :
232 -- x_object_version_number
233 -- Needed for checking whether record has already
234 -- been updated by some other user during update.
235 -- The new version number is returned in case of
236 -- insert or update.
237 --
238 -- Notes :
239 --
240 --
241 ---------------------------------------------------------------
242 PROCEDURE Put(
243 p_party_id NUMBER
244 , p_category VARCHAR2
245 , p_preference_code VARCHAR2
246 , p_value_varchar2 VARCHAR2 := FND_API.G_MISS_CHAR
247 , p_value_number NUMBER := FND_API.G_MISS_NUM
248 , p_value_date DATE := FND_API.G_MISS_DATE
249 , p_value_name VARCHAR2 := FND_API.G_MISS_CHAR
250 , p_module VARCHAR2 := FND_API.G_MISS_CHAR
251 , p_additional_value1 VARCHAR2 := FND_API.G_MISS_CHAR
252 , p_additional_value2 VARCHAR2 := FND_API.G_MISS_CHAR
253 , p_additional_value3 VARCHAR2 := FND_API.G_MISS_CHAR
254 , p_additional_value4 VARCHAR2 := FND_API.G_MISS_CHAR
255 , p_additional_value5 VARCHAR2 := FND_API.G_MISS_CHAR
256 , p_object_version_number IN OUT NOCOPY NUMBER
257 , x_return_status OUT NOCOPY VARCHAR2
258 , x_msg_count OUT NOCOPY NUMBER
259 , x_msg_data OUT NOCOPY VARCHAR2
260 );
261
262
263 ----------------------------------------------------------------
264 -- API name : Remove
265 -- TYPE : Public
266 -- FUNCTION : Remove preference values defined for a party.
267 -- For a single value preference, the value will
268 -- be removed if you don't specify a value or
269 -- the value specified is the defined value.
270 -- For a multiple value preference, all value will
271 -- be removed if you don't specify a value.
272 -- A value will be removed if you specify the value
273 -- you want to remove.
274 -- Parameters:
275 -- IN : p_party_id IN NUMBER (required)
276 -- Party on which the preference value will be added
277 --
278 -- p_category IN VARCHAR2(required)
279 -- Preference category for identifying a particular
280 -- preference
281 --
282 -- p_preference_code IN VARCHAR2 (required)
283 -- Preference code for identifying a particular
284 -- preference
285 --
286 -- p_value_varchar2 IN VARCHAR2 (optional)
287 -- Value to be addded
288 --
289 -- p_value_number IN NUMBER (optional)
290 -- Value to be added
291 --
292 -- p_value_date IN DATE (optional)
293 -- Value to be added
294 --
295 -- p_object_version_number
296 -- Version number used in case removing particular
297 -- preference value.
298 --
299 -- OUT NOCOPY :
300 -- x_return_status 1 byte result code:
301 -- 'S' Success
302 -- 'E' Error
303 -- 'U' Unexpected Error
304 --
305 -- x_msg_count
306 -- Number of messages in message stack
307 -- If 'E' or 'U' is returned, there will be an
308 -- error message on the FND_MESSAGE stack which
309 -- can be retrieved with FND_MESSAGE.GET_ENCODED()
310 -- x_msg_data
311 -- The first message in the FND_MESSAGE stack
312 --
313 -- Notes : Version number cannot be used in case of removing
314 -- all the values since different records may have
315 -- different version numbers
316 --
317 --
318 ---------------------------------------------------------------
319 PROCEDURE Remove(
320 p_party_id NUMBER
321 , p_category VARCHAR2
322 , p_preference_code VARCHAR2
323 , p_value_varchar2 VARCHAR2 := FND_API.G_MISS_CHAR
324 , p_value_number NUMBER := FND_API.G_MISS_NUM
325 , p_value_date DATE := FND_API.G_MISS_DATE
326 , p_object_version_number NUMBER
327 , x_return_status OUT NOCOPY VARCHAR2
328 , x_msg_count OUT NOCOPY NUMBER
329 , x_msg_data OUT NOCOPY VARCHAR2
330 );
331
332
333 ----------------------------------------------------------------
334 -- API name : Retrieve
335 -- TYPE : Public
336 -- FUNCTION : Retrieve preference values defined for a party.
337 -- The values will be retrieved as a reference cursor
338 -- It is designed for the middle tier Java program
339 -- to retrieve data from server without resetting
340 -- the values into a local structure such as Vector
341 -- or Array.
342 --
343 -- Parameters:
344 -- IN : p_party_id IN NUMBER (required)
345 -- Party on which the preference value will be added
346 --
347 -- p_category IN VARCHAR2(required)
348 -- Preference category for identifying a particular
349 -- preference
350 --
351 -- p_preference_code IN VARCHAR2 (required)
352 -- Preference code for identifying a particular
353 -- preference
354 --
355 -- OUT NOCOPY : x_preference_values
356 -- A reference cursor returns preference values of
357 -- a particular preference code for a party.
358 --
359 -- x_return_status 1 byte result code:
360 -- 'S' Success
361 -- 'E' Error
362 -- 'U' Unexpected Error
363 --
364 -- x_msg_count
365 -- Number of messages in message stack
366 -- If 'E' or 'U' is returned, there will be an
367 -- error message on the FND_MESSAGE stack which
368 -- can be retrieved with FND_MESSAGE.GET_ENCODED()
369 -- x_msg_data
370 -- The first message in the FND_MESSAGE stack
371 --
372 -- Notes :
373 --
374 --
375 ---------------------------------------------------------------
376 PROCEDURE Retrieve(
377 p_party_id NUMBER
378 , p_category VARCHAR2
379 , p_preference_code VARCHAR2
380 , x_preference_value OUT NOCOPY ref_cursor_typ
381 , x_return_status OUT NOCOPY VARCHAR2
382 , x_msg_count OUT NOCOPY NUMBER
383 , x_msg_data OUT NOCOPY VARCHAR2
384 );
385
386
387 ----------------------------------------------------------------
388 -- API name : Value_Varchar2
389 -- TYPE : Public
390 -- FUNCTION : Returns value_varchar2 value for a preference
391 --
392 -- Parameters:
393 -- IN : p_party_id IN NUMBER (required)
397 -- Preference category for identifying a particular
394 -- Party on which the preference should be checked
395 --
396 -- p_category IN VARCHAR2(required)
398 -- preference
399 --
400 -- p_preference_code IN VARCHAR2 (required)
401 -- Preference to check
402 --
403 -- OUT NOCOPY :
404 -- Returns VARCHAR2
405 --
406 -- If there is an error in input, there will be an
407 -- error message on the FND_MESSAGE stack which
408 -- can be retrieved with FND_MESSAGE.GET_ENCODED()
409 --
410 -- Notes : Returns null if there is no preference set
411 --
412 ---------------------------------------------------------------
413 FUNCTION Value_Varchar2(
414 p_party_id NUMBER
415 , p_category VARCHAR2
416 , p_preference_code VARCHAR2
417 ) RETURN VARCHAR2;
418
419
420 ----------------------------------------------------------------
421 -- API name : Value_Number
422 -- TYPE : Public
423 -- FUNCTION : Returns value_number value for a preference
424 --
425 -- Parameters:
426 -- IN : p_party_id IN NUMBER (required)
427 -- Party on which the preference should be checked
428 --
429 -- p_category IN VARCHAR2(required)
430 -- Preference category for identifying a particular
431 -- preference
432 --
433 -- p_preference_code IN VARCHAR2 (required)
434 -- Preference to check
435 --
436 -- OUT NOCOPY :
437 -- Returns NUMBER
438 --
439 -- If there is an error in input, there will be an
440 -- error message on the FND_MESSAGE stack which
441 -- can be retrieved with FND_MESSAGE.GET_ENCODED()
442 --
443 -- Notes : Returns null if there is no preference set
444 --
445 ---------------------------------------------------------------
446 FUNCTION Value_Number(
447 p_party_id NUMBER
448 , p_category VARCHAR2
449 , p_preference_code VARCHAR2
450 ) RETURN NUMBER;
451
452
453 ----------------------------------------------------------------
454 -- API name : Value_Date
455 -- TYPE : Public
456 -- FUNCTION : Returns value_date value for a preference
457 --
458 -- Parameters:
459 -- IN : p_party_id IN NUMBER (required)
460 -- Party on which the preference should be checked
461 --
462 -- p_category IN VARCHAR2(required)
463 -- Preference category for identifying a particular
464 -- preference
465 --
466 -- p_preference_code IN VARCHAR2 (required)
467 -- Preference to check
468 --
469 -- OUT NOCOPY :
470 -- Returns DATE
471 --
472 -- If there is an error in input, there will be an
473 -- error message on the FND_MESSAGE stack which
474 -- can be retrieved with FND_MESSAGE.GET_ENCODED()
475 --
476 -- Notes : Returns null if there is no preference set
477 --
478 ---------------------------------------------------------------
479
480 FUNCTION Value_Date(
481 p_party_id NUMBER
482 , p_category VARCHAR2
483 , p_preference_code VARCHAR2
484 ) RETURN DATE;
485
486
487 ----------------------------------------------------------------
488 -- API name : Contains_Value
489 -- TYPE : Public
490 -- FUNCTION : Determines whether a particular preference value
491 -- has been set
492 --
493 -- Parameters:
494 -- IN : p_party_id IN NUMBER (required)
495 -- Party on which the preference should be checked
496 --
497 -- p_category IN VARCHAR2(required)
498 -- Preference category for identifying a particular
499 -- preference
500 --
501 -- p_preference_code IN VARCHAR2 (required)
502 -- Preference code for identifying a particular
503 -- preference
504 --
505 -- p_value_number IN NUMBER (required)
506 -- value to be checked
507 --
508 -- OUT NOCOPY :
509 -- RETURNs 1 byte result code:
510 -- 'Y' preference value has been set.
511 -- 'N' not exist.
512 -- 'E' Error
513 -- 'U' Unexpected Error
514 --
515 -- If 'E' or 'U' is returned, there will be an
516 -- error message on the FND_MESSAGE stack which
517 -- can be retrieved with FND_MESSAGE.GET_ENCODED()
518 --
519 -- Notes : One of the parameters: p_value_varchar2,
520 -- p_value_number, p_value_date must be passed.
521 -- This function is overloaded.
522 --
523 ---------------------------------------------------------------
524 FUNCTION Contains_Value(
525 p_party_id NUMBER
526 , p_category VARCHAR2
527 , p_preference_code VARCHAR2
528 , p_value_number NUMBER
529 ) RETURN VARCHAR2;
530
531
532 ----------------------------------------------------------------
533 -- API name : Contains_Value
534 -- TYPE : Public
535 -- FUNCTION : Determines whether a particular preference value
536 -- has been set
537 --
538 -- Parameters:
539 -- IN : p_party_id IN NUMBER (required)
540 -- Party on which the preference should be checked
541 --
542 -- p_category IN VARCHAR2(required)
543 -- Preference category for identifying a particular
544 -- preference
545 --
546 -- p_preference_code IN VARCHAR2 (required)
547 -- Preference code for identifying a particular
548 -- preference
549 --
550 -- p_value_date IN DATE (required)
551 -- value to be checked
552 --
553 -- OUT NOCOPY :
554 -- RETURNs 1 byte result code:
555 -- 'Y' preference value has been set.
556 -- 'N' not exist.
557 -- 'E' Error
558 -- 'U' Unexpected Error
559 --
560 -- If 'E' or 'U' is returned, there will be an
561 -- error message on the FND_MESSAGE stack which
562 -- can be retrieved with FND_MESSAGE.GET_ENCODED()
563 --
564 -- Notes : One of the parameters: p_value_varchar2,
565 -- p_value_number, p_value_date must be passed.
566 -- This function is overloaded.
567 --
568 ---------------------------------------------------------------
569 FUNCTION Contains_Value(
570 p_party_id NUMBER
571 , p_category VARCHAR2
572 , p_preference_code VARCHAR2
573 , p_value_date DATE
574 ) RETURN VARCHAR2;
575
576
577 END HZ_PREFERENCE_PUB;
[Home] [Help]