[Home] [Help]
PACKAGE: APPS.IBC_CITEM_RUNTIME_PVT
Source
1 PACKAGE IBC_CITEM_RUNTIME_PVT as
2 /* $Header: ibcvcirs.pls 120.0 2005/05/27 14:56:47 appldev noship $ */
3
4 --------------------------------------------------------------------------------
5 -- Start of comments
6 -- API name : Validate_Citem
7 -- Type : Private
8 -- Pre-reqs : None
9 -- Function : Check if content item is valid.
10 -- 1) content item id must be valid.
11 -- 2) wd_restricted_flag of content item must be false.
12 -- 3) content item status must be approved.
13 -- Parameters :
14 -- p_init_msg_list IN VARCHAR2 Optional
15 -- Default = FND_API.G_FALSE
16 -- p_content_item_id IN NUMBER Required
17 -- OUT : x_content_type_code OUT VARCHAR2
18 -- x_item_reference_code OUT VARCHAR2
19 -- x_live_citem_version_id OUT NUMBER
20 -- x_encrypt_flag OUT VARCHAR2
21 -- x_return_status OUT VARCHAR2
22 -- x_msg_count OUT NUMBER
23 -- x_msg_data OUT VARCHAR2
24 --------------------------------------------------------------------------------
25 PROCEDURE Validate_Citem (
26 p_init_msg_list IN VARCHAR2 DEFAULT FND_API.G_FALSE,
27 p_content_item_id IN NUMBER,
28 x_content_type_code OUT NOCOPY VARCHAR2,
29 x_item_reference_code OUT NOCOPY VARCHAR2,
30 x_live_citem_version_id OUT NOCOPY NUMBER,
31 x_encrypt_flag OUT NOCOPY VARCHAR2,
32 x_return_status OUT NOCOPY VARCHAR2,
33 x_msg_count OUT NOCOPY NUMBER,
34 x_msg_data OUT NOCOPY VARCHAR2
35 );
36
37 --------------------------------------------------------------------------------
38 -- Start of comments
39 -- API name : Validate_Start_End_Date
40 -- Type : Private
41 -- Pre-reqs : None
42 -- Function : Check sysdate against content item's start/end date. The
43 -- action of validation also depends on profile options,
44 -- IBC_ENFORCE_AVAILABLE_DATE and IBC_ENFORCE_EXPIRATION_DATE.
45 -- Parameters :
46 -- p_init_msg_list IN VARCHAR2 Optional
47 -- Default = FND_API.G_FALSE
48 -- p_content_item_id IN NUMBER Required
49 -- p_citem_version_id IN NUMBER Required
50 -- OUT : x_version_number OUT NUMBER
51 -- x_start_date OUT DATE
52 -- x_end_date OUT DATE
53 -- x_return_status OUT VARCHAR2
54 -- x_msg_count OUT NUMBER
55 -- x_msg_data OUT VARCHAR2
56 --------------------------------------------------------------------------------
57 PROCEDURE Validate_Start_End_Date (
58 p_init_msg_list IN VARCHAR2 DEFAULT FND_API.G_FALSE,
59 p_content_item_id IN NUMBER,
60 p_citem_version_id IN NUMBER,
61 x_version_number OUT NOCOPY NUMBER,
62 x_start_date OUT NOCOPY DATE,
63 x_end_date OUT NOCOPY DATE,
64 x_return_status OUT NOCOPY VARCHAR2,
65 x_msg_count OUT NOCOPY NUMBER,
66 x_msg_data OUT NOCOPY VARCHAR2
67 );
68
69 --------------------------------------------------------------------------------
70 -- Start of comments
71 -- API name : Get_Citem_Meta
72 -- Type : Private
73 -- Pre-reqs : None
74 -- Function : Return a content item with just the meta-data.
75 -- Parameters :
76 -- p_init_msg_list IN VARCHAR2 Optional
77 -- Default = FND_API.G_FALSE
78 -- p_content_item_id IN NUMBER Required
79 -- p_label_code IN VARCHAR2 Optional
80 -- Default = NULL
81 -- OUT : x_content_item_meta OUT IBC_CITEM_RUNTIME_PUB.CONTENT_ITEM_META_REC
82 -- x_item_found OUT VARCHAR2
83 -- x_return_status OUT VARCHAR2
84 -- x_msg_count OUT NUMBER
85 -- x_msg_data OUT VARCHAR2
86 --------------------------------------------------------------------------------
87 PROCEDURE Get_Citem_Meta (
88 p_init_msg_list IN VARCHAR2 DEFAULT FND_API.G_FALSE,
89 p_content_item_id IN NUMBER,
90 p_label_code IN VARCHAR2 DEFAULT NULL,
91 x_content_item_meta OUT NOCOPY IBC_CITEM_RUNTIME_PUB.CONTENT_ITEM_META_REC,
92 x_item_found OUT NOCOPY VARCHAR2,
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 -- API name : Get_Citem_Xml
101 -- Type : Private
102 -- Pre-reqs : None
103 -- Function : Return a content item with its data in Xml.
104 -- Parameters :
105 -- p_init_msg_list IN VARCHAR2 Optional
106 -- Default = FND_API.G_FALSE
107 -- p_content_item_id IN NUMBER Required
108 -- p_xml_clob_loc IN OUT CLOB Required
109 -- p_num_levels IN NUMBER Optional
110 -- DEFAULT = NULL
111 -- p_label_code IN VARCHAR2 Optional
112 -- Default = NULL
113 -- p_lang_code IN VARCHAR2 Optional
114 -- Default = NULL
115 -- p_validate_dates IN VARCHAR2 Optional
116 -- Default = FND_API.G_TRUE
117 -- OUT :
118 -- x_return_status OUT VARCHAR2
119 -- x_msg_count OUT NUMBER
120 -- x_msg_data OUT VARCHAR2
121 --------------------------------------------------------------------------------
122 PROCEDURE Get_Citem_Xml (
123 p_init_msg_list IN VARCHAR2 DEFAULT FND_API.G_FALSE,
124 p_content_item_id IN NUMBER,
125 p_xml_clob_loc IN OUT NOCOPY CLOB,
126 p_num_levels IN NUMBER DEFAULT NULL,
127 p_label_code IN VARCHAR2 DEFAULT NULL,
128 p_lang_code IN VARCHAR2 DEFAULT NULL,
129 p_validate_dates IN VARCHAR2 DEFAULT FND_API.G_TRUE,
130 x_num_levels_loaded OUT NOCOPY NUMBER,
131 x_return_status OUT NOCOPY VARCHAR2,
132 x_msg_count OUT NOCOPY NUMBER,
133 x_msg_data OUT NOCOPY VARCHAR2
134 );
135
136
137
138
139 -------------------------------------------------------------------------------
140 --
141 -- Private APIs for Runtime Cache Loading
142 --
143 -------------------------------------------------------------------------------
144 PROCEDURE Bulk_Load (
145 p_init_msg_list IN VARCHAR2 DEFAULT FND_API.G_FALSE,
146 x_clobs OUT NOCOPY JTF_CLOB_TABLE,
147 x_content_item_ids OUT NOCOPY JTF_NUMBER_TABLE,
148 x_label_codes OUT NOCOPY JTF_VARCHAR2_TABLE_100,
149 x_lang_codes OUT NOCOPY JTF_VARCHAR2_TABLE_100,
150 x_return_status OUT NOCOPY VARCHAR2,
151 x_msg_count OUT NOCOPY NUMBER,
152 x_msg_data OUT NOCOPY VARCHAR2
153 );
154
155 PROCEDURE Load_Translated_Content_Items (
156 p_init_msg_list IN VARCHAR2 DEFAULT FND_API.G_FALSE,
157 p_content_item_ids IN JTF_NUMBER_TABLE,
158 p_label_codes IN JTF_VARCHAR2_TABLE_100,
159 p_lang_codes IN JTF_VARCHAR2_TABLE_100,
160 p_validate_dates IN VARCHAR2 DEFAULT FND_API.G_TRUE,
161 x_clobs OUT NOCOPY JTF_CLOB_TABLE,
162 x_content_item_ids OUT NOCOPY JTF_NUMBER_TABLE,
163 x_label_codes OUT NOCOPY JTF_VARCHAR2_TABLE_100,
164 x_lang_codes OUT NOCOPY JTF_VARCHAR2_TABLE_100,
165 x_return_status OUT NOCOPY VARCHAR2,
166 x_msg_count OUT NOCOPY NUMBER,
167 x_msg_data OUT NOCOPY VARCHAR2
168 );
169
170 PROCEDURE Load_Citem_Version_Number (
171 p_init_msg_list IN VARCHAR2 DEFAULT FND_API.G_FALSE,
172 p_content_item_id IN NUMBER,
173 p_label_code IN VARCHAR2 DEFAULT NULL,
174 x_version_number OUT NOCOPY NUMBER,
175 x_return_status OUT NOCOPY VARCHAR2,
176 x_msg_count OUT NOCOPY NUMBER,
177 x_msg_data OUT NOCOPY VARCHAR2
178 );
179
180 PROCEDURE Load_Associations (
181 p_init_msg_list IN VARCHAR2 DEFAULT FND_API.G_FALSE,
182 p_association_type_code IN VARCHAR2,
183 p_associated_object_val1 IN VARCHAR2,
184 p_associated_object_val2 IN VARCHAR2 DEFAULT NULL,
185 p_associated_object_val3 IN VARCHAR2 DEFAULT NULL,
186 p_associated_object_val4 IN VARCHAR2 DEFAULT NULL,
187 p_associated_object_val5 IN VARCHAR2 DEFAULT NULL,
188 x_content_item_id_tbl OUT NOCOPY JTF_NUMBER_TABLE,
189 x_return_status OUT NOCOPY VARCHAR2,
190 x_msg_count OUT NOCOPY NUMBER,
191 x_msg_data OUT NOCOPY VARCHAR2
192 );
193
194 PROCEDURE Get_Citem_Xml (
195 p_init_msg_list IN VARCHAR2 DEFAULT FND_API.G_FALSE,
196 p_content_item_id IN NUMBER,
197 p_xml_clob_loc IN OUT NOCOPY CLOB,
198 p_num_levels IN NUMBER DEFAULT NULL,
199 p_citem_version_id IN NUMBER DEFAULT NULL,
200 p_lang_code IN VARCHAR2 DEFAULT NULL,
201 p_validate_dates IN VARCHAR2 DEFAULT FND_API.G_TRUE,
202 x_num_levels_loaded OUT NOCOPY NUMBER,
203 x_return_status OUT NOCOPY VARCHAR2,
204 x_msg_count OUT NOCOPY NUMBER,
205 x_msg_data OUT NOCOPY VARCHAR2
206 );
207
208 END IBC_CITEM_RUNTIME_PVT;