PACKAGE: APPS.RG_XBRL_PKG

Source

1 PACKAGE RG_XBRL_PKG AS
2 /* $Header: rgxbrlps.pls 120.0 2003/05/14 00:26:28 vtreiger noship $ */
3 --
4 -- Name
5 --   rg_xbrl_pkg
6 -- Purpose
7 --   to include all server side procedures and packages for
8 --   XBRL taxonomy processing
9 -- Notes
10 --
11 -- History
12 --   02/19/03	V Treiger	Created
13 --
14 --
15 -- Procedures
16 -- Name
17 --   Upload_taxonomy
18 -- Purpose
19 --   wrapper to run procedure load_taxonomy from SRS
20 -- Arguments
21 --   p_full_tax_name - Taxonomy Name
22 --   p_tax_file_name - Taxonomy Alias
23 --   p_tax_descr     - Taxonomy Description
24 PROCEDURE Upload_taxonomy(errbuf	OUT NOCOPY VARCHAR2,
25 		          retcode	OUT NOCOPY VARCHAR2,
26 		          p_full_tax_name IN VARCHAR2,
27 		          p_tax_file_name IN VARCHAR2,
28 		          p_tax_descr     IN VARCHAR2);
29 
30 -- Name
31 --   Remove_taxonomy
32 -- Purpose
33 --   wrapper to run procedure delete_taxonomy from SRS
34 -- Arguments
35 --   p_full_tax_name - Taxonomy Name
36 PROCEDURE Remove_taxonomy(errbuf	OUT NOCOPY VARCHAR2,
37 		          retcode	OUT NOCOPY VARCHAR2,
38 		          p_full_tax_name IN VARCHAR2);
39 
40 -- Name
41 --   delete_taxonomy
42 -- Purpose
43 --   removes taxonomy from taxonomy storage and elements storage
44 -- Arguments
45 --   p_full_tax_name - Taxonomy Name
46 PROCEDURE delete_taxonomy(p_full_tax_name IN VARCHAR2);
47 
48 -- Name
49 --   load_taxonomy
50 -- Purpose
51 --   load taxonomy into taxonomy storage and elements storage
52 -- Arguments
53 --   p_full_tax_name - Taxonomy Name
54 --   p_tax_file_name - Taxonomy Alias
55 --   p_tax_descr     - Taxonomy Description
56 PROCEDURE load_taxonomy(p_full_tax_name  IN VARCHAR2,
57                         p_tax_file_name  IN VARCHAR2,
58                         p_tax_descr      IN VARCHAR2);
59 
60 -- Name
61 --   update_flags
62 -- Purpose
63 --   updates flags in elements storage
64 -- Arguments
65 --   p_taxonomy_id - Taxonomy ID
66 PROCEDURE update_flags(p_taxonomy_id IN NUMBER);
67 
68 -- Name
69 --   verify_import
70 -- Purpose
71 --   get import URLs from Taxonomy Schema definition
72 --   and check that import taxonomies have been loaded
73 --   before processing current Taxonomy
74 -- Arguments
75 --   p_filename   - Taxonomy Schema Definition filename
76 --   p_valid_flag - Imported taxonomies presence validation flag
77 --   p_valid_str  - String of all URLs from imported taxonomies
78 PROCEDURE verify_import(p_filename IN VARCHAR2,
79                         p_valid_flag IN OUT NOCOPY NUMBER,
80                         p_valid_str  IN OUT NOCOPY VARCHAR2,
81                         p_srch_str1 IN VARCHAR2,
82                         p_srch_str2 IN VARCHAR2,
83                         p_srch_str3 IN VARCHAR2,
84                         p_srch_str4 IN VARCHAR2);
85 
86 -- Name
87 --   read_url
88 -- Purpose
89 --   get URL and linkbase names from
90 --   Taxonomy Schema definition
91 -- Arguments
92 --   filename     - Taxonomy Schema Definition filename
93 --   p_first_srch - first search string
94 --   p_last_replace - last search string
95 --   p_url_ret   - Taxonomy URL string
96 --   p_link_srch - linkbase search string
97 --   p_link_c - Calculation linkbase name
98 --   p_link_d - Definition linkbase name
99 --   p_link_c - Label linkbase name
100 --   p_link_c - Presentation linkbase name
101 --   p_link_c - Reference linkbase name
102 PROCEDURE  read_url(filename IN VARCHAR2,p_first_srch IN VARCHAR2,p_last_replace IN VARCHAR2,
103   p_url_ret IN OUT NOCOPY VARCHAR2,p_link_srch IN VARCHAR2,p_link_c IN OUT NOCOPY VARCHAR2,
104   p_link_d IN OUT NOCOPY VARCHAR2,p_link_l IN OUT NOCOPY VARCHAR2,p_link_p IN OUT NOCOPY VARCHAR2,
105   p_link_r  IN OUT NOCOPY VARCHAR2);
106 
107 -- Name
108 --   insert_tax_clob
109 -- Purpose
110 --   insert taxonomy elements in elements storage from
111 --   taxonomy schema definition
112 -- Arguments
113 --   p_taxonomy_id - Taxonomy ID
114 --   filename      - Taxonomy Schema Definition filename
115 --   p_valid_str   - String of Imported Taxonomies URLs
116 PROCEDURE insert_tax_clob(p_taxonomy_id IN NUMBER,
117                           filename      IN VARCHAR2,
118                           p_valid_str   IN VARCHAR2);
119 
120 -- Name
121 --   update_lbl_clob
122 -- Purpose
123 --   update label details in elements storage from
124 --   label linkbase
125 -- Arguments
126 --   p_tax_name    - Taxonomy Alias
127 --   p_taxonomy_id - Taxonomy ID
128 --   filename      - Label Linkbase filename
129 PROCEDURE update_lbl_clob(p_tax_name    IN VARCHAR2,
130                           p_taxonomy_id IN NUMBER,
131                           filename      IN VARCHAR2);
132 
133 -- Name
134 --   update_dfn_clob
135 -- Purpose
136 --   update parent details in elements storage from
137 --   definition linkbase
138 -- Arguments
139 --   p_tax_name    - Taxonomy Alias
140 --   p_taxonomy_id - Taxonomy ID
141 --   filename      - Definition Linkbase filename
142 PROCEDURE update_dfn_clob(p_tax_name    IN VARCHAR2,
143                           p_taxonomy_id IN NUMBER,
144                           filename      IN VARCHAR2);
145 
146 END RG_XBRL_PKG;