1 Package hr_asg_budget_value_api AUTHID CURRENT_USER as
2 /* $Header: peabvapi.pkh 120.1 2005/10/02 02:09:07 aroussel $ */
3 /*#
4 * This package maintains assignment budget values.
5 * @rep:scope public
6 * @rep:product per
7 * @rep:displayname Assignment Budget Value
8 */
9 --
10 -- ----------------------------------------------------------------------------
11 -- |-------------------------< create_asg_budget_value >----------------------|
12 -- ----------------------------------------------------------------------------
13 --
14 -- {Start Of Comments}
15 /*#
16 * This API creates an assignment budget value.
17 *
18 * An assignment budget value gives information on how much that assignment is
19 * contributing to your enterprise. It has an associated unit; example values
20 * are 'Full Time Equivalent', 'Headcount', 'Percentage Full Time'. Assignment
21 * budget values are used primarily in reporting.
22 *
23 * <p><b>Licensing</b><br>
24 * This API is licensed for use with Human Resources.
25 *
26 * <p><b>Prerequisites</b><br>
27 * A valid assignment must exist on the effective date
28 *
29 * <p><b>Post Success</b><br>
30 * An assignment budget value will be created.
31 *
32 * <p><b>Post Failure</b><br>
33 * An assignment budget value will not be created and an error will be raised.
34 * @param p_validate If true, then validation alone will be performed and the
35 * database will remain unchanged. If false and all validation checks pass,
36 * then the database will be modified.
37 * @param p_effective_date Reference date for validating lookup values are
38 * applicable during the start to end active date range. This date does not
39 * determine when the changes take effect.
40 * @param p_business_group_id Uniquely identifies the business group to create
41 * the assignment budget value within. Must match the business group of the
42 * parent assignment.
43 * @param p_assignment_id Uniquely identifies the assignment with which the new
44 * assignment budget value will be associated.
45 * @param p_unit The unit of the budget value. Valid values are defined by the
46 * lookup type 'BUDGET_MEASUREMENT_TYPE'.
47 * @param p_value The actual number of units that this assignment budget value
48 * represents.
49 * @param p_request_id When the API is executed from a concurrent program set
50 * to the concurrent request identifier.
51 * @param p_program_application_id When the API is executed from a concurrent
52 * program set to the program's Application.
53 * @param p_program_id When the API is executed from a concurrent program set
54 * to the program's identifier.
55 * @param p_program_update_date When the API is executed from a concurrent
56 * program set to when the program was ran.
57 * @param p_last_update_date Not used
58 * @param p_last_updated_by Not used
59 * @param p_last_update_login Not used
60 * @param p_created_by Not used
61 * @param p_creation_date Not used
62 * @param p_object_version_number If p_validate is false, then set to the
63 * version number of the created assignment budget value. If p_validate is
64 * true, then the value will be null.
65 * @param p_assignment_budget_value_id If p_validate is false, then this
66 * uniquely identifies the created assignment budget value. If p_validate is
67 * true, then set to null.
68 * @rep:displayname Create Assignment Budget Value
69 * @rep:category BUSINESS_ENTITY HR_BUDGET
70 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
71 * @rep:scope public
72 * @rep:lifecycle active
73 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
74 */
75 --
76 -- {End Of Comments}
77 --
78 procedure CREATE_ASG_BUDGET_VALUE
79 (p_validate in boolean default false
80 ,p_effective_date in date
81 ,p_business_group_id in number
82 ,p_assignment_id in number
83 ,p_unit in varchar2
84 ,p_value in number
85 ,p_request_id in number default null
86 ,p_program_application_id in number default null
87 ,p_program_id in number default null
88 ,p_program_update_date in date default null
89 ,p_last_update_date in date default null
90 ,p_last_updated_by in number default null
91 ,p_last_update_login in number default null
92 ,p_created_by in number default null
93 ,p_creation_date in date default null
94 ,p_object_version_number out nocopy number
95 ,p_assignment_budget_value_id out nocopy number
96 );
97 --
98 -- ----------------------------------------------------------------------------
99 -- |-------------------------< update_asg_budget_value >----------------------|
100 -- ----------------------------------------------------------------------------
101 --
102 -- {Start Of Comments}
103 /*#
104 * This API updates an assignment budget value.
105 *
106 * An assignment budget value gives information on how much that assignment is
107 * contributing to your enterprise. It has an associated unit; example values
108 * are 'Full Time Equivalent', 'Headcount', 'Percentage Full Time'. Assignment
109 * budget values are used primarily in reporting.
110 *
111 * <p><b>Licensing</b><br>
112 * This API is licensed for use with Human Resources.
113 *
114 * <p><b>Prerequisites</b><br>
115 * An assignment budget value must exist
116 *
117 * <p><b>Post Success</b><br>
118 * An assignment budget value will be updated.
119 *
120 * <p><b>Post Failure</b><br>
121 * An assignment budget value will not be updated and an error will be raised.
122 * @param p_validate If true, then validation alone will be performed and the
123 * database will remain unchanged. If false and all validation checks pass,
124 * then the database will be modified.
125 * @param p_assignment_budget_value_id Uniquely identifies the assignment
126 * budget value to be updated.
127 * @param p_effective_date Determines when the DateTrack operation comes into
128 * force.
129 * @param p_datetrack_mode Indicates which DateTrack mode to use when updating
130 * the record. You must set to either UPDATE, CORRECTION, UPDATE_OVERRIDE or
131 * UPDATE_CHANGE_INSERT. Modes available for use with a particular record
132 * depend on the dates of previous record changes and the effective date of
133 * this change.
134 * @param p_business_group_id Uniquely identifies the business group to update
135 * the assignment budget value within. Must match the business group of the
136 * parent assignment.
137 * @param p_unit The unit of the budget value. Valid values are defined by the
138 * lookup type 'BUDGET_MEASUREMENT_TYPE'.
139 * @param p_value The actual number of units that this assignment budget value
140 * represents.
141 * @param p_request_id When the API is executed from a concurrent program set
142 * to the concurrent request identifier.
143 * @param p_program_application_id When the API is executed from a concurrent
144 * program set to the program's Application.
145 * @param p_program_id When the API is executed from a concurrent program set
146 * to the program's identifier.
147 * @param p_program_update_date When the API is executed from a concurrent
148 * program set to when the program was ran.
149 * @param p_last_update_date Not used
150 * @param p_last_updated_by Not used
151 * @param p_last_update_login Not used
152 * @param p_created_by Not used
153 * @param p_creation_date Not used
154 * @param p_object_version_number Pass in the current version number of the
155 * assignment budget value to be updated. When the API completes if p_validate
156 * is false, will be set to the new version number of the updated assignment
157 * budget value. If p_validate is true will be set to the same value which was
158 * passed in.
159 * @rep:displayname Update Assignment Budget Value
160 * @rep:category BUSINESS_ENTITY HR_BUDGET
161 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
162 * @rep:scope public
163 * @rep:lifecycle active
164 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
165 */
166 --
167 -- {End Of Comments}
168 --
169 procedure UPDATE_ASG_BUDGET_VALUE
170 (p_validate in boolean default false
171 ,p_assignment_budget_value_id in number
172 ,p_effective_date in date
173 ,p_datetrack_mode in varchar2
174 ,p_business_group_id in number default hr_api.g_number
175 ,p_unit in varchar2 default hr_api.g_varchar2
176 ,p_value in number default hr_api.g_number
177 ,p_request_id in number default hr_api.g_number
178 ,p_program_application_id in number default hr_api.g_number
179 ,p_program_id in number default hr_api.g_number
180 ,p_program_update_date in date default hr_api.g_date
181 ,p_last_update_date in date default hr_api.g_date
182 ,p_last_updated_by in number default hr_api.g_number
183 ,p_last_update_login in number default hr_api.g_number
184 ,p_created_by in number default hr_api.g_number
185 ,p_creation_date in date default hr_api.g_date
186 ,p_object_version_number in out nocopy number
187 );
188 --
189 -- ----------------------------------------------------------------------------
190 -- |-------------------------< delete_asg_budget_value >----------------------|
191 -- ----------------------------------------------------------------------------
192 --
193 -- {Start Of Comments}
194 /*#
195 * Deletes an assignment budget value.
196 *
197 *
198 * <p><b>Licensing</b><br>
199 * This API is licensed for use with Human Resources.
200 *
201 * <p><b>Prerequisites</b><br>
202 * An assignment budget value must exist
203 *
204 * <p><b>Post Success</b><br>
205 * An assignment budget value will be deleted
206 *
207 * <p><b>Post Failure</b><br>
208 * An assignment budget value will not be deleted and an error will be raised.
209 * @param p_validate If true, then validation alone will be performed and the
210 * database will remain unchanged. If false and all validation checks pass,
211 * then the database will be modified.
212 * @param p_assignment_budget_value_id Uniquely identifies the assignment
213 * budget value to be deleted.
214 * @param p_effective_date Determines when the DateTrack operation comes into
215 * force.
216 * @param p_datetrack_mode Indicates which DateTrack mode to use when deleting
217 * the record. You must set to either ZAP, DELETE, FUTURE_CHANGE or
218 * DELETE_NEXT_CHANGE. Modes available for use with a particular record depend
219 * on the dates of previous record changes and the effective date of this
220 * change.
221 * @param p_object_version_number Current version number of the assignment
222 * budget value to be deleted.
223 * @rep:displayname Delete Assignment Budget Value
224 * @rep:category BUSINESS_ENTITY HR_BUDGET
225 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
226 * @rep:scope public
227 * @rep:lifecycle active
228 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
229 */
230 --
231 -- {End Of Comments}
232 --
233 procedure DELETE_ASG_BUDGET_VALUE
234 (p_validate in boolean default false
235 ,p_assignment_budget_value_id in number
236 ,p_effective_date in date
237 ,p_datetrack_mode in varchar2
238 ,p_object_version_number in out nocopy number
239 );
240 --
241 end hr_asg_budget_value_api;
[Home] [Help]