1 package RRS_SITE_INFO AUTHID DEFINER as
2 /* $Header: RRSGSDTS.pls 120.0.12010000.15 2009/08/31 20:58:01 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_party_site_address_tab Collection object returning Site Address Details
122 * @param x_site_uses_tab Collection object returning Purpose of Site
123 * @param x_property_tab Collection object returning Entities or Property Details
124 * @param x_site_cluster_tab Collection object returning Cluster Information
125 * @param x_site_hierar_tab Collection object returning Hierarchy Information
126 * @param x_trade_area_grp_tab Collection object returning Trade Area Group Details
127 * @param x_relationship_tab Collection object returning relationships Details
128 * @param x_site_phone_tab Collection object returning Phone Details for a Site
129 * @param x_site_email_tab Collection object returning Email Details of a Site
130 * @param x_site_url_tab Collection object returning URL Details for a Site
131 * @param x_site_person_tab Collection object returning Person Details
132 * @param x_site_attachment_tab Collection object returning Attachment Details
133 * @param x_site_asset_tab Collection object returning Asset Information
134 * @param x_site_attrib_row_table Collection object returning UDA for Entity Site
135 * @param x_site_attrib_data_table Collection object returning UDA for Entity Site
136 * @param x_loc_attrib_row_table Collection object returning UDA for Entity Location
137 * @param x_loc_attrib_data_table Collection object returning UDA for Entity Location
138 * @param x_tr_area_attrib_row_table Collection object returning UDA for Entity Trade Area
139 * @param x_tr_area_attrib_data_table Collection object returning UDA for Entity Trade Area
140 * @rep:scope public
141 * @rep:lifecycle active
142 * @rep:displayname Get Complete Site Details
143 */
144
145
146 Procedure Get_complete_site_details(
147 p_site_id_num IN varchar2
148 ,p_site_name IN varchar2 Default null
149 ,p_page_name IN varchar2 Default null
150 ,x_site_header_tab OUT NOCOPY rrs_site_header_tab
151 ,x_site_address_tab OUT NOCOPY rrs_site_address_tab
152 ,x_site_uses_tab OUT NOCOPY rrs_site_uses_tab
153 ,x_party_site_address_tab OUT NOCOPY rrs_site_address_tab
154 ,x_property_tab OUT NOCOPY rrs_property_tab
155 ,x_site_cluster_tab OUT NOCOPY rrs_site_cluster_tab
156 ,x_site_hierar_tab OUT NOCOPY rrs_site_hierar_tab
157 ,x_trade_area_grp_tab OUT NOCOPY rrs_trade_area_grp_tab
158 ,x_relationship_tab OUT NOCOPY rrs_relationship_tab
159 ,x_site_phone_tab OUT NOCOPY rrs_site_phone_tab
160 ,x_site_email_tab OUT NOCOPY rrs_site_email_tab
161 ,x_site_url_tab OUT NOCOPY rrs_site_url_tab
162 ,x_site_person_tab OUT NOCOPY rrs_site_person_tab
163 ,x_site_attachment_tab OUT NOCOPY rrs_site_attachment_tab
164 ,x_site_asset_tab OUT NOCOPY rrs_site_asset_tab
165 ,x_site_attrib_row_table OUT NOCOPY EGO_USER_ATTR_ROW_TABLE
166 ,x_site_attrib_data_table OUT NOCOPY EGO_USER_ATTR_DATA_TABLE
167 ,x_loc_attrib_row_table OUT NOCOPY EGO_USER_ATTR_ROW_TABLE
168 ,x_loc_attrib_data_table OUT NOCOPY EGO_USER_ATTR_DATA_TABLE
169 ,x_tr_area_attrib_row_table OUT NOCOPY EGO_USER_ATTR_ROW_TABLE
170 ,x_tr_area_attrib_data_table OUT NOCOPY EGO_USER_ATTR_DATA_TABLE
171 );
172
173
174 --
175 -- Get_site_details (PUBLIC)
176 -- Retrieve the Header information and Basic attributes of a Site.
177 -- IN:
178 -- p_site_id_num - Site Identification Number
179 --
180 /*#
181 * Retrieves Header and Basic information of a particular site.
182 * @param p_site_id_num Site Identification Number
183 * @param p_site_name Site Name
184 * @param x_site_header_tab Collection object returning Site Header Details
185 * @param x_site_address_tab Collection object returning Site Address Details
186 * @param x_site_uses_tab Collection object returning Purpose of Site
187 * @rep:scope public
188 * @rep:lifecycle active
189 * @rep:displayname Get Site Details
190 */
191
192
193 Procedure Get_site_details(
194 p_site_id_num IN varchar2
195 ,p_site_name IN varchar2 Default null
196 ,x_site_header_tab OUT NOCOPY rrs_site_header_tab
197 ,x_site_address_tab OUT NOCOPY rrs_site_address_tab
198 ,x_site_uses_tab OUT NOCOPY rrs_site_uses_tab
199 );
200
201
202 --
203 -- Get_site_complete_attributes (PUBLIC)
204 -- Retrieves User Defined Attributes for a specific Site.
205 -- IN:
206 -- p_site_id_num - Site Identification Number
207 -- p_site_name - Page Name for which attributes to display.
208 --
209 /*#
210 * Retrieves Header and Basic information of a particular site.
211 * @param p_site_id_num Site Identification Number
212 * @param p_site_name Site Name
213 * @param x_site_attrib_row_table Collection object returning UDA for Entity Site
214 * @param x_site_attrib_data_table Collection object returning UDA for Entity Site
215 * @param x_loc_attrib_row_table Collection object returning UDA for Entity Location
216 * @param x_loc_attrib_data_table Collection object returning UDA for Entity Location
217 * @param x_tr_area_attrib_row_table Collection object returning UDA for Entity Trade Area
218 * @param x_tr_area_attrib_data_table Collection object returning UDA for Entity Trade Area
219 * @rep:scope public
220 * @rep:lifecycle active
221 * @rep:displayname Get Complete Site Attributes
222 */
223
224
225 Procedure Get_site_complete_attributes(
226 p_site_id_num IN varchar2
227 ,p_site_name IN varchar2 Default null
228 ,x_site_attrib_row_table OUT NOCOPY EGO_USER_ATTR_ROW_TABLE
229 ,x_site_attrib_data_table OUT NOCOPY EGO_USER_ATTR_DATA_TABLE
230 ,x_loc_attrib_row_table OUT NOCOPY EGO_USER_ATTR_ROW_TABLE
231 ,x_loc_attrib_data_table OUT NOCOPY EGO_USER_ATTR_DATA_TABLE
232 ,x_tr_area_attrib_row_table OUT NOCOPY EGO_USER_ATTR_ROW_TABLE
233 ,x_tr_area_attrib_data_table OUT NOCOPY EGO_USER_ATTR_DATA_TABLE
234 );
235
236
237 --
238 -- Get_site_attributes (PUBLIC)
239 -- Retrieves User Defined Attributes for a specific Site.
240 -- IN:
241 -- p_site_id_num - Site Identification Number
242 -- p_page_name - Page Name for which attributes to display.
243 --
244 /*#
245 * Retrieves Attributes information for Entity type Site.
246 * @param p_site_id_num Site Identification Number
247 * @param p_site_name Site Name
248 * @param p_page_name Page Name for Attributes
249 * @param x_site_attrib_row_table Collection object returning UDA for Entity Site
250 * @param x_site_attrib_data_table Collection object returning UDA for Entity Site
251 * @rep:scope public
252 * @rep:lifecycle active
253 * @rep:displayname Get Site Attributes
254 */
255
256
257 Procedure Get_site_attributes(
258 p_site_id_num IN varchar2
259 ,p_site_name IN varchar2 Default null
260 ,p_page_name IN varchar2 Default null
261 ,x_site_attrib_row_table OUT NOCOPY EGO_USER_ATTR_ROW_TABLE
262 ,x_site_attrib_data_table OUT NOCOPY EGO_USER_ATTR_DATA_TABLE
263 );
264
265
266 --
267 -- Get_location_attributes (PUBLIC)
268 -- Retrieves User Defined Attributes for a specific Site for Location Entity.
269 -- IN:
270 -- p_site_id_num - Site Identification Number
271 -- p_page_name - Page Name for which attributes to display.
272 --
273 /*#
274 * Retrieves Attributes information for Entity type Location.
275 * @param p_site_id_num Site Identification Number
276 * @param p_site_name Site Name
277 * @param p_page_name Page Name for Attributes
278 * @param x_loc_attrib_row_table Collection object returning UDA for Entity Location
279 * @param x_loc_attrib_data_table Collection object returning UDA for Entity Location
280 * @rep:scope public
281 * @rep:lifecycle active
282 * @rep:displayname Get Location Attributes
283 */
284
285 Procedure Get_location_attributes(
286 p_site_id_num IN varchar2
287 ,p_site_name IN varchar2 Default null
288 ,p_page_name IN varchar2 Default null
289 ,x_loc_attrib_row_table OUT NOCOPY EGO_USER_ATTR_ROW_TABLE
290 ,x_loc_attrib_data_table OUT NOCOPY EGO_USER_ATTR_DATA_TABLE
291 );
292
293 --
294 -- Get_trade_area_attributes (PUBLIC)
295 -- Retrieves User Defined Attributes for a specific Site for Trade Area Entity.
296 -- IN:
297 -- p_site_id_num - Site Identification Number
298 -- p_page_name - Page Name for which attributes to display.
299 --
300 /*#
301 * Retrieves Attributes information for Entity type Trade Area.
302 * @param p_site_id_num Site Identification Number
303 * @param p_site_name Site Name
304 * @param p_page_name Page Name for Attributes
305 * @param x_tr_area_attrib_row_table Collection object returning UDA for Entity Trade Area
306 * @param x_tr_area_attrib_data_table Collection object returning UDA for Entity Trade Area
307 * @rep:scope public
308 * @rep:lifecycle active
309 * @rep:displayname Get Trade Area Attributes
310 */
311
312 Procedure Get_trade_area_attributes(
313 p_site_id_num IN varchar2
314 ,p_site_name IN varchar2 Default null
315 ,p_page_name IN varchar2 Default null
316 ,x_tr_area_attrib_row_table OUT NOCOPY EGO_USER_ATTR_ROW_TABLE
317 ,x_tr_area_attrib_data_table OUT NOCOPY EGO_USER_ATTR_DATA_TABLE
318 );
319
320
321 --
322 -- Get_site_associations (PUBLIC)
323 -- Retrieves Trade areas , clusters and Hierarchy information for a site.
324 -- IN:
325 -- p_site_id_num - Site Identification Number
326 --
327 /*#
328 * Retrieves Trade areas , clusters and Hierarchy information for a site.
329 * @param p_site_id_num Site Identification Number
330 * @param p_site_name Site Name
331 * @param x_property_tab Collection object returning Entities or Property Details
332 * @param x_site_cluster_tab Collection object returning Cluster Information
333 * @param x_site_hierar_tab Collection object returning Hierarchy Information
334 * @param x_trade_area_grp_tab Collection object returning Trade Area Group Details
335 * @param x_relationship_tab Collection object returning relationships Details
336 * @rep:scope public
337 * @rep:lifecycle active
338 * @rep:displayname Get Site Associations
339 */
340
341
342 Procedure Get_site_associations(
343 p_site_id_num IN varchar2
347 ,x_site_hierar_tab OUT NOCOPY rrs_site_hierar_tab
344 ,p_site_name IN varchar2 Default null
345 ,x_property_tab OUT NOCOPY rrs_property_tab
346 ,x_site_cluster_tab OUT NOCOPY rrs_site_cluster_tab
348 ,x_trade_area_grp_tab OUT NOCOPY rrs_trade_area_grp_tab
349 ,x_relationship_tab OUT NOCOPY rrs_relationship_tab
350 );
351
352 --
353 -- Get_site_attachments (PUBLIC)
354 -- Retrieve the attachments associated with a specific Site.
355 -- IN:
356 -- p_site_id_num - Site Identification Number
357 --
358 /*#
359 * Retrieve the attachments associated with a specific Site.
360 * @param p_site_id_num Site Identification Number
361 * @param p_site_name Site Name
362 * @param x_site_attachment_tab Collection object returning Attachment Details
363 * @rep:scope public
364 * @rep:lifecycle active
365 * @rep:displayname Get Site Attachments
366 */
367
368
369 Procedure Get_site_attachments(
370 p_site_id_num IN varchar2
371 ,p_site_name IN varchar2 Default null
372 ,x_site_attachment_tab OUT NOCOPY rrs_site_attachment_tab
373 );
374
375
376 --
377 -- Get_site_contacts (PUBLIC)
378 -- Retrieves the contact details for a Site.
379 -- IN:
380 -- p_site_id_num - Site Identification Number
381 --
382 /*#
383 * Retrieves the contact details for a Site.
384 * @param p_site_id_num Site Identification Number
385 * @param p_site_name Site Name
386 * @param x_party_site_address_tab Collection object returning Site Address Details
387 * @param x_site_phone_tab Collection object returning Phone Details for a Site
388 * @param x_site_email_tab Collection object returning Email Details of a Site
389 * @param x_site_url_tab Collection object returning URL Details for a Site
390 * @param x_site_person_tab Collection object returning Person Details
391 * @rep:scope public
392 * @rep:lifecycle active
393 * @rep:displayname Get Site Contacts
394 */
395
396
397 Procedure Get_site_contacts(
398 p_site_id_num IN varchar2
399 ,p_site_name IN varchar2 Default null
400 ,x_party_site_address_tab OUT NOCOPY rrs_site_address_tab
401 ,x_site_phone_tab OUT NOCOPY rrs_site_phone_tab
402 ,x_site_email_tab OUT NOCOPY rrs_site_email_tab
403 ,x_site_url_tab OUT NOCOPY rrs_site_url_tab
404 ,x_site_person_tab OUT NOCOPY rrs_site_person_tab
405 );
406
407
408 --
409 -- Get_site_assets (PUBLIC)
410 -- Retrieve details of assets related to a Site.
411 -- IN:
412 -- p_site_id_num - Site Identification Number
413 --
414 /*#
415 * Retrieve details of assets related to a Site.
416 * @param p_site_id_num Site Identification Number
417 * @param p_site_name Site Name
418 * @param x_site_asset_tab Collection object returning Asset Information
419 * @rep:scope public
420 * @rep:lifecycle active
421 * @rep:displayname Get Site Assets
422 */
423
424
425 Procedure Get_site_assets(
426 p_site_id_num IN varchar2
427 ,p_site_name IN varchar2 Default null
428 ,x_site_asset_tab OUT NOCOPY rrs_site_asset_tab
429 );
430
431 end RRS_SITE_INFO;
[Home] [Help]