4 * This package contains Duty Station APIs.
1 Package ghr_duty_station_api AUTHID CURRENT_USER as
2 /* $Header: ghdutapi.pkh 120.1 2005/10/02 01:57:45 aroussel $ */
3 /*#
5 * @rep:scope public
6 * @rep:product per
7 * @rep:displayname Duty Station
8 */
9 --
10 -- ----------------------------------------------------------------------------
11 -- |---------------------------< create_duty_station >------------------------|
12 -- ----------------------------------------------------------------------------
13 --
14 -- {Start Of Comments}
15 /*#
16 * This API creates a new Duty Station.
17 *
18 * This API Inserts a Duty Station record in the ghr_duty_stations_f table. If
19 * p_validate is set to false, it inserts a new record into the table.
20 *
21 * <p><b>Licensing</b><br>
22 * This API is licensed for use with Human Resources.
23 *
24 * <p><b>Prerequisites</b><br>
25 * The State or Country code and the County code must be present to create a
26 * new duty station. Before creating a duty station, the user should confirm
27 * that the corresponding State or Country code and the County code exist in
28 * the ghr_duty_stations_f table. For non-US duty stations, the State or
32 *
29 * Country code and the County code are the same. Also, the locality pay area
30 * should be present in ghr_locality_pay_areas_f as of the duty station
31 * creation effective date.
33 * <p><b>Post Success</b><br>
34 * The Duty Station record is successfully inserted into the database.
35 *
36 * <p><b>Post Failure</b><br>
37 * The Duty Station record is not created and the process raises an error
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_duty_station_id {@rep:casecolumn
42 * GHR_DUTY_STATIONS_F.DUTY_STATION_ID}
43 * @param p_effective_start_date If p_validate is false, then set to the
44 * earliest effective start date for the created duty station. If p_validate is
45 * true, then set to null.
46 * @param p_effective_end_date If p_validate is false, then set to the
47 * effective end date for the created duty station. If p_validate is true, then
48 * set to null.
49 * @param p_locality_pay_area_id {@rep:casecolumn
50 * GHR_DUTY_STATIONS_F.LOCALITY_PAY_AREA_ID}
51 * @param p_leo_pay_area_code {@rep:casecolumn
52 * GHR_DUTY_STATIONS_F.LEO_PAY_AREA_CODE}
53 * @param p_name {@rep:casecolumn GHR_DUTY_STATIONS_F.NAME}
54 * @param p_duty_station_code {@rep:casecolumn
55 * GHR_DUTY_STATIONS_F.DUTY_STATION_CODE}
56 * @param p_msa_code {@rep:casecolumn GHR_DUTY_STATIONS_F.MSA_CODE}
57 * @param p_cmsa_code {@rep:casecolumn GHR_DUTY_STATIONS_F.CMSA_CODE}
58 * @param p_state_or_country_code State or Country code, first 2 characters of
59 * duty station code.
60 * @param p_county_code {@rep:casecolumn GHR_DUTY_STATIONS_F.COUNTY_CODE}
61 * @param p_is_duty_station Indicates if row is a Duty Station. If code only
62 * contains a State code, it is not a Duty Station.
63 * @param p_effective_date Determines when the DateTrack operation comes into
64 * force.
65 * @param p_object_version_number If p_validate is false, then set to the
66 * version number of the created Duty Station. If p_validate is true, then the
67 * value will be null.
68 * @rep:displayname Create Duty Station
69 * @rep:category BUSINESS_ENTITY GHR_DUTY_STATION
70 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
71 * @rep:scope public
72 * @rep:lifecycle active
73 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
74 */
75 --
76 -- {End Of Comments}
77 --
78 procedure create_duty_station
79 (p_validate in boolean default false
80 ,p_duty_station_id OUT nocopy number
81 ,p_effective_start_date out nocopy date
82 ,p_effective_end_date out nocopy date
83 ,p_locality_pay_area_id in number
84 ,p_leo_pay_area_code in varchar2 default null
85 ,p_name in varchar2 default null
86 ,p_duty_station_code in varchar2
87 ,p_msa_code in varchar2 default null
88 ,p_cmsa_code in varchar2 default null
89 ,p_state_or_country_code in varchar2
90 ,p_county_code in varchar2 default null
91 ,p_is_duty_station in varchar2 default 'Y'
92 ,p_effective_date in date
93 ,p_object_version_number out nocopy number
94 );
95 --
96 -- ----------------------------------------------------------------------------
97 -- |---------------------------< update_duty_station >------------------------|
98 -- ----------------------------------------------------------------------------
99 --
100 -- {Start Of Comments}
101 /*#
102 * This API updates the modified Duty Station details.
103 *
104 * This API updates Name, CMSA_code, MSA_code, Locality_pay_area_id,
105 * Leo_pay_area_id, Is_duty_station flag of an existing Duty Station record.
106 * The DateTrack mode determines how the process updates the rows.
107 *
108 * <p><b>Licensing</b><br>
109 * This API is licensed for use with Human Resources.
110 *
111 * <p><b>Prerequisites</b><br>
112 * The Duty Station record should exists as of the effective date.
113 *
114 * <p><b>Post Success</b><br>
115 * The API updates the modified Duty Station details.
116 *
117 * <p><b>Post Failure</b><br>
118 * The API does not update the Duty Station record and an error is raised.
119 * @param p_validate If true, then validation alone will be performed and the
120 * database will remain unchanged. If false and all validation checks pass,
121 * then the database will be modified.
122 * @param p_duty_station_id {@rep:casecolumn
123 * GHR_DUTY_STATIONS_F.DUTY_STATION_ID}
124 * @param p_effective_start_date If p_validate is false, then set to the
125 * effective start date on the updated duty station row which now exists as of
126 * the effective date. If p_validate is true, then set to null.
127 * @param p_effective_end_date If p_validate is false, then set to the
128 * effective end date on the updated duty station row which now exists as of
129 * the effective date. If p_validate is true, then set to null.
130 * @param p_locality_pay_area_id {@rep:casecolumn
131 * GHR_DUTY_STATIONS_F.LOCALITY_PAY_AREA_ID}
132 * @param p_leo_pay_area_code {@rep:casecolumn
133 * GHR_DUTY_STATIONS_F.LEO_PAY_AREA_CODE}
134 * @param p_name {@rep:casecolumn GHR_DUTY_STATIONS_F.NAME}
135 * @param p_duty_station_code {@rep:casecolumn
136 * GHR_DUTY_STATIONS_F.DUTY_STATION_CODE}
137 * @param p_msa_code {@rep:casecolumn GHR_DUTY_STATIONS_F.MSA_CODE}
138 * @param p_cmsa_code {@rep:casecolumn GHR_DUTY_STATIONS_F.CMSA_CODE}
139 * @param p_state_or_country_code State or Country code, first 2 characters of
140 * duty station code.
141 * @param p_county_code {@rep:casecolumn GHR_DUTY_STATIONS_F.COUNTY_CODE}
142 * @param p_is_duty_station Indicates if row is a Duty Station. If code only
143 * contains a State code, it is not a Duty Station.
147 * updating the record. You must set to either UPDATE, CORRECTION,
144 * @param p_effective_date Determines when the DateTrack operation comes into
145 * force.
146 * @param p_datetrack_update_mode Indicates which DateTrack mode to use when
148 * UPDATE_OVERRIDE or UPDATE_CHANGE_INSERT. Modes available for use with a
149 * particular record depend on the dates of previous record changes and the
150 * effective date of this change.
151 * @param p_object_version_number Pass in the current version number of the
152 * duty station to be updated. When the API completes if p_validate is false,
153 * will be set to the new version number of the updated duty station. If
154 * p_validate is true will be set to the same value which was passed in.
155 * @rep:displayname Update Duty Station
156 * @rep:category BUSINESS_ENTITY GHR_DUTY_STATION
157 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
158 * @rep:scope public
159 * @rep:lifecycle active
160 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
161 */
162 --
163 -- {End Of Comments}
164 --
165 procedure update_duty_station
166 (p_validate in boolean default false
167 ,p_duty_station_id in number
168 ,p_effective_start_date out nocopy date
169 ,p_effective_end_date out nocopy date
170 ,p_locality_pay_area_id in number
171 ,p_leo_pay_area_code in varchar2 default hr_api.g_varchar2
172 ,p_name in varchar2 default hr_api.g_varchar2
173 ,p_duty_station_code in varchar2
174 ,p_msa_code in varchar2
175 ,p_cmsa_code in varchar2
176 ,p_state_or_country_code in varchar2
177 ,p_county_code in varchar2
178 ,p_is_duty_station in varchar2 default hr_api.g_varchar2
179 ,p_effective_date in date
180 ,p_datetrack_update_mode in varchar2
181 ,p_object_version_number IN out nocopy number
182 );
183 --
184 -- ----------------------------------------------------------------------------
185 -- |---------------------------< delete_duty_station >------------------------|
186 -- ----------------------------------------------------------------------------
187 --
188 -- {Start Of Comments}
189 /*#
190 * This API end dates the existing Duty Station record.
191 *
192 * This API allows DateTrack modes other than ZAP. This process allows users
193 * only to end date, not purge duty stations.
194 *
195 * <p><b>Licensing</b><br>
196 * This API is licensed for use with Human Resources.
197 *
198 * <p><b>Prerequisites</b><br>
199 * To end date a Duty Station, ensure that no active assignments containing a
200 * Location with the Duty Station exist after the Duty Station end date. If
201 * active assignments exist, delete them before end dating the Duty Station
202 * record.
203 *
204 * <p><b>Post Success</b><br>
205 * The Duty Station record is end dated in the database.
206 *
207 * <p><b>Post Failure</b><br>
208 * The API does not end date the Duty Station record and an error is raised.
209 * @param p_validate If true, then validation alone will be performed and the
210 * database will remain unchanged. If false and all validation checks pass,
211 * then the database will be modified.
212 * @param p_duty_station_id {@rep:casecolumn
213 * GHR_DUTY_STATIONS_F.DUTY_STATION_ID}
214 * @param p_effective_start_date If p_validate is false, then set to the
215 * effective start date for the Deleted Duty Station row which now exists as of
216 * the effective date. If p_validate is true or all row instances have been
217 * deleted then set to null.
218 * @param p_effective_end_date If p_validate is false, then set to the
219 * effective End Date for the deleted Duty Station row which now exists as of
220 * the effective date. If p_validate is true or all row instances have been
221 * deleted then set to null.
222 * @param p_object_version_number Current version number of the Duty Station to
223 * be deleted.
224 * @param p_effective_date Determines when the DateTrack operation comes into
225 * force.
226 * @param p_datetrack_mode Indicates which DateTrack mode to use when deleting
227 * the record. You must set to either DELETE, FUTURE_CHANGE or
228 * DELETE_NEXT_CHANGE. Modes available for use with a particular record depend
229 * on the dates of previous record changes and the effective date of this
230 * change.
231 * @rep:displayname Delete Existing Duty Station
232 * @rep:category BUSINESS_ENTITY GHR_DUTY_STATION
233 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
234 * @rep:scope public
235 * @rep:lifecycle active
236 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
237 */
238 --
239 -- {End Of Comments}
240 --
241 procedure delete_duty_station
242 (p_validate in boolean default false
243 ,p_duty_station_id in number
244 ,p_effective_start_date out nocopy date
245 ,p_effective_end_date out nocopy date
246 ,p_object_version_number in number
247 ,p_effective_date in date
248 ,p_datetrack_mode in varchar2
249 );
250 end ghr_duty_station_api;
[Home] [Help]