1 Package hr_user_acct_api AUTHID CURRENT_USER as
2 /* $Header: hrusrapi.pkh 120.5 2008/03/31 04:42:16 ubhat noship $ */
3 /*#
4 * This package contains user account APIs.
5 * @rep:scope public
6 * @rep:product per
7 * @rep:displayname User Account
8 */
9 --
10 -- Private Global Variables
11 --
12
13 --
14 -- ----------------------------------------------------------------------------
15 -- |-----------------------------< create_user_acct >-------------------------|
16 -- ----------------------------------------------------------------------------
17 --
18 -- {Start Of Comments}
19 /*#
20 * This API creates a new user account for a person.
21 *
22 * <p><b>Licensing</b><br>
23 * This API is licensed for use with Human Resources.
24 *
25 * <p><b>Prerequisites</b><br>
26 * The person must exist as of effective date.
27 *
28 * <p><b>Post Success</b><br>
29 * The user account is successfully created.
30 *
31 * <p><b>Post Failure</b><br>
32 * The user account is not created and an error is raised.
33 *
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_person_id Identifies the person for whom you create the user account.
38 * @param p_per_effective_start_date Identifies the effective start date of the person.
39 * @param p_per_effective_end_date Identifies the effective end date of the person.
40 * @param p_assignment_id Identifies the assignment for the associated person.
41 * @param p_asg_effective_start_date Identifies the effective start date of the assignment.
42 * @param p_asg_effective_end_date Identifies the effective end date of the assignment.
43 * @param p_business_group_id Identifies the business group of the person.
44 * @param p_date_from Identifies the start date depending on the p_run_type and letting the
45 * user hook program know the person extract criteria.
46 * @param p_date_to Identifies the end date depending on the p_run_type and letting the
47 * user hook program know the person extract criteria.
48 * @param p_hire_date Hire Date.
49 * @param p_org_structure_id Identifies the organization structure for letting the user hook
50 * program know the person extract criteria.
51 * @param p_org_structure_vers_id Identifies version of the organization structure
52 * for letting the user hook program know the person extract criteria.
53 * @param p_parent_org_id Identifies the parent organization for letting the user hook
54 * program know the person extract criteria.
55 * @param p_single_org_id Identifies the single organization for letting the user hook
56 * program know the person extract criteria.
57 * @param p_run_type Identifies run type for letting the user hook program
58 * know the person extract criteria.
59 * @param p_user_id If p_validate is false, then this uniquely identifies
60 * the created user account. If p_validate is true, then set to null.
61 * @rep:displayname Create User Account
62 * @rep:category BUSINESS_ENTITY FND_USER
63 * @rep:lifecycle active
64 * @rep:category MISC_EXTENSIONS HR_DATAPUMP
65 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
66 * @rep:scope public
67 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
68 */
69 --
70 -- {End Of Comments}
71 --
72 --
73 PROCEDURE create_user_acct
74 (p_validate in boolean default false
75 ,p_person_id in number
76 ,p_per_effective_start_date in date default null
77 ,p_per_effective_end_date in date default null
78 ,p_assignment_id in number default null
79 ,p_asg_effective_start_date in date default null
80 ,p_asg_effective_end_date in date default null
81 ,p_business_group_id in number
82 ,p_date_from in date default null
83 ,p_date_to in date default null
84 ,p_hire_date in date default null
85 ,p_org_structure_id in number default null
86 ,p_org_structure_vers_id in number default null
87 ,p_parent_org_id in number default null
88 ,p_single_org_id in number default null
89 ,p_run_type in varchar2 default null
90 ,p_user_id out nocopy number
91 );
92 --
93 -- ----------------------------------------------------------------------------
94 -- |------------------------- < update_user_acct > ---------------------------|
95 -- | |
96 -- | USAGE: |
97 -- | ----- |
98 -- | This wrapper module is used to update fnd_user and |
99 -- | fnd_user_responsibility records specifically for expiring a user |
100 -- | account. User accounts for terminated persons will not be |
101 -- | deleted because some HR history forms have sql statements join to the |
102 -- | fnd_user table to derive the who columns. |
103 -- ----------------------------------------------------------------------------
104 --
105 -- {Start Of Comments}
106 /*#
107 * This API updates user accounts.
108 *
109 * The API is strictly used for inactivating terminated
110 * person user accounts. These user accounts will not be deleted.
111 *
112 * <p><b>Licensing</b><br>
113 * This API is licensed for use with Human Resources.
114 *
115 * <p><b>Prerequisites</b><br>
116 * The person should exist as a terminated person.
117 *
118 * <p><b>Post Success</b><br>
119 * All user accounts associated with the terminated person are inactivated.
120 *
121 * <p><b>Post Failure</b><br>
122 * The user account is not updated and an error is raised.
123 *
124 * @param p_validate If true, then validation alone will be performed and the
125 * database will remain unchanged. If false and all validation checks pass,
126 * then the database will be modified.
127 * @param p_person_id Identifies the person whose user account should be inactivated.
128 * @param p_per_effective_start_date Identifies the effective start date of the person as an ex-person.
129 * @param p_per_effective_end_date Identifies the effective end date of the person as an ex-person.
130 * @param p_assignment_id Identifies the terminated assignments for the associated person.
131 * @param p_asg_effective_start_date Identifies the effective start date of the terminated assignment.
132 * @param p_asg_effective_end_date Identifies the effective end date of the terminated assignment.
133 * @param p_business_group_id Identifies the business group of the person.
134 * @param p_date_from Identifies the start date depending on the p_run_type and letting the
135 * user hook program know the person extract criteria.
136 * @param p_date_to Identifies the end date depending on the p_run_type and letting the
137 * user hook program know the person extract criteria.
138 * @param p_org_structure_id Identifies the organization structure for letting the user hook
139 * program know the person extract criteria.
140 * @param p_org_structure_vers_id Identifies version of the organization structure
141 * for letting the user hook program know the person extract criteria.
142 * @param p_parent_org_id Identifies the parent organization for letting the user hook
143 * program know the person extract criteria.
144 * @param p_single_org_id Identifies the single organization for letting the user hook
145 * program know the person extract criteria.
146 * @param p_run_type Identifies run type for letting the user hook program
147 * know the person extract criteria.
148 * @param p_inactivate_date Date on which the person is terminated.
149 * @rep:displayname Update User Account
150 * @rep:category BUSINESS_ENTITY FND_USER
151 * @rep:lifecycle active
152 * @rep:category MISC_EXTENSIONS HR_DATAPUMP
153 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
154 * @rep:scope public
155 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
156 */
157 --
158 -- {End Of Comments}
159 --
160
161 PROCEDURE update_user_acct
162 (p_validate in boolean default false
163 ,p_person_id in number
164 ,p_per_effective_start_date in date default null
165 ,p_per_effective_end_date in date default null
166 ,p_assignment_id in number default null
167 ,p_asg_effective_start_date in date default null
168 ,p_asg_effective_end_date in date default null
169 ,p_business_group_id in number
170 ,p_date_from in date default null
171 ,p_date_to in date default null
172 ,p_org_structure_id in number default null
173 ,p_org_structure_vers_id in number default null
174 ,p_parent_org_id in number default null
175 ,p_single_org_id in number default null
176 ,p_run_type in varchar2 default null
177 ,p_inactivate_date in date
178 );
179
180 --
181 --
182 END hr_user_acct_api;
[Home] [Help]