1 PACKAGE pa_client_extn_budget_wf AUTHID CURRENT_USER AS
2 /* $Header: PAWFBCES.pls 120.3 2006/07/05 06:13:15 psingara noship $ */
3 /*#
4 * This extension enables you to customize the workflow processes for changing the status of a budget.
5 * @rep:scope public
6 * @rep:product PA
7 * @rep:lifecycle active
8 * @rep:displayname Budget Workflow
9 * @rep:compatibility S
10 * @rep:category BUSINESS_ENTITY PA_PROJECT
11 * @rep:category BUSINESS_ENTITY PA_BUDGET
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 * When Oracle Projects determines whether to call Oracle Workflow for a budget status change, it bases the decision on the settings in the budget
17 * type and the project type.
18 * @param p_draft_version_id The identifier of the draft version
19 * @rep:paraminfo {@rep:required}
20 * @param p_project_id The identifier of the project
21 * @rep:paraminfo {@rep:required}
22 * @param p_budget_type_code The budge type code
23 * @rep:paraminfo {@rep:required}
24 * @param p_pm_product_code The project management product code
25 * @rep:paraminfo {@rep:required}
26 * @param p_fin_plan_type_id Identifier for the financial plan type
27 * @param p_version_type The type of version
28 * @param p_result Result of the procedure. Value is either Y or N.
29 * @rep:paraminfo {@rep:required}
30 * @param p_err_code Error handling code
31 * @rep:paraminfo {@rep:required}
32 * @param p_err_stage Error handling stage
33 * @rep:paraminfo {@rep:required}
34 * @param p_err_stack Error handling stack
35 * @rep:paraminfo {@rep:required}
36 * @rep:scope public
37 * @rep:lifecycle active
38 * @rep:displayname Budget Workflow Creation
39 * @rep:compatibility S
40 */
41 PROCEDURE Budget_WF_Is_Used
42 (p_draft_version_id IN NUMBER
43 , p_project_id IN NUMBER
44 , p_budget_type_code IN VARCHAR2
45 , p_pm_product_code IN VARCHAR2
46 , p_fin_plan_type_id IN NUMBER default NULL
47 , p_version_type IN VARCHAR2 default NULL
48 , p_result IN OUT NOCOPY VARCHAR2 --File.Sql.39 bug 4440895
49 , p_err_code IN OUT NOCOPY NUMBER --File.Sql.39 bug 4440895
50 , p_err_stage IN OUT NOCOPY VARCHAR2 --File.Sql.39 bug 4440895
51 , p_err_stack IN OUT NOCOPY VARCHAR2 --File.Sql.39 bug 4440895
52 );
53 /*#
54 * This procedure starts the workflow process for the budget status changes.
55 * @param p_draft_version_id The identifier of the draft version
56 * @rep:paraminfo {@rep:required}
57 * @param p_project_id The identifier of the project
58 * @rep:paraminfo {@rep:required}
59 * @param p_budget_type_code The budge type code
60 * @rep:paraminfo {@rep:required}
61 * @param p_mark_as_original Marks as original request
62 * @rep:paraminfo {@rep:required}
63 * @param p_fck_req_flag Flag indicating if fund checking is required
64 * @param p_bgt_intg_flag Flag indicating if budgetary control is enabled
65 * @param p_fin_plan_type_id The identifier for financial plan type
66 * @param p_version_type The type of version
67 * @param p_item_type The type of item
68 * @rep:paraminfo {@rep:required}
69 * @param p_item_key The item key
70 * @rep:paraminfo {@rep:required}
71 * @param p_err_code Error handling code
72 * @rep:paraminfo {@rep:required}
73 * @param p_err_stage Error handling stage
74 * @rep:paraminfo {@rep:required}
75 * @param p_err_stack Error handling stack
76 * @rep:paraminfo {@rep:required}
77 * @rep:scope public
78 * @rep:lifecycle active
79 * @rep:displayname Start Budget Workflow
80 * @rep:compatibility S
81 */
82 PROCEDURE Start_Budget_WF
83 (p_draft_version_id IN NUMBER
84 , p_project_id IN NUMBER
85 , p_budget_type_code IN VARCHAR2
86 , p_mark_as_original IN VARCHAR2
87 , p_fck_req_flag IN VARCHAR2 DEFAULT NULL
88 , p_bgt_intg_flag IN VARCHAR2 DEFAULT NULL
89 , p_fin_plan_type_id IN NUMBER default NULL
90 , p_version_type IN VARCHAR2 default NULL
91 , p_item_type OUT NOCOPY VARCHAR2 --File.Sql.39 bug 4440895
92 , p_item_key OUT NOCOPY VARCHAR2 --File.Sql.39 bug 4440895
93 , p_err_code IN OUT NOCOPY NUMBER --File.Sql.39 bug 4440895
94 , p_err_stage IN OUT NOCOPY VARCHAR2 --File.Sql.39 bug 4440895
95 , p_err_stack IN OUT NOCOPY VARCHAR2 --File.Sql.39 bug 4440895
96 );
97
98 /*#
99 * This procedure is called by the Oracle Workflow to determine the budget approver.
100 * @param p_item_type The workflow item type
101 * @rep:paraminfo {@rep:required}
102 * @param p_item_key The workflow item key
103 * @rep:paraminfo {@rep:required}
104 * @param p_project_id Identifier of the project
105 * @rep:paraminfo {@rep:required}
106 * @param p_budget_type_code The budge type code
107 * @rep:paraminfo {@rep:required}
108 * @param p_workflow_started_by_id Identifier of the person who requested the budget status change
109 * @rep:paraminfo {@rep:required}
110 * @param p_fin_plan_type_id The identifier of the financial plan type
111 * @param p_version_type The type of version
112 * @param p_draft_version_id The identifier of the draft version
113 * @param p_budget_baseliner_id Identifier of the person selected to approve the budget status change
114 * @rep:paraminfo {@rep:required}
115 * @rep:scope public
116 * @rep:lifecycle active
117 * @rep:displayname Select Budget Approver
118 * @rep:compatibility S
119 */
120 PROCEDURE Select_Budget_Approver
121 (p_item_type IN VARCHAR2
122 , p_item_key IN VARCHAR2
123 , p_project_id IN NUMBER
124 , p_budget_type_code IN VARCHAR2
125 , p_workflow_started_by_id IN NUMBER
126 , p_fin_plan_type_id IN NUMBER default NULL
127 , p_version_type IN VARCHAR2 default NULL
128 , p_draft_version_id IN NUMBER default NULL
129 , p_budget_baseliner_id OUT NOCOPY NUMBER --File.Sql.39 bug 4440895
130 );
131
132 /*#
133 * This procedure enables you to create validations that Oracle Projects performs whenever a budget or forecast is submitted or baselined.
134 * @param p_item_type The workflow item type
135 * @rep:paraminfo {@rep:required}
136 * @param p_item_key The workflow item key
137 * @rep:paraminfo {@rep:required}
138 * @param p_project_id Identifier of the project
139 * @rep:paraminfo {@rep:required}
140 * @param p_budget_type_code The budge type code
141 * @rep:paraminfo {@rep:required}
142 * @param p_workflow_started_by_id Identifier of the person who requested the budget status change
143 * @rep:paraminfo {@rep:required}
144 * @param p_event Identifies the requested status of the budget. Value is either SUBMIT or BASELINE.
145 * @rep:paraminfo {@rep:required}
146 * @param p_fin_plan_type_id The identifier of the financial plan type
147 * @param p_version_type The type of version
148 * @param p_warnings_only_flag Flag indicating the level of errors the procedure generated. Y indicates that only warnings were generated. N indicates that errors were generated.
149 * @rep:paraminfo {@rep:required}
150 * @param p_err_msg_count The number of warnings and errors the procedure generated
151 * @rep:paraminfo {@rep:required}
152 * @rep:scope public
153 * @rep:lifecycle active
154 * @rep:displayname Verify Budget Rules
155 * @rep:compatibility S
156 */
157 PROCEDURE Verify_Budget_Rules
158 (p_item_type IN VARCHAR2
159 , p_item_key IN VARCHAR2
160 , p_project_id IN NUMBER
161 , p_budget_type_code IN VARCHAR2
162 , p_workflow_started_by_id IN NUMBER
163 , p_event IN VARCHAR2
164 , p_fin_plan_type_id IN NUMBER default NULL
165 , p_version_type IN VARCHAR2 default NULL
166 , p_warnings_only_flag OUT NOCOPY VARCHAR2 --File.Sql.39 bug 4440895
167 , p_err_msg_count OUT NOCOPY NUMBER --File.Sql.39 bug 4440895
168 );
169
170
171 END pa_client_extn_budget_wf;
[Home] [Help]