DBA Data[Home] [Help]

PACKAGE: APPS.HR_NL_ABSENCE_ACTION_API

Source


1 Package HR_NL_ABSENCE_ACTION_api as
2 /* $Header: penaaapi.pkh 120.1 2005/10/02 02:18:47 aroussel $ */
3 /*#
4  * This package contains Dutch Absence Action APIs.
5  * @rep:scope public
6  * @rep:product per
7  * @rep:displayname Absence Action for Netherlands
8 */
9 --
10 -- ----------------------------------------------------------------------------
11 -- |--------------------------< create_absence_action >-----------------------|
12 -- ----------------------------------------------------------------------------
13 --
14 -- {Start Of Comments}
15 /*#
16  * This API creates a new Absence Action.
17  *
18  * Create Absence Actions against an absence for a person in the Netherlands.
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  * The person and absence must exist on the effective date.
25  *
26  * <p><b>Post Success</b><br>
27  * When the Absence Action is valid, the API sets the following
28  *
29  * <p><b>Post Failure</b><br>
30  * The API does not create an Absence Action and raises an error.
31  * @param p_validate If true, then validation alone will be performed and the
32  * database will remain unchanged. If false and all validation checks pass,
33  * then the database will be modified.
34  * @param p_absence_attendance_id Absence for which an action is to be created.
35  * @param p_expected_date Expected date when the action is to be performed.
36  * @param p_description Description of the action.
37  * @param p_actual_start_date Actual start date of the action.
38  * @param p_actual_end_date Actual end date of the action.
39  * @param p_holder Holder (owner) of the action.
40  * @param p_comments Comments on work done for the action.
41  * @param p_document_file_name Name of the document associated with the action.
42  * @param p_absence_action_id If p_validate is false, then this uniquely
43  * identifies the absence action created. If p_validate is true, then set to
44  * null.
45  * @param p_object_version_number If p_validate is false, then set to the
46  * version number of the created absence action. If p_validate is true, then
47  * the value will be null.
48  * @param p_enabled Indication of whether action is enabled.
49  * @rep:displayname Create Absence Action for the Netherlands
50  * @rep:category BUSINESS_ENTITY PER_EMPLOYEE_ABSENCE
51  * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
52  * @rep:scope public
53  * @rep:lifecycle active
54  * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
55 */
56 --
57 -- {End Of Comments}
58 --
59 procedure CREATE_ABSENCE_ACTION
60   (p_validate                      in     boolean  default false
61   ,p_absence_attendance_id         in     number
62   ,p_expected_date                 in     date
63   ,p_description                   in     varchar2
64   ,p_actual_start_date             in     date     default null
65   ,p_actual_end_date               in     date     default null
66   ,p_holder                        in     varchar2 default null
67   ,p_comments                      in     varchar2 default null
68   ,p_document_file_name            in     varchar2 default null
69   ,p_absence_action_id             out    nocopy  number
70   ,p_object_version_number         out    nocopy  number
71   ,p_enabled                       in     varchar2 default null
72   );
73 --
74 -- ----------------------------------------------------------------------------
75 -- |--------------------------< update_absence_action >-----------------------|
76 -- ----------------------------------------------------------------------------
77 --
78 -- {Start Of Comments}
79 /*#
80  * This API updates an existing Absence Action.
81  *
82  * Update Absence Actions against an absence for a person.
83  *
84  * <p><b>Licensing</b><br>
85  * This API is licensed for use with Human Resources.
86  *
87  * <p><b>Prerequisites</b><br>
88  * The absence and Absence Action, as identified by the in parameters
89  * p_absence_attendance_id and p_absence_action_id and the in out parameter
90  * p_object_version_number, must already exist.
91  *
92  * <p><b>Post Success</b><br>
93  * When the Absence Action is valid, the API sets the following
94  *
95  * <p><b>Post Failure</b><br>
96  * The API does not update the Absence Action and raises an error.
97  * @param p_validate If true, then validation alone will be performed and the
98  * database will remain unchanged. If false and all validation checks pass,
99  * then the database will be modified.
100  * @param p_absence_attendance_id Absence for which an action is to be updated.
101  * @param p_absence_action_id Absence Action to be updated.
102  * @param p_object_version_number Pass in the current version number of the
103  * absence action to be updated. When the API completes if p_validate is false,
104  * will be set to the new version number of the updated absence action. If
105  * p_validate is true will be set to the same value which was passed in.
106  * @param p_expected_date Expected date when the action is to be performed.
107  * @param p_description Description of the action.
108  * @param p_actual_start_date Actual start date of the action.
109  * @param p_actual_end_date Actual end date of the action.
110  * @param p_holder Holder (owner) of the action.
111  * @param p_comments Comments on work done for the action.
112  * @param p_document_file_name Name of the document associated with the action.
113  * @param p_enabled Indication of whether action is enabled.
114  * @rep:displayname Update Absence Action for Netherlands
115  * @rep:category BUSINESS_ENTITY PER_EMPLOYEE_ABSENCE
116  * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
117  * @rep:scope public
118  * @rep:lifecycle active
119  * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
120 */
121 --
122 -- {End Of Comments}
123 --
124 procedure UPDATE_ABSENCE_ACTION
125   (p_validate                      in     boolean  default false
126   ,p_absence_attendance_id         in     number
127   ,p_absence_action_id             in     number
128   ,p_object_version_number         in out nocopy number
129   ,p_expected_date                 in     date
130   ,p_description                   in     varchar2
131   ,p_actual_start_date             in     date     default hr_api.g_date
132   ,p_actual_end_date               in     date     default hr_api.g_date
133   ,p_holder                        in     varchar2 default hr_api.g_varchar2
134   ,p_comments                      in     varchar2 default hr_api.g_varchar2
135   ,p_document_file_name            in     varchar2 default hr_api.g_varchar2
136   ,p_enabled                       in     varchar2 default hr_Api.g_varchar2
137   );
138 --
139 -- ----------------------------------------------------------------------------
140 -- |--------------------------< delete_absence_action >-----------------------|
141 -- ----------------------------------------------------------------------------
142 --
143 -- {Start Of Comments}
144 /*#
145  * This API deletes an existing Absence Action.
146  *
147  * Delete Absence Actions against an absence for a person.
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 Absence Action as identified by the in parameter p_absence_action_id and
154  * the in out parameter p_object_version_number must already exist.
155  *
156  * <p><b>Post Success</b><br>
157  * The Absence Action is deleted.
158  *
159  * <p><b>Post Failure</b><br>
160  * The API does not delete the Absence Action and raises an error.
161  * @param p_validate If true, then validation alone will be performed and the
162  * database will remain unchanged. If false and all validation checks pass,
163  * then the database will be modified.
164  * @param p_absence_action_id Absence Action to be deleted.
165  * @param p_object_version_number Current version number of the absence action
166  * to be deleted.
167  * @rep:displayname Delete Absence Action for Netherlands
168  * @rep:category BUSINESS_ENTITY PER_EMPLOYEE_ABSENCE
169  * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
170  * @rep:scope public
171  * @rep:lifecycle active
172  * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
173 */
174 --
175 -- {End Of Comments}
176 --
177 procedure DELETE_ABSENCE_ACTION
178   (p_validate                      in     boolean  default false
179   ,p_absence_action_id             in     number
180   ,p_object_version_number         in     number
181   );
182 --
183 end HR_NL_ABSENCE_ACTION_api;