1 Package OKS_MISC_UTIL_WEB AUTHID CURRENT_USER AS
2 /* $Header: OKSJMUTS.pls 120.13 2006/08/17 21:01:09 hmnair noship $ */
3
4 -- GLOBAL VARIABLES
5 --------------------------------------------------------------------------
6 g_pkg_name CONSTANT VARCHAR2(200) := 'OKS_MISC_UTIL_WEB';
7 g_app_name_oks CONSTANT VARCHAR2(3) := 'OKS';
8 g_app_name_okc CONSTANT VARCHAR2(3) := 'OKC';
9 G_MODULE CONSTANT VARCHAR2(250) := 'oks.plsql.'||g_pkg_name||'.';
10 --------------------------------------------------------------------------
11
12 -- GLOBAL MESSAGE CONSTANTS
13 -----------------------------------------------------------------------------------
14 g_true CONSTANT VARCHAR2(1) := OKC_API.G_TRUE;
15 g_false CONSTANT VARCHAR2(1) := OKC_API.G_FALSE;
16 g_ret_sts_success CONSTANT VARCHAR2(1) := OKC_API.G_RET_STS_SUCCESS;
17 g_ret_sts_error CONSTANT VARCHAR2(1) := OKC_API.G_RET_STS_ERROR;
18 g_ret_sts_unexp_error CONSTANT VARCHAR2(1) := OKC_API.G_RET_STS_UNEXP_ERROR;
19 g_required_value CONSTANT VARCHAR2(200) := OKC_API.G_REQUIRED_VALUE;
20 g_invlaid_value CONSTANT VARCHAR2(200) := OKC_API.G_INVALID_VALUE;
21 g_col_name_token CONSTANT VARCHAR2(200) := OKC_API.G_COL_NAME_TOKEN;
22 g_parent_table_token CONSTANT VARCHAR2(200) := OKC_API.G_PARENT_TABLE_TOKEN;
23 g_child_table_token CONSTANT VARCHAR2(200) := OKC_API.G_CHILD_TABLE_TOKEN;
24 g_no_parent_record CONSTANT VARCHAR2(200) := 'OKS_NO_PARENT_RECORD';
25 g_unexpected_error CONSTANT VARCHAR2(200) := 'OKC_CONTRACTS_UNEXPECTED_ERROR';
26 g_sqlerrm_token CONSTANT VARCHAR2(200) := 'SQLerrm';
27 g_sqlcode_token CONSTANT VARCHAR2(200) := 'SQLcode';
28 g_uppercase_required CONSTANT VARCHAR2(200) := 'OKC_CONTRACTS_UPPERCASE_REQUIRED';
29 -----------------------------------------------------------------------------------
30
31 -- RECORD TYPES TABLE TYPES
32 -- =======================================================================================
33
34 /*
35 ||==========================================================================
36 || PROCEDURE: duration_period
37 ||--------------------------------------------------------------------------
38 ||
39 || Description:
40 || A funtion to retrieve duration unit in between 2 dates.
41 ||
42 || Pre Conditions:
43 ||
44 || In Parameters:
45 || p_start_date -- start date of duration
46 || p_end_date -- end date of duration
47 ||
48 || Return:
49 || Time unit as a string.
50 ||
51 || Post Success:
52 ||
53 || Post Failure:
54 ||
55 || Access Status:
56 || Public.
57 ||
58 ||==========================================================================
59 */
60 FUNCTION duration_period(
61 p_start_date IN DATE,
62 p_end_date IN DATE
63 ) RETURN NUMBER;
64
65 /*
66 ||==========================================================================
67 || PROCEDURE: duration_unit
68 ||--------------------------------------------------------------------------
69 ||
70 || Description:
71 || A funtion to retrieve duration period in between 2 dates.
72 ||
73 || Pre Conditions:
74 ||
75 || In Parameters:
76 || p_start_date -- start date of duration
77 || p_end_date -- end date of duration
78 ||
79 || Return:
80 || Time period as a number.
81 ||
82 || Post Success:
83 ||
84 || Post Failure:
85 ||
86 || Access Status:
87 || Public.
88 ||
89 ||==========================================================================
90 */
91 FUNCTION duration_unit(
92 p_start_date IN DATE,
93 p_end_date IN DATE
94 ) RETURN VARCHAR2;
95
96 /*
97 ||==========================================================================
98 || PROCEDURE: adjusted_discount
99 ||--------------------------------------------------------------------------
100 ||
101 || Description:
102 || A funtion to retrieve the adjusted discount in an invoice.
103 ||
104 || Pre Conditions:
105 ||
106 || In Parameters:
107 || p_contract_id -- Contract ID of the contract
108 || p_line_id -- Line ID of the line
109 ||
110 || Return:
111 || Adjusted discount for the line.
112 ||
113 || Post Success:
114 ||
115 || Post Failure:
116 ||
117 || Access Status:
118 || Public.
119 ||
120 ||==========================================================================
121 */
122 FUNCTION adjusted_discount(
123 p_contract_id IN NUMBER,
124 p_line_id IN NUMBER
125 ) RETURN Number;
126
127 /*
128 ||==========================================================================
129 || PROCEDURE: adjusted_surcharge
130 ||--------------------------------------------------------------------------
131 ||
132 || Description:
133 || A funtion to retrieve the adjusted discount in an invoice.
134 ||
135 || Pre Conditions:
136 ||
137 || In Parameters:
138 || p_contract_id -- Contract ID of the contract
139 || p_line_id -- Line ID of the line
140 ||
141 || Return:
142 || Adjusted surcharge for the line.
143 ||
144 || Post Success:
145 ||
146 || Post Failure:
147 ||
148 || Access Status:
149 || Public.
150 ||
151 ||==========================================================================
152 */
153 FUNCTION adjusted_surcharge(
154 p_contract_id IN NUMBER,
155 p_line_id IN NUMBER
156 ) RETURN Number;
157
158 /*
159 ||==========================================================================
160 || PROCEDURE: adjusted_total
161 ||--------------------------------------------------------------------------
162 ||
163 || Description:
164 || A funtion to retrieve the adjusted total in an invoice.
165 ||
166 || Pre Conditions:
167 ||
168 || In Parameters:
169 || p_contract_id -- Contract ID of the contract
170 || p_line_id -- Line ID of the line
171 ||
172 || Return:
173 || Adjusted total for the line.
174 ||
175 || Post Success:
176 ||
177 || Post Failure:
178 ||
179 || Access Status:
180 || Public.
181 ||
182 ||==========================================================================
183 */
184 FUNCTION adjusted_total(
185 p_contract_id IN NUMBER,
186 p_line_id IN NUMBER
187 ) RETURN Number;
188
189
190 FUNCTION get_terminated_amount(p_level IN VARCHAR2,
191 p_id IN NUMBER
192 ) RETURN NUMBER;
193
194 FUNCTION get_adjustment_amount(p_chr_id IN NUMBER DEFAULT NULL,
195 p_cle_id IN NUMBER DEFAULT NULL
196 ) RETURN NUMBER;
197
198 FUNCTION get_total_amount(p_chr_id IN NUMBER
199 ) RETURN NUMBER;
200
201
202 /**
203 * Addded function to retrieve Line Billed Amount for HTML Inquiry Line Billing Details Page
204 * @param p_line_id Line or Sub Line Id
205 * @param p_line_level line level character "L" for Line, "SL" for Sub Line
206 * @return total billed amount
207 */
208 FUNCTION get_line_billed_amount
209 (p_line_id IN NUMBER,
210 p_line_level IN VARCHAR2
211 ) RETURN NUMBER;
212
213 /**
214 * Addded function to retrieve Line Billed Amount for HTML Inquiry Line Billing Details Page
215 * @param p_line_id Line or Sub Line Id
216 * @param p_line_level line level character "L" for Line, "SL" for Sub Line
217 * @return pending invoice amount
218 */
219 FUNCTION get_line_unbilled_amount
220 (p_line_id IN NUMBER,
221 p_line_level IN VARCHAR2
222 ) RETURN NUMBER;
223
224
225
226 -- Function to retrieve unbilled amount for a contract
227 -- Parameters: p_chr_id (Identifier of the contract)
228
229 FUNCTION get_header_unbilled_amount (p_chr_id IN NUMBER )
230 RETURN NUMBER;
231
232
233 -- Function to retrieve billed amount for a contract (Header level)
234 -- Parameters: p_chr_id (Identifier of the contract)
235
236 FUNCTION get_header_billed_amount (p_chr_id IN NUMBER)
237 RETURN NUMBER;
238
239
240 -- Function to get Duration and Period for a given Strat Date and End Date ( ex: 1 Year)
241 FUNCTION get_duration_period (p_start_date DATE,
242 p_end_date DATE)
243 RETURN VARCHAR2;
244
245 -- Function to get the covered level name.
246 FUNCTION get_covlvl_name (p_jtot_object1_code VARCHAR2,
247 p_object1_id1 VARCHAR2,
248 p_object1_id2 VARCHAR2)
249 RETURN VARCHAR2;
250
251 -- Get Service or Covd Level Name
252 FUNCTION get_name (p_line_id IN NUMBER,
253 p_lse_id IN NUMBER)
254 RETURN VARCHAR2;
255
256 -- Function to get the commiment number.
257 -- Parameters: p_commitment_id - Commitment ID
258 FUNCTION get_commiment_number(p_commitment_id NUMBER,
259 p_org_id NUMBER)
260 RETURN NUMBER;
261
262 -- Function to validate whether the covered level is a standard item or a component.
263 -- Parameter: p_line_id - Sub line ID.
264 FUNCTION validate_component_yn(p_line_id IN NUMBER)
265 RETURN VARCHAR2;
266
267 END OKS_MISC_UTIL_WEB;