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