1 PACKAGE OKL_CONTRACT_INFO AUTHID CURRENT_USER AS
2 /* $Header: OKLRCONS.pls 115.13 2003/09/04 02:35:37 pdevaraj noship $ */
3
4 ---------------------------------------------------------------------------
5 -- GLOBAL MESSAGE CONSTANTS
6 ---------------------------------------------------------------------------
7 G_FND_APP CONSTANT VARCHAR2(200) := okl_api.G_FND_APP;
8 G_REQUIRED_VALUE CONSTANT VARCHAR2(200) := 'OKL_REQUIRED_VALUE';
9 G_INVALID_VALUE CONSTANT VARCHAR2(200) := okl_api.G_INVALID_VALUE;
10 G_COL_NAME_TOKEN CONSTANT VARCHAR2(200) := 'COL_NAME';
11 G_COL_NAME1_TOKEN CONSTANT VARCHAR2(200) := 'COL_NAME1';
12 G_COL_NAME2_TOKEN CONSTANT VARCHAR2(200) := 'COL_NAME2';
13 G_PARENT_TABLE_TOKEN CONSTANT VARCHAR2(200) := 'PARENT_TABLE';
14 G_ERROR CONSTANT VARCHAR2(200) := 'OKL_ERROR';
15 G_UNEXPECTED_ERROR CONSTANT VARCHAR2(200) := 'OKL_UNEXPECTED_ERROR';
16 G_SQLERRM_TOKEN CONSTANT VARCHAR2(200) := 'OKL_SQLERRM';
17 G_SQLCODE_TOKEN CONSTANT VARCHAR2(200) := 'OKL_SQLCODE';
18 ---------------------------------------------------------------------------
19 -- GLOBAL VARIABLES
20 ---------------------------------------------------------------------------
21 G_PKG_NAME CONSTANT VARCHAR2(200) := 'OKL_CONTRACT_INFO';
22 G_APP_NAME CONSTANT VARCHAR2(3) := 'OKL';
23
24 ---------------------------------------------------------------------------
25 -- GLOBAL EXCEPTION
26 ---------------------------------------------------------------------------
27 G_EXCEPTION_HALT_VALIDATION EXCEPTION;
28 ---------------------------------------------------------------------------
29 -- Procedures and Functions
30 ---------------------------------------------------------------------------
31
32 -- Returns customer ID or party ID
33 FUNCTION get_customer(
34 p_contract_id IN NUMBER,
35 x_customer OUT NOCOPY VARCHAR2)
36 RETURN VARCHAR2;
37
38 -- Returns Vendor Program ID
39 FUNCTION get_vendor_program(
40 p_contract_id IN NUMBER,
41 x_vendor_program OUT NOCOPY VARCHAR2)
42 RETURN VARCHAR2;
43
44 -- Returns Bill to Address ID
45 FUNCTION get_bill_to_address(
46 p_contract_id IN NUMBER,
47 x_bill_to_address_id OUT NOCOPY VARCHAR2)
48 RETURN VARCHAR2;
49
50 -- Returns Private Label as a String namely URL
51 FUNCTION get_private_label(
52 p_contract_id IN NUMBER,
53 x_private_label OUT NOCOPY VARCHAR2)
54 RETURN VARCHAR2;
55
56 -- Returns non notification flag as "Y" or "N"
57 FUNCTION get_non_notify_flag(
58 p_contract_id IN NUMBER,
59 x_non_notify_flag OUT NOCOPY VARCHAR2)
60 RETURN VARCHAR2;
61
62 -- Returns Currency Code
63 FUNCTION get_currency(
64 p_contract_id IN NUMBER,
65 x_currency OUT NOCOPY VARCHAR2)
66 RETURN VARCHAR2;
67
68 -- Returns existance of syndication for contract as "Y" or "N"
69 FUNCTION get_syndicate_flag(
70 p_contract_id IN NUMBER,
71 x_syndicate_flag OUT NOCOPY VARCHAR2)
72 RETURN VARCHAR2;
73
74 -- Returns org ID for a contract
75 FUNCTION GET_ORG_ID(
76 p_contract_id IN NUMBER,
77 x_org_id OUT NOCOPY NUMBER )
78 RETURN VARCHAR2;
79
80 -- Returns REMAINING no. of PAYMENTS
81 FUNCTION get_remaining_payments(
82 p_contract_id IN NUMBER,
83 x_remaining_payments OUT NOCOPY NUMBER)
84 RETURN VARCHAR2;
85
86 -- Returns RULE VALUE (accepts prompt as a parameter)
87 FUNCTION get_rule_value(
88 p_contract_id IN NUMBER
89 ,p_rule_group_code IN VARCHAR2
90 ,p_rule_code IN VARCHAR2
91 ,p_rule_name IN VARCHAR2
92 ,x_id1 OUT NOCOPY VARCHAR2
93 ,x_id2 OUT NOCOPY VARCHAR2
94 ,x_value OUT NOCOPY VARCHAR2)
95 RETURN VARCHAR2;
96
97
98 -- Returns RULE VALUE (accepts segment number as a parameter)
99 FUNCTION get_rule_value(
100 p_contract_id IN NUMBER
101 ,p_rule_group_code IN VARCHAR2
102 ,p_rule_code IN VARCHAR2
103 ,p_segment_number IN NUMBER
104 ,x_id1 OUT NOCOPY VARCHAR2
105 ,x_id2 OUT NOCOPY VARCHAR2
106 ,x_value OUT NOCOPY VARCHAR2)
107 RETURN VARCHAR2;
108
109 -- Returns DAYS PAST DUE
110 FUNCTION get_days_past_due(
111 p_contract_id IN NUMBER,
112 x_days_past_due OUT NOCOPY NUMBER)
113 RETURN VARCHAR2;
114
115 -- Returns AMOUNT PAST DUE
116 FUNCTION get_amount_past_due(
117 p_contract_id IN NUMBER,
118 x_amount_past_due OUT NOCOPY NUMBER)
119 RETURN VARCHAR2;
120
121 -- Returns next due date and amount for a contract
122 FUNCTION get_next_due (
123 p_contract_id IN NUMBER,
124 x_next_due_amt OUT NOCOPY NUMBER,
125 x_next_due_date OUT NOCOPY DATE )
126 RETURN VARCHAR2 ;
127
128 -- Returns last due date and amount for a contract
129 FUNCTION get_last_due(
130 p_contract_id IN NUMBER,
131 x_last_due_amt OUT NOCOPY NUMBER,
132 x_last_due_date OUT NOCOPY DATE )
133 RETURN VARCHAR2;
134
135 -- Returns total asset cost
136 FUNCTION get_total_asset_cost (
137 p_contract_id IN NUMBER,
138 x_asset_cost OUT NOCOPY NUMBER )
139 RETURN VARCHAR2;
140
141 -- Retunrs Amount outstanding for a contract
142 FUNCTION get_outstanding_rcvble (
143 p_contract_id IN NUMBER,
144 x_rcvble_amt OUT NOCOPY NUMBER)
145 RETURN VARCHAR2;
146
147 -- Returns term duration of a contract with start and end date
148 FUNCTION get_contract_term (
149 p_contract_id IN NUMBER,
150 x_start_date OUT NOCOPY DATE,
151 x_end_date OUT NOCOPY DATE,
152 x_term_duration OUT NOCOPY NUMBER)
153 RETURN VARCHAR2;
154
155 -- Returns the net investment for a contract
156 FUNCTION get_net_investment (
157 p_contract_id IN NUMBER,
158 x_net_investment OUT NOCOPY NUMBER)
159 RETURN VARCHAR2;
160
161 -- Returns advance rent, Security Deposit and Interest Type for a
162 FUNCTION get_rent_security_interest (
163 p_contract_id IN NUMBER,
164 x_advance_rent OUT NOCOPY NUMBER,
165 x_security_deposit OUT NOCOPY NUMBER,
166 x_interest_type OUT NOCOPY NUMBER)
167 RETURN VARCHAR2;
168
169 -- Returns Insurance Lapsed Y/N
170 FUNCTION get_insurance_lapse(
171 p_contract_id IN NUMBER,
172 x_insurance_lapse_yn OUT NOCOPY VARCHAR2)
173 RETURN VARCHAR2;
174
175 -- Returns Unrefunded Cures
176 /*FUNCTION get_unrefunded_cures(
177 p_contract_id IN NUMBER,
178 x_unrefunded_cures OUT NOCOPY NUMBER)
179 RETURN VARCHAR2;*/
180
181 -- Returns Fair market Value
182 FUNCTION get_fair_market_value(
183 p_contract_id IN NUMBER,
184 x_fair_market_value OUT NOCOPY NUMBER)
185 RETURN VARCHAR2;
186
187 -- Returns net book Value
188 FUNCTION get_net_book_value(
189 p_contract_id IN NUMBER,
190 x_net_book_value OUT NOCOPY NUMBER)
191 RETURN VARCHAR2;
192
193 /* Returns contractual interest
194 Need to implement interest calculation as a Formula at
195 contract level */
196 FUNCTION get_interest(
197 p_contract_id IN NUMBER,
198 x_interest OUT NOCOPY NUMBER)
199 RETURN VARCHAR2;
200
201 ---------------------------------------------------------------------------
202 -- FUNCTION get_immediate_repurchase_yn
203 ---------------------------------------------------------------------------
204 -- Get Rule value for 'Request Immediate Repurchase' Returns Y/N
205 FUNCTION get_immediate_repurchase_yn(
206 p_contract_id IN NUMBER,
207 x_value OUT NOCOPY VARCHAR2)
208 RETURN VARCHAR2;
209
210 ---------------------------------------------------------------------------
211 -- FUNCTION get_asset_value
212 -- Returns Asset value for a given asset ID and valuation type
213 -- The valid valuation type are,
214 -- FMV - Fair Market Value
215 -- FLV - Forced Liquidation Value
216 -- OLV - Orderly Liquidation Value
217 ---------------------------------------------------------------------------
218 FUNCTION get_asset_value(
219 p_asset_id IN NUMBER,
220 p_asset_valuation_type IN VARCHAR2
221 )
222 RETURN NUMBER;
223
224 ---------------------------------------------------------------------------
225 -- FUNCTION get_notice_of_assignment_yn
226 ---------------------------------------------------------------------------
227 FUNCTION get_notice_of_assignment_yn(
228 p_contract_id IN NUMBER,
229 x_assignment_yn OUT NOCOPY VARCHAR2)
230 RETURN VARCHAR2;
231
232 END OKL_CONTRACT_INFO;