1 Package pay_user_column_instance_api AUTHID CURRENT_USER as
2 /* $Header: pyuciapi.pkh 120.1 2005/10/02 02:34 aroussel $ */
3 /*#
4 * This package contains the User Column Instance APIs.
5 * @rep:scope public
6 * @rep:product per
7 * @rep:displayname User Column Instance
8 */
9 --
10 -- ----------------------------------------------------------------------------
11 -- |-----------------------< create_user_column_instance >--------------------|
12 -- ----------------------------------------------------------------------------
13 --
14 -- {Start Of Comments}
15 /*#
16 * This API creates a user column instance.
17 *
18 *
19 * <p><b>Licensing</b><br>
20 * This API is licensed for use with Human Resources.
21 *
22 * <p><b>Prerequisites</b><br>
23 * A valid user row identified by p_user_row_id and a valid user column
24 * identified by p_user_column_id must exist. The p_business_group_id and
25 * p_legislation_code for this row must be consistent with the parent rows
26 * identified by p_user_row_id and p_user_column_id.
27 *
28 * <p><b>Post Success</b><br>
29 * The user column instance will be successfully inserted into the database.
30 *
31 * <p><b>Post Failure</b><br>
32 * The user column instance will not be created and an error will be raised.
33 * @param p_validate If true, then validation alone will be performed and the
34 * database will remain unchanged. If false and all validation checks pass,
35 * then the database will be modified.
36 * @param p_effective_date Determines when the DateTrack operation comes into
37 * force.
38 * @param p_user_row_id User Row ID.
39 * @param p_user_column_id User Column ID.
40 * @param p_value Stored value.
41 * @param p_business_group_id The user column instance's business group.
42 * @param p_legislation_code The user column instance's legislation.
43 * @param p_user_column_instance_id If p_validate is false, this uniquely
44 * identifies the user column instance created. If p_validate is true this
45 * parameter will be null.
46 * @param p_object_version_number If p_validate is false, then set to the
47 * version number of the created user column instance. If p_validate is true,
48 * then the value will be null.
49 * @param p_effective_start_date If p_validate is false, then set to the
50 * earliest effective start date for the created user column instance. If
51 * p_validate is true, then set to null.
52 * @param p_effective_end_date If p_validate is false, then set to the
53 * effective end date for the created user column instance. If p_validate is
54 * true, then set to null.
55 * @rep:displayname Create User Column Instance
56 * @rep:category BUSINESS_ENTITY PAY_USER_DEFINED_TABLE
57 * @rep:category MISC_EXTENSIONS HR_DATAPUMP
58 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
59 * @rep:scope public
60 * @rep:lifecycle active
61 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
62 */
63 --
64 -- {End Of Comments}
65 --
66 procedure create_user_column_instance
67 (p_validate in boolean default false
68 ,p_effective_date in date
69 ,p_user_row_id in number
70 ,p_user_column_id in number
71 ,p_value in varchar2 default null
72 ,p_business_group_id in number default null
73 ,p_legislation_code in varchar2 default null
74 ,p_user_column_instance_id out nocopy number
75 ,p_object_version_number out nocopy number
76 ,p_effective_start_date out nocopy date
77 ,p_effective_end_date out nocopy date
78 );
79 --
80 -- ----------------------------------------------------------------------------
81 -- |-----------------------< update_user_column_instance >--------------------|
82 -- ----------------------------------------------------------------------------
83 --
84 -- {Start Of Comments}
85 /*#
86 * This API updates a user column instance.
87 *
88 *
89 * <p><b>Licensing</b><br>
90 * This API is licensed for use with Human Resources.
91 *
92 * <p><b>Prerequisites</b><br>
93 * A valid user column instance identified by p_user_column_instance_id and
94 * p_object_version_number must exist.
95 *
96 * <p><b>Post Success</b><br>
97 * The user column instance will be successfully updated in the database.
98 *
99 * <p><b>Post Failure</b><br>
100 * The user column instance will not be updated and an error will be raised.
101 * @param p_validate If true, then validation alone will be performed and the
105 * force
102 * database will remain unchanged. If false and all validation checks pass,
103 * then the database will be modified.
104 * @param p_effective_date Determines when the DateTrack operation comes into
106 * @param p_user_column_instance_id Identifier of user column instance created.
107 * @param p_datetrack_update_mode Indicates which DateTrack mode to use when
108 * updating the record. You must set to either UPDATE, CORRECTION,
109 * UPDATE_OVERRIDE or UPDATE_CHANGE_INSERT. Modes available for use with a
110 * particular record depend on the dates of previous record changes and the
111 * effective date of this change.
112 * @param p_value Stored value.
113 * @param p_object_version_number Pass in the current version number of the
114 * user column instance to be updated. When the API completes if p_validate is
115 * false, will be set to the new version number of the updated user column
116 * instance. If p_validate is true will be set to the same value which was
117 * passed in
118 * @param p_effective_start_date If p_validate is false, then set to the
119 * effective start date on the updated user column instance row which now
120 * exists as of the effective date. If p_validate is true, then set to null.
121 * @param p_effective_end_date If p_validate is false, then set to the
122 * effective end date on the updated user column instance row which now exists
123 * as of the effective date. If p_validate is true, then set to null.
124 * @rep:displayname Update User Column Instance
125 * @rep:category BUSINESS_ENTITY PAY_USER_DEFINED_TABLE
126 * @rep:category MISC_EXTENSIONS HR_DATAPUMP
127 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
128 * @rep:scope public
129 * @rep:lifecycle active
130 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
131 */
132 --
133 -- {End Of Comments}
134 --
135 procedure update_user_column_instance
136 (p_validate in boolean default false
137 ,p_effective_date in date
138 ,p_user_column_instance_id in number
139 ,p_datetrack_update_mode in varchar2
140 ,p_value in varchar2 default HR_API.G_VARCHAR2
141 ,p_object_version_number in out nocopy number
142 ,p_effective_start_date out nocopy date
143 ,p_effective_end_date out nocopy date
144 );
145 --
146 -- ----------------------------------------------------------------------------
147 -- |-----------------------< delete_user_column_instance >--------------------|
148 -- ----------------------------------------------------------------------------
149 --
150 -- {Start Of Comments}
151 /*#
152 * This API deletes a user column instance.
153 *
154 *
155 * <p><b>Licensing</b><br>
156 * This API is licensed for use with Human Resources.
157 *
158 * <p><b>Prerequisites</b><br>
159 * A valid user column instance identified by p_user_column_instance_id and
160 * p_object_version_number must exist.
161 *
162 * <p><b>Post Success</b><br>
163 * The user column instance will have been successfully deleted from the
164 * database.
165 *
166 * <p><b>Post Failure</b><br>
167 * The user column instance will not be deleted and an error will be raised.
168 * @param p_validate If true, then validation alone will be performed and the
169 * database will remain unchanged. If false and all validation checks pass,
170 * then the database will be modified.
171 * @param p_effective_date Determines when the DateTrack operation comes into
172 * force.
173 * @param p_user_column_instance_id Unique identifier of the user column
174 * instance record.
175 * @param p_datetrack_update_mode Indicates which DateTrack mode to use when
176 * updating the record. You must set to either UPDATE, CORRECTION,
177 * UPDATE_OVERRIDE or UPDATE_CHANGE_INSERT. Modes available for use with a
178 * particular record depend on the dates of previous record changes and the
179 * effective date of this change.
180 * @param p_object_version_number Pass in the current version number of the
181 * user column instance to be deleted. When the API completes if p_validate is
182 * false, will be set to the new version number of the deleted user column
183 * instance. If p_validate is true will be set to the same value which was
184 * passed in.
185 * @param p_effective_start_date If p_validate is false, then set to the
186 * effective start date for the deleted user column instance row which now
187 * exists as of the effective date. If p_validate is true or all row instances
188 * have been deleted then set to null.
189 * @param p_effective_end_date If p_validate is false, then set to the
190 * effective end date for the deleted user column instance row which now exists
191 * as of the effective date. If p_validate is true or all row instances have
192 * been deleted then set to null.
193 * @rep:displayname Delete User Column Instance
194 * @rep:category BUSINESS_ENTITY PAY_USER_DEFINED_TABLE
195 * @rep:category MISC_EXTENSIONS HR_DATAPUMP
196 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
197 * @rep:scope public
198 * @rep:lifecycle active
199 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
200 */
201 --
202 -- {End Of Comments}
203 --
204 procedure delete_user_column_instance
205 (p_validate in boolean default false
206 ,p_effective_date in date
207 ,p_user_column_instance_id in number
208 ,p_datetrack_update_mode in varchar2
209 ,p_object_version_number in out nocopy number
210 ,p_effective_start_date out nocopy date
211 ,p_effective_end_date out nocopy date
212 );
213
214 --
215 end pay_user_column_instance_api;
[Home] [Help]