DBA Data[Home] [Help]

PACKAGE: APPS.GHR_NOAC_LAS_API

Source


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