1 package dripref as
2
3 /*--------------------------- get_oat_id -------------------------*/
4 /*
5 NAME
6 get_oat_id
7
8 DESCRIPTION
9 given a class and object id and an attribute name, return oat_id
10 */
11 function get_oat_id(
12 class_id in binary_integer,
13 object_id in binary_integer,
14 att_name in varchar2
15 )
16 return binary_integer;
17
18 /*--------------------------- get_obj_info -------------------------*/
19 /*
20 NAME
21 get_obj_info
22
23 DESCRIPTION
24 given an object name, selects the object information and return
25 the data as a record
26 */
27 function get_obj_info(
28 object_name in varchar2
29 )
30 return dr_def.obj_rec;
31
32 /*--------------------------- get_pref_info -------------------------*/
33 /*
34 NAME
35 get_pref_info
36
37 DESCRIPTION
38 given a preference name, selects the preference information and
39 returns the data as a record.
40 */
41 function get_pref_info(
42 pre_name in varchar2,
43 new_pref in boolean default false,
44 check_own in boolean default false
45 )
46 return dr_def.pref_rec;
47
48 /*---------------------------- create_preference ----------------------------*/
49 /*
50 NAME
51 create_preference
52
53 DESCRIPTION
54 this procedure create a preference for the framework object whose name
55 is specified in 'object_name'.
56
57 ARGUMENTS
58 preference_name - preference name, this can be structured as
59 [OWNER.]PREFERENCE_NAME
60 object_name - name of the object to apply the preference to.
61
62 */
63 procedure create_preference(
64 preference_name in varchar2,
65 object_name in varchar2,
66 preference_implicit_commit in boolean);
67
68 /*---------------------------- drop_preference ----------------------------*/
69 /*
70 NAME
71 drop_preference
72
73 DESCRIPTION
74 delete the preference specified in 'name' from TexTile dictionary.
75
76 ARGUMENTS
77 name - preference name
78 */
79 procedure drop_preference(preference_name in varchar2,
80 preference_implicit_commit in boolean);
81
82 /*--------------------------- drop_user_preferences ----------------------*/
83 /*
84 NAME
85 drop_user_preferences
86
87 DESCRIPTION
88 deletes all preferences for the given user from the Text dictionary.
89 If the user is null, then preferences from all dropped users will
90 be deleted (called by ctx_adm.recover).
91
92 ARGUMENTS
93 user_name
94 */
95 procedure drop_user_preferences(user_name in varchar2 := null);
96
97 /*------------------------------ set_attribute ---------------------------*/
98 /*
99 NAME
100 set_attribute
101
102 DESCRIPTION
103 set the specified attribute in the specified preference to the
104 provided value. if a setting for this attribute already exists,
105 this will override the old value for that attribute
106
107 ARGUMENTS
108 */
109 procedure set_attribute(
110 preference_name in varchar2,
111 attribute_name in varchar2,
112 attribute_value in varchar2,
113 preference_implicit_commit in boolean
114 );
115
116 /*---------------------------- unset_attribute ---------------------------*/
117 /*
118 NAME
119 unset_attribute
120
121 DESCRIPTION
122 remove the value for the specified attribute in the specified preference
123
124 ARGUMENTS
125 */
126 procedure unset_attribute(
127 preference_name in varchar2,
128 attribute_name in varchar2,
129 preference_implicit_commit in boolean
130 );
131
132 /*========================================================================*/
133 /*========================================================================*/
134 /* INDEXING */
135 /*========================================================================*/
136 /*========================================================================*/
137
138 /*--------------------------- set_preferences -------------------------*/
139 /*
140 NAME
141 set_preferences - Check all preferences used in a policy
142 */
143 procedure set_preferences(
144 idx_owner in varchar2,
145 idx_id in number,
146 idx_langcol in varchar2,
147 prefnames in DR_DEF.NAME_TAB,
148 new_sdata_section out boolean,
149 ia in sys.ODCIIndexInfo default NULL
150 );
151
152 /*--------------------------- rpl_preferences -------------------------*/
153 /*
154 NAME
155 rpl_preferences - replace preferences used in an index with the
156 supplied ones
157 */
158 procedure rpl_preferences(
159 idx_owner in varchar2,
160 idx_id in number,
161 idx_langcol in varchar2,
162 prefnames in DR_DEF.NAME_TAB,
163 section_id in number,
164 alt_I out boolean,
165 new_sdata_section out boolean
166 );
167
168 /*--------------------------- copy_preferences -------------------------*/
169 /*
170 NAME
171 copy_preferences - copy prefs from one index to another
172 */
173 procedure copy_preferences(
174 source_idx_id in number,
175 dest_idx_id in number,
176 all_prefs in boolean default FALSE
177 );
178
179 /*--------------------------- get_default_filter ------------------*/
180 /*
181 NAME
182 get_default_filter
183
184 DESCRIPTION
185 get the default value for the filter preference
186 */
187 function get_default_filter(
188 p_dstore_pref in varchar2,
189 p_coltype in number
190 )
191 return varchar2;
192
193 /*--------------------------- add_partition_storage ---------------*/
194 /*
195 NAME
196 add_partition_storage
197
198 DESCRIPTION
199 add a storage clause for the partition
200 */
201 procedure add_partition_storage(
202 p_idx_id in number,
203 p_part_id in number,
204 p_storage_pref in varchar2
205 );
206
207 /*--------------------------- remove_partition_storage -----------*/
208 /*
209 NAME
210 remove_partition_storage
211
212 DESCRIPTION
213 remove storage class values for the partition
214 */
215 procedure remove_partition_storage(
216 p_idx_id in number,
217 p_part_id in number
218 );
219
220 /*--------------------------- get_attribute_value ------------------*/
221 /*
222 NAME
223 get_attribute_value
224
225 DESCRIPTION
226 given a preference record and an attribute name, returns the
227 value of the attribute in the preference. used from drival.
228 */
229 function get_attribute_value(
230 pre_rec dr_def.pref_rec,
231 attribute_name varchar2
232 )
233 return varchar2;
234
235 /*========================================================================*/
236 /*========================================================================*/
237 /* AFTER-INDEXING REPORT */
238 /*========================================================================*/
239 /*========================================================================*/
240
241 /*--------------------------- get_index_values ---------------------------*/
242 /* get the values for the class for the index */
243
244 PROCEDURE get_index_values(
245 p_idx_id in number,
246 p_cla_id in binary_integer,
247 o_ixv in out nocopy dr_def.ixv_tab
248 );
249
250 /*--------------------------- get_sub_index_values -----------------------*/
251 /* get the sub-values for the class for the index */
252
253 PROCEDURE get_sub_index_values(
254 p_idx_id in number,
255 p_cla_id in binary_integer,
256 p_sub_grp in binary_integer,
257 o_ixv in out nocopy dr_def.ixv_tab
258 );
259
260 /*========================================================================*/
261 /*========================================================================*/
262 /* CLASSIFICATION */
263 /*========================================================================*/
264 /*========================================================================*/
265
266 /*---------------------------- GetPrefClaObj -----------------------------*/
267
268 procedure GetPrefClaObj(
269 p_preid in number,
270 o_claid out number,
271 o_objid out number
272 );
273
274 /*---------------------------- GetObjDefault -----------------------------*/
275
276 procedure GetObjDefault(
277 p_oatid in number,
278 o_default out varchar2
279 );
280
281 /*---------------------------- OpenPrefValue ------------------------------*/
282
283 procedure OpenPrefValue(
284 p_preid in number
285 );
286
287 /*---------------------------- NextPrefValue ------------------------------*/
288
289 function NextPrefValue(
290 o_value out varchar2,
291 o_oatid out number
292 ) return binary_integer;
293
294 end dripref;
[Home] [Help]