1 Package hr_security_user_api AUTHID CURRENT_USER as
2 /* $Header: hrseuapi.pkh 120.5.12000000.1 2007/01/21 18:29:10 appldev ship $ */
3 /*#
4 * This package contains user based security maintenance
5 * @rep:scope public
6 * @rep:product per
7 * @rep:displayname User Security Maintenance
8 */
9 --
10 -- ----------------------------------------------------------------------------
11 -- |-------------------------< create_security_user >-------------------------|
12 -- ----------------------------------------------------------------------------
13 --
14 -- {Start Of Comments}
15 /*#
16 * This API adds the specified user into the list of static users for
17 * whom security permissions should be re-evalulated during a Security List
18 * Maintenance run and stored in static lists.
19 *
20 * <p><b>Licensing</b><br>
21 * This API is licensed for use with Human Resources.
22 *
23 * <p><b>Prerequisites</b><br>
24 * User must be valid and should exist in application.
25 *
26 * <p><b>Post Success</b><br>
27 * The user is successfully added into this security profile's static list
28 * of users:
29 *
30 * <p><b>Post Failure</b><br>
31 * The user will not be added to the security profile's list of static
32 * users and an error message will be raised.
33 *
34 * @param p_validate If true, then validation alone will be performed and
35 * the database will remain unchanged. If false and all validation checks pass,
36 * then the database will be modified.
37 * @param p_effective_date The effective date used for validation.
38 * @param p_user_id The user to add in the static users list.
39 * @param p_security_profile_id The security profile to add the user into.
40 * @param p_process_in_next_run_flag The flag used for Static User Processing -
41 * indicates whether user should have slm run if slm is to be run for only
42 * 'process in next run' users.
43 * @param p_security_user_id The primary key identifier for this unique
44 * user/security profile association.
45 * @param p_object_version_number This is set to the version number of the
46 * created list entry.
47 * @rep:displayname Create Security User
48 * @rep:category BUSINESS_ENTITY PER_SECURITY_PROFILE
49 * @rep:lifecycle active
50 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
51 * @rep:scope public
52 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
53 */
54 --
55 -- {End Of Comments}
56 --
57 procedure create_security_user
58 (p_validate in boolean default false
59 ,p_effective_date in date
60 ,p_user_id in number
61 ,p_security_profile_id in number
62 ,p_process_in_next_run_flag in varchar2 default 'Y'
63 ,p_security_user_id out nocopy number
64 ,p_object_version_number out nocopy number
65 );
66 --
67 -- ----------------------------------------------------------------------------
68 -- |-------------------------< update_security_user >-------------------------|
69 -- ----------------------------------------------------------------------------
70 --
71 -- {Start Of Comments}
72 /*#
73 * This API updates a particular user / security profile association.
74 * This API allows the user, or the security profile, or both to be
75 * changed in this association.
76 *
77 * <p><b>Licensing</b><br>
78 * This API is licensed for use with Human Resources.
79 *
80 * <p><b>Prerequisites</b><br>
81 * None.
82 *
83 * <p><b>Post Success</b><br>
84 * The user/security profile association is successfully updated.
85 *
86 * <p><b>Post Failure</b><br>
87 * The user / security profile association will not be updated and an
88 * error message will be raised.
89 *
90 * @param p_validate If true, then validation alone will be performed and
91 * the database will remain unchanged. If false and all validation checks pass,
92 * then the database will be modified.
93 * @param p_effective_date The effective date used for validation.
94 * @param p_security_user_id The primary key identifier for this unique user
95 * security profile association.
96 * @param p_user_id The user to include in the static users list.
97 * @param p_security_profile_id Security profile for which this user is in
98 * @param p_process_in_next_run_flag The flag used for Static User Processing -
99 * indicates whether user should have slm run if slm is to be run for only
100 * 'process in next run' users. Will be updated from 'Y' to 'N' after processing.
101 * @param p_object_version_number This is set to the the version number of
102 * the updated entry.
103 * @param p_del_static_lists_warning If set to true, existing security
104 * permissions in the static lists will be deleted upon commiting because they
105 * are redundant as a result of this update. If set to false, either the
106 * permissions in the static lists remain correct, or the user does not have
107 * any rows in the static permission lists.
108 * @rep:displayname Update Security User
109 * @rep:category BUSINESS_ENTITY PER_SECURITY_PROFILE
110 * @rep:lifecycle active
111 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
112 * @rep:scope public
113 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
114 */
115 --
116 -- {End Of Comments}
117 --
118 procedure update_security_user
119 (p_validate in boolean default false
120 ,p_effective_date in date
121 ,p_security_user_id in number
122 ,p_user_id in number default hr_api.g_number
123 ,p_security_profile_id in number default hr_api.g_number
124 ,p_process_in_next_run_flag in varchar2 default hr_api.g_varchar2
125 ,p_object_version_number in out nocopy number
126 ,p_del_static_lists_warning out nocopy boolean
127 );
128 --
129 -- ----------------------------------------------------------------------------
130 -- |--------------------------< delete_security_user >------------------------|
131 -- ----------------------------------------------------------------------------
132 --
133 -- {Start Of Comments}
134 /*#
135 * Deletes this particular user / security profile association.
136 *
137 * <p><b>Licensing</b><br>
138 * This API is licensed for use with Human Resources.
139 *
140 * <p><b>Prerequisites</b><br>
141 * None.
142 *
143 * <p><b>Post Success</b><br>
144 * The user is successfully deleted from this security profile's static
145 * list of users.
146 *
147 * <p><b>Post Failure</b><br>
148 * The user is not deleted from this security profile's static list of
149 * users and an error message will be raised.
150 *
151 * @param p_validate If true, then validation alone will be performed and
152 * the database will remain unchanged. If false and all validation checks pass,
153 * then the database will be modified.
154 * @param p_security_user_id The primary key identifier for this unique
155 * user / security profile association.
156 * @param p_object_version_number The version number of the entry being
157 * deleted.
158 * @param p_del_static_lists_warning If set to true, existing security
159 * permissions in the static lists will be deleted upon commiting because they
160 * are redundant as a result of this delete.If set to false, either the
161 * permissions in the static lists remain correct, or the user does
162 * not have any rows in the static permission lists.
163 * @rep:displayname Delete Security User
164 * @rep:category BUSINESS_ENTITY PER_SECURITY_PROFILE
165 * @rep:lifecycle active
166 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
167 * @rep:scope public
168 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
169 */
170 --
171 -- {End Of Comments}
172 --
173 procedure delete_security_user
174 (p_validate in boolean default false
175 ,p_security_user_id in number
176 ,p_object_version_number in number
177 ,p_del_static_lists_warning out nocopy boolean
178 );
179 --
180 end hr_security_user_api;
[Home] [Help]