1 Package pay_user_column_api AUTHID CURRENT_USER as
2 /* $Header: pypucapi.pkh 120.1 2005/10/02 02:33 aroussel $ */
3 /*#
4 * This API creates a new user column for an user table.
5 * @rep:scope public
6 * @rep:product per
7 * @rep:displayname User Column
8 */
9 --
10 -- ----------------------------------------------------------------------------
11 -- |----------------------------< create_user_column >------------------------|
12 -- ----------------------------------------------------------------------------
13 --
14 -- {Start Of Comments}
15 /*#
16 * This API creates a user column.
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 table identified by p_user_table_id must exist. If p_formula_id
24 * is not null then a valid formula identified by p_formula_id must exist. The
25 * p_business_group_id and p_legislation_code for this row must be consistent
26 * with the parent row identified by p_user_table_id.
27 *
28 * <p><b>Post Success</b><br>
29 * The user column will be successfully inserted into the database.
30 *
31 * <p><b>Post Failure</b><br>
32 * The user column 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_business_group_id The user column's business group.
37 * @param p_legislation_code The user column's legislation.
38 * @param p_user_table_id User Table ID.
39 * @param p_formula_id Formula identifier that corresponds to a formula of type
40 * - User Table Validation.
41 * @param p_user_column_name Name of the user column.
42 * @param p_user_column_id If p_validate is false, this uniquely identifies the
43 * user column created. If p_validate is true this parameter will be null.
44 * @param p_object_version_number If p_validate is false, then set to the
45 * version number of the created user column. If p_validate is true, then the
46 * value will be null.
47 * @rep:displayname Create User Column
48 * @rep:category BUSINESS_ENTITY PAY_USER_DEFINED_TABLE
49 * @rep:category MISC_EXTENSIONS HR_DATAPUMP
50 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
51 * @rep:scope public
52 * @rep:lifecycle active
53 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
54 */
55 --
56 -- {End Of Comments}
57 --
58 procedure create_user_column
59 (p_validate in boolean default false
60 ,p_business_group_id in number default null
61 ,p_legislation_code in varchar2 default null
62 ,p_user_table_id in number
63 ,p_formula_id in number default null
64 ,p_user_column_name in varchar2
65 ,p_user_column_id out nocopy number
66 ,p_object_version_number out nocopy number
67 );
68 --
69 -- ----------------------------------------------------------------------------
70 -- |----------------------------< update_user_column >------------------------|
71 -- ----------------------------------------------------------------------------
72 --
73 -- {Start Of Comments}
74 /*#
75 * This API updates a user column.
76 *
77 *
78 * <p><b>Licensing</b><br>
79 * This API is licensed for use with Human Resources.
80 *
81 * <p><b>Prerequisites</b><br>
82 * The user column record identified by p_user_column_id and
83 * p_object_version_number must exist. If p_formula_id is not null then a valid
84 * formula identified by p_formula_id must exist.
85 *
86 * <p><b>Post Success</b><br>
87 * The user column will be successfully updated in the database.
88 *
89 * <p><b>Post Failure</b><br>
90 * The user column will not be updated and an error will be raised.
91 * @param p_validate If true, then validation alone will be performed and the
92 * database will remain unchanged. If false and all validation checks pass,
93 * then the database will be modified.
94 * @param p_user_column_id Unique identifier of the user column.
95 * @param p_user_column_name Name of the user column.
96 * @param p_formula_id Formula identifier that corresponds to a formula of type
97 * - User Table Validation.
98 * @param p_object_version_number Pass in the current version number of the
99 * user column. to be updated. When the API completes if p_validate is false,
100 * will be set to the new version number of the updated user column. If
101 * p_validate is true will be set to the same value which was passed in.
102 * @param p_formula_warning Set to true if the formula_id is also updated.
103 * @rep:displayname Update User Column
104 * @rep:category BUSINESS_ENTITY PAY_USER_DEFINED_TABLE
105 * @rep:category MISC_EXTENSIONS HR_DATAPUMP
106 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
107 * @rep:scope public
108 * @rep:lifecycle active
109 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
110 */
111 --
112 -- {End Of Comments}
113 --
114 procedure update_user_column
115 (p_validate in boolean default false
116 ,p_user_column_id in number
117 ,p_user_column_name in varchar2 default hr_api.g_varchar2
118 ,p_formula_id in number default hr_api.g_varchar2
119 ,p_object_version_number in out nocopy number
120 ,p_formula_warning out nocopy boolean
121 );
122 --
123 -- ----------------------------------------------------------------------------
124 -- |----------------------------< delete_user_column >------------------------|
125 -- ----------------------------------------------------------------------------
126 --
130 *
127 -- {Start Of Comments}
128 /*#
129 * This API removes a user column.
131 *
132 * <p><b>Licensing</b><br>
133 * This API is licensed for use with Human Resources.
134 *
135 * <p><b>Prerequisites</b><br>
136 * The user column record identified by p_user_column_id and
137 * p_object_version_number must exist.
138 *
139 * <p><b>Post Success</b><br>
140 * The user column will have been successfully deleted from the database.
141 *
142 * <p><b>Post Failure</b><br>
143 * The user column will not be deleted and an error will be raised.
144 * @param p_validate If true, then validation alone will be performed and the
145 * database will remain unchanged. If false and all validation checks pass,
146 * then the database will be modified.
147 * @param p_user_column_id Unique identifier of the user column.
148 * @param p_object_version_number Pass in the current version number of the
149 * user column to be deleted. When the API completes if p_validate is false,
150 * will be set to the new version number of the deleted user column. If
151 * p_validate is true will be set to the same value which was passed in.
152 * @rep:displayname Delete User Column
153 * @rep:category BUSINESS_ENTITY PAY_USER_DEFINED_TABLE
154 * @rep:category MISC_EXTENSIONS HR_DATAPUMP
155 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
156 * @rep:scope public
157 * @rep:lifecycle active
158 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
159 */
160 --
161 -- {End Of Comments}
162 --
163 procedure delete_user_column
164 (p_validate in boolean default false
165 ,p_user_column_id in number
166 ,p_object_version_number in out nocopy number
167 );
168 --
169 end pay_user_column_api;
[Home] [Help]