1 Package pqh_fr_validation_events_api as
2 /* $Header: pqvleapi.pkh 120.1 2005/10/02 02:28:47 aroussel $ */
3 /*#
4 * This package contains APIs to create, update and delete events in a services
5 * validation process.
6 * @rep:scope public
7 * @rep:product per
8 * @rep:displayname Validation Event for France
9 */
10 --
11 -- ----------------------------------------------------------------------------
12 -- |-------------------------< insert_validation_event >----------------------|
13 -- ----------------------------------------------------------------------------
14 --
15 -- {Start Of Comments}
16 /*#
17 * This API validates the inputs and creates a new validation event record.
18 *
19 * During the services validation process for a civil servant the organization
20 * needs to record a set of events that happen during the processing. This API
21 * creates the event for a services validation record.
22 *
23 * <p><b>Licensing</b><br>
24 * This API is licensed for use with Human Resources.
25 *
26 * <p><b>Prerequisites</b><br>
27 * A validation event can be created only for a services validation that is not
28 * already validated.
29 *
30 * <p><b>Post Success</b><br>
31 * A validation event is created for the services validation.
32 *
33 * <p><b>Post Failure</b><br>
34 * A validation event is not created in the database and an error is raised
35 * @param p_effective_date Specifies the reference date for validating lookup
36 * values, applicable within the active date range. This date does not
37 * determine when the changes take effect.
38 * @param p_validation_id Identifier of the service validation for which the
39 * validation event is being created. It references the primary key of
40 * PQH_FR_VALIDATIONS. It is a mandatory parameter
41 * @param p_event_type Event type code for the validation. Valid values are
42 * identified by lookup type 'FR_PQH_EVENT_TYPE'
43 * @param p_event_code Event code for the validation corresponding to the event
44 * type. Valid values are identified by lookup type 'FR_PQH_VALIDATION_EVENT'.
45 * @param p_start_date {@rep:casecolumn PQH_FR_VALIDATION_EVENTS.START_DATE}
46 * @param p_end_date {@rep:casecolumn PQH_FR_VALIDATION_EVENTS.END_DATE}
47 * @param p_comments Comment text
48 * @param p_validation_event_id The process returns the unique validation event
49 * identifier generated for each new record as primary key
50 * @param p_object_version_number If p_validate is false, the process returns
51 * the version number of the created validation event record. If p_validate is
52 * true, the process returns null
53 * @rep:displayname Create Validation Event
54 * @rep:category BUSINESS_ENTITY PQH_FR_SERVICES_VALIDATION
55 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
56 * @rep:scope public
57 * @rep:lifecycle active
58 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
59 */
60 --
61 -- {End Of Comments}
62 --
63 procedure Insert_Validation_event
64 (
65 p_effective_date in date
66 ,p_validation_id in number
67 ,p_event_type in varchar2
68 ,p_event_code in varchar2
69 ,p_start_date in date default null
70 ,p_end_date in date default null
71 ,p_comments in varchar2 default null
72 ,p_validation_event_id out nocopy number
73 ,p_object_version_number out nocopy number
74 );
75 --
76 -- ----------------------------------------------------------------------------
77 -- |-------------------------< update_validation_event >----------------------|
78 -- ----------------------------------------------------------------------------
79 --
80 -- {Start Of Comments}
81 /*#
82 * This API validates the changes made to an existing validation event record
83 * and updates the record in the database.
84 *
85 * This API updates records into PQH_FR_VALIDATION_EVENTS table
86 *
87 * <p><b>Licensing</b><br>
88 * This API is licensed for use with Human Resources.
89 *
90 * <p><b>Prerequisites</b><br>
91 * A validation event must exist with the specified object version number.
92 *
93 * <p><b>Post Success</b><br>
94 * The validation event is updated in the database.
95 *
96 * <p><b>Post Failure</b><br>
97 * The validation event is not updated in the database and an error is raised
98 * @param p_effective_date Specifies the reference date for validating lookup
99 * values, applicable within the active date range. This date does not
100 * determine when the changes take effect.
101 * @param p_validation_event_id Unique validation event identifier generated
102 * for each new record as primary key. It is a mandatory parameter
103 * @param p_object_version_number Passes the current version number of the
104 * validation event to be updated. When the API completes if p_validate is
105 * false, the process returns the new version number of the updated validation
106 * event. If p_validate is true, it returns the same value which was passed in
107 * @param p_validation_id Identifier of the service validation for which the
108 * validation event is being created. It references the primary key of
109 * PQH_FR_VALIDATIONS. It is a mandatory parameter
110 * @param p_event_type Event type code for the validation. Valid values are
111 * identified by lookup type 'FR_PQH_EVENT_TYPE'
112 * @param p_event_code Event code for the validation corresponding to the event
113 * type. Valid values are identified by lookup type 'FR_PQH_VALIDATION_EVENT'.
114 * @param p_start_date {@rep:casecolumn PQH_FR_VALIDATION_EVENTS.START_DATE}
115 * @param p_end_date {@rep:casecolumn PQH_FR_VALIDATION_EVENTS.END_DATE}
116 * @param p_comments Comment text
117 * @rep:displayname Update Validation Event
118 * @rep:category BUSINESS_ENTITY PQH_FR_SERVICES_VALIDATION
119 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
120 * @rep:scope public
121 * @rep:lifecycle active
122 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
123 */
124 --
125 -- {End Of Comments}
126 --
127 procedure Update_Validation_event
128 ( p_effective_date in date
129 ,p_validation_event_id in number
130 ,p_object_version_number in out nocopy number
131 ,p_validation_id in number default hr_api.g_number
132 ,p_event_type in varchar2 default hr_api.g_varchar2
133 ,p_event_code in varchar2 default hr_api.g_varchar2
134 ,p_start_date in date default hr_api.g_date
135 ,p_end_date in date default hr_api.g_date
136 ,p_comments in varchar2 default hr_api.g_varchar2
137 );
138 --
139 -- ----------------------------------------------------------------------------
140 -- |-------------------------< delete_validation_event >----------------------|
141 -- ----------------------------------------------------------------------------
142 --
143 -- {Start Of Comments}
144 /*#
145 * This API deletes a validation event record from the database.
146 *
147 * This API deletes records from PQH_FR_VALIDATION_EVENTS table
148 *
149 * <p><b>Licensing</b><br>
150 * This API is licensed for use with Human Resources.
151 *
152 * <p><b>Prerequisites</b><br>
153 * The validation event must exist with the specified object version number.
154 *
155 * <p><b>Post Success</b><br>
156 * The validation event is deleted from the database.
157 *
158 * <p><b>Post Failure</b><br>
159 * The validation event is not deleted from the database and an error is raised
160 * @param p_validation_event_id Unique validation event identifier generated
161 * for each new record as primary key. It is a mandatory parameter
162 * @param p_object_version_number Current version number of the validation
163 * event record to be deleted
164 * @rep:displayname Delete Validation Event
165 * @rep:category BUSINESS_ENTITY PQH_FR_SERVICES_VALIDATION
166 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
167 * @rep:scope public
168 * @rep:lifecycle active
169 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
170 */
171 --
172 -- {End Of Comments}
173 --
174 Procedure Delete_Validation_event
175 (p_validation_event_id in number
176 ,p_object_version_number in number);
177 --
178 end PQH_FR_VALIDATION_EVENTS_API;
[Home] [Help]