[Home] [Help]
PACKAGE: APPS.PA_CLIENT_EXTN_CAP_INT
Source
1 PACKAGE PA_CLIENT_EXTN_CAP_INT AS
2 -- $Header: PACINTXS.pls 120.2 2006/07/25 20:42:31 skannoji noship $
3 /*#
4 * This extension enables you to customize the capitalized interest calculation process.
5 * @rep:scope public
6 * @rep:product PA
7 * @rep:lifecycle active
8 * @rep:displayname Capitalized Interest Extension
9 * @rep:compatibility S
10 * @rep:category BUSINESS_ENTITY PA_PROJECT
11 * @rep:category BUSINESS_ENTITY PA_CAPITAL_ASSET
12 * @rep:doccd 120pjapi.pdf See the Oracle Projects API's, Client Extensions, and Open Interfaces Reference
13 */
14
15 /*#
16 * This procedure enables you to define duration and amount thresholds at levels lower than those defined for the operating unit.
17 * @param p_project_id Identifier of the project
18 * @rep:paraminfo {@rep:required}
19 * @param p_task_id Identifier of the task
20 * @rep:paraminfo {@rep:required}
21 * @param p_rate_name Rate name
22 * @rep:paraminfo {@rep:required}
23 * @param p_start_date Start date of the GL period
24 * @rep:paraminfo {@rep:required}
25 * @param p_end_date End date of the GL period
26 * @rep:paraminfo {@rep:required}
27 * @param p_threshold_amt_type Threshold amount type
28 * @rep:paraminfo {@rep:required}
29 * @param p_budget_type Budget type
30 * @rep:paraminfo {@rep:required}
31 * @param p_fin_plan_type_id Identifier of the financial plan type
32 * @rep:paraminfo {@rep:required}
33 * @param p_interest_calc_method Interest calculation method
34 * @rep:paraminfo {@rep:required}
35 * @param p_cip_cost_type CIP cost type
36 * @rep:paraminfo {@rep:required}
37 * @param x_duration_threshold Duration threshold
38 * @rep:paraminfo {@rep:required}
39 * @param x_amt_threshold Amount threshold
40 * @rep:paraminfo {@rep:required}
41 * @param x_return_status API standard: return status of the API (S = success, F = failure, U = unexpected error)
42 * @rep:paraminfo {@rep:required}
43 * @param x_error_msg_count The error message count
44 * @rep:paraminfo {@rep:required}
45 * @param x_error_msg_code The error message code
46 * @rep:paraminfo {@rep:required}
47 * @rep:scope public
48 * @rep:lifecycle active
49 * @rep:displayname Check Thresholds
50 * @rep:compatibility S
51 */
52 PROCEDURE check_thresholds
53 (p_project_id IN NUMBER
54 ,p_task_id IN NUMBER
55 ,p_rate_name IN VARCHAR2
56 ,p_start_date IN DATE
57 ,p_end_date IN DATE
58 ,p_threshold_amt_type IN VARCHAR2
59 ,p_budget_type IN VARCHAR2
60 ,p_fin_plan_type_id IN NUMBER
61 ,p_interest_calc_method IN VARCHAR2
62 ,p_cip_cost_type IN VARCHAR2
63 ,x_duration_threshold IN OUT NOCOPY NUMBER
64 ,x_amt_threshold IN OUT NOCOPY NUMBER
65 ,x_return_status OUT NOCOPY VARCHAR2
66 ,x_error_msg_count OUT NOCOPY NUMBER
67 ,x_error_msg_code OUT NOCOPY VARCHAR2);
68
69 /*#
70 * This function enables you to specify organizations other than source project owning organization or source task owning
71 * organization as the expenditure organization for generated transactions.
72 * @return Returns the expenditure organization
73 * @param p_expenditure_item_id Identifier of the expenditure item
74 * @rep:paraminfo {@rep:required}
75 * @param p_line_num CDL line number
76 * @rep:paraminfo {@rep:required}
77 * @param p_rate_name Rate name
78 * @rep:paraminfo {@rep:required}
79 * @rep:scope public
80 * @rep:lifecycle active
81 * @rep:displayname Expenditure Organization
82 * @rep:compatibility S
83 */
84 FUNCTION expenditure_org
85 (p_expenditure_item_id IN NUMBER
86 ,p_line_num IN NUMBER
87 ,p_rate_name IN VARCHAR2) RETURN NUMBER;
88
89 /*#
90 * This function enables you to define multiple interest rate multipliers based on rate name and task owning organization.
91 * @return Returns the interest rate multiplier
92 * @param p_expenditure_item_id Identifier of the expenditure item
93 * @rep:paraminfo {@rep:required}
94 * @param p_line_num CDL line number
95 * @rep:paraminfo {@rep:required}
96 * @param p_rate_name Rate name
97 * @rep:paraminfo {@rep:required}
98 * @rep:scope public
99 * @rep:lifecycle active
100 * @rep:displayname Rate Multiplier
101 * @rep:compatibility S
102 */
103 FUNCTION rate_multiplier
104 (p_expenditure_item_id IN NUMBER
105 ,p_line_num IN NUMBER
106 ,p_rate_name IN VARCHAR2) RETURN NUMBER;
107
108 /*#
109 * This procedure enables you to redirect capitalized interest transactions to specific tasks.
110 * @param p_source_task_id Identifier of the task
111 * @rep:paraminfo {@rep:required}
112 * @param p_source_task_num Task number
113 * @rep:paraminfo {@rep:required}
114 * @param p_rate_name Rate name
115 * @rep:paraminfo {@rep:required}
116 * @param x_target_task_id Identifier of the target task
117 * @rep:paraminfo {@rep:required}
118 * @param x_target_task_num Target task number
119 * @rep:paraminfo {@rep:required}
120 * @param x_return_status API standard: return status of the API (S = success, F = failure, U = unexpected error)
121 * @rep:paraminfo {@rep:required}
122 * @param x_error_msg_count The error message count
123 * @rep:paraminfo {@rep:required}
124 * @param x_error_msg_code The error message code
125 * @rep:paraminfo {@rep:required}
126 * @rep:scope public
127 * @rep:lifecycle active
128 * @rep:displayname Get Target Task
129 * @rep:compatibility S
130 */
131 PROCEDURE get_target_task
132 (p_source_task_id IN NUMBER
133 ,p_source_task_num IN VARCHAR2
134 ,p_rate_name IN VARCHAR2
135 ,x_target_task_id OUT NOCOPY NUMBER
136 ,x_target_task_num OUT NOCOPY VARCHAR2
137 ,x_return_status OUT NOCOPY VARCHAR2
138 ,x_error_msg_count OUT NOCOPY NUMBER
139 ,x_error_msg_code OUT NOCOPY VARCHAR2);
140
141 /*#
142 * This procedure enables you to control how the transaction attribute columns are populated.
143 * @param p_project_id Identifier of the project
144 * @rep:paraminfo {@rep:required}
145 * @param p_source_task_id Identifier of the task
146 * @rep:paraminfo {@rep:required}
147 * @param p_target_task_id Identifier of the target task
148 * @rep:paraminfo {@rep:required}
149 * @param p_rate_name Rate name
150 * @rep:paraminfo {@rep:required}
151 * @param p_grouping_method Grouping method
152 * @rep:paraminfo {@rep:required}
153 * @param x_attribute_category Descriptive flexfield category
154 * @rep:paraminfo {@rep:required}
155 * @param x_attribute1 Descriptive flexfield segment
156 * @rep:paraminfo {@rep:required}
157 * @param x_attribute2 Descriptive flexfield segment
158 * @rep:paraminfo {@rep:required}
159 * @param x_attribute3 Descriptive flexfield segment
160 * @rep:paraminfo {@rep:required}
161 * @param x_attribute4 Descriptive flexfield segment
162 * @rep:paraminfo {@rep:required}
163 * @param x_attribute5 Descriptive flexfield segment
164 * @rep:paraminfo {@rep:required}
165 * @param x_attribute6 Descriptive flexfield segment
166 * @rep:paraminfo {@rep:required}
167 * @param x_attribute7 Descriptive flexfield segment
168 * @rep:paraminfo {@rep:required}
169 * @param x_attribute8 Descriptive flexfield segment
170 * @rep:paraminfo {@rep:required}
171 * @param x_attribute9 Descriptive flexfield segment
172 * @rep:paraminfo {@rep:required}
173 * @param x_attribute10 Descriptive flexfield segment
174 * @rep:paraminfo {@rep:required}
175 * @param x_return_status API standard: return status of the API (S = success, F = failure, U = unexpected error)
176 * @rep:paraminfo {@rep:required}
177 * @param x_error_msg_count The error message count
178 * @rep:paraminfo {@rep:required}
179 * @param x_error_msg_code The error message code
180 * @rep:paraminfo {@rep:required}
181 * @rep:scope public
182 * @rep:lifecycle active
183 * @rep:displayname Get Transcation Attributes
184 * @rep:compatibility S
185 */
186 PROCEDURE get_txn_attributes
187 (p_project_id IN NUMBER
188 ,p_source_task_id IN NUMBER
189 ,p_target_task_id IN NUMBER
190 ,p_rate_name IN VARCHAR2
191 ,p_grouping_method IN VARCHAR2
192 ,x_attribute_category OUT NOCOPY VARCHAR2
193 ,x_attribute1 OUT NOCOPY VARCHAR2
194 ,x_attribute2 OUT NOCOPY VARCHAR2
195 ,x_attribute3 OUT NOCOPY VARCHAR2
196 ,x_attribute4 OUT NOCOPY VARCHAR2
197 ,x_attribute5 OUT NOCOPY VARCHAR2
198 ,x_attribute6 OUT NOCOPY VARCHAR2
199 ,x_attribute7 OUT NOCOPY VARCHAR2
200 ,x_attribute8 OUT NOCOPY VARCHAR2
201 ,x_attribute9 OUT NOCOPY VARCHAR2
202 ,x_attribute10 OUT NOCOPY VARCHAR2
203 ,x_return_status OUT NOCOPY VARCHAR2
204 ,x_error_msg_count OUT NOCOPY NUMBER
205 ,x_error_msg_code OUT NOCOPY VARCHAR2);
206
207 /*#
208 * This procedure enables you to define calculations for capitalized interest.
209 * @param p_gl_period GL period
210 * @rep:paraminfo {@rep:required}
211 * @param p_rate_name Rate name
212 * @rep:paraminfo {@rep:required}
213 * @param p_curr_period_mult Current period multiplier
214 * @rep:paraminfo {@rep:required}
215 * @param p_period_mult Period multiplier
216 * @rep:paraminfo {@rep:required}
217 * @param p_project_id Identifier of the project
218 * @rep:paraminfo {@rep:required}
219 * @param p_source_task_id Identifier of the task
220 * @rep:paraminfo {@rep:required}
221 * @param p_target_task_id Identifier of the target task
222 * @rep:paraminfo {@rep:required}
223 * @param p_exp_org_id Identifier of the expenditure
224 * @rep:paraminfo {@rep:required}
225 * @param p_exp_item_date Expenditure item date
226 * @rep:paraminfo {@rep:required}
227 * @param p_prior_period_amt Prior basis amount for capitalized interest calculation
228 * @rep:paraminfo {@rep:required}
229 * @param p_curr_period_amt Current basis amount for capitalized interest calculation
230 * @rep:paraminfo {@rep:required}
231 * @param p_grouping_method Grouping method
232 * @rep:paraminfo {@rep:required}
233 * @param p_rate_mult Rate multiplier
234 * @rep:paraminfo {@rep:required}
235 * @param x_cap_int_amt Capitalized interest amount
236 * @rep:paraminfo {@rep:required}
237 * @param x_return_status Error status (0 = successful execution, <0 = Oracle error, >0 = application error)
238 * @rep:paraminfo {@rep:required}
239 * @param x_error_msg_count The error message count
240 * @rep:paraminfo {@rep:required}
241 * @param x_error_msg_code The error message code
242 * @rep:paraminfo {@rep:required}
243 * @rep:scope public
244 * @rep:lifecycle active
245 * @rep:displayname Calculate Capitalized Interest
246 * @rep:compatibility S
247 */
248 PROCEDURE calculate_cap_interest
249 (p_gl_period IN VARCHAR2
250 ,p_rate_name IN VARCHAR2
251 ,p_curr_period_mult IN NUMBER
252 ,p_period_mult IN NUMBER
253 ,p_project_id IN NUMBER
254 ,p_source_task_id IN NUMBER
255 ,p_target_task_id IN NUMBER
256 ,p_exp_org_id IN NUMBER
257 ,p_exp_item_date IN DATE
258 ,p_prior_period_amt IN NUMBER
259 ,p_curr_period_amt IN NUMBER
260 ,p_grouping_method IN VARCHAR2
261 ,p_rate_mult IN NUMBER
262 ,x_cap_int_amt IN OUT NOCOPY NUMBER
263 ,x_return_status OUT NOCOPY VARCHAR2
264 ,x_error_msg_count OUT NOCOPY NUMBER
265 ,x_error_msg_code OUT NOCOPY VARCHAR2);
266
267 /*#
268 * This function enables you to control how the transaction attribute columns are populated.
269 * @return Returns transaction attribute grouping method
270 * @param p_gl_period GL period
271 * @rep:paraminfo {@rep:required}
272 * @param p_project_id Identifier of the project
273 * @rep:paraminfo {@rep:required}
274 * @param p_source_task_id Identifier of the task
275 * @rep:paraminfo {@rep:required}
276 * @param p_expenditure_item_id Identifier of the expenditure item
277 * @rep:paraminfo {@rep:required}
278 * @param p_line_num Line number
279 * @rep:paraminfo {@rep:required}
280 * @param p_expenditure_id Identifier of the expenditure
281 * @rep:paraminfo {@rep:required}
282 * @param p_expenditure_type Expenditure type
283 * @rep:paraminfo {@rep:required}
284 * @param p_expenditure_category Expenditure category
285 * @rep:paraminfo {@rep:required}
286 * @param p_attribute1 Descriptive flexfield segment
287 * @rep:paraminfo {@rep:required}
288 * @param p_attribute2 Descriptive flexfield segment
289 * @rep:paraminfo {@rep:required}
290 * @param p_attribute3 Descriptive flexfield segment
291 * @rep:paraminfo {@rep:required}
292 * @param p_attribute4 Descriptive flexfield segment
293 * @rep:paraminfo {@rep:required}
294 * @param p_attribute5 Descriptive flexfield segment
295 * @rep:paraminfo {@rep:required}
296 * @param p_attribute6 Descriptive flexfield segment
297 * @rep:paraminfo {@rep:required}
298 * @param p_attribute7 Descriptive flexfield segment
299 * @rep:paraminfo {@rep:required}
300 * @param p_attribute8 Descriptive flexfield segment
301 * @rep:paraminfo {@rep:required}
302 * @param p_attribute9 Descriptive flexfield segment
303 * @rep:paraminfo {@rep:required}
304 * @param p_attribute10 Descriptive flexfield segment
305 * @rep:paraminfo {@rep:required}
306 * @param p_attribute_category Descriptive flexfield category
307 * @rep:paraminfo {@rep:required}
308 * @param p_transaction_source Transcation source
309 * @rep:paraminfo {@rep:required}
310 * @param p_rate_name Rate name
311 * @rep:paraminfo {@rep:required}
312 * @rep:scope public
313 * @rep:lifecycle active
314 * @rep:displayname Grouping Method
315 * @rep:compatibility S
316 */
317 FUNCTION grouping_method
318 (p_gl_period IN VARCHAR2
319 ,p_project_id IN NUMBER
320 ,p_source_task_id IN NUMBER
321 ,p_expenditure_item_id IN NUMBER
322 ,p_line_num IN NUMBER
323 ,p_expenditure_id IN NUMBER
324 ,p_expenditure_type IN VARCHAR2
325 ,p_expenditure_category IN VARCHAR2
326 ,p_attribute1 IN VARCHAR2
327 ,p_attribute2 IN VARCHAR2
328 ,p_attribute3 IN VARCHAR2
329 ,p_attribute4 IN VARCHAR2
330 ,p_attribute5 IN VARCHAR2
331 ,p_attribute6 IN VARCHAR2
332 ,p_attribute7 IN VARCHAR2
333 ,p_attribute8 IN VARCHAR2
334 ,p_attribute9 IN VARCHAR2
335 ,p_attribute10 IN VARCHAR2
336 ,p_attribute_category IN VARCHAR2
337 ,p_transaction_source IN VARCHAR2
338 ,p_rate_name IN VARCHAR2) RETURN VARCHAR2;
339
340 END PA_CLIENT_EXTN_CAP_INT ;