1 PACKAGE JTF_FM_UTL_V AUTHID CURRENT_USER AS
2 /* $Header: jtfvfmus.pls 115.14 2004/02/10 13:44:12 applrt ship $ */
3
4
5 G_LEVEL_UNEXPECTED CONSTANT NUMBER := 6;
6 G_LEVEL_ERROR CONSTANT NUMBER := 5;
7 G_LEVEL_EXCEPTION CONSTANT NUMBER := 4;
8 G_LEVEL_EVENT CONSTANT NUMBER := 3;
9 G_LEVEL_PROCEDURE CONSTANT NUMBER := 2;
10 G_LEVEL_STATEMENT CONSTANT NUMBER := 1;
11
12
13 ---------------------------------------------------------------------
14 -- Function
15 -- Confirm_Pasta_Printable
16 --
17 -- PURPOSE
18 -- Confirm whether any of the documents attached is not an
19 -- RTF or PDF
20 --
21 -- PARAMETERS
22 -- p_request_id : request_id
23 -- RETURNS
24 -- True : If all the files are RTF or PDF
25 -- False : If any of the files is not an RTF or PDF
26 --
27 --
28 ---------------------------------------------------------------------
29 FUNCTION CONFIRM_PASTA_PRINTABLE
30 (
31 p_request_id NUMBER
32 )
33 RETURN VARCHAR2;
34
35
36 ---------------------------------------------------------------------
37 -- Function
38 -- Confirm_Rtf
39 --
40 -- PURPOSE
41 -- Confirm whether a file is an RTF file or not
42 --
43 -- PARAMETERS
44 -- p_file_id : File id in FND_LOBS
45 -- RETURNS
46 -- True : If the file is an RTF file
47 -- False : If the file is not an RTF file
48
49 --
50 ---------------------------------------------------------------------
51 FUNCTION CONFIRM_RTF
52 (
53 p_file_id IN NUMBER
54 )
55 RETURN BOOLEAN;
56
57 ---------------------------------------------------------------------
58 -- Function
59 -- Confirm_PDF
60 --
61 -- PURPOSE
62 -- Confirm whether a file is an PDF file or not
63 --
64 -- PARAMETERS
65 -- p_file_id : File id in FND_LOBS
66 -- RETURNS
67 -- True : If the file is an PDF file
68 -- False : If the file is not an PDF file
69 ---------------------------------------------------------------------
70 FUNCTION CONFIRM_PDF
71 (
72 p_file_id IN NUMBER
73 )
74 RETURN BOOLEAN;
75
76 ---------------------------------------------------------------------
77 -- Function
78 -- Confirm_Text_Html
79 --
80 -- PURPOSE
81 -- Confirm whether a file is an HTML or Text File
82 --
83 -- PARAMETERS
84 -- p_file_id : File id in FND_LOBS
85 -- RETURNS
86 -- True : If the file is an HTML file or Text file
87 -- False : If the file is not an HTML file or Text file
88 ------------------------------------------------------------------------
89 FUNCTION CONFIRM_TEXT_HTML
90 (
91 p_file_id IN NUMBER
92 )
93 RETURN BOOLEAN;
94
95 ---------------------------------------------------------------------
96 -- PROCEDURE
97 -- Get_Message
98 --
99 -- PURPOSE
100 -- Gets a Message.
101 --
102 -- PARAMETERS
103 -- p_application_code : 'JTF' for fulfillment
104 -- p_message_nm : The name of the message
105 -- p_arg1 : Token one value
106 -- p_arg2 : Token two value
107 -- x_message : Translated Output message with tokens inserted
108 -- NOTES
109 -- 1. Currently gets ERROR messages only
110 -- 2. The taken names must be ARG1 and ARG2
111 ---------------------------------------------------------------------
112 PROCEDURE Get_Message
113 (
114 p_api_version IN NUMBER,
115 p_init_msg_list IN VARCHAR2 := FND_API.G_FALSE,
116 p_commit IN VARCHAR2 := FND_API.G_FALSE,
117 p_validation_level IN NUMBER := FND_API.G_VALID_LEVEL_FULL,
118 x_return_status OUT NOCOPY VARCHAR2,
119 x_msg_count OUT NOCOPY NUMBER,
120 x_msg_data OUT NOCOPY VARCHAR2,
121 p_application_code IN VARCHAR2,
122 p_message_nm IN VARCHAR2,
123 p_arg1 IN VARCHAR2 := NULL,
124 p_arg2 IN VARCHAR2 := NULL,
125 x_message OUT NOCOPY VARCHAR2
126 );
127
128 ---------------------------------------------------------------------
129 -- PROCEDURE
130 -- Post_Message
131 --
132 -- PURPOSE
133 -- Posts a Message.
134 --
135 -- PARAMETERS
136 -- p_application_code : 'JTF' for fulfillment
137 -- p_message_nm : The name of the message
138 -- p_arg1 : Token one value
139 -- p_arg2 : Token two value
140 --
141 -- NOTES
142 -- 1. Currently gets ERROR messages only
143 -- 2. The taken names must be ARG1 and ARG2
144 ---------------------------------------------------------------------
145 PROCEDURE Post_Message
146 (
147 p_api_version IN NUMBER,
148 p_init_msg_list IN VARCHAR2 := FND_API.G_FALSE,
149 p_commit IN VARCHAR2 := FND_API.G_FALSE,
150 p_validation_level IN NUMBER := FND_API.G_VALID_LEVEL_FULL,
151 x_return_status OUT NOCOPY VARCHAR2,
152 x_msg_count OUT NOCOPY NUMBER,
153 x_msg_data OUT NOCOPY VARCHAR2,
154 p_application_code IN VARCHAR2,
155 p_message_nm IN VARCHAR2,
156 p_arg1 IN VARCHAR2 := NULL,
157 p_arg2 IN VARCHAR2 := NULL
158 );
159
160 ---------------------------------------------------------------------
161 -- PROCEDURE
162 -- Get_Post_Message
163 --
164 -- PURPOSE
165 -- Posts and Gets the Message in one call.
166 --
167 -- PARAMETERS
168 -- p_application_code : 'JTF' for fulfillment
169 -- p_message_nm : The name of the message
170 -- p_arg1 : Token one value
171 -- p_arg2 : Token two value
172 -- x_message : Translated Output message with tokens inserted
173 --
174 -- NOTES
175 -- 1. Currently gets ERROR messages only
176 -- 2. The taken names must be ARG1 and ARG2
177 ---------------------------------------------------------------------
178 PROCEDURE Get_Post_Message
179 (
180 p_api_version IN NUMBER,
181 p_init_msg_list IN VARCHAR2 := FND_API.G_FALSE,
182 p_commit IN VARCHAR2 := FND_API.G_FALSE,
183 p_validation_level IN NUMBER := FND_API.G_VALID_LEVEL_FULL,
184 x_return_status OUT NOCOPY VARCHAR2,
185 x_msg_count OUT NOCOPY NUMBER,
186 x_msg_data OUT NOCOPY VARCHAR2,
187 p_application_code IN VARCHAR2,
188 p_message_nm IN VARCHAR2,
189 p_arg1 IN VARCHAR2 := NULL,
190 p_arg2 IN VARCHAR2 := NULL,
191 x_message OUT NOCOPY VARCHAR2
192 );
193
194
195 ---------------------------------------------------------------------
196 -- PROCEDURE
197 -- PRINT_Message
198 --
199 -- PURPOSE
200 -- Logs Messages
201 --
202 -- PARAMETERS
203
204 -- p_message : The message
205 -- p_log_level : Logging Level
206 -- p_module_name: 'module that logs the message'
207
208 --
209 -- NOTES
210 -- 1. This procedure will be used by all Fulfillment API's to
211 -- centrally log messages
212 -- Date : June 2nd 2003
213
214 ---------------------------------------------------------------------
215 PROCEDURE Print_Message
216 (
217
218 p_message IN VARCHAR2,
219 p_log_level IN NUMBER,
220 p_module_name IN VARCHAR2
221 );
222
223 ---------------------------------------------------------------------
224 -- PROCEDURE
225 -- ADD_ERROR_MESSAGE
226 --
227 -- PURPOSE
228 -- IN TURN CALLS PRINT_MESSAGE.
229 --
230 -- PARAMETERS
231
232 -- p_api_name : The api where error occured
233 -- p_error_msg : The error message
234
235 --
236 -- NOTES
237 -- 1. This procedure will be used by all Fulfillment API's to
238 -- centrally log messages
239 -- Date : June 2nd 2003
240
241 ---------------------------------------------------------------------
242 PROCEDURE Add_Error_Message
243 (
244 p_api_name IN VARCHAR2,
245 p_error_msg IN VARCHAR2
246 );
247
248 ---------------------------------------------------------------------
249 -- PROCEDURE
250 -- GET_ERROR_MESSAGE
251 --
252 -- PURPOSE
253 -- TO GET THE LAST ERROR MESSAGE
254 --
255 -- PARAMETERS
256
257 -- ONLY ONE OUT PARAMETER WHICH IS THE LAST MESSAGE IN THE STACK
258
259 --
260 -- NOTES
261 -- Date : June 2nd 2003
262
263 ---------------------------------------------------------------------
264
265 PROCEDURE Get_Error_Message
266 (
267 x_msg_data OUT NOCOPY VARCHAR2
268 ) ;
269
270
271 ---------------------------------------------------------------------
272 -- PROCEDURE
273 -- HANDLE_ERROR
274 --
275 -- PURPOSE
276 -- TO RAISE THE APPROPRIATE ERROR
277 --
278 -- PARAMETERS
279 -- P_name the key of the message
280 -- p_token the arguments to the message
281 -- NOTES
282 -- Date : June 2nd 2003
283
284 ---------------------------------------------------------------------
285 PROCEDURE HANDLE_ERROR(
286 p_name IN VARCHAR2,
287 p_token IN VARCHAR2
288
289 );
290 PROCEDURE HANDLE_ERROR( p_name IN VARCHAR2);
291
292 ----------------------------------------------------------------------
293 -- INSERT_EMAIL_STATS
294 ---------------------------------------------------------------------
295 PROCEDURE INSERT_EMAIL_STATS
296 (
297 p_request_id IN NUMBER
298 );
299
300 -----------------------------------------------------------------------
301
302 type fm_pvt_rec_type is record
303 (
304 content_xml VARCHAR2(32767),
305 request_id NUMBER,
306 party_id NUMBER,
307 queue VARCHAR2(2),
308 preview VARCHAR2(30),
309 priority NUMBER,
310 doc_id NUMBER,
311 doc_ref VARCHAR2(30),
312 param_names JTF_FM_REQUEST_GRP.G_VARCHAR_TBL_TYPE,
313 param_values JTF_FM_REQUEST_GRP.G_VARCHAR_TBL_TYPE
314 );
315 --functions moevd from other modules within our apis.
316
317 FUNCTION IS_FLD_VALID( p_string IN VARCHAR2) RETURN BOOLEAN;
318 FUNCTION IS_FLD_VALID( p_number IN NUMBER) RETURN BOOLEAN;
319 FUNCTION GET_ENCODING RETURN VARCHAR2;
320 FUNCTION REPLACE_TAG(p_string IN VARCHAR2) RETURN VARCHAR2;
321 FUNCTION GET_MEDIA(p_content_xml IN VARCHAR2) RETURN VARCHAR2;
322 FUNCTION GET_MEDIA_TYPE( p_content_xml IN VARCHAR2) RETURN VARCHAR2;
323 PROCEDURE Get_Dtd(p_dtd IN OUT NOCOPY VARCHAR2);
324 PROCEDURE FM_SUBMIT_REQ_V1
325 (p_api_version IN NUMBER,
326 p_init_msg_list IN VARCHAR2,
327 p_commit IN VARCHAR2,
328 x_return_status OUT NOCOPY VARCHAR2,
329 x_msg_count OUT NOCOPY NUMBER,
330 x_msg_data OUT NOCOPY VARCHAR2,
331 p_fulfill_electronic_rec IN JTF_FM_OCM_REQUEST_GRP.FULFILL_ELECTRONIC_REC_TYPE,
332 fm_pvt_rec IN FM_PVT_REC_TYPE
333
334 ) ;
335
336
337 END JTF_FM_UTL_V;
[Home] [Help]