1 Package pay_datetracked_events_api as
2 /* $Header: pydteapi.pkh 120.1 2005/10/02 02:30:27 aroussel $ */
3 /*#
4 * This package contains APIs for Datetracked Events.
5 * @rep:scope public
6 * @rep:product per
7 * @rep:displayname DateTrack Events
8 */
9 --
10 -- ----------------------------------------------------------------------------
11 -- |-------------------------< create_datetracked_event >---------------------|
12 -- ----------------------------------------------------------------------------
13 --
14 -- {Start Of Comments}
15 /*#
16 * This API creates Datetracked Events.
17 *
18 * Created Datetracked Events will then be used by the event model.
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 * Requires an event group and a datetracked table.
25 *
26 * <p><b>Post Success</b><br>
27 * The datetracked event has been successfully created.
28 *
29 * <p><b>Post Failure</b><br>
30 * If the column argument is not a column on the dated table we are trying to
31 * create, then raise error HR_xxxx_INVALID_COLUMN_NAME. Also if the
32 * update_type is not a recognisable value for the lookup type UPDATE_TYPE,
33 * then raise error HR_xxxx_INVALID_UPDATE_TYPE.
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_effective_date Reference date for validating lookup values are
38 * applicable during the start to end active date range. This date does not
39 * determine when the changes take effect.
40 * @param p_event_group_id Proration Group.
41 * @param p_dated_table_id Dated Table
42 * @param p_update_type Taken from UPDATE_TYPE lookup.
43 * @param p_column_name Mandatory only if update_type ='UPDATE'. Should be a
44 * column name of the dated table.
45 * @param p_business_group_id Business Group of the Record.
46 * @param p_legislation_code Legislation Code
47 * @param p_proration_style Proration Style Out Parameters: Name Type
48 * Description
49 * @param p_datetracked_event_id {@rep:casecolumn
50 * PAY_DATETRACKED_EVENTS.DATETRACKED_EVENT_ID}
51 * @param p_object_version_number If p_validate is false, then set to the
52 * version number of the created datetracked event. If p_validate is true, then
53 * the value will be null.
54 * @rep:displayname Create DateTrack Event
55 * @rep:category BUSINESS_ENTITY PAY_PAYROLL_EVENT_GROUP
56 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
57 * @rep:scope public
58 * @rep:lifecycle active
59 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
60 */
61 --
62 -- {End Of Comments}
63 --
64 procedure create_datetracked_event
65 (
66 p_validate in boolean default false
67 ,p_effective_date in date
68 ,p_event_group_id in number
69 ,p_dated_table_id in number
70 ,p_update_type in varchar2
71 ,p_column_name in varchar2
72 ,p_business_group_id in number
73 ,p_legislation_code in varchar2
74 ,p_proration_style in varchar2 default null
75 ,p_datetracked_event_id out nocopy number
76 ,p_object_version_number out nocopy number
77 ) ;
78 --
79 -- ----------------------------------------------------------------------------
80 -- |-------------------------< update_datetracked_event >---------------------|
81 -- ----------------------------------------------------------------------------
82 --
83 -- {Start Of Comments}
84 /*#
85 * This API updates a datetracked event.
86 *
87 * The updated datetracked event will be used by the event model.
88 *
89 * <p><b>Licensing</b><br>
90 * This API is licensed for use with Human Resources.
91 *
92 * <p><b>Prerequisites</b><br>
93 * The datetracked event to be updated should exists.
94 *
95 * <p><b>Post Success</b><br>
96 * The datetracked event has been successfully updated.
97 *
98 * <p><b>Post Failure</b><br>
99 * If the column argument is not a column on the dated table we are trying to
100 * create, then raise error HR_xxxx_INVALID_COLUMN_NAME. Also if the
101 * update_type is not a recognisable value for the lookup type UPDATE_TYPE,
102 * then raise error HR_xxxx_INVALID_UPDATE_TYPE.
103 * @param p_validate If true, then validation alone will be performed and the
104 * database will remain unchanged. If false and all validation checks pass,
105 * then the database will be modified.
106 * @param p_effective_date Reference date for validating lookup values are
107 * applicable during the start to end active date range. This date does not
108 * determine when the changes take effect.
109 * @param p_datetracked_event_id Primary Key of the record.
110 * @param p_object_version_number Pass in the current version number of the
111 * datetracked event to be updated. When the API completes if p_validate is
112 * false, will be set to the new version number of the updated datetracked
113 * event. If p_validate is true will be set to the same value which was passed
114 * in.
115 * @param p_event_group_id Proration Group.
116 * @param p_dated_table_id Dated Table
117 * @param p_update_type Taken from UPDATE_TYPE lookup.
118 * @param p_column_name Mandatory only if update_type ='UPDATE'. Should be a
119 * column name of the dated table.
120 * @param p_business_group_id Business Group of the Record.
121 * @param p_legislation_code Legislation Code
122 * @param p_proration_style Proration Style
123 * @rep:displayname Update DateTrack Event
124 * @rep:category BUSINESS_ENTITY PAY_PAYROLL_EVENT_GROUP
125 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
126 * @rep:scope public
127 * @rep:lifecycle active
128 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
129 */
130 --
131 -- {End Of Comments}
132 --
133 procedure update_datetracked_event
134 (
135 p_validate in boolean default false
136 ,p_effective_date in date
137 ,p_datetracked_event_id in number
138 ,p_object_version_number in out nocopy number
139 ,p_event_group_id in number default hr_api.g_number
140 ,p_dated_table_id in number default hr_api.g_number
141 ,p_update_type in varchar2 default hr_api.g_varchar2
142 ,p_column_name in varchar2 default hr_api.g_varchar2
143 ,p_business_group_id in number default hr_api.g_number
144 ,p_legislation_code in varchar2 default hr_api.g_varchar2
145 ,p_proration_style in varchar2 default hr_api.g_varchar2
146 );
147 --
148 -- ----------------------------------------------------------------------------
149 -- |-------------------------< delete_datetracked_event >---------------------|
150 -- ----------------------------------------------------------------------------
151 --
152 -- {Start Of Comments}
153 /*#
154 * This API deletes a datetracked event.
155 *
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 * The datetracked event to be deleted should exists.
162 *
163 * <p><b>Post Success</b><br>
164 * The event group has been successfully deleted.
165 *
166 * <p><b>Post Failure</b><br>
167 * An error will be raised and the Datetracked Event will not be deleted.
168 * @param p_validate If true, then validation alone will be performed and the
169 * database will remain unchanged. If false and all validation checks pass,
170 * then the database will be modified.
171 * @param p_datetracked_event_id Primary Key of the record.
172 * @param p_object_version_number Pass in the current version number of the
173 * Datetracked Event to be deleted. When the API completes if p_validate is
174 * false, will be set to the new version number of the deleted Datetracked
175 * Event. If p_validate is true will be set to the same value which was passed
176 * in.
177 * @rep:displayname Delete DateTrack Event
178 * @rep:category BUSINESS_ENTITY PAY_PAYROLL_EVENT_GROUP
179 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
180 * @rep:scope public
181 * @rep:lifecycle active
182 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
183 */
184 --
185 -- {End Of Comments}
186 --
187 procedure delete_datetracked_event
188 (
189 p_validate in boolean default false
190 ,p_datetracked_event_id in number
191 ,p_object_version_number in number
192 );
193 --
194 end pay_datetracked_events_api;
195 --
[Home] [Help]