DBA Data[Home] [Help]

PACKAGE: APPS.CLN_RN_UTILS

Source


1 PACKAGE CLN_RN_UTILS AUTHID CURRENT_USER AS
2 /* $Header: CLNRNUTS.pls 120.6 2006/04/06 01:42:14 amchaudh noship $ */
3 
4      -- Name
5      --   CONVERT_TO_RN_TIMEZONE
6      -- Purpose
7 
8      --   Converts a date value from server time zone into RosettaNet time zone
9      -- Arguments
10      --   Date
11      -- Notes
12      --
13    PROCEDURE CONVERT_TO_RN_TIMEZONE(
14      p_input_date           IN DATE,
15      x_utc_date             OUT NOCOPY DATE );
16 
17     -- Name
18     --   CONVERT_TO_RN_DATETIME
19     -- Purpose
20     --   Converts a date value into RosettaNet datetime format
21     --   RosettaNet Datetime Format: YYYYMMDDThhmmss.SSSZ
22 
23     -- Arguments
24     --   Date
25     -- Notes
26     --   If the date passed is NULL, then sysdate is considered.
27    PROCEDURE CONVERT_TO_RN_DATETIME(
28      p_server_date          IN DATE,
29      x_rn_datetime          OUT NOCOPY VARCHAR2);
30 
31 
32     -- Name
33     --   CONVERT_TO_RN_DATE_EVENT
34     -- Purpose
35     --   Converts a date value into RosettaNet date format and time format
36     --   RosettaNet Date Format: YYYYMMDDZ  Time Format : hhmmss.SSSZ
37     -- Arguments
38     --   Date
39     -- Notes
40     --   If the date passed is NULL, then sysdate is considered.
41   PROCEDURE CONVERT_TO_RN_DATE_EVENT(
42      p_server_date              IN DATE,
43      x_rn_date                  OUT NOCOPY VARCHAR2,
44      x_rn_time                  OUT NOCOPY VARCHAR2);
45 
46     -- Name
47     --   CONVERT_TO_RN_DATE
48     -- Purpose
49     --   Converts a date value into RosettaNet date format
50     --   RosettaNet Date Format: YYYYMMDDZ
51     -- Arguments
52     --   Date
53     -- Notes
54     --   If the date passed is NULL, then sysdate is considered.
55    PROCEDURE CONVERT_TO_RN_DATE(
56      p_server_date          IN DATE,
57      x_rn_date              OUT NOCOPY VARCHAR2);
58 
59       -- Name
60       --   CONVERT_TO_DB_DATE
61       -- Purpose
62       --   Converts a date value from RosettaNet date/datetime format to db format
63       --   RosettaNet Datetime Format: YYYYMMDDThhmmss.SSSZ
64       --   RosettaNet Date Format    : YYYYMMDDZ
65       -- Arguments
66 
67       --   Date
68       -- Notes
69       --   If the date passed is NULL, then sysdate is considered.
70     PROCEDURE CONVERT_TO_DB_DATE(
71        p_rn_date            IN VARCHAR2,
72        x_db_date            OUT NOCOPY DATE);
73 
74 
75 
76       -- Name
77       --   CONVERT_TO_DB_DATE
78       -- Purpose
79       --   Converts a date value from RosettaNet date/datetime format to db format
80       --   RosettaNet Date Format    : YYYYMMDDZ
81       --   RosettaNet Time Format    : hhmmss.SSSZ
82       -- Arguments
83       --   Date
84       -- Notes
85       --   If the date passed is NULL, then sysdate is considered.
86   PROCEDURE CONVERT_TO_DB_DATE(
87      p_rn_date                  IN VARCHAR2,
88      p_rn_time                  IN VARCHAR2,
89      x_db_date                  OUT NOCOPY DATE);
90 
91 
92     -- Name
93     --   CONVERT_Number_To_Char
94     -- Purpose
95     --   Converts a Number value into a character with the given format
96     -- Arguments
97     --   Number
98     --   Format
99     -- Notes
100     --   If the date passed is NULL, then sysdate is considered.
101    PROCEDURE CONVERT_NUMBER_TO_CHAR(
102      p_number               IN NUMBER,
103      p_format               IN VARCHAR2,
104      x_char                 OUT NOCOPY VARCHAR2);
105 
106     -- Name
107     --   GET_FROM_ROLE
108     -- Purpose
109     --   Gets the fromRole details
110     --   based on the Organization ID
111     -- Arguments
112     --   Date
113 
114     -- Notes
115     --   Organization ID
116   PROCEDURE GET_FROM_ROLE(
117      p_org_id               IN VARCHAR2,
118      x_name                 OUT NOCOPY VARCHAR2,
119      x_email                OUT NOCOPY VARCHAR2,
120      x_telephone            OUT NOCOPY VARCHAR2,
121      x_fax                  OUT NOCOPY VARCHAR2,
122      x_ece_location_code    OUT NOCOPY VARCHAR2  );
123 
124     -- Name
125     --   GET_TO_ROLE
126     -- Purpose
127     --   Gets the toRole details
128 
129     --   based on the TP Header ID
130     -- Arguments
131     --   TP Header ID
132     -- Notes
133     --   No special notes
134   PROCEDURE GET_TO_ROLE(
135      p_tp_header_id         IN VARCHAR2,
136      x_name                 OUT NOCOPY VARCHAR2,
137      x_email                OUT NOCOPY VARCHAR2,
138      x_telephone            OUT NOCOPY VARCHAR2,
139      x_fax                  OUT NOCOPY VARCHAR2,
140      x_ece_location_code    OUT NOCOPY VARCHAR2 );
141 
142 
143     -- Name
144     --   VALIDATE_XML
145     -- Purpose
146     --   Called by the "CLN Validate XML" workflow activity. This procedure gets the XML payload
147     --   from the workflow, does the validations. Errors out if any validation fails.
148     -- Arguments
149     --   Standard Workflow API signature
150     -- Notes
151     --   No special notes
152     PROCEDURE VALIDATE_XML(
153          p_itemtype        IN VARCHAR2,
154          p_itemkey         IN VARCHAR2,
155          p_actid           IN NUMBER,
156          p_funcmode        IN VARCHAR2,
157          x_resultout       IN OUT NOCOPY VARCHAR2);
158 
159 
160 
161     -- Name
162     --   GET_ITEM_CONFIG_PARAMS
163     -- Purpose
164     --   This is a utilty routine called from XGM to parse values for
165     --   top_level, parent level line id for item configuration details
166     --   from a delimitor separated, concatenated string for item configuration
167     -- Arguments
168     --   p_item_config_dtl_tag Input tag value from XML
169     --   x_top_model_line_id   top model line id parsed from input tag-value
170     --   x_link_to_line_id     link to line id parsed from input tag-value
171     -- Notes
172     --   No special notes
173     PROCEDURE GET_ITEM_CONFIG_PARAMS(
174             p_item_config_dtl_tag       IN  VARCHAR2,
175             x_top_model_line_id OUT NOCOPY VARCHAR2,
176             x_link_to_line_id           OUT NOCOPY VARCHAR2
177             );
178 
179     -- Name
180     --   CREATE_ITEM_CONFIG_TAG
181     -- Purpose
182     --   This is a utilty routine called from XGM to construct a
183     --   a delimitor separated, concatenated string for item config linkage details
184     -- Arguments
185     --   p_top_model_line_id   input top model ine id field
186     --   p_link_to_line_id     input link to line id field
187     --   x_item_config_dtl_tag value to be used in XML
188     -- Notes
189     --   No special notes
190     PROCEDURE CREATE_ITEM_CONFIG_TAG(
191                         p_top_model_line_id        IN        VARCHAR2,
192                         p_link_to_line_id                IN    VARCHAR2,
193                         x_item_config_dtl_tag        OUT         NOCOPY VARCHAR2
194                 );
195 
196 
197 
198 
199     -- Name
200     --   GET_USER_ID
201     -- Purpose
202     --   This is a utilty routine called from XGM to get the user id when user name is given
203     -- Arguments
204     --   p_user_name    input user name
205     --   p_user_id      output user id
206     -- Notes
207     --   No special notes
208     Procedure get_user_id(
209                        p_user_name IN VARCHAR,
210                        x_user_id OUT NOCOPY NUMBER,
211                        x_error_code OUT NOCOPY NUMBER,
212                        x_error_message OUT NOCOPY VARCHAR);
213 
214 
215 
216     -- Name
217     --   getPurchaseOrderNum
218     -- Purpose
219     --   This is a utilty routine called from XGM to get the Purchase Order Number when Po-Relnum is given
220     -- Arguments
221     --   PoAndRel       input Po-Relnum
222     --   PoNum          output Purchase Order Num
223     -- Notes
224     --   No special notes
225 
226 
227     PROCEDURE getPurchaseOrderNum(
228                        p_PoAndRel        IN     VARCHAR2,
229                        x_PoNum           OUT    NOCOPY  VARCHAR2);
230 
231 
232     -- Name
233     --   getPurchaseOrderNum
234     -- Purpose
235     --   This is a utilty routine called from XGM to get the Release Number when Po-Relnum is given
236     -- Arguments
237     --   PoAndRel       input Po-Relnum
238     --   RelNum         output Release Num in varchar
239     -- Notes
240     --   No special notes
241     PROCEDURE getRelNum(p_PoAndRel        IN     VARCHAR2,
242                        x_RelNum          OUT    NOCOPY   VARCHAR2);
243 
244 
245 
246 
247     -- Name
248     --   getRelNum
249     -- Purpose
250     --   This is a utilty routine called from XGM to get the Release Number when Po-Relnum is given
251     -- Arguments
252     --   PoAndRel       input Po-Relnum
253     --   RelNum         output Release Num in num
254     -- Notes
255     --   No special notes
256     PROCEDURE getRelNum(
257                      p_PoAndRel        IN     VARCHAR2,
258                      x_RelNum          OUT    NOCOPY   NUMBER);
259 
260     -- Name
261     --   getrevnum
262     -- Purpose
263     --   This is a utilty routine called from XGM to get the Revision Number
264     -- Arguments
265     --   PoRelAndRev       input Po_Num -RelNum:Revnum
266     --   porel             output PO-REL num
267     --   revnum         output rev Num
268     -- Notes
269     --   No special notes
270 
271    PROCEDURE getRevNum(
272                     p_PORELANDREV       IN   varchar2,
273                     x_porel           OUT  NOCOPY VARCHAR2,
274                     x_revnum          OUT  NOCOPY VARCHAR2);
275 
276     -- Name
277     --   CONCAT_PO_RELNUM
278     -- Purpose
279     --   This is a utilty routine called from XGM to get the Po-Relnum
280     -- Arguments
281     --   PoAndRel       input Po Num
282     --   RelNum         input release num
283     --   RelNum         output PO Num - Release Num
284     -- Notes
285     --   No special notes
286     PROCEDURE CONCAT_PO_RELNUM(
287                     p_ponum IN VARCHAR2,
288                     p_porelnum IN VARCHAR2,
289                     x_poandrelnum OUT NOCOPY VARCHAR2);
290 
291 
292     -- Name
293     --   CONCAT_PORELNUM_REVNUM
294     -- Purpose
295     --   This is a utilty routine called from XGM to get the PoRelnum: Rev Num
296     -- Arguments
297     --   p_porelnum       input PoRel Num
298     --   p_porevnum       input release num
299     --   x_porelrevnum    output PORelNum:Rev Num
300     -- Notes
301     --   No special notes
302 
303     PROCEDURE CONCAT_PORELNUM_REVNUM(
304                     p_porelnum IN VARCHAR2,
305                     p_porevnum IN VARCHAR2,
306                     x_porelrevnum OUT NOCOPY VARCHAR2);
307 
308 
309     -- Name
310     --   getTagParamValue
311     -- Purpose
312     --   This is a utilty routine called from XGM to get the a tag value
313     --   Tag and tag value tuple is separated by '='
314     --   Different tags are separated by a '|'
315     -- Arguments
316     --   p_xml_tag        input tag path beginning with root element
317     --   p_param          input tag name
318     --   x_value          output tag value
319     -- Notes
320     --   No special notes
321 
322     PROCEDURE getTagParamValue(
323                         p_xml_tag        IN VARCHAR2,
324                         p_param                IN vARCHAR2,
325                         x_value                OUT NOCOPY VARCHAR2);
326 
327 
328     -- Name
329     --   Get_tag_value_from_xml
330     -- Purpose
331     --   This is a utilty routine called from XGM to get the a tag value when the path to tag is specified
332     --   The path starts from root element
333     -- Arguments
334     --   p_internal_control_num        input internal control number of xml message
335     --   p_tag_path                    input tag path
336     --   x_tag_value                   output tag value
337     -- Notes
341          p_internal_control_num    IN  NUMBER,
338     --   No special notes
339 
340     PROCEDURE Get_tag_value_from_xml(
342          p_tag_path                IN  VARCHAR2,
343          x_tag_value               IN OUT NOCOPY VARCHAR2);
344 
345 
346     -- Name
347     --   TRUNCATE_STRING
348     -- Purpose
349     --   This is a utilty routine called from XGM to limit the length of input string
350     -- Arguments
351     --   p_internal_control_num        input internal control number of xml message
352     --   p_tag_path                    input tag path
353     --   x_tag_value                   output tag value
354     -- Notes
355     --   No special notes
356     PROCEDURE TRUNCATE_STRING(
357          p_instring in varchar2,
358          p_numofchar in number,
359          x_outstring out nocopy varchar2 );
360 
361 END CLN_RN_UTILS;