1 PACKAGE fnd_preference AUTHID CURRENT_USER AS
2 /* $Header: AFTCPRFS.pls 115.9 2002/04/15 14:28:49 pkm ship $ */
3
4
5
6 -- Each row of the record contains the name of the preference, value and action
7 -- to be performed it e.g. I- insert, U-update, D-delete.
8
9 TYPE prefs_rec_type IS RECORD(name VARCHAR2(30),value VARCHAR2(240),
10 action VARCHAR2(1));
11
12 TYPE prefs_tab_type IS TABLE OF prefs_rec_type INDEX BY BINARY_INTEGER;
13
14 -- Get the value of the given preference.
15
16 FUNCTION get(p_user_name IN VARCHAR2,
17 p_module_name IN VARCHAR2,
18 p_pref_name IN VARCHAR2) RETURN VARCHAR2;
19
20
21 -- Get the value of the given encrypted preference.
22 -- Note: length of p_key value must be an exact multiple of 8.
23
24 FUNCTION eget(p_user_name IN VARCHAR2,
25 p_module_name IN VARCHAR2,
26 p_pref_name IN VARCHAR2,
27 p_key IN VARCHAR2) RETURN VARCHAR2;
28
29
30 -- Get the value of a preference.
31 -- Note: Returns *NULL* for blank preferences
32 -- *UNKNOWN* for missing preferences
33
34 FUNCTION GetDefined(p_user_name IN VARCHAR2,
35 p_module_name IN VARCHAR2,
36 p_pref_name IN VARCHAR2) RETURN VARCHAR2;
37
38
39 -- Updates the value of the preference if it exists, otherwise creates it.
40
41 PROCEDURE put(p_user_name IN VARCHAR2,
42 p_module_name IN VARCHAR2,
43 p_pref_name IN VARCHAR2,
44 p_pref_value IN VARCHAR2);
45
46
47 -- Updates the value of the encrypted preference if it exists,
48 -- otherwise creates it.
49 -- Note: length of p_key value must be an exact multiple of 8.
50
51 PROCEDURE eput(p_user_name IN VARCHAR2,
52 p_module_name IN VARCHAR2,
53 p_pref_name IN VARCHAR2,
54 p_pref_value IN VARCHAR2,
55 p_key IN VARCHAR2);
56
57
58 -- Updates the value of the preference if it exists, otherwise creates it
59 -- If pref_value is *NULL*, blanks out value
60 -- If pref_value is *UNKNOWN*, does nothing
61
62 PROCEDURE putDefined(p_user_name IN VARCHAR2,
63 p_module_name IN VARCHAR2,
64 p_pref_name IN VARCHAR2,
65 p_pref_value IN VARCHAR2);
66
67
68 -- Returns true or false depending on whether the prefernce exits in the
69 -- table or not.
70
71 FUNCTION exists(p_user_name IN VARCHAR2,
72 p_module_name IN VARCHAR2,
73 p_pref_name IN VARCHAR2) RETURN BOOLEAN ;
74
75
76 -- Deletes the preference from the table.
77
78 PROCEDURE remove(p_user_name IN VARCHAR2,
79 p_module_name IN VARCHAR2,
80 p_pref_name IN VARCHAR2);
81
82
83 -- Removes all preference information for one user and module.
84
85 PROCEDURE delete_all(p_user_name IN VARCHAR2,
86 p_module_name IN VARCHAR2);
87
88
89 -- Saves information for many preferences belonging to one user and module.
90
91 PROCEDURE save_changes(p_user_name IN VARCHAR2,
92 p_module_name IN VARCHAR2,
93 p_prefs_tab IN prefs_tab_type);
94
95
96 END;
[Home] [Help]