1 Package pay_pgp_shd AUTHID CURRENT_USER as
2 /* $Header: pypgprhi.pkh 115.0 99/07/17 06:22:06 porting ship $ */
3 --
4 -- ----------------------------------------------------------------------------
5 -- | Global Record Type Specification |
6 -- ----------------------------------------------------------------------------
7 --
8 Type g_rec_type Is Record
9 (
10 people_group_id number(15),
11 group_name varchar2(240),
12 id_flex_num number(15),
13 summary_flag varchar2(9), -- Increased length
14 enabled_flag varchar2(9), -- Increased length
15 start_date_active date,
16 end_date_active date,
17 segment1 varchar2(60),
18 segment2 varchar2(60),
19 segment3 varchar2(60),
20 segment4 varchar2(60),
21 segment5 varchar2(60),
22 segment6 varchar2(60),
23 segment7 varchar2(60),
24 segment8 varchar2(60),
25 segment9 varchar2(60),
26 segment10 varchar2(60),
27 segment11 varchar2(60),
28 segment12 varchar2(60),
29 segment13 varchar2(60),
30 segment14 varchar2(60),
31 segment15 varchar2(60),
32 segment16 varchar2(60),
33 segment17 varchar2(60),
34 segment18 varchar2(60),
35 segment19 varchar2(60),
36 segment20 varchar2(60),
37 segment21 varchar2(60),
38 segment22 varchar2(60),
39 segment23 varchar2(60),
40 segment24 varchar2(60),
41 segment25 varchar2(60),
42 segment26 varchar2(60),
43 segment27 varchar2(60),
44 segment28 varchar2(60),
45 segment29 varchar2(60),
46 segment30 varchar2(60)
47 );
48 --
49 -- ----------------------------------------------------------------------------
50 -- | Global Definitions - Internal Development Use Only |
51 -- ----------------------------------------------------------------------------
52 --
53 g_old_rec g_rec_type; -- Global record definition
54 g_api_dml boolean; -- Global api dml status
55 --
56 -- ----------------------------------------------------------------------------
57 -- |------------------------< segment_combination_check >---------------------|
58 -- ----------------------------------------------------------------------------
59 -- {Start Of Comments}
60 --
61 -- Description:
62 -- This procedure determines the combination state for the specified
63 -- people group combination segments. The returning
64 -- p_people_group_id can have three states:
65 --
66 -- p_people_group_id
67 -- state meaning
68 -- ===================== =======
69 -- -1 Segment combination does not exist
70 -- null The segment combination is null
71 -- id A segment combination has been found
72 --
73 -- Depending on the p_people_group_id state the following out arguments
74 -- are either set or null.
75 --
76 -- p_people_group_id out
77 -- state argument set
78 -- ===================== ======== ===
79 -- -1 p_id_flex_num Y
80 --
81 -- null p_id_flex_num N
82 --
83 -- id p_id_flex_num Y
84 --
85 -- Pre Conditions:
86 --
87 -- In Arguments:
88 -- segments1..30
89 -- p_business_group_id => is specified to enable the derivation of the
90 -- id_flex_num within this process
91 --
92 -- Post Success:
93 -- Depending on the p_people_group_id state the corresponding out
94 -- arguments will be set.
95 --
96 -- Post Failure:
97 -- This procedure should never fail.
98 --
99 -- Developer Implementation Notes:
100 -- None.
101 --
102 -- Access Status:
103 -- Internal Development Use Only.
104 --
105 -- {End Of Comments}
106 -- ----------------------------------------------------------------------------
107 procedure segment_combination_check
108 (p_segment1 in varchar2 default null,
109 p_segment2 in varchar2 default null,
110 p_segment3 in varchar2 default null,
111 p_segment4 in varchar2 default null,
112 p_segment5 in varchar2 default null,
113 p_segment6 in varchar2 default null,
114 p_segment7 in varchar2 default null,
115 p_segment8 in varchar2 default null,
116 p_segment9 in varchar2 default null,
117 p_segment10 in varchar2 default null,
118 p_segment11 in varchar2 default null,
119 p_segment12 in varchar2 default null,
120 p_segment13 in varchar2 default null,
121 p_segment14 in varchar2 default null,
122 p_segment15 in varchar2 default null,
123 p_segment16 in varchar2 default null,
124 p_segment17 in varchar2 default null,
125 p_segment18 in varchar2 default null,
126 p_segment19 in varchar2 default null,
127 p_segment20 in varchar2 default null,
128 p_segment21 in varchar2 default null,
129 p_segment22 in varchar2 default null,
130 p_segment23 in varchar2 default null,
131 p_segment24 in varchar2 default null,
132 p_segment25 in varchar2 default null,
133 p_segment26 in varchar2 default null,
134 p_segment27 in varchar2 default null,
135 p_segment28 in varchar2 default null,
136 p_segment29 in varchar2 default null,
137 p_segment30 in varchar2 default null,
138 p_business_group_id in number,
139 p_people_group_id out number,
140 p_group_name out varchar2,
141 p_id_flex_num out number);
142 --
143 -- ----------------------------------------------------------------------------
144 -- |------------------------< return_api_dml_status >-------------------------|
145 -- ----------------------------------------------------------------------------
146 -- {Start Of Comments}
147 --
148 -- Description:
149 -- This function will return the current g_api_dml private global
150 -- boolean status.
151 -- The g_api_dml status determines if at the time of the function
152 -- being executed if a dml statement (i.e. INSERT, UPDATE or DELETE)
153 -- is being issued from within an api.
154 -- If the status is TRUE then a dml statement is being issued from
155 -- within this entity api.
156 -- This function is primarily to support database triggers which
157 -- need to maintain the object_version_number for non-supported
158 -- dml statements (i.e. dml statement issued outside of the api layer).
159 --
160 -- Pre Conditions:
161 -- None.
162 --
163 -- In Arguments:
164 -- None.
165 --
166 -- Post Success:
167 -- Processing continues.
168 -- If the function returns a TRUE value then, dml is being executed from
169 -- within this api.
170 --
171 -- Post Failure:
172 -- None.
173 --
174 -- Access Status:
175 -- Internal Table Handler Use Only.
176 --
177 -- {End Of Comments}
178 -- ----------------------------------------------------------------------------
179 Function return_api_dml_status Return Boolean;
180 --
181 -- ----------------------------------------------------------------------------
182 -- |---------------------------< constraint_error >---------------------------|
183 -- ----------------------------------------------------------------------------
184 -- {Start Of Comments}
185 --
186 -- Description:
187 -- This procedure is called when a constraint has been violated (i.e.
188 -- The exception hr_api.check_integrity_violated,
189 -- hr_api.parent_integrity_violated, hr_api.child_integrity_violated or
190 -- hr_api.unique_integrity_violated has been raised).
191 -- The exceptions can only be raised as follows:
192 -- 1) A check constraint can only be violated during an INSERT or UPDATE
193 -- dml operation.
194 -- 2) A parent integrity constraint can only be violated during an
195 -- INSERT or UPDATE dml operation.
196 -- 3) A child integrity constraint can only be violated during an
197 -- DELETE dml operation.
198 -- 4) A unique integrity constraint can only be violated during INSERT or
199 -- UPDATE dml operation.
200 --
201 -- Pre Conditions:
202 -- 1) Either hr_api.check_integrity_violated,
203 -- hr_api.parent_integrity_violated, hr_api.child_integrity_violated or
204 -- hr_api.unique_integrity_violated has been raised with the subsequent
205 -- stripping of the constraint name from the generated error message
206 -- text.
207 -- 2) Standalone validation test which correspond with a constraint error.
208 --
209 -- In Arguments:
210 -- p_constraint_name is in upper format and is just the constraint name
211 -- (e.g. not prefixed by brackets, schema owner etc).
212 --
213 -- Post Success:
214 -- Development dependant.
215 --
216 -- Post Failure:
217 -- Developement dependant.
218 --
219 -- Developer Implementation Notes:
220 -- For each constraint being checked the hr system package failure message
221 -- has been generated as a template only. These system error messages should
222 -- be modified as required (i.e. change the system failure message to a user
223 -- friendly defined error message).
224 --
225 -- Access Status:
226 -- Internal Development Use Only.
227 --
228 -- {End Of Comments}
229 -- ----------------------------------------------------------------------------
230 Procedure constraint_error
231 (p_constraint_name in all_constraints.constraint_name%TYPE);
232 --
233 -- ----------------------------------------------------------------------------
234 -- |-----------------------------< api_updating >-----------------------------|
235 -- ----------------------------------------------------------------------------
236 -- {Start Of Comments}
237 --
238 -- Description:
239 -- This function is used to populate the g_old_rec record with the
240 -- current row from the database for the specified primary key
241 -- provided that the primary key exists and is valid and does not
242 -- already match the current g_old_rec. The function will always return
243 -- a TRUE value if the g_old_rec is populated with the current row.
244 -- A FALSE value will be returned if all of the primary key arguments
245 -- are null.
246 --
247 -- Pre Conditions:
248 -- None.
249 --
250 -- In Arguments:
251 --
252 -- Post Success:
253 -- A value of TRUE will be returned indiciating that the g_old_rec
254 -- is current.
255 -- A value of FALSE will be returned if all of the primary key arguments
256 -- have a null value (this indicates that the row has not be inserted into
257 -- the Schema), and therefore could never have a corresponding row.
258 --
259 -- Post Failure:
260 -- A failure can only occur under two circumstances:
261 -- 1) The primary key is invalid (i.e. a row does not exist for the
262 -- specified primary key values).
263 --
264 -- Developer Implementation Notes:
265 -- None.
266 --
267 -- Access Status:
268 -- Internal Development Use Only.
269 --
270 -- {End Of Comments}
271 -- ----------------------------------------------------------------------------
272 Function api_updating(p_people_group_id in number) Return Boolean;
273 --
274 -- ----------------------------------------------------------------------------
275 -- |-----------------------------< convert_args >-----------------------------|
276 -- ----------------------------------------------------------------------------
277 -- {Start Of Comments}
278 --
279 -- Description:
280 -- This function is used to turn attribute arguments into the record
281 -- structure g_rec_type.
282 --
283 -- Pre Conditions:
284 -- This is a private function and can only be called from the ins or upd
285 -- attribute processes.
286 --
287 -- In Arguments:
288 --
289 -- Post Success:
290 -- A returning record structure will be returned.
291 --
292 -- Post Failure:
293 -- No direct error handling is required within this function. Any possible
294 -- errors within this function will be a PL/SQL value error due to conversion
295 -- of datatypes or data lengths.
296 --
297 -- Developer Implementation Notes:
298 -- None.
299 --
300 -- Access Status:
301 -- Internal Table Handler Use Only.
302 --
303 -- {End Of Comments}
304 -- ----------------------------------------------------------------------------
305 Function convert_args
306 (
307 p_people_group_id in number,
308 p_group_name in varchar2,
309 p_id_flex_num in number,
310 p_summary_flag in varchar2,
311 p_enabled_flag in varchar2,
312 p_start_date_active in date,
313 p_end_date_active in date,
314 p_segment1 in varchar2,
315 p_segment2 in varchar2,
316 p_segment3 in varchar2,
317 p_segment4 in varchar2,
318 p_segment5 in varchar2,
319 p_segment6 in varchar2,
320 p_segment7 in varchar2,
321 p_segment8 in varchar2,
322 p_segment9 in varchar2,
323 p_segment10 in varchar2,
324 p_segment11 in varchar2,
325 p_segment12 in varchar2,
326 p_segment13 in varchar2,
327 p_segment14 in varchar2,
328 p_segment15 in varchar2,
329 p_segment16 in varchar2,
330 p_segment17 in varchar2,
331 p_segment18 in varchar2,
332 p_segment19 in varchar2,
333 p_segment20 in varchar2,
334 p_segment21 in varchar2,
335 p_segment22 in varchar2,
336 p_segment23 in varchar2,
337 p_segment24 in varchar2,
338 p_segment25 in varchar2,
339 p_segment26 in varchar2,
340 p_segment27 in varchar2,
341 p_segment28 in varchar2,
342 p_segment29 in varchar2,
343 p_segment30 in varchar2
344 )
345 Return g_rec_type;
346 --
347 end pay_pgp_shd;