1 package RRS_SITE_INFO AUTHID DEFINER as
2 /* $Header: RRSGSDTS.pls 120.0.12010000.14 2009/01/20 23:54:38 sunarang noship $ */
3 /*#
4 This package is created for retrieving the Site Details from Site Hub.
5 It will accept Site Identification Number as an input Parameter and will
6 retrieve all the relative information for the Site depending on the
7 procedure call.
8 It has various procedures for returning information related to a specific
9 Site.
10 <code><pre>
11 There are 6 categories of information , which this API can retrieve.
12 </pre></code>
13
14 <code><pre>
15 1. Basic Attributes of a Site and Basic details ( like Address and Purpose )
16 </pre></code>
17 <code><pre>
18 2. Associations of a site. ( like Trade Areas , Clusters and Hierarchy )
19 </pre></code>
20 <code><pre>
21 3. Attributes of a Site ( These are the UDA's for various entities i.e. Site
22 , Location and Trade Area ).
23 </pre></code>
24 <code><pre>
25 4. Contacts of a Site ( like Phone , Email , URL and other contact details )
26 </pre></code>
27 <code><pre>
28 5. Attachments related to the Site. ( If there are any documents of links
29 created as an attachments for this Site )
30 </pre></code>
31 <code><pre>
32 6. Asset Details attached to this Site ( like Details of any assets attached
33 to this site )
34 </pre></code>
35
36 For retrieving all these above details for a Site , we need to call
37 Get_complete_site_details() procedure with input as a Site Number.
38
39 Every procedure returns a collection with relevant information retrieved
40 from these procedures. These are the collections which are returned from
41 various procedures.
42 <code><pre>
43 CREATE TYPE RRS_SITE_HEADER_TAB AS TABLE OF RRS_SITE_HEADER_REC;
44 </pre></code>
45
46 <code><pre>
47 CREATE TYPE RRS_SITE_ADDRESS_TAB IS TABLE OF RRS_SITE_ADDRESS_REC;
48 </pre></code>
49
50 <code><pre>
51 CREATE TYPE RRS_SITE_USES_TAB IS TABLE OF RRS_SITE_USES_REC;
52 </pre></code>
53
54 <code><pre>
55 CREATE TYPE RRS_SITE_CLUSTER_TAB IS TABLE OF RRS_SITE_CLUSTER_REC;
56 </pre></code>
57
58 <code><pre>
59 CREATE TYPE RRS_SITE_HIERAR_TAB IS TABLE OF RRS_SITE_HIERAR_REC;
60 </pre></code>
61
62 <code><pre>
63 CREATE TYPE RRS_TRADE_AREA_GRP_TAB IS TABLE OF RRS_TRADE_AREA_GRP_REC;
64 </pre></code>
65
66 <code><pre>
67 CREATE TYPE RRS_RELATIONSHIP_TAB IS TABLE OF RRS_RELATIONSHIP_REC;
68 </pre></code>
69
70 <code><pre>
71 CREATE TYPE RRS_SITE_PHONE_TAB IS TABLE OF RRS_SITE_PHONE_REC;
72 </pre></code>
73
74 <code><pre>
75 CREATE TYPE RRS_SITE_EMAIL_TAB IS TABLE OF RRS_SITE_EMAIL_REC;
76 </pre></code>
77
78 <code><pre>
79 CREATE TYPE RRS_SITE_URL_TAB IS TABLE OF RRS_SITE_URL_REC;
80 </pre></code>
81
82 <code><pre>
83 CREATE TYPE RRS_SITE_PERSON_TAB IS TABLE OF RRS_SITE_PERSON_REC;
84 </pre></code>
85
86 <code><pre>
87 CREATE TYPE RRS_SITE_ATTACHMENT_TAB IS TABLE OF RRS_SITE_ATTACHMENT_REC;
88 </pre></code>
89
90 <code><pre>
91 CREATE TYPE RRS_SITE_ASSET_TAB IS TABLE OF RRS_SITE_ASSET_REC;
92 </pre></code>
93
94 <code><pre>
95 CREATE TYPE RRS_PROPERTY_TAB IS TABLE OF RRS_PROPERTY_REC;
96 </pre></code>
97
98 *@rep:scope public
99 *@rep:product RRS
100 *@rep:displayname Get Site Information
101 *@rep:lifecycle active
102 *@rep:compatibility N
103 *@rep:category BUSINESS_ENTITY RRS_SITE
104 */
105
106
107
108 --
109 -- Get_complete_site_details (PUBLIC)
110 -- Retrieve all the details of a specific Site.
111 -- IN:
112 -- p_site_id_num - Site Identification Number
113 --
114 /*#
115 * Retrieves all the information of a particular site.
116 * @param p_site_id_num Site Identification Number
117 * @param p_site_name Site Name
118 * @param p_page_name Page Name for Attributes
119 * @param x_site_header_tab Collection object returning Site Header Details
120 * @param x_site_address_tab Collection object returning Site Address Details
121 * @param x_site_uses_tab Collection object returning Purpose of Site
122 * @param x_property_tab Collection object returning Entities or Property Details
123 * @param x_site_cluster_tab Collection object returning Cluster Information
124 * @param x_site_hierar_tab Collection object returning Hierarchy Information
125 * @param x_trade_area_grp_tab Collection object returning Trade Area Group Details
126 * @param x_relationship_tab Collection object returning relationships Details
127 * @param x_site_phone_tab Collection object returning Phone Details for a Site
128 * @param x_site_email_tab Collection object returning Email Details of a Site
129 * @param x_site_url_tab Collection object returning URL Details for a Site
130 * @param x_site_person_tab Collection object returning Person Details
131 * @param x_site_attachment_tab Collection object returning Attachment Details
132 * @param x_site_asset_tab Collection object returning Asset Information
133 * @param x_site_attrib_row_table Collection object returning UDA for Entity Site
134 * @param x_site_attrib_data_table Collection object returning UDA for Entity Site
135 * @param x_loc_attrib_row_table Collection object returning UDA for Entity Location
136 * @param x_loc_attrib_data_table Collection object returning UDA for Entity Location
137 * @param x_tr_area_attrib_row_table Collection object returning UDA for Entity Trade Area
138 * @param x_tr_area_attrib_data_table Collection object returning UDA for Entity Trade Area
139 * @rep:scope public
140 * @rep:lifecycle active
141 * @rep:displayname Get Complete Site Details
142 */
143
144
145 Procedure Get_complete_site_details(
146 p_site_id_num IN varchar2
147 ,p_site_name IN varchar2 Default null
148 ,p_page_name IN varchar2 Default null
149 ,x_site_header_tab OUT NOCOPY rrs_site_header_tab
150 ,x_site_address_tab OUT NOCOPY rrs_site_address_tab
151 ,x_site_uses_tab OUT NOCOPY rrs_site_uses_tab
152 ,x_property_tab OUT NOCOPY rrs_property_tab
153 ,x_site_cluster_tab OUT NOCOPY rrs_site_cluster_tab
154 ,x_site_hierar_tab OUT NOCOPY rrs_site_hierar_tab
155 ,x_trade_area_grp_tab OUT NOCOPY rrs_trade_area_grp_tab
156 ,x_relationship_tab OUT NOCOPY rrs_relationship_tab
157 ,x_site_phone_tab OUT NOCOPY rrs_site_phone_tab
158 ,x_site_email_tab OUT NOCOPY rrs_site_email_tab
159 ,x_site_url_tab OUT NOCOPY rrs_site_url_tab
160 ,x_site_person_tab OUT NOCOPY rrs_site_person_tab
161 ,x_site_attachment_tab OUT NOCOPY rrs_site_attachment_tab
162 ,x_site_asset_tab OUT NOCOPY rrs_site_asset_tab
163 ,x_site_attrib_row_table OUT NOCOPY EGO_USER_ATTR_ROW_TABLE
164 ,x_site_attrib_data_table OUT NOCOPY EGO_USER_ATTR_DATA_TABLE
165 ,x_loc_attrib_row_table OUT NOCOPY EGO_USER_ATTR_ROW_TABLE
166 ,x_loc_attrib_data_table OUT NOCOPY EGO_USER_ATTR_DATA_TABLE
167 ,x_tr_area_attrib_row_table OUT NOCOPY EGO_USER_ATTR_ROW_TABLE
168 ,x_tr_area_attrib_data_table OUT NOCOPY EGO_USER_ATTR_DATA_TABLE
169 );
170
171
172 --
173 -- Get_site_details (PUBLIC)
174 -- Retrieve the Header information and Basic attributes of a Site.
175 -- IN:
176 -- p_site_id_num - Site Identification Number
177 --
178 /*#
179 * Retrieves Header and Basic information of a particular site.
180 * @param p_site_id_num Site Identification Number
181 * @param p_site_name Site Name
182 * @param x_site_header_tab Collection object returning Site Header Details
183 * @param x_site_address_tab Collection object returning Site Address Details
184 * @param x_site_uses_tab Collection object returning Purpose of Site
185 * @rep:scope public
186 * @rep:lifecycle active
187 * @rep:displayname Get Site Details
188 */
189
190
191 Procedure Get_site_details(
192 p_site_id_num IN varchar2
193 ,p_site_name IN varchar2 Default null
194 ,x_site_header_tab OUT NOCOPY rrs_site_header_tab
195 ,x_site_address_tab OUT NOCOPY rrs_site_address_tab
196 ,x_site_uses_tab OUT NOCOPY rrs_site_uses_tab
197 );
198
199
200 --
201 -- Get_site_complete_attributes (PUBLIC)
202 -- Retrieves User Defined Attributes for a specific Site.
203 -- IN:
204 -- p_site_id_num - Site Identification Number
205 -- p_site_name - Page Name for which attributes to display.
206 --
207 /*#
208 * Retrieves Header and Basic information of a particular site.
209 * @param p_site_id_num Site Identification Number
210 * @param p_site_name Site Name
211 * @param x_site_attrib_row_table Collection object returning UDA for Entity Site
212 * @param x_site_attrib_data_table Collection object returning UDA for Entity Site
213 * @param x_loc_attrib_row_table Collection object returning UDA for Entity Location
214 * @param x_loc_attrib_data_table Collection object returning UDA for Entity Location
215 * @param x_tr_area_attrib_row_table Collection object returning UDA for Entity Trade Area
216 * @param x_tr_area_attrib_data_table Collection object returning UDA for Entity Trade Area
217 * @rep:scope public
218 * @rep:lifecycle active
219 * @rep:displayname Get Complete Site Attributes
220 */
221
222
223 Procedure Get_site_complete_attributes(
224 p_site_id_num IN varchar2
225 ,p_site_name IN varchar2 Default null
226 ,x_site_attrib_row_table OUT NOCOPY EGO_USER_ATTR_ROW_TABLE
227 ,x_site_attrib_data_table OUT NOCOPY EGO_USER_ATTR_DATA_TABLE
228 ,x_loc_attrib_row_table OUT NOCOPY EGO_USER_ATTR_ROW_TABLE
229 ,x_loc_attrib_data_table OUT NOCOPY EGO_USER_ATTR_DATA_TABLE
230 ,x_tr_area_attrib_row_table OUT NOCOPY EGO_USER_ATTR_ROW_TABLE
231 ,x_tr_area_attrib_data_table OUT NOCOPY EGO_USER_ATTR_DATA_TABLE
232 );
233
234
235 --
236 -- Get_site_attributes (PUBLIC)
237 -- Retrieves User Defined Attributes for a specific Site.
238 -- IN:
239 -- p_site_id_num - Site Identification Number
240 -- p_page_name - Page Name for which attributes to display.
241 --
242 /*#
243 * Retrieves Attributes information for Entity type Site.
244 * @param p_site_id_num Site Identification Number
245 * @param p_site_name Site Name
246 * @param p_page_name Page Name for Attributes
247 * @param x_site_attrib_row_table Collection object returning UDA for Entity Site
248 * @param x_site_attrib_data_table Collection object returning UDA for Entity Site
249 * @rep:scope public
250 * @rep:lifecycle active
251 * @rep:displayname Get Site Attributes
252 */
253
254
255 Procedure Get_site_attributes(
256 p_site_id_num IN varchar2
257 ,p_site_name IN varchar2 Default null
258 ,p_page_name IN varchar2 Default null
259 ,x_site_attrib_row_table OUT NOCOPY EGO_USER_ATTR_ROW_TABLE
260 ,x_site_attrib_data_table OUT NOCOPY EGO_USER_ATTR_DATA_TABLE
261 );
262
263
264 --
265 -- Get_location_attributes (PUBLIC)
266 -- Retrieves User Defined Attributes for a specific Site for Location Entity.
267 -- IN:
268 -- p_site_id_num - Site Identification Number
269 -- p_page_name - Page Name for which attributes to display.
270 --
271 /*#
272 * Retrieves Attributes information for Entity type Location.
273 * @param p_site_id_num Site Identification Number
274 * @param p_site_name Site Name
275 * @param p_page_name Page Name for Attributes
276 * @param x_loc_attrib_row_table Collection object returning UDA for Entity Location
277 * @param x_loc_attrib_data_table Collection object returning UDA for Entity Location
278 * @rep:scope public
279 * @rep:lifecycle active
280 * @rep:displayname Get Location Attributes
281 */
282
283 Procedure Get_location_attributes(
284 p_site_id_num IN varchar2
285 ,p_site_name IN varchar2 Default null
286 ,p_page_name IN varchar2 Default null
287 ,x_loc_attrib_row_table OUT NOCOPY EGO_USER_ATTR_ROW_TABLE
288 ,x_loc_attrib_data_table OUT NOCOPY EGO_USER_ATTR_DATA_TABLE
289 );
290
291 --
292 -- Get_trade_area_attributes (PUBLIC)
293 -- Retrieves User Defined Attributes for a specific Site for Trade Area Entity.
294 -- IN:
295 -- p_site_id_num - Site Identification Number
296 -- p_page_name - Page Name for which attributes to display.
297 --
298 /*#
299 * Retrieves Attributes information for Entity type Trade Area.
300 * @param p_site_id_num Site Identification Number
301 * @param p_site_name Site Name
302 * @param p_page_name Page Name for Attributes
306 * @rep:lifecycle active
303 * @param x_tr_area_attrib_row_table Collection object returning UDA for Entity Trade Area
304 * @param x_tr_area_attrib_data_table Collection object returning UDA for Entity Trade Area
305 * @rep:scope public
307 * @rep:displayname Get Trade Area Attributes
308 */
309
310 Procedure Get_trade_area_attributes(
311 p_site_id_num IN varchar2
312 ,p_site_name IN varchar2 Default null
313 ,p_page_name IN varchar2 Default null
314 ,x_tr_area_attrib_row_table OUT NOCOPY EGO_USER_ATTR_ROW_TABLE
315 ,x_tr_area_attrib_data_table OUT NOCOPY EGO_USER_ATTR_DATA_TABLE
316 );
317
318
319 --
320 -- Get_site_associations (PUBLIC)
321 -- Retrieves Trade areas , clusters and Hierarchy information for a site.
322 -- IN:
323 -- p_site_id_num - Site Identification Number
324 --
325 /*#
329 * @param x_property_tab Collection object returning Entities or Property Details
326 * Retrieves Trade areas , clusters and Hierarchy information for a site.
327 * @param p_site_id_num Site Identification Number
328 * @param p_site_name Site Name
330 * @param x_site_cluster_tab Collection object returning Cluster Information
331 * @param x_site_hierar_tab Collection object returning Hierarchy Information
332 * @param x_trade_area_grp_tab Collection object returning Trade Area Group Details
333 * @param x_relationship_tab Collection object returning relationships Details
334 * @rep:scope public
335 * @rep:lifecycle active
336 * @rep:displayname Get Site Associations
337 */
338
339
340 Procedure Get_site_associations(
341 p_site_id_num IN varchar2
342 ,p_site_name IN varchar2 Default null
343 ,x_property_tab OUT NOCOPY rrs_property_tab
344 ,x_site_cluster_tab OUT NOCOPY rrs_site_cluster_tab
345 ,x_site_hierar_tab OUT NOCOPY rrs_site_hierar_tab
346 ,x_trade_area_grp_tab OUT NOCOPY rrs_trade_area_grp_tab
347 ,x_relationship_tab OUT NOCOPY rrs_relationship_tab
348 );
349
350 --
351 -- Get_site_attachments (PUBLIC)
352 -- Retrieve the attachments associated with a specific Site.
353 -- IN:
354 -- p_site_id_num - Site Identification Number
355 --
356 /*#
357 * Retrieve the attachments associated with a specific Site.
358 * @param p_site_id_num Site Identification Number
359 * @param p_site_name Site Name
360 * @param x_site_attachment_tab Collection object returning Attachment Details
361 * @rep:scope public
362 * @rep:lifecycle active
363 * @rep:displayname Get Site Attachments
364 */
365
366
367 Procedure Get_site_attachments(
368 p_site_id_num IN varchar2
369 ,p_site_name IN varchar2 Default null
370 ,x_site_attachment_tab OUT NOCOPY rrs_site_attachment_tab
371 );
372
373
374 --
375 -- Get_site_contacts (PUBLIC)
376 -- Retrieves the contact details for a Site.
377 -- IN:
378 -- p_site_id_num - Site Identification Number
379 --
380 /*#
381 * Retrieves the contact details for a Site.
382 * @param p_site_id_num Site Identification Number
383 * @param p_site_name Site Name
384 * @param x_site_address_tab Collection object returning Site Address Details
385 * @param x_site_phone_tab Collection object returning Phone Details for a Site
386 * @param x_site_email_tab Collection object returning Email Details of a Site
387 * @param x_site_url_tab Collection object returning URL Details for a Site
388 * @param x_site_person_tab Collection object returning Person Details
389 * @rep:scope public
390 * @rep:lifecycle active
391 * @rep:displayname Get Site Contacts
392 */
393
394
395 Procedure Get_site_contacts(
396 p_site_id_num IN varchar2
397 ,p_site_name IN varchar2 Default null
398 ,x_site_address_tab OUT NOCOPY rrs_site_address_tab
399 ,x_site_phone_tab OUT NOCOPY rrs_site_phone_tab
400 ,x_site_email_tab OUT NOCOPY rrs_site_email_tab
401 ,x_site_url_tab OUT NOCOPY rrs_site_url_tab
402 ,x_site_person_tab OUT NOCOPY rrs_site_person_tab
403 );
404
405
406 --
407 -- Get_site_assets (PUBLIC)
408 -- Retrieve details of assets related to a Site.
409 -- IN:
410 -- p_site_id_num - Site Identification Number
411 --
412 /*#
413 * Retrieve details of assets related to a Site.
414 * @param p_site_id_num Site Identification Number
415 * @param p_site_name Site Name
416 * @param x_site_asset_tab Collection object returning Asset Information
417 * @rep:scope public
418 * @rep:lifecycle active
419 * @rep:displayname Get Site Assets
420 */
421
422
423 Procedure Get_site_assets(
424 p_site_id_num IN varchar2
425 ,p_site_name IN varchar2 Default null
426 ,x_site_asset_tab OUT NOCOPY rrs_site_asset_tab
427 );
428
429 end RRS_SITE_INFO;
[Home] [Help]