1 PACKAGE BIS_RSG_PUB_APIS_PKG AS
2 /* $Header: BISRSPAS.pls 120.0 2005/10/17 15:26:45 slowe noship $ */
3 TYPE BIS_RSG_CONTENT_INFO IS RECORD(
4 Name varchar2(480),
5 Type varchar2(30)
6 );
7 TYPE BIS_RSG_CONTENT_LIST IS TABLE OF BIS_RSG_CONTENT_INFO;
8
9 -- Return the name of the request set of which this request is the root
10 -- if not found then return null and set appropriate errcode
11 Function Get_RS_Name ( p_root_request_id in number,errbuf out NOCOPY varchar2,
12 errcode out NOCOPY varchar2) return varchar2;
13
14 -- Return the name of the request set of which this request is part of
15 -- if not found then return null and set appropriate errcode
16 Function Get_Current_RS_Name ( errbuf out NOCOPY varchar2,
17 errcode out NOCOPY varchar2) return varchar2;
18
19 -- Return the refresh mode of the request set
20 -- if not found then return null and set appropriate errcode
21 Function Get_RS_Refresh_mode (p_req_set_name IN varchar2, errbuf out NOCOPY varchar2,
22 errcode out NOCOPY varchar2) return varchar2;
23
24 -- Return the refresh mode of the request set of which this request is part of
25 -- if not found then return null and set appropriate errcode
26 Function Get_Current_RS_Refresh_mode (errbuf out NOCOPY varchar2,
27 errcode out NOCOPY varchar2) return varchar2;
28
29 -- populate p_content_list with the list of contents of the request set
30 -- if not found then set appropriate errcode (overloaded)
31 Procedure Get_content_in_RS( p_req_set_name IN varchar2, p_content_list OUT NOCOPY BIS_RSG_CONTENT_LIST,
32 errbuf out NOCOPY varchar2, errcode out NOCOPY varchar2);
33
34 -- populate p_page_list with the list of page of the request set
35 -- if not found then set appropriate errcode
36 Procedure Get_pages_in_RS ( p_req_set_name IN varchar2, p_page_list out nocopy BIS_RSG_CONTENT_LIST,
37 errbuf out NOCOPY varchar2, errcode out NOCOPY varchar2);
38 -- populate p_page_list with the list of page of the request set of which this request is a part of
39 -- if not found then set appropriate errcode
40 Procedure Get_pages_in_current_RS( p_page_list out nocopy BIS_RSG_CONTENT_LIST,
41 errbuf out NOCOPY varchar2, errcode out NOCOPY varchar2);
42
43 -- populate p_report_list with the list of report of the request set
44 -- if not found then set appropriate errcode
45 Procedure Get_reports_in_RS ( p_req_set_name IN varchar2, p_report_list out nocopy BIS_RSG_CONTENT_LIST,
46 errbuf out NOCOPY varchar2, errcode out NOCOPY varchar2);
47 -- populate p_report_list with the list of report of the request set of which this request is a part of
48 -- if not found then set appropriate errcode
49 Procedure Get_reports_in_current_RS( p_report_list out nocopy BIS_RSG_CONTENT_LIST,
50 errbuf out NOCOPY varchar2, errcode out NOCOPY varchar2);
51
52 /*
53 List of error codes return by the APIS
54 BIS_RSG_NO_RS_FOUND - In case we don't any data for this request set in our table/wrong req id is given
55 BIS_RSG_SUCCESS - api is successful
56 BIS_RSG_ERR_UNEXPECTED - some unexpected error occurred
57 BIS_RSG_RS_NO_REF_MODE - in case the the refresh mode option is nulll for request set
58 - like in case of Gather Statistics request set
59 BIS_RSG_NO_RS_STANDALONE - There is no request set associated with the request id. This is a standalone request.
60 */
61 end BIS_RSG_PUB_APIS_PKG;