1 Package ghr_noac_remarks_api as
2 /* $Header: ghnreapi.pkh 120.2 2005/10/02 01:57:59 aroussel $ */
3 /*#
4 * This package contains the procedures for creating, updating, and deleting US
5 * Federal Human Resources Nature of actions (NOACs) and Remarks combination
6 * records.
7 * @rep:scope public
8 * @rep:product per
9 * @rep:displayname Nature of Action Code /Remark combination
10 */
11 --
12 -- ----------------------------------------------------------------------------
13 -- |---------------------------< create_noac_remarks >------------------------|
14 -- ----------------------------------------------------------------------------
15 --
16 -- {Start Of Comments}
17 /*#
18 * This API creates Nature of Action Code/Remark combination records.
19 *
20 * This API creates a Nature of Action Code/Remark combination record in the
21 * table GHR_noac_remarks for an existing parent nature of action id and remark
22 * id
23 *
24 * <p><b>Licensing</b><br>
25 * This API is licensed for use with Human Resources.
26 *
27 * <p><b>Prerequisites</b><br>
28 * A parent nature of action id record must exist in GHR_nature_of_actions and
29 * a parent remark_id record must exist in GHR_remarks.
30 *
31 * <p><b>Post Success</b><br>
32 * The API creates the Nature of Action Code / Remark combination record in the
33 * database.
34 *
35 * <p><b>Post Failure</b><br>
36 * The API does not create the Nature of Action Code/Remark combination record
37 * and an error is raised.
38 * @param p_validate If true, then validation alone will be performed and the
39 * database will remain unchanged. If false and all validation checks pass,
40 * then the database will be modified.
41 * @param p_noac_remark_id If p_validate is false, then this uniquely
42 * identifies the Nature of Action/Remark combination record created. If
43 * p_validate is true, then set to null.
44 * @param p_nature_of_action_id {@rep:casecolumn
45 * GHR_NATURE_OF_ACTIONS.NATURE_OF_ACTION_ID}
46 * @param p_remark_id {@rep:casecolumn GHR_REMARKS.REMARK_ID}
47 * @param p_required_flag {@rep:casecolumn GHR_NOAC_REMARKS.REQUIRED_FLAG}
48 * @param p_enabled_flag {@rep:casecolumn GHR_NOAC_REMARKS.ENABLED_FLAG}
49 * @param p_date_from {@rep:casecolumn GHR_NOAC_REMARKS.DATE_FROM}
50 * @param p_date_to {@rep:casecolumn GHR_NOAC_REMARKS.DATE_TO}
51 * @param p_object_version_number If p_validate is false, then set to the
52 * version number of the created Noac_remarks_id. If p_validate is true, then
53 * the value will be null.
54 * @param p_effective_date Reference date for validating lookup values are
55 * applicable during the start to end active date range. This date does not
56 * determine when the changes take effect.
57 * @rep:displayname Create Nature of Action/Remark Combination
58 * @rep:category BUSINESS_ENTITY GHR_REQ_FOR_PERSONNEL_ACTION
59 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
60 * @rep:scope public
61 * @rep:lifecycle active
62 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
63 */
64 --
65 -- {End Of Comments}
66 --
67 procedure create_noac_remarks
68 (
69 p_validate in boolean default false
70 ,p_noac_remark_id out NOCOPY number
71 ,p_nature_of_action_id in number default null
72 ,p_remark_id in number default null
73 ,p_required_flag in varchar2 default null
74 ,p_enabled_flag in varchar2 default null
75 ,p_date_from in date default null
76 ,p_date_to in date default null
77 ,p_object_version_number out NOCOPY number
78 ,p_effective_date in date
79 );
80 --
81 -- ----------------------------------------------------------------------------
82 -- |---------------------------< update_noac_remarks >------------------------|
83 -- ----------------------------------------------------------------------------
84 --
85 -- {Start Of Comments}
86 /*#
87 * This API updates the Nature of Action Code/Remark combination records.
88 *
89 * This API updates a Nature of Action Code/Remark combination record in the
90 * table GHR_noac_remarks for an existing parent nature of action id.
91 *
92 * <p><b>Licensing</b><br>
93 * This API is licensed for use with Human Resources.
94 *
95 * <p><b>Prerequisites</b><br>
96 * A parent nature of action id record must exist in GHR_nature_of_actions and
97 * a parent remark_id record must exist in GHR_remarks.
98 *
99 * <p><b>Post Success</b><br>
100 * The API updates the Nature of Action Code/Remark combination record in the
101 * database.
102 *
103 * <p><b>Post Failure</b><br>
104 * The API does not update the Nature of Action/Remark combination record and
105 * an error is raised.
106 * @param p_validate If true, then validation alone will be performed and the
107 * database will remain unchanged. If false and all validation checks pass,
108 * then the database will be modified.
109 * @param p_noac_remark_id Uniquely identifies the Nature of action Code/Remark
110 * combination record.
111 * @param p_nature_of_action_id {@rep:casecolumn
112 * GHR_NATURE_OF_ACTIONS.NATURE_OF_ACTION_ID}
113 * @param p_remark_id {@rep:casecolumn GHR_REMARKS.REMARK_ID}
114 * @param p_required_flag {@rep:casecolumn GHR_NOAC_REMARKS.REQUIRED_FLAG}
115 * @param p_enabled_flag {@rep:casecolumn GHR_NOAC_REMARKS.ENABLED_FLAG}
116 * @param p_date_from {@rep:casecolumn GHR_NOAC_REMARKS.DATE_FROM}
117 * @param p_date_to {@rep:casecolumn GHR_NOAC_REMARKS.DATE_TO}
118 * @param p_object_version_number Pass in the current version number of the
119 * Nature of Action Code and remark code id to be updated. When the API
120 * completes if p_validate is false, will be set to the new version number of
121 * the updated Nature of Action Code and remark code id. If p_validate is true
122 * will be set to the same value which was passed in.
123 * @param p_effective_date Reference date for validating lookup values are
124 * applicable during the start to end active date range. This date does not
125 * determine when the changes take effect.
126 * @rep:displayname Update Nature of Action/Remark Combination
127 * @rep:category BUSINESS_ENTITY GHR_REQ_FOR_PERSONNEL_ACTION
128 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
129 * @rep:scope public
130 * @rep:lifecycle active
131 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
132 */
133 --
134 -- {End Of Comments}
135 --
136 procedure update_noac_remarks
137 (
138 p_validate in boolean default false
139 ,p_noac_remark_id in number
140 ,p_nature_of_action_id in number default hr_api.g_number
141 ,p_remark_id in number default hr_api.g_number
142 ,p_required_flag in varchar2 default hr_api.g_varchar2
143 ,p_enabled_flag in varchar2 default hr_api.g_varchar2
144 ,p_date_from in date default hr_api.g_date
145 ,p_date_to in date default hr_api.g_date
146 ,p_object_version_number in out NOCOPY number
147 ,p_effective_date in date
148 );
149 --
150 -- ----------------------------------------------------------------------------
151 -- |---------------------------< delete_noac_remarks >------------------------|
152 -- ----------------------------------------------------------------------------
153 --
154 -- {Start Of Comments}
155 /*#
156 * This API deletes Nature of Action Code/Remark combination records.
157 *
158 * This API deletes a Nature of Action Code/Remark combination records in the
159 * table GHR_noac_remarks for an existing parent nature of action id.
160 *
161 * <p><b>Licensing</b><br>
162 * This API is licensed for use with Human Resources.
163 *
164 * <p><b>Prerequisites</b><br>
165 * The Nature of Action Code/Remark combination record specified must exist.
166 *
167 * <p><b>Post Success</b><br>
168 * The API deletes the Nature of Action Code/Remark combination records from
169 * the database.
170 *
171 * <p><b>Post Failure</b><br>
172 * The API does not delete the Nature of action Code/Remark combination record
173 * and an error is raised.
174 * @param p_validate If true, then validation alone will be performed and the
175 * database will remain unchanged. If false and all validation checks pass,
176 * then the database will be modified.
177 * @param p_noac_remark_id Uniquely identifies the Nature of Action Code/Remark
178 * combination record.
179 * @param p_object_version_number Current version number of the Nature of
180 * Action Code/Remark combination to be deleted.
181 * @param p_effective_date Reference date for validating lookup values are
182 * applicable during the start to end active date range. This date does not
183 * determine when the changes take effect.
184 * @rep:displayname Delete Nature of Action/Remark Combination
185 * @rep:category BUSINESS_ENTITY GHR_REQ_FOR_PERSONNEL_ACTION
186 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
187 * @rep:scope public
188 * @rep:lifecycle active
189 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
190 */
191 --
192 -- {End Of Comments}
193 --
194 procedure delete_noac_remarks
195 (
196 p_validate in boolean default false
197 ,p_noac_remark_id in number
198 ,p_object_version_number in out NOCOPY number
199 ,p_effective_date in date
200 );
201 --
202 -- ----------------------------------------------------------------------------
203 -- |----------------------------------< lck >---------------------------------|
204 -- ----------------------------------------------------------------------------
205 -- {Start Of Comments}
206 --
207 -- Description:
208 --
209 -- Prerequisites:
210 --
211 --
212 -- In Parameters:
213 -- Name Reqd Type Description
214 -- p_noac_remark_id Yes number PK of record
215 -- p_object_version_number Yes number OVN of record
216 --
217 -- Post Success:
218 --
219 -- Name Type Description
220 --
221 -- Post Failure:
222 --
223 -- Access Status:
224 -- Public.
225 --
226 -- {End Of Comments}
227 --
228 procedure lck
229 (
230 p_noac_remark_id in number
231 ,p_object_version_number in number
232 );
233 --
234 end ghr_noac_remarks_api;
[Home] [Help]