1 Package BEN_CWB_PERSON_TASKS_API AUTHID CURRENT_USER as
2 /* $Header: bectkapi.pkh 120.1 2005/10/02 02:35:52 aroussel $ */
3 /*#
4 * This package contains Compensation Workbench Person Task APIs.
5 * @rep:scope public
6 * @rep:product PER
7 * @rep:displayname Compensation Workbench Person Task
8 */
9 --
10 -- ----------------------------------------------------------------------------
11 -- |----------------------------< create_person_task >------------------------|
12 -- ----------------------------------------------------------------------------
13 --
14 -- {Start Of Comments}
15 /*#
16 * This API creates compensation workbench tasks for a person.
17 *
18 * Any self-service page, which creates task status, uses this API.
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 * A person with a compensation life event reason in a Compensation Workbench
25 * Plan must exist.
26 *
27 * <p><b>Post Success</b><br>
28 * A Compensation Workbench Task will be created in the database.
29 *
30 * <p><b>Post Failure</b><br>
31 * A Compensation Workbench Task will not be created in the database.
32 *
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_group_per_in_ler_id This parameter identifies the Group Life Event
37 * Reason ID of Compensation Workbench Person. Foreign key to BEN_PER_IN_LER.
38 * @param p_task_id This parameter identifies the Compensation Workbench Task.
39 * A sequence generated primary key.
40 * @param p_group_pl_id This parameter specifies the compensation workbench
41 * group plan.
42 * @param p_lf_evt_ocrd_dt This parameter specifies the life event occured date
43 * for person processed.
44 * @param p_status_cd This parameter specifies the status code for a task.
45 * Valid values are defined in 'BEN_SUBMIT_STAT' lookup type.
46 * @param p_access_cd This parameter specifies the access code for manager.
47 * Valid values are defined by 'BEN_CWB_TASK_ACCESS' lookup type.
48 * @param p_task_last_update_date This parameter identifies the date when the
49 * task was last updated.
50 * @param p_task_last_update_by This parameter the person who updated the task
51 * last.
52 * @param p_object_version_number If p_validate is false, then set to the
53 * version number of the created Compensation Workbench Task. If p_validate is
54 * true, then the value will be null.
55 * @rep:displayname Create Compensation Workbench Person Task
56 * @rep:category BUSINESS_ENTITY BEN_CWB_TASK
57 * @rep:lifecycle active
58 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
59 * @rep:scope public
60 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
61 */
62 --
63 -- {End Of Comments}
64 --
65 procedure create_person_task
66 (p_validate in boolean default false
67 ,p_group_per_in_ler_id in number
68 ,p_task_id in number
69 ,p_group_pl_id in number
70 ,p_lf_evt_ocrd_dt in date
71 ,p_status_cd in varchar2 default null
72 ,p_access_cd in varchar2 default null
73 ,p_task_last_update_date in date default null
74 ,p_task_last_update_by in number default null
75 ,p_object_version_number out nocopy number
76 );
77 --
78 -- ----------------------------------------------------------------------------
79 -- |----------------------------< update_person_task >------------------------|
80 -- ----------------------------------------------------------------------------
81 --
82 -- {Start Of Comments}
83 /*#
84 * This API updates compensation workbench tasks for a person.
85 *
86 * Any self-service page, which updates task status, uses this API.
87 *
88 * <p><b>Licensing</b><br>
89 * This API is licensed for use with Human Resources.
90 *
91 * <p><b>Prerequisites</b><br>
92 * A Compensation Workbench Task record must exist in the database to update.
93 *
94 * <p><b>Post Success</b><br>
95 * The Compensation Workbench Task will be updated in the database.
96 *
97 * <p><b>Post Failure</b><br>
98 * The Compensation Workbench Task will be not updated in the database.
99 *
100 * @param p_validate If true, then validation alone will be performed and the
101 * database will remain unchanged. If false and all validation checks pass,
102 * then the database will be modified.
103 * @param p_group_per_in_ler_id This parameter identifies the Group Life Event
104 * Reason ID of Compensation Workbench Person. Foreign key to BEN_PER_IN_LER.
105 * @param p_task_id This parameter identifies the Compensation Workbench Task.
106 * A sequence generates the primary key.
107 * @param p_group_pl_id This parameter specifies a Compensation Workbench Group
108 * Plan.
109 * @param p_lf_evt_ocrd_dt This parameter specifies the life event occured date
110 * for person processed.
111 * @param p_status_cd This parameter specifies the status code for Task. Valid
112 * values are defined in 'BEN_SUBMIT_STAT' lookup type.
113 * @param p_access_cd This parameter specifies the access code for manager.
114 * Valid values are defined by 'BEN_CWB_TASK_ACCESS' lookup type.
115 * @param p_task_last_update_date This parameter identifies the date when the
116 * Task was last updated.
117 * @param p_task_last_update_by This parameter identifies the person who
118 * updated the Task last.
119 * @param p_object_version_number Pass in the current version number of the
120 * Compensation Workbench Task to be updated. When the API completes if
121 * p_validate is false, will be set to the new version number of the updated
122 * Compensation Workbench Task If p_validate is true will be set to the same
123 * value which was passed in.
124 * @rep:displayname Update Compensation Workbench Person Task
125 * @rep:category BUSINESS_ENTITY BEN_CWB_TASK
126 * @rep:lifecycle active
127 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
128 * @rep:scope public
129 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
130 */
131 --
132 -- {End Of Comments}
133 --
134 procedure update_person_task
135 (p_validate in boolean default false
136 ,p_group_per_in_ler_id in number
137 ,p_task_id in number
138 ,p_group_pl_id in number default hr_api.g_number
139 ,p_lf_evt_ocrd_dt in date default hr_api.g_date
140 ,p_status_cd in varchar2 default hr_api.g_varchar2
141 ,p_access_cd in varchar2 default hr_api.g_varchar2
142 ,p_task_last_update_date in date default hr_api.g_date
143 ,p_task_last_update_by in number default hr_api.g_number
144 ,p_object_version_number in out nocopy number
145 );
146 --
147 -- ----------------------------------------------------------------------------
148 -- |----------------------------< delete_person_task >------------------------|
149 -- ----------------------------------------------------------------------------
150 --
151 -- {Start Of Comments}
152 /*#
153 * This API deletes compensation workbench tasks for a person.
154 *
155 * Any self-service page which deletes task uses this API.
156 *
157 * <p><b>Licensing</b><br>
158 * This API is licensed for use with Human Resources.
159 *
160 * <p><b>Prerequisites</b><br>
161 * A Compensation Workbench Task record exists in the database to delete.
162 *
163 * <p><b>Post Success</b><br>
164 * The Compensation Workbench Task will be deleted in the database.
165 *
166 * <p><b>Post Failure</b><br>
167 * The Compensation Workbench Task will be not deleted in the database.
168 *
169 * @param p_validate If true, then validation alone will be performed and the
170 * database will remain unchanged. If false and all validation checks pass,
171 * then the database will be modified.
172 * @param p_group_per_in_ler_id This parameter identifies the Group Life Event
173 * Reason ID of Compensation Workbench Person. Foreign key to BEN_PER_IN_LER.
174 * @param p_task_id This parameter identifies the Compensation Workbench Task.
175 * A sequence generates primary key.
176 * @param p_object_version_number Current version number of the Compensation
177 * Workbench Task to be deleted.
178 * @rep:displayname Delete Compensation Workbench Person Task
179 * @rep:category BUSINESS_ENTITY BEN_CWB_TASK
180 * @rep:lifecycle active
181 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
182 * @rep:scope public
183 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
184 */
185 --
186 -- {End Of Comments}
187 --
188 procedure delete_person_task
189 (p_validate in boolean default false
190 ,p_group_per_in_ler_id in number
191 ,p_task_id in number
192 ,p_object_version_number in number
193 );
194 --
195 end BEN_CWB_PERSON_TASKS_API;
[Home] [Help]