1 PACKAGE IBC_CITEM_RUNTIME_PUB as
2 /* $Header: ibcpcirs.pls 120.0 2005/05/27 14:59:00 appldev noship $ */
3
4 ----------------------------------------------
5 -- Type Definitions
6 ----------------------------------------------
7
8 -- Rendition table parameters
9 TYPE Rendition_File_Name_Tbl IS TABLE OF VARCHAR2(256);
10 TYPE Rendition_File_Id_Tbl IS TABLE OF NUMBER;
11 TYPE Rendition_Mime_Type_Tbl IS TABLE OF VARCHAR2(30);
12 TYPE Rendition_Name_Tbl IS TABLE OF VARCHAR2(240);
13 -- Component attributes table parameters
14 TYPE Comp_Item_Attrib_Tcode_Tbl IS TABLE OF VARCHAR2(100);
15 TYPE Comp_Item_Citem_Id_Tbl IS TABLE OF NUMBER;
16
17 -- Content Item Meta
18 TYPE Content_Item_Meta_Rec IS RECORD (
19 content_item_id NUMBER,
20 version_number NUMBER,
21 available_date DATE,
22 expiration_date DATE,
23 content_type_code VARCHAR2(100),
24 item_reference_code VARCHAR2(100),
25 encrypt_flag VARCHAR2(1),
26 content_item_name VARCHAR2(240),
27 description VARCHAR2(2000),
28 attachment_file_name VARCHAR2(256),
29 attachment_file_id NUMBER,
30 default_mime_type VARCHAR2(30),
31 default_rendition_name VARCHAR2(240)
32 );
33 TYPE Content_Item_Meta_Tbl IS TABLE OF Content_Item_Meta_Rec;
34
35 -- Content Item Basic
36 TYPE Content_Item_Basic_Rec IS RECORD (
37 content_item_id NUMBER,
38 version_number NUMBER,
39 available_date DATE,
40 expiration_date DATE,
41 content_type_code VARCHAR2(100),
42 item_reference_code VARCHAR2(100),
43 encrypt_flag VARCHAR2(1),
44 content_item_name VARCHAR2(240),
45 description VARCHAR2(2000),
46 attachment_file_name VARCHAR2(256),
47 attachment_file_id NUMBER,
48 rendition_file_names Rendition_File_Name_Tbl,
49 rendition_file_ids Rendition_File_Id_Tbl,
50 rendition_mime_types Rendition_Mime_Type_Tbl,
51 rendition_names Rendition_Name_Tbl,
52 default_mime_type VARCHAR2(30),
53 default_rendition_name VARCHAR2(240),
54 attribute_bundle CLOB,
55 comp_item_attrib_tcodes Comp_Item_Attrib_Tcode_Tbl,
56 comp_item_citem_ids Comp_Item_Citem_Id_Tbl
57 );
58
59
60 TYPE Content_Item_Id_Tbl IS TABLE OF NUMBER;
61
62
63 --------------------------------------------------------------------------------
64 -- Start of comments
65 -- API name : Get_Citems_Meta_By_Assoc
66 -- Type : Public
67 -- Pre-reqs : None
68 -- Function : Return a list of content items with their meta-data
69 -- based on association.
70 -- Parameters :
71 -- IN : p_api_version IN NUMBER Required
72 -- p_init_msg_list IN VARCHAR2 Optional
73 -- Default = FND_API.G_FALSE
74 -- p_association_type_code IN VARCHAR2 Required
75 -- p_associated_object_val1 IN VARCHAR2 Required
76 -- p_associated_object_val2 IN VARCHAR2 Optional
77 -- Default = NULL
78 -- p_associated_object_val3 IN VARCHAR2 Optional
79 -- Default = NULL
80 -- p_associated_object_val4 IN VARCHAR2 Optional
81 -- Default = NULL
82 -- p_associated_object_val5 IN VARCHAR2 Optional
83 -- Default = NULL
84 -- p_label_code IN VARCHAR2 Optional
85 -- Default = NULL
86 -- OUT : x_return_status OUT VARCHAR2
87 -- x_msg_count OUT NUMBER
88 -- x_msg_data OUT VARCHAR2
89 -- x_content_item_meta_tbl OUT CONTENT_ITEM_META_TBL
90 --------------------------------------------------------------------------------
91 PROCEDURE Get_Citems_Meta_By_Assoc (
92 p_api_version IN NUMBER,
93 p_init_msg_list IN VARCHAR2 DEFAULT FND_API.G_FALSE,
94 p_association_type_code IN VARCHAR2,
95 p_associated_object_val1 IN VARCHAR2,
96 p_associated_object_val2 IN VARCHAR2 DEFAULT NULL,
97 p_associated_object_val3 IN VARCHAR2 DEFAULT NULL,
98 p_associated_object_val4 IN VARCHAR2 DEFAULT NULL,
99 p_associated_object_val5 IN VARCHAR2 DEFAULT NULL,
100 p_label_code IN VARCHAR2 DEFAULT NULL,
101 x_return_status OUT NOCOPY VARCHAR2,
102 x_msg_count OUT NOCOPY NUMBER,
103 x_msg_data OUT NOCOPY VARCHAR2,
104 x_content_item_meta_tbl OUT NOCOPY CONTENT_ITEM_META_TBL
105 );
106
107 --------------------------------------------------------------------------------
108 -- Start of comments
109 -- API name : Get_Citems_Meta_By_Assoc_Ctyp
110 -- Type : Public
111 -- Pre-reqs : None
112 -- Function : Return a list of content items with their meta-data
113 -- based on association and content type.
114 -- Parameters :
115 -- IN : p_api_version IN NUMBER Required
116 -- p_init_msg_list IN VARCHAR2 Optional
117 -- Default = FND_API.G_FALSE
118 -- p_association_type_code IN VARCHAR2 Required
119 -- p_associated_object_val1 IN VARCHAR2 Required
120 -- p_associated_object_val2 IN VARCHAR2 Optional
121 -- Default = NULL
122 -- p_associated_object_val3 IN VARCHAR2 Optional
123 -- Default = NULL
124 -- p_associated_object_val4 IN VARCHAR2 Optional
125 -- Default = NULL
126 -- p_associated_object_val5 IN VARCHAR2 Optional
127 -- Default = NULL
128 -- p_content_type_code IN VARCHAR2 Required
129 -- p_label_code IN VARCHAR2 Optional
130 -- Default = NULL
131 -- OUT : x_return_status OUT VARCHAR2
132 -- x_msg_count OUT NUMBER
133 -- x_msg_data OUT VARCHAR2
134 -- x_content_item_meta_tbl OUT CONTENT_ITEM_META_TBL
135 --------------------------------------------------------------------------------
136 PROCEDURE Get_Citems_Meta_By_Assoc_Ctyp (
137 p_api_version IN NUMBER,
138 p_init_msg_list IN VARCHAR2 DEFAULT FND_API.G_FALSE,
139 p_association_type_code IN VARCHAR2,
140 p_associated_object_val1 IN VARCHAR2,
141 p_associated_object_val2 IN VARCHAR2 DEFAULT NULL,
142 p_associated_object_val3 IN VARCHAR2 DEFAULT NULL,
143 p_associated_object_val4 IN VARCHAR2 DEFAULT NULL,
144 p_associated_object_val5 IN VARCHAR2 DEFAULT NULL,
145 p_content_type_code IN VARCHAR2,
146 p_label_code IN VARCHAR2 DEFAULT NULL,
147 x_return_status OUT NOCOPY VARCHAR2,
148 x_msg_count OUT NOCOPY NUMBER,
149 x_msg_data OUT NOCOPY VARCHAR2,
150 x_content_item_meta_tbl OUT NOCOPY CONTENT_ITEM_META_TBL
151 );
152
153 --------------------------------------------------------------------------------
154 -- Start of comments
155 -- API name : Get_Citems_Meta
156 -- Type : Public
157 -- Pre-reqs : None
158 -- Function : Return a list of content items with their meta-data
159 -- based on the given list of content item ids.
160 -- Parameters :
161 -- IN : p_api_version IN NUMBER Required
162 -- p_init_msg_list IN VARCHAR2 Optional
163 -- Default = FND_API.G_FALSE
164 -- p_content_item_ids IN CONTENT_ITEM_ID_TBL Required
165 -- p_label_code IN VARCHAR2 Optional
166 -- Default = NULL
167 -- OUT : x_return_status OUT VARCHAR2
168 -- x_msg_count OUT NUMBER
169 -- x_msg_data OUT VARCHAR2
170 -- x_content_item_meta_tbl OUT CONTENT_ITEM_META_TBL
171 --------------------------------------------------------------------------------
172 PROCEDURE Get_Citems_Meta (
173 p_api_version IN NUMBER,
174 p_init_msg_list IN VARCHAR2 DEFAULT FND_API.G_FALSE,
175 p_content_item_ids IN CONTENT_ITEM_ID_TBL,
176 p_label_code IN VARCHAR2 DEFAULT NULL,
177 x_return_status OUT NOCOPY VARCHAR2,
178 x_msg_count OUT NOCOPY NUMBER,
179 x_msg_data OUT NOCOPY VARCHAR2,
180 x_content_item_meta_tbl OUT NOCOPY CONTENT_ITEM_META_TBL
181 );
182
183 --------------------------------------------------------------------------------
184 -- Start of comments
185 -- API name : Get_Citem_Meta
186 -- Type : Public
187 -- Pre-reqs : None
188 -- Function : Return a content item with just the meta-data.
189 -- Parameters :
190 -- IN : p_api_version IN NUMBER Required
191 -- p_init_msg_list IN VARCHAR2 Optional
192 -- Default = FND_API.G_FALSE
193 -- p_content_item_id IN NUMBER Required
194 -- p_label_code IN VARCHAR2 Optional
195 -- Default = NULL
196 -- OUT : x_return_status OUT VARCHAR2
197 -- x_msg_count OUT NUMBER
198 -- x_msg_data OUT VARCHAR2
199 -- x_content_item_meta OUT CONTENT_ITEM_META_REC
200 --------------------------------------------------------------------------------
201 PROCEDURE Get_Citem_Meta (
202 p_api_version IN NUMBER,
203 p_init_msg_list IN VARCHAR2 DEFAULT FND_API.G_FALSE,
204 p_content_item_id IN NUMBER,
205 p_label_code IN VARCHAR2 DEFAULT NULL,
206 x_return_status OUT NOCOPY VARCHAR2,
207 x_msg_count OUT NOCOPY NUMBER,
208 x_msg_data OUT NOCOPY VARCHAR2,
209 x_content_item_meta OUT NOCOPY CONTENT_ITEM_META_REC
210 );
211
212 --------------------------------------------------------------------------------
213 -- Start of comments
214 -- API name : Get_Citem_Basic
215 -- Type : Public
216 -- Pre-reqs : None
217 -- Function : Return a content item with basic data.
218 -- Parameters :
219 -- IN : p_api_version IN NUMBER Required
220 -- p_init_msg_list IN VARCHAR2 Optional
221 -- Default = FND_API.G_FALSE
222 -- p_content_item_id IN NUMBER Required
223 -- p_label_code IN VARCHAR2 Optional
224 -- Default = NULL
225 -- OUT : x_return_status OUT VARCHAR2
226 -- x_msg_count OUT NUMBER
227 -- x_msg_data OUT VARCHAR2
228 -- x_content_item_basic OUT CONTENT_ITEM_BASIC_REC
229 --------------------------------------------------------------------------------
230 PROCEDURE Get_Citem_Basic (
231 p_api_version IN NUMBER,
232 p_init_msg_list IN VARCHAR2 DEFAULT FND_API.G_FALSE,
233 p_content_item_id IN NUMBER,
234 p_label_code IN VARCHAR2 DEFAULT NULL,
235 x_return_status OUT NOCOPY VARCHAR2,
236 x_msg_count OUT NOCOPY NUMBER,
237 x_msg_data OUT NOCOPY VARCHAR2,
238 x_content_item_basic OUT NOCOPY CONTENT_ITEM_BASIC_REC
239 );
240
241 --------------------------------------------------------------------------------
242 -- Start of comments
243 -- API name : Get_Citem_Basic_Xml
244 -- Type : Public
245 -- Pre-reqs : None
246 -- Function : Return a content item with basic data as an XML Document.
247 -- The item's compounded items are returned as references in
248 -- the Xml.
249 -- Parameters :
250 -- IN : p_api_version IN NUMBER Required
251 -- p_init_msg_list IN VARCHAR2 Optional
252 -- Default = FND_API.G_FALSE
253 -- p_content_item_id IN NUMBER Required
254 -- p_label_code IN VARCHAR2 Optional
255 -- Default = NULL
256 -- OUT : x_return_status OUT VARCHAR2
257 -- x_msg_count OUT NUMBER
258 -- x_msg_data OUT VARCHAR2
259 -- x_content_item_xml OUT CLOB
260 --------------------------------------------------------------------------------
261 PROCEDURE Get_Citem_Basic_Xml (
262 p_api_version IN NUMBER,
263 p_init_msg_list IN VARCHAR2 DEFAULT FND_API.G_FALSE,
264 p_content_item_id IN NUMBER,
265 p_label_code IN VARCHAR2 DEFAULT NULL,
266 x_return_status OUT NOCOPY VARCHAR2,
267 x_msg_count OUT NOCOPY NUMBER,
268 x_msg_data OUT NOCOPY VARCHAR2,
269 x_content_item_xml OUT NOCOPY CLOB
270 );
271
272 --------------------------------------------------------------------------------
273 -- Start of comments
274 -- API name : Get_Citem_Deep_Xml
275 -- Type : Public
276 -- Pre-reqs : None
277 -- Function : Return a content item with full data as an XML Document.
278 -- The item's component items are fully expanded in
279 -- the Xml rather than as references. If the item's component
280 -- in turn has some other components, they will be fully expanded
281 -- also.
282 -- Parameters :
283 -- IN : p_api_version IN NUMBER Required
284 -- p_init_msg_list IN VARCHAR2 Optional
285 -- Default = FND_API.G_FALSE
286 -- p_content_item_id IN NUMBER Required
287 -- p_label_code IN VARCHAR2 Optional
288 -- Default = NULL
289 -- OUT : x_return_status OUT VARCHAR2
290 -- x_msg_count OUT NUMBER
291 -- x_msg_data OUT VARCHAR2
292 -- x_content_item_xml OUT CLOB
293 -- x_num_levels_loaded OUT NUMBER
294 --------------------------------------------------------------------------------
295 PROCEDURE Get_Citem_Deep_Xml (
296 p_api_version IN NUMBER,
297 p_init_msg_list IN VARCHAR2 DEFAULT FND_API.G_FALSE,
298 p_content_item_id IN NUMBER,
299 p_label_code IN VARCHAR2 DEFAULT NULL,
300 x_return_status OUT NOCOPY VARCHAR2,
301 x_msg_count OUT NOCOPY NUMBER,
302 x_msg_data OUT NOCOPY VARCHAR2,
303 x_content_item_xml OUT NOCOPY CLOB,
304 x_num_levels_loaded OUT NOCOPY NUMBER
305 );
306
307 --------------------------------------------------------------------------------
308 -- Start of comments
309 -- API name : Get_Citem_Deep_Xml
310 -- Type : Public
311 -- Pre-reqs : None
312 -- Function : Return a content item with full data as an XML Document.
313 -- This method returns a specific content item version
314 -- The item's component items are fully expanded in
315 -- the Xml rather than as references. If the item's component
316 -- in turn has some other components, they will be fully expanded
317 -- also.
318 -- Parameters :
319 -- IN : p_api_version IN NUMBER Required
320 -- p_init_msg_list IN VARCHAR2 Optional
321 -- Default = FND_API.G_FALSE
322 -- p_content_item_id IN NUMBER Required
323 -- p_citem_version_id IN VARCHAR2 Required
324 -- OUT : x_return_status OUT VARCHAR2
325 -- x_msg_count OUT NUMBER
326 -- x_msg_data OUT VARCHAR2
327 -- x_content_item_xml OUT CLOB
328 -- x_num_levels_loaded OUT NUMBER
329 --------------------------------------------------------------------------------
330 PROCEDURE Get_Citem_Deep_Xml (
331 p_api_version IN NUMBER,
332 p_init_msg_list IN VARCHAR2 DEFAULT FND_API.G_FALSE,
333 p_content_item_id IN NUMBER,
334 p_citem_version_id IN NUMBER,
335 x_return_status OUT NOCOPY VARCHAR2,
336 x_msg_count OUT NOCOPY NUMBER,
337 x_msg_data OUT NOCOPY VARCHAR2,
338 x_content_item_xml OUT NOCOPY CLOB,
339 x_num_levels_loaded OUT NOCOPY NUMBER
340 );
341
342
343 END IBC_CITEM_RUNTIME_PUB;
[Home] [Help]