1 PACKAGE XTR_COMMON_FUNCTIONS as
2 /* $Header: xtrfuncs.pls 120.0 2005/07/19 12:55:51 rjose noship $ */
3
4 --------------------------------------
5 -- declaration of public procedures and functions
6 --------------------------------------
7
8 /**
9 * FUNCTION DEAL_STATUS_CHECK
10 *
11 * DESCRIPTION
12 * This function returns True if the statis of the Deal is Current.
13 *
14 * EXTERNAL PROCEDURES/FUNCTIONS ACCESSED
15 *
16 * ARGUMENTS
17 * IN:
18 * p_deal_number Deal Number of the Deal for which
19 * Status is to be determined.
20 * IN/OUT:
21 *
22 * OUT:
23 * True if Deal Status is Current. False for all other statuses.
24 *
25 * NOTES
26 * Originally from DEAL_STATUS_CHECK in XTRUTIL.pld
27 *
28 * MODIFICATION HISTORY
29 *
30 * 14-JUN-2005 Rajesh Jose o Created.
31 *
32 */
33
34 FUNCTION DEAL_STATUS_CHECK(
35 p_deal_number IN XTR_DEALS.DEAL_NO%TYPE) RETURN BOOLEAN;
36
37 /**
38 * FUNCTION INTEREST_OVERRIDE_CHECK
39 *
40 * DESCRIPTION
41 * Determines whether the user has the authority to override interest.
42 *
43 * EXTERNAL PROCEDURES/FUNCTIONS ACCESSED
44 *
45 * ARGUMENTS
46 * IN:
47 * IN/OUT:
48 * OUT:
49 * TRUE if the user has the authority to override interest. Else False.
50 *
51 * NOTES
52 * Originally from INTEREST_OVERRIDE_CHECK in XTRUTIL.pld
53 *
54 * MODIFICATION HISTORY
55 *
56 * 14-JUL-2005 Rajesh Jose o Created.
57 */
58
59 FUNCTION INTEREST_OVERRIDE_CHECK return BOOLEAN;
60
61 /**
62 * FUNCTION INTEREST_CHECK_COVER
63 *
64 * DESCRIPTION
65 * Cover Function which calls the following functions
66 * Settled_Interest_Check
67 * Interest_Reval_Check
68 * Interest_Accrual_Check
69 * Interest_Jrnls_Check
70 * Interest_Recon_Check
71 * Settled_Int_Tax_Check
72 *
73 * EXTERNAL PROCEDURES/FUNCTIONS ACCESSED
74 *
75 * ARGUMENTS
76 * IN:
77 * p_deal_type Deal Type of the Deal
78 * p_deal_number Deal Number
79 * p_transaction_number Transaction Number
80 * p_date Date
81 * p_maturity_date Maturity Date of the Deal
82 * p_check_intset_record Flag to indicate whether the check should be
83 * done for INTSET records only.
84 * IN/OUT:
85 * OUT:
86 * Returns False if any of the functions return False. Else returns True.
87 *
88 * NOTES
89 * Originally from INTEREST_CHECK_COVER in XTRUTIL.pld
90 *
91 * MODIFICATION HISTORY
92 *
93 * 14-JUL-2005 Rajesh Jose o Created.
94 */
95
96 FUNCTION INTEREST_CHECK_COVER(
97 p_deal_type IN XTR_DEALS.DEAL_TYPE%TYPE,
98 p_deal_number IN XTR_DEALS.DEAL_NO%TYPE,
99 p_transaction_number IN XTR_DEALS.TRANSACTION_NO%TYPE
100 DEFAULT NULL,
101 p_date IN DATE DEFAULT NULL,
102 p_maturity_date IN DATE DEFAULT NULL,
103 p_check_intset_record IN VARCHAR2 DEFAULT 'N') RETURN BOOLEAN;
104
105 /**
106 * FUNCTION SETTLED_INTEREST_CHECK
107 *
108 * DESCRIPTION
109 * This function checks whether the input transaction has been settled.
110 *
111 * EXTERNAL PROCEDURES/FUNCTIONS ACCESSED
112 *
113 * ARGUMENTS
114 * IN:
115 * p_deal_type Deal Type of the Deal
116 * p_deal_number Deal Number
117 * p_transaction_number Transaction Number
118 * p_date Date
119 * p_maturity_date Maturity Date of the Deal
120 * p_check_intset_record Flag to indicate whether the check should be
121 * done for INTSET records only.
122 * IN/OUT:
123 * OUT:
124 * Returns False if the transactions has been settled. Else returns True.
125 *
126 * NOTES
127 * Originally from SETTLED_INTEREST_CHECK in XTRUTIL.pld
128 *
129 * MODIFICATION HISTORY
130 *
131 * 14-JUL-2005 Rajesh Jose o Created.
132 */
133
134 FUNCTION SETTLED_INTEREST_CHECK(
135 p_deal_type IN XTR_DEALS.DEAL_TYPE%TYPE,
136 p_deal_number IN XTR_DEALS.DEAL_NO%TYPE,
137 p_transaction_number IN XTR_DEALS.TRANSACTION_NO%TYPE
138 DEFAULT NULL,
139 p_date IN DATE DEFAULT NULL,
140 p_maturity_date IN DATE DEFAULT NULL,
141 p_check_intset_record IN VARCHAR2 DEFAULT 'N') RETURN BOOLEAN;
142
143 /**
144 * FUNCTION INTEREST_REVALUED_CHECK
145 *
146 * DESCRIPTION
147 * This function checks whether the input transaction has been revalued.
148 *
149 * EXTERNAL PROCEDURES/FUNCTIONS ACCESSED
150 *
151 * ARGUMENTS
152 * IN:
153 * p_deal_type Deal Type of the Deal
154 * p_deal_number Deal Number
155 * p_transaction_number Transaction Number
156 * p_date Date
157 * IN/OUT:
158 * OUT:
159 * Returns False if the transaction has been revalued. Else returns True.
160 *
161 * NOTES
162 * Originally from INTEREST_REVAL_CHECK in XTRUTIL.pld
163 *
164 * MODIFICATION HISTORY
165 *
166 * 14-JUL-2005 Rajesh Jose o Created.
167 */
168
169 FUNCTION INTEREST_REVALUED_CHECK(
170 p_deal_type IN XTR_DEALS.DEAL_TYPE%TYPE,
171 p_deal_number IN XTR_DEALS.DEAL_NO%TYPE,
172 p_transaction_number IN XTR_DEALS.TRANSACTION_NO%TYPE
173 DEFAULT NULL,
174 p_date IN DATE DEFAULT NULL) RETURN BOOLEAN;
175
176 /**
177 * FUNCTION INTEREST_ACCRUAL_CHECK
178 *
179 * DESCRIPTION
180 * This function checks whether accruals have been passed for
181 * the input transaction.
182 *
183 * EXTERNAL PROCEDURES/FUNCTIONS ACCESSED
184 *
185 * ARGUMENTS
186 * IN:
187 * p_deal_type Deal Type of the Deal
188 * p_deal_number Deal Number
189 * p_transaction_number Transaction Number
190 * p_date Date
191 * IN/OUT:
192 * OUT:
193 * Returns False if the transaction has been accrued. Else returns True.
194 *
195 * NOTES
196 * Originally from INTEREST_ACCRUAL_CHECK in XTRUTIL.pld
197 *
198 * MODIFICATION HISTORY
199 *
200 * 14-JUL-2005 Rajesh Jose o Created.
201 */
202
203 FUNCTION INTEREST_ACCRUAL_CHECK(
204 p_deal_type IN XTR_DEALS.DEAL_TYPE%TYPE,
205 p_deal_number IN XTR_DEALS.DEAL_NO%TYPE,
206 p_transaction_number IN XTR_DEALS.TRANSACTION_NO%TYPE
207 DEFAULT NULL,
208 p_date IN DATE DEFAULT NULL) RETURN BOOLEAN;
209
210 /**
211 * FUNCTION INTEREST_JOURNAL_CHECK
212 *
213 * DESCRIPTION
214 * This function checks whether journals have been passed for
215 * the input transaction.
216 *
217 * EXTERNAL PROCEDURES/FUNCTIONS ACCESSED
218 *
219 * ARGUMENTS
220 * IN:
221 * p_deal_type Deal Type of the Deal
222 * p_deal_number Deal Number
223 * p_transaction_number Transaction Number
224 * p_date Date
225 * p_check_intset_record Flag to indicate whether the check should be
226 * done for INTSET records only.
227 * IN/OUT:
228 * OUT:
229 * Returns False if the transaction has been accrued. Else returns True.
230 *
231 * NOTES
232 * Originally from INTEREST_JRNLS_CHECK in XTRUTIL.pld
233 *
234 * MODIFICATION HISTORY
235 *
236 * 14-JUL-2005 Rajesh Jose o Created.
237 */
238
239 FUNCTION INTEREST_JOURNAL_CHECK(
240 p_deal_type IN XTR_DEALS.DEAL_TYPE%TYPE,
241 p_deal_number IN XTR_DEALS.DEAL_NO%TYPE,
242 p_transaction_number IN XTR_DEALS.TRANSACTION_NO%TYPE
243 DEFAULT NULL,
244 p_date IN DATE DEFAULT NULL,
245 p_check_intset_record IN VARCHAR2 DEFAULT 'N') RETURN BOOLEAN;
246
247 /**
248 * FUNCTION INTEREST_RECONCILED_CHECK
249 *
250 * DESCRIPTION
251 * This function checks whether the transaction has been reconciled.
252 *
253 * EXTERNAL PROCEDURES/FUNCTIONS ACCESSED
254 *
255 * ARGUMENTS
256 * IN:
257 * p_deal_type Deal Type of the Deal
258 * p_deal_number Deal Number
259 * p_transaction_number Transaction Number
260 * p_date Date
261 * IN/OUT:
262 * OUT:
263 * Returns False if the transaction has been reconciled. Else returns True.
264 *
265 * NOTES
266 * Originally from INTEREST_RECON_CHECK in XTRUTIL.pld
267 *
268 * MODIFICATION HISTORY
269 *
270 * 14-JUL-2005 Rajesh Jose o Created.
271 */
272
273 FUNCTION INTEREST_RECONCILED_CHECK(
274 p_deal_type IN XTR_DEALS.DEAL_TYPE%TYPE,
275 p_deal_number IN XTR_DEALS.DEAL_NO%TYPE,
276 p_transaction_number IN XTR_DEALS.TRANSACTION_NO%TYPE
277 DEFAULT NULL,
278 p_date IN DATE DEFAULT NULL) RETURN BOOLEAN;
279
280
281 /**
282 * FUNCTION SETTLED_INTEREST_TAX_CHECK
283 *
284 * DESCRIPTION
285 * This function checks whether the tax exposure transaction for Bond
286 * Deals has been settled.
287 *
288 * EXTERNAL PROCEDURES/FUNCTIONS ACCESSED
289 *
290 * ARGUMENTS
291 * IN:
292 * p_deal_type Deal Type of the Deal
293 * p_deal_number Deal Number
294 * p_transaction_number Transaction Number
295 * p_date Date
296 * p_maturity_date Maturity Date of the Deal
297 * IN/OUT:
298 * OUT:
299 * Returns False if the tax exposure transaction has been settled.
300 * Else returns True.
301 *
302 * NOTES
303 * Originally from SETTLED_INT_TAX_CHECK in XTRUTIL.pld
304 *
305 * MODIFICATION HISTORY
306 *
307 * 14-JUL-2005 Rajesh Jose o Created.
308 */
309
310 FUNCTION SETTLED_INTEREST_TAX_CHECK(
311 p_deal_type IN XTR_DEALS.DEAL_TYPE%TYPE,
312 p_deal_number IN XTR_DEALS.DEAL_NO%TYPE,
313 p_transaction_number IN XTR_DEALS.TRANSACTION_NO%TYPE
314 DEFAULT NULL,
315 p_date IN DATE DEFAULT NULL,
316 p_maturity_date IN DATE DEFAULT NULL) RETURN BOOLEAN;
317
318
319 END XTR_COMMON_FUNCTIONS;
320