1 PACKAGE PA_FP_CALC_PLAN_PUB AUTHID CURRENT_USER AS
2 /* $Header: PAFPCPUS.pls 120.2 2006/07/20 09:20:34 psingara noship $*/
3 /*#
4 * This package contains the APIs that are used for refreshing conversion/cost rates for workplan and financial plan.
5 * @rep:scope public
6 * @rep:product PA
7 * @rep:lifecycle active
8 * @rep:displayname Refresh Rates
9 * @rep:compatibility S
10 * @rep:category BUSINESS_ENTITY PA_BUDGET
11 * @rep:category BUSINESS_ENTITY PA_PROJECT
12 * @rep:category BUSINESS_ENTITY PA_FORECAST
13 * @rep:doccd 120pjapi.pdf See the Oracle Projects API's, Client Extensions, and Open Interfaces Reference
14 */
15
16 /*
17 Procedure: Refresh_Rates
18 ------------------------
19 Description:
20 ------------
21 This public AMG API refreshes the cost rates or conversion rates (depending
22 on the IN parameters) of either all the planning resources in the entire
23 budget version or specific planning resources in the budget version.
24 It supports both Workplan and Financial structures, and it performs all
25 validation and security checks before refreshing rates.
26 */
27
28 /*#
29 * This API is used to refresh the cost rates and conversion rates (depending on the IN parameters) of either
30 * all the planning resources in the entire budget version or specific planning resources in the budget version.
31 * It supports both the workplan and financial plan structures, and it performs all validation and security checks before
32 * refreshing rates.
33 * @param p_api_version_number API standard: version number
34 * @rep:paraminfo {@rep:required}
35 * @param p_init_msg_list API standard (default = F): indicates if message stack will be initialized
36 * @param p_commit API standard (default = F): indicates if the transaction will be committed
37 * @param p_pm_product_code Code identifying the external system
38 * @rep:paraminfo {@rep:required}
39 * @param p_project_id Identifier of the project
40 * @param p_pm_project_reference The reference code that uniquely identifies the project in the external system
41 * @param p_update_plan_type The type of plan to be updated. Accepted values are WORKPLAN or FINPLAN
42 * @rep:paraminfo {@rep:required}
43 * @param p_structure_version_id Identifier of the workplan structure version. A value must be supplied if the value of P_UPDATE_PLAN_TYPE is WORKPLAN
44 * @param p_budget_version_number The version number for the budget
45 * @param p_version_type The budget version type. The valid values are COST, REVENUE, and ALL
46 * @param p_finplan_type_id The identifier of the financial plan type
47 * @param p_finplan_type_name The name of the financial plan type
48 * @param p_resource_class_code_tab The resource class codes. If this parameter has a value, only the planning resource assignments in the specified resource classes are refreshed.
49 * @param p_resource_asgn_id_tab The planning resource assignments. If this parameter ihas a value, only the specified planning resource assignments are refreshed.
50 * @param p_txn_curr_code_tab The transaction currency code. If this parameter has a value, only amounts in the specified transaction currencies are refreshed.
51 * @param p_refresh_cost_bill_rates_flag Flag indicating if cost and bill rates are refreshed. Accepted values are Y and N.
52 * @param p_refresh_conv_rates_flag Flag indicating if conversion rates are refreshed. Accepted values are Y and N.
53 * @param p_budget_version_id Identifier of the budget version
54 * @param x_return_status API standard: return status of the API (success/failure/unexpected error)
55 * @param x_msg_count API standard: number of error messages
56 * @param x_msg_data API standard: error message
57 * @rep:paraminfo {@rep:precision 2000}
58 * @rep:scope public
59 * @rep:lifecycle active
60 * @rep:displayname Refresh Rates
61 * @rep:compatibility S
62 */
63 PROCEDURE REFRESH_RATES
64 (
65 p_api_version_number IN NUMBER := 1.0
66 , p_init_msg_list IN VARCHAR2 := FND_API.G_FALSE
67 , p_commit IN VARCHAR2 := FND_API.G_FALSE
68 , p_pm_product_code IN VARCHAR2 := PA_INTERFACE_UTILS_PUB.G_PA_MISS_CHAR
69 , p_project_id IN NUMBER := PA_INTERFACE_UTILS_PUB.G_PA_MISS_NUM
70 , p_pm_project_reference IN VARCHAR2 := PA_INTERFACE_UTILS_PUB.G_PA_MISS_CHAR
71 , p_update_plan_type IN VARCHAR2
72 , p_structure_version_id IN NUMBER := PA_INTERFACE_UTILS_PUB.G_PA_MISS_NUM
73 , p_budget_version_number IN PA_BUDGET_VERSIONS.version_number%TYPE := PA_INTERFACE_UTILS_PUB.G_PA_MISS_NUM
74 , p_version_type IN PA_BUDGET_VERSIONS.version_type%TYPE := PA_INTERFACE_UTILS_PUB.G_PA_MISS_CHAR
75 , p_finplan_type_id IN PA_BUDGET_VERSIONS.fin_plan_type_id%TYPE := PA_INTERFACE_UTILS_PUB.G_PA_MISS_NUM
76 , p_finplan_type_name IN PA_FIN_PLAN_TYPES_VL.name%TYPE := PA_INTERFACE_UTILS_PUB.G_PA_MISS_CHAR
77 , p_resource_class_code_tab IN SYSTEM.PA_VARCHAR2_30_TBL_TYPE := SYSTEM.PA_VARCHAR2_30_TBL_TYPE()
78 , p_resource_asgn_id_tab IN SYSTEM.PA_NUM_TBL_TYPE := SYSTEM.PA_NUM_TBL_TYPE()
79 , p_txn_curr_code_tab IN SYSTEM.PA_VARCHAR2_15_TBL_TYPE := SYSTEM.PA_VARCHAR2_15_TBL_TYPE()
80 , p_refresh_cost_bill_rates_flag IN VARCHAR2 := 'N'
81 , p_refresh_conv_rates_flag IN VARCHAR2 := 'N'
82 , p_budget_version_id IN NUMBER := PA_INTERFACE_UTILS_PUB.G_PA_MISS_NUM
83 , x_return_status OUT VARCHAR2
84 , x_msg_count OUT NUMBER
85 , x_msg_data OUT VARCHAR2
86 );
87 END PA_FP_CALC_PLAN_PUB;
[Home] [Help]