1 Package pqh_budget_fund_srcs_api as
2 /* $Header: pqbfsapi.pkh 120.1 2005/10/02 02:25:46 aroussel $ */
3 /*#
4 * This package contains APIs to create, update and delete the Budget Costing
5 * Information.
6 * @rep:scope public
7 * @rep:product per
8 * @rep:displayname Budget Fund Source
9 */
10 --
11 -- ----------------------------------------------------------------------------
12 -- |--------------------------< create_budget_fund_src >----------------------|
13 -- ----------------------------------------------------------------------------
14 --
15 -- {Start Of Comments}
16 /*#
17 * This API creates the budget funding source.
18 *
19 * Budget Cost allocation information is created or PTEAO information is
20 * created.
21 *
22 * <p><b>Licensing</b><br>
23 * This API is licensed for use with Human Resources.
24 *
25 * <p><b>Prerequisites</b><br>
26 * Budget element should already exist. Cost allocation key flexfield or PTEAO
27 * information should already exist.
28 *
29 * <p><b>Post Success</b><br>
30 * Budget funding source for an element will be created in the database.
31 *
32 * <p><b>Post Failure</b><br>
33 * Budget funding source for an element will not be created and an error will
34 * be raised.
35 * @param p_validate If true, then validation alone will be performed and the
36 * database will remain unchanged. If false and all validation checks pass,
37 * then the database will be modified.
38 * @param p_budget_fund_src_id If p_validate is false, then this uniquely
39 * identifies the budget source fund created. If p_validate is true, then set
40 * to null.
41 * @param p_budget_element_id {@rep:casecolumn
42 * PQH_BUDGET_FUND_SRCS.BUDGET_ELEMENT_ID}
43 * @param p_cost_allocation_keyflex_id {@rep:casecolumn
44 * PQH_BUDGET_FUND_SRCS.COST_ALLOCATION_KEYFLEX_ID}
45 * @param p_project_id {@rep:casecolumn PQH_BUDGET_FUND_SRCS.PROJECT_ID}
46 * @param p_award_id {@rep:casecolumn PQH_BUDGET_FUND_SRCS.AWARD_ID}
47 * @param p_task_id {@rep:casecolumn PQH_BUDGET_FUND_SRCS.TASK_ID}
48 * @param p_expenditure_type {@rep:casecolumn
49 * PQH_BUDGET_FUND_SRCS.EXPENDITURE_TYPE}
50 * @param p_organization_id {@rep:casecolumn
51 * PQH_BUDGET_FUND_SRCS.ORGANIZATION_ID}
52 * @param p_distribution_percentage Percentage of budget element value given
53 * for funding source.
54 * @param p_object_version_number If p_validate is false, then set to the
55 * version number of the created budget source fund. If p_validate is true,
56 * then the value will be null.
57 * @rep:displayname Create Budget Fund Source
58 * @rep:category BUSINESS_ENTITY HR_BUDGET
59 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
60 * @rep:scope public
61 * @rep:lifecycle active
62 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
63 */
64 --
65 -- {End Of Comments}
66 --
67 procedure create_budget_fund_src
68 (
69 p_validate in boolean default false
70 ,p_budget_fund_src_id out nocopy number
71 ,p_budget_element_id in number default null
72 ,p_cost_allocation_keyflex_id in number default null
73 ,p_project_id in number default null
74 ,p_award_id in number default null
75 ,p_task_id in number default null
76 ,p_expenditure_type in varchar2 default null
77 ,p_organization_id in number default null
78 ,p_distribution_percentage in number default null
79 ,p_object_version_number out nocopy number
80 );
81 --
82 -- ----------------------------------------------------------------------------
83 -- |--------------------------< update_budget_fund_src >----------------------|
84 -- ----------------------------------------------------------------------------
85 --
86 -- {Start Of Comments}
87 /*#
88 * This API updates the budget funding source.
89 *
90 * Budget cost allocation information is updated or PTEAO information is
91 * updated.
92 *
93 * <p><b>Licensing</b><br>
94 * This API is licensed for use with Human Resources.
95 *
96 * <p><b>Prerequisites</b><br>
97 * Budget funding source to be updated should exist.
98 *
99 * <p><b>Post Success</b><br>
100 * Budget funding source for a element will be updated in the database.
101 *
102 * <p><b>Post Failure</b><br>
103 * Budget funding source for a element will not be updated and an error will be
104 * raised.
105 * @param p_validate If true, then validation alone will be performed and the
106 * database will remain unchanged. If false and all validation checks pass,
107 * then the database will be modified.
108 * @param p_budget_fund_src_id Identifies the budget fund source to be updated.
109 * @param p_budget_element_id {@rep:casecolumn
110 * PQH_BUDGET_FUND_SRCS.BUDGET_ELEMENT_ID}
111 * @param p_cost_allocation_keyflex_id {@rep:casecolumn
112 * PQH_BUDGET_FUND_SRCS.COST_ALLOCATION_KEYFLEX_ID}
113 * @param p_project_id {@rep:casecolumn PQH_BUDGET_FUND_SRCS.PROJECT_ID}
114 * @param p_award_id {@rep:casecolumn PQH_BUDGET_FUND_SRCS.AWARD_ID}
115 * @param p_task_id {@rep:casecolumn PQH_BUDGET_FUND_SRCS.TASK_ID}
116 * @param p_expenditure_type {@rep:casecolumn
117 * PQH_BUDGET_FUND_SRCS.EXPENDITURE_TYPE}
118 * @param p_organization_id {@rep:casecolumn
119 * PQH_BUDGET_FUND_SRCS.ORGANIZATION_ID}
120 * @param p_distribution_percentage Percentage of budget element value given
121 * for funding source.
122 * @param p_object_version_number Pass in the current version number of the
123 * budget funding source to be updated. When the API completes if p_validate is
124 * false, will be set to the new version number of the updated budget funding
125 * source. If p_validate is true will be set to the same value which was passed
126 * in.
127 * @rep:displayname Update Budget Fund Source
128 * @rep:category BUSINESS_ENTITY HR_BUDGET
129 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
130 * @rep:scope public
131 * @rep:lifecycle active
132 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
133 */
134 --
135 -- {End Of Comments}
136 --
137 procedure update_budget_fund_src
138 (
139 p_validate in boolean default false
140 ,p_budget_fund_src_id in number
141 ,p_budget_element_id in number default hr_api.g_number
142 ,p_cost_allocation_keyflex_id in number default hr_api.g_number
143 ,p_project_id in number default hr_api.g_number
144 ,p_award_id in number default hr_api.g_number
145 ,p_task_id in number default hr_api.g_number
146 ,p_expenditure_type in varchar2 default hr_api.g_varchar2
147 ,p_organization_id in number default hr_api.g_number
148 ,p_distribution_percentage in number default hr_api.g_number
149 ,p_object_version_number in out nocopy number
150 );
151 --
152 -- ----------------------------------------------------------------------------
153 -- |--------------------------< delete_budget_fund_src >----------------------|
154 -- ----------------------------------------------------------------------------
155 --
156 -- {Start Of Comments}
157 /*#
158 * This API deletes the budget funding source.
159 *
160 * Budget cost allocation information is deleted or PTEAO information is
161 * deleted.
162 *
163 * <p><b>Licensing</b><br>
164 * This API is licensed for use with Human Resources.
165 *
166 * <p><b>Prerequisites</b><br>
167 * Budget funding source to be deleted should exist.
168 *
169 * <p><b>Post Success</b><br>
170 * Budget funding source for a element will be deleted in the database.
171 *
172 * <p><b>Post Failure</b><br>
173 * Budget funding source for a element will not be deleted and an error will be
174 * raised.
175 * @param p_validate If true, then validation alone will be performed and the
176 * database will remain unchanged. If false and all validation checks pass,
177 * then the database will be modified.
178 * @param p_budget_fund_src_id This uniquely identifies the budget funding
179 * source
180 * @param p_object_version_number Current version number of the budget funding
181 * source to be deleted.
182 * @rep:displayname Delete Budget Fund Source
183 * @rep:category BUSINESS_ENTITY HR_BUDGET
184 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
185 * @rep:scope public
186 * @rep:lifecycle active
187 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
188 */
189 --
190 -- {End Of Comments}
191 --
192 procedure delete_budget_fund_src
193 (
194 p_validate in boolean default false
195 ,p_budget_fund_src_id in number
196 ,p_object_version_number in number
197 );
198 --
199 end pqh_budget_fund_srcs_api;
[Home] [Help]