[Home] [Help]
PACKAGE: APPS.OKL_RULE_APIS_PVT
Source
1 Package OKL_RULE_APIS_PVT AUTHID CURRENT_USER As
2 /* $Header: OKLRRAPS.pls 115.7 2002/11/30 08:57:04 spillaip noship $ */
3 -----------------------------------------------
4 --global variables
5 -----------------------------------------------
6 G_API_TYPE CONSTANT VARCHAR2(5) := '_PVT';
7 G_PKG_NAME CONSTANT VARCHAR2(30) := 'OKL_RULE_APIS_PVT';
8 G_APP_NAME CONSTANT VARCHAR2(3) := OKL_API.G_APP_NAME;
9 G_ERROR CONSTANT VARCHAR2(30) := 'OKL_CONTRACTS_ERROR';
10 G_UNEXPECTED_ERROR CONSTANT VARCHAR2(30) := 'OKL_CONTRACTS_UNEXP_ERROR';
11 ------------------------------------------------
12 -- record structure for rule group
13 SUBTYPE rgpv_rec_type is OKL_RULE_PUB.rgpv_rec_type;
14 -- record structure for rule
15 SUBTYPE rulv_rec_type is OKL_RULE_PUB.rulv_rec_type;
16 -- table structure for rule group
17 SUBTYPE rgpv_tbl_type is OKL_RULE_PUB.rgpv_tbl_type;
18 -- table structure for rule
19 SUBTYPE rulv_tbl_type is OKL_RULE_PUB.rulv_tbl_type;
20 -- output record structure for displayed attributes of a rule's segments
21 -- for a given id1 and id2 for jtot_object will store name and description to be
22 -- displayed. For a rule_information segment will store name to be displayed
23 Type rulv_disp_rec_type is record (id NUMBER := Null,
24 rdf_code VARCHAR2(90) := Null,
25 obj1_name VARCHAR2(500) := Null,
26 obj1_descr VARCHAR2(2000) := Null,
27 obj1_status VARCHAR2(30) := Null,
28 obj1_start_date DATE := Null,
29 obj1_end_date DATE := Null,
30 obj1_org_id NUMBER := Null,
31 obj1_inv_org_id NUMBER := Null,
32 obj1_book_type_code VARCHAR2(15) := Null,
33 obj1_select VARCHAR2(2000) := Null,
34 obj2_name VARCHAR2(500) := Null,
35 obj2_descr VARCHAR2(2000) := Null,
36 obj2_status VARCHAR2(30) := Null,
37 obj2_start_date DATE := Null,
38 obj2_end_date DATE := Null,
39 obj2_org_id NUMBER := Null,
40 obj2_inv_org_id NUMBER := Null,
41 obj2_book_type_code VARCHAR2(15) := Null,
42 obj2_select VARCHAR2(2000) := Null,
43 obj3_name VARCHAR2(500) := Null,
44 obj3_descr VARCHAR2(2000) := Null,
45 obj3_status VARCHAR2(30) := Null,
46 obj3_start_date DATE := Null,
47 obj3_end_date DATE := Null,
48 obj3_org_id NUMBER := Null,
49 obj3_inv_org_id NUMBER := Null,
50 obj3_book_type_code VARCHAR2(15) := Null,
51 obj3_select VARCHAR2(2000) := Null,
52 rul_info1_name VARCHAR2(500) := Null,
53 rul_info1_select VARCHAR2(2000) := Null,
54 rul_info2_name VARCHAR2(500) := Null,
55 rul_info2_select VARCHAR2(2000) := Null,
56 rul_info3_name VARCHAR2(500) := Null,
57 rul_info3_select VARCHAR2(2000) := Null,
58 rul_info4_name VARCHAR2(500) := Null,
59 rul_info4_select VARCHAR2(2000) := Null,
60 rul_info5_name VARCHAR2(500) := Null,
61 rul_info5_select VARCHAR2(2000) := Null,
62 rul_info6_name VARCHAR2(500) := Null,
63 rul_info6_select VARCHAR2(2000) := Null,
64 rul_info7_name VARCHAR2(500) := Null,
65 rul_info7_select VARCHAR2(2000) := Null,
66 rul_info8_name VARCHAR2(500) := Null,
67 rul_info8_select VARCHAR2(2000) := Null,
68 rul_info9_name VARCHAR2(500) := Null,
69 rul_info9_select VARCHAR2(2000) := Null,
70 rul_info10_name VARCHAR2(500) := Null,
71 rul_info10_select VARCHAR2(2000) := Null,
72 rul_info11_name VARCHAR2(500) := Null,
73 rul_info11_select VARCHAR2(2000) := Null,
74 rul_info12_name VARCHAR2(500) := Null,
75 rul_info12_select VARCHAR2(2000) := Null,
76 rul_info13_name VARCHAR2(500) := Null,
77 rul_info13_select VARCHAR2(2000) := Null,
78 rul_info14_name VARCHAR2(500) := Null,
79 rul_info14_select VARCHAR2(2000) := Null,
80 rul_info15_name VARCHAR2(500) := Null,
81 rul_info15_select VARCHAR2(2000) := Null
82 );
83 --Start of Comments
84 --Procedure Name : Get_Contract_Rgs
85 --Description : Get Contract Rule Groups for a chr_id, cle_id
86 -- if chr_id is given gets data for header
87 -- if only cle_id or cle_id and chr_id(dnz_chr_id) are given
88 -- fetches data for line
89 --End of comments
90
91 Procedure Get_Contract_Rgs(p_api_version IN NUMBER,
92 p_init_msg_list IN VARCHAR2 DEFAULT OKL_API.G_FALSE,
93 p_chr_id IN NUMBER,
94 p_cle_id IN NUMBER,
95 p_rgd_code IN VARCHAR2 default Null,
96 x_return_status OUT NOCOPY VARCHAR2,
97 x_msg_count OUT NOCOPY NUMBER,
98 x_msg_data OUT NOCOPY VARCHAR2,
99 x_rgpv_tbl OUT NOCOPY rgpv_tbl_type,
100 x_rg_count OUT NOCOPY NUMBER);
101 --Start of Comments
102 --Procedure : Get Contract Rules
103 --Description : Gets all or specific rules for a rule group
104 -- End of Comments
105
106 Procedure Get_Contract_Rules(p_api_version IN NUMBER,
107 p_init_msg_list IN VARCHAR2 DEFAULT OKL_API.G_FALSE,
108 p_rgpv_rec IN rgpv_rec_type,
109 p_rdf_code IN VARCHAR2 default Null,
110 x_return_status OUT NOCOPY VARCHAR2,
111 x_msg_count OUT NOCOPY NUMBER,
112 x_msg_data OUT NOCOPY VARCHAR2,
113 x_rulv_tbl OUT NOCOPY rulv_tbl_type,
114 x_rule_count OUT NOCOPY NUMBER );
115
116 -- Start of comments
117 --Procedure : Get Rule Information
118 --Description : Fetches the display value (name) and select clause of the
119 -- rule information column in a rule if stored value(p_rule_info)
120 -- is provided else just returns the select clause
121 -- IN p_rdf_code : rule_code
122 -- p_appl_col_name : segment column name ('RULE_INFORMATION1',...)
123 -- p_rule_info : segment column value default Null
124 -- End of Comments
125
126 Procedure Get_rule_Information (p_api_version IN NUMBER,
127 p_init_msg_list IN VARCHAR2 DEFAULT OKL_API.G_FALSE,
128 p_rdf_code IN VARCHAR2,
129 p_appl_col_name IN VARCHAR2,
130 p_rule_info IN VARCHAR2 default Null,
131 x_return_status OUT NOCOPY VARCHAR2,
132 x_msg_count OUT NOCOPY NUMBER,
133 x_msg_data OUT NOCOPY VARCHAR2,
134 x_name OUT NOCOPY VARCHAR2,
135 x_select OUT NOCOPY VARCHAR2);
136
137 -- Start of comments
138 --Procedure : Get_jtot_object
139 --Description : Fetches the display values (name,description) and additional
140 -- columns status, start_date, end_date, org_id, inv_org_id,
141 -- book_type_code, if present if id1 and id2 are given
142 -- Also returns the select clause associated with the jtf_object
143 -- End of Comments
144
145 Procedure Get_jtot_object(p_api_version IN NUMBER,
146 p_init_msg_list IN VARCHAR2 DEFAULT OKL_API.G_FALSE,
147 p_object_code IN VARCHAR2,
148 p_id1 IN VARCHAR2 default null,
149 p_id2 IN VARCHAR2 default null,
150 x_return_status OUT NOCOPY VARCHAR2,
151 x_msg_count OUT NOCOPY NUMBER,
152 x_msg_data OUT NOCOPY VARCHAR2,
153 x_id1 OUT NOCOPY VARCHAR2,
154 x_id2 OUT NOCOPY VARCHAR2,
155 x_name OUT NOCOPY VARCHAR2,
156 x_description OUT NOCOPY VARCHAR2,
157 x_status OUT NOCOPY VARCHAR2,
158 x_start_date OUT NOCOPY DATE,
159 x_end_date OUT NOCOPY DATE,
160 x_org_id OUT NOCOPY NUMBER,
161 x_inv_org_id OUT NOCOPY NUMBER,
162 x_book_type_code OUT NOCOPY VARCHAR2,
163 x_select OUT NOCOPY VARCHAR2);
164
165 --Start of Comments
166 --Procedure : Get_Rule_disp_value
167 --Description : Fetches the displayed values of all rule segments
168 --End of Comments
169
170 Procedure Get_Rule_disp_value (p_api_version IN NUMBER,
171 p_init_msg_list IN VARCHAR2 DEFAULT OKL_API.G_FALSE,
172 p_rulv_rec IN Rulv_rec_type,
173 x_return_status OUT NOCOPY VARCHAR2,
174 x_msg_count OUT NOCOPY NUMBER,
175 x_msg_data OUT NOCOPY VARCHAR2,
176 x_rulv_disp_rec OUT NOCOPY rulv_disp_rec_type);
177
178 --Start of Comments
179 --Procedure : Get_Rule_Segment_value
180 --Description : Fetches the displayed value and select clauses of
181 -- of specific rule segment.
182 --Note : This API requires exact screen prompt label of the segment
183 -- to be passed as p_rdf_name
184 --End of Comments
185
186 Procedure Get_rule_Segment_Value(p_api_version IN NUMBER,
187 p_init_msg_list IN VARCHAR2 DEFAULT OKL_API.G_FALSE,
188 x_return_status OUT NOCOPY VARCHAR2,
189 x_msg_count OUT NOCOPY NUMBER,
190 x_msg_data OUT NOCOPY VARCHAR2,
191 p_chr_id IN NUMBER,
192 p_cle_id IN NUMBER,
193 p_rgd_code IN VARCHAR2,
194 p_rdf_code IN VARCHAR2,
195 p_rdf_name IN VARCHAR2,
196 x_id1 OUT NOCOPY VARCHAR2,
197 x_id2 OUT NOCOPY VARCHAR2,
198 x_name OUT NOCOPY VARCHAR2,
199 x_description OUT NOCOPY VARCHAR2,
200 x_status OUT NOCOPY VARCHAR2,
201 x_start_date OUT NOCOPY DATE,
202 x_end_date OUT NOCOPY DATE,
203 x_org_id OUT NOCOPY NUMBER,
204 x_inv_org_id OUT NOCOPY NUMBER,
205 x_book_type_code OUT NOCOPY VARCHAR2,
206 x_select OUT NOCOPY VARCHAR2);
207 --Start of Comments
208 --Bug#2525946 : overloaded to take rule segment numbers as input
209 --Procedure : Get_Rule_Segment_value
210 --Description : Fetches the displayed value and select clauses of
211 -- of specific rule segment.
212 --Note : This API requires segment number
213 -- Segment number 1 to 15 are mapped to RULE_INFORMATION1 to
214 -- RULE_INFORMATION15. Segment Numbers 16, 17 and 18 are mapped
215 -- to jtot_object1, jtot_object2 and jtot_object3 respectively
216 --End of Comments
217 Procedure Get_rule_Segment_Value(p_api_version IN NUMBER,
218 p_init_msg_list IN VARCHAR2 DEFAULT OKL_API.G_FALSE,
219 x_return_status OUT NOCOPY VARCHAR2,
220 x_msg_count OUT NOCOPY NUMBER,
221 x_msg_data OUT NOCOPY VARCHAR2,
222 p_chr_id IN NUMBER,
223 p_cle_id IN NUMBER,
224 p_rgd_code IN VARCHAR2,
225 p_rdf_code IN VARCHAR2,
226 p_segment_number IN NUMBER,
227 x_id1 OUT NOCOPY VARCHAR2,
228 x_id2 OUT NOCOPY VARCHAR2,
229 x_name OUT NOCOPY VARCHAR2,
230 x_description OUT NOCOPY VARCHAR2,
231 x_status OUT NOCOPY VARCHAR2,
232 x_start_date OUT NOCOPY DATE,
233 x_end_date OUT NOCOPY DATE,
234 x_org_id OUT NOCOPY NUMBER,
235 x_inv_org_id OUT NOCOPY NUMBER,
236 x_book_type_code OUT NOCOPY VARCHAR2,
237 x_select OUT NOCOPY VARCHAR2);
238
239
240 End OKL_RULE_APIS_PVT;