PACKAGE: APPS.FND_REQUEST_INFO

Source

1 package  FND_REQUEST_INFO as
2 /* $Header: AFCPRINS.pls 120.4 2006/04/05 02:32:09 ktanneru ship $ */
3 /*#
4  * Used in MLS functions to get the MLS information for a request. An MLS function can use the FND_REQUEST_INFO APIs to retrieve the
5  * concurrent program application short name, the concurrent program short name, and the concurrent request parameters if needed.
6  * @rep:scope public
7  * @rep:product FND
8  * @rep:displayname Request Information
9  * @rep:category BUSINESS_ENTITY FND_CP_REQUEST
10  * @rep:lifecycle active
11  * @rep:compatibility S
12  */
13 
14 
15  -- Name
16  --  initialize
17  -- Purpose
18  --  It initilizes the global variables and for the current request.
19 
20 procedure initialize;
21 
22 
23  -- Name
24  --  get_request_id
25  -- Purpose
26  --  It will return the current request id.
27 
28 FUNCTION GET_REQUEST_ID return number;
29 pragma restrict_references(get_request_id, WNDS, WNPS );
30 
31  -- Name
32  --  get_param_info
33  -- Purpose
34  --  It will return request parameter name for a given parameter number
35  -- Arguments
36  --  param_num - IN     - number
37  --  name      - OUT    - varchar2
38 /*#
39  * Retrieves the parameter name for a given parameter number. The function will return -1 if it fails to retrieve the parameter number.
40  * @param Param_num The parameter number for the given parameter name
41  * @param Name The name of the parameter of the request's concurrent program
42  * @return Returns -1 if it fails to retrieve information
43  * @rep:displayname Get Parameter Information
44  * @rep:scope public
45  * @rep:lifecycle active
46  * @rep:compatibility S
47  */
48 FUNCTION GET_PARAM_INFO(Param_num in number,
49                         Name out nocopy varchar2)
50 return number;
51 pragma restrict_references(get_param_info, WNDS, WNPS);
52 
53  -- Name
54  --  get_param_number
55  -- Purpose
56  --  It will return request parameter number for a given parameter name
57  -- Arguments
58  --  name      - IN    - varchar2
59  --  param_num - OUT   - number
60 /*#
61  * Retrieves the parameter number for a given parameter name. The function will return -1 if it fails to retrieve the parameter number.
62  * @param name The name of the parameter of the request's concurrent program
63  * @param Param_num Parameter number for the given parameter name
64  * @return Returns -1 if fails to retrieve information
65  * @rep:displayname Get Parameter Number
66  * @rep:scope public
67  * @rep:lifecycle active
68  * @rep:compatibility S
69  */
70 FUNCTION GET_PARAM_NUMBER(name in varchar2,
71                           Param_num out nocopy number)
72 return number;
73 
74 pragma restrict_references(get_param_number, WNDS, WNPS);
75 
76 
77  -- Name
78  --  get_program
79  -- Purpose
80  --  It will return requests developer concurrent program name and
81  --  application short name
82 /*#
83  * Retrieves the concurrent program short name and the short name of the application that owns the concurrent program
84  * @param PROG_NAME The short name of the concurrent program
85  * @param PROG_APP_NAME The short name of the application that owns the program
86  * @rep:displayname Get Program
87  * @rep:scope public
88  * @rep:lifecycle active
89  * @rep:compatibility S
90  */
91 PROCEDURE GET_PROGRAM(PROG_NAME out nocopy VARCHAR2,
92                       PROG_APP_NAME out nocopy varchar2);
93 
94 pragma restrict_references(get_program, WNDS, WNPS);
95 
96 
97  -- Name
98  --  get_parameter
99  -- Purpose
100  --  Returns request parameter value for a given parameter number or parameter
101  --   name.
102  --  Function will return the value as varchar2.
103 /*#
104  * Retrieves the concurrent requests's parameter value for a given parameter number. Values are always returned as strings (varchar2).
105  * @param param_num The number of the parameter of the request's concurrent program
106  * @return Returns the parameter value for the given parameter number
107  * @rep:displayname Get Parameter
108  * @rep:scope public
109  * @rep:lifecycle active
110  * @rep:compatibility S */
111 FUNCTION GET_PARAMETER(param_num in number) return varchar2;
112 
113 pragma restrict_references(get_parameter, WNDS, WNPS);
114 
115 FUNCTION GET_PARAMETER(name in varchar2) return varchar2;
116 
117  -- Name
118  --  get_territory
119  -- Purpose
120  --  Returns request nls_territory value
121  --  Function will return the value as varchar2.
122 
123 FUNCTION GET_TERRITORY return varchar2;
124 
125 pragma restrict_references(get_territory, WNDS, WNPS);
126 
127 end;