DBA Data[Home] [Help]

PACKAGE: APPS.PER_PMP_SHD

Source


1 Package per_pmp_shd as
2 /* $Header: pepmprhi.pkh 120.2 2006/08/11 05:49:43 tpapired noship $ */
3 --
4 -- ----------------------------------------------------------------------------
5 -- |                    Global Record Type Specification                      |
6 -- ----------------------------------------------------------------------------
7 --
8 Type g_rec_type Is Record
9   (plan_id                         number(15)
10   ,object_version_number           number(15)
11   ,plan_name                       varchar2(400)
12   ,administrator_person_id         number(15)
13   ,previous_plan_id                number(15)
14   ,start_date                      date
15   ,end_date                        date
16   ,status_code                     varchar2(30)
17   ,hierarchy_type_code             varchar2(30)
18   ,supervisor_id                   number(15)
19   ,supervisor_assignment_id        number(15)
20   ,organization_structure_id       number(15)
21   ,org_structure_version_id        number(15)
22   ,top_organization_id           number(15)
23   ,position_structure_id           number(15)
24   ,pos_structure_version_id        number(15)
25   ,top_position_id               number(15)
26   ,hierarchy_levels                number(15)
27   ,automatic_enrollment_flag       varchar2(30)
28   ,assignment_types_code           varchar2(30)
29   ,primary_asg_only_flag           varchar2(30)
30   ,include_obj_setting_flag        varchar2(30)
31   ,obj_setting_start_date          date
32   ,obj_setting_deadline            date
33   ,obj_set_outside_period_flag     varchar2(30)
34   ,method_code                     varchar2(30)
35   ,notify_population_flag          varchar2(30)
36   ,automatic_allocation_flag       varchar2(30)
37   ,copy_past_objectives_flag       varchar2(30)
38   ,sharing_alignment_task_flag     varchar2(30)
39   ,include_appraisals_flag         varchar2(30)
40   ,change_sc_status_flag    varchar2(30)
41   ,attribute_category              varchar2(30)
42   ,attribute1                      varchar2(150)
43   ,attribute2                      varchar2(150)
44   ,attribute3                      varchar2(150)
45   ,attribute4                      varchar2(150)
46   ,attribute5                      varchar2(150)
47   ,attribute6                      varchar2(150)
48   ,attribute7                      varchar2(150)
49   ,attribute8                      varchar2(150)
50   ,attribute9                      varchar2(150)
51   ,attribute10                     varchar2(150)
52   ,attribute11                     varchar2(150)
53   ,attribute12                     varchar2(150)
54   ,attribute13                     varchar2(150)
55   ,attribute14                     varchar2(150)
56   ,attribute15                     varchar2(150)
57   ,attribute16                     varchar2(150)
58   ,attribute17                     varchar2(150)
59   ,attribute18                     varchar2(150)
60   ,attribute19                     varchar2(150)
61   ,attribute20                     varchar2(150)
62   ,attribute21                     varchar2(150)
63   ,attribute22                     varchar2(150)
64   ,attribute23                     varchar2(150)
65   ,attribute24                     varchar2(150)
66   ,attribute25                     varchar2(150)
67   ,attribute26                     varchar2(150)
68   ,attribute27                     varchar2(150)
69   ,attribute28                     varchar2(150)
70   ,attribute29                     varchar2(150)
71   ,attribute30                     varchar2(150)
72   );
73 --
74 -- ----------------------------------------------------------------------------
75 -- |           Global Definitions - Internal Development Use Only             |
76 -- ----------------------------------------------------------------------------
77 --
78 g_old_rec  g_rec_type;                            -- Global record definition
79 -- Global table name
80 g_tab_nam  constant varchar2(30) := 'PER_PERF_MGMT_PLANS';
81 --
82 -- ----------------------------------------------------------------------------
83 -- |---------------------------< constraint_error >---------------------------|
84 -- ----------------------------------------------------------------------------
85 -- {Start Of Comments}
86 --
87 -- Description:
88 --   This procedure is called when a constraint has been violated (i.e.
89 --   The exception hr_api.check_integrity_violated,
90 --   hr_api.parent_integrity_violated, hr_api.child_integrity_violated or
91 --   hr_api.unique_integrity_violated has been raised).
92 --   The exceptions can only be raised as follows:
93 --   1) A check constraint can only be violated during an INSERT or UPDATE
94 --      dml operation.
95 --   2) A parent integrity constraint can only be violated during an
96 --      INSERT or UPDATE dml operation.
97 --   3) A child integrity constraint can only be violated during an
98 --      DELETE dml operation.
99 --   4) A unique integrity constraint can only be violated during INSERT or
100 --      UPDATE dml operation.
101 --
102 -- Prerequisites:
103 --   1) Either hr_api.check_integrity_violated,
104 --      hr_api.parent_integrity_violated, hr_api.child_integrity_violated or
105 --      hr_api.unique_integrity_violated has been raised with the subsequent
106 --      stripping of the constraint name from the generated error message
107 --      text.
108 --   2) Standalone validation test which corresponds with a constraint error.
109 --
110 -- In Parameter:
111 --   p_constraint_name is in upper format and is just the constraint name
112 --   (e.g. not prefixed by brackets, schema owner etc).
113 --
114 -- Post Success:
115 --   Development dependant.
116 --
117 -- Post Failure:
118 --   Developement dependant.
119 --
120 -- Developer Implementation Notes:
121 --   For each constraint being checked the hr system package failure message
122 --   has been generated as a template only. These system error messages should
123 --   be modified as required (i.e. change the system failure message to a user
124 --   friendly defined error message).
125 --
126 -- Access Status:
127 --   Internal Development Use Only.
128 --
129 -- {End Of Comments}
130 -- ----------------------------------------------------------------------------
131 Procedure constraint_error
132   (p_constraint_name in all_constraints.constraint_name%TYPE);
133 --
134 -- ----------------------------------------------------------------------------
135 -- |-----------------------------< api_updating >-----------------------------|
136 -- ----------------------------------------------------------------------------
137 --  {Start Of Comments}
138 --
139 -- Description:
140 --   This function is used to populate the g_old_rec record with the
141 --   current row from the database for the specified primary key
145 --   A FALSE value will be returned if all of the primary key arguments
142 --   provided that the primary key exists and is valid and does not
143 --   already match the current g_old_rec. The function will always return
144 --   a TRUE value if the g_old_rec is populated with the current row.
146 --   are null.
147 --
148 -- Prerequisites:
149 --   None.
150 --
151 -- In Parameters:
152 --
153 -- Post Success:
154 --   A value of TRUE will be returned indiciating that the g_old_rec
155 --   is current.
156 --   A value of FALSE will be returned if all of the primary key arguments
157 --   have a null value (this indicates that the row has not be inserted into
158 --   the Schema), and therefore could never have a corresponding row.
159 --
160 -- Post Failure:
161 --   A failure can only occur under two circumstances:
162 --   1) The primary key is invalid (i.e. a row does not exist for the
163 --      specified primary key values).
164 --   2) If an object_version_number exists but is NOT the same as the current
165 --      g_old_rec value.
166 --
167 -- Developer Implementation Notes:
168 --   None.
169 --
173 -- {End Of Comments}
170 -- Access Status:
171 --   Internal Development Use Only.
172 --
174 -- ----------------------------------------------------------------------------
175 Function api_updating
176   (p_plan_id                              in     number
177   ,p_object_version_number                in     number
178   )      Return Boolean;
179 --
180 -- ----------------------------------------------------------------------------
181 -- |---------------------------------< lck >----------------------------------|
182 -- ----------------------------------------------------------------------------
183 -- {Start of comments}
184 --
185 -- Description:
186 --   The Lck process has two main functions to perform. Firstly, the row to be
187 --   updated or deleted must be locked. The locking of the row will only be
188 --   successful if the row is not currently locked by another user.
189 --   Secondly, during the locking of the row, the row is selected into
190 --   the g_old_rec data structure which enables the current row values from
191 --   the server to be available to the api.
192 --
193 -- Prerequisites:
194 --   When attempting to call the lock the object version number (if defined)
195 --   is mandatory.
196 --
197 -- In Parameters:
198 --   The arguments to the Lck process are the primary key(s) which uniquely
199 --   identify the row and the object version number of row.
200 --
201 -- Post Success:
202 --   On successful completion of the Lck process the row to be updated or
203 --   deleted will be locked and selected into the global data structure
204 --   g_old_rec.
205 --
206 -- Post Failure:
207 --   The Lck process can fail for three reasons:
208 --   1) When attempting to lock the row the row could already be locked by
209 --      another user. This will raise the HR_Api.Object_Locked exception.
210 --   2) The row which is required to be locked doesn't exist in the HR Schema.
211 --      This error is trapped and reported using the message name
212 --      'HR_7220_INVALID_PRIMARY_KEY'.
213 --   3) The row although existing in the HR Schema has a different object
214 --      version number than the object version number specified.
215 --      This error is trapped and reported using the message name
216 --      'HR_7155_OBJECT_INVALID'.
217 --
218 -- Developer Implementation Notes:
219 --   For each primary key and the object version number arguments add a
220 --   call to hr_api.mandatory_arg_error procedure to ensure that these
221 --   argument values are not null.
222 --
223 -- Access Status:
224 --   Internal Development Use Only.
225 --
226 -- {End of comments}
227 -- ----------------------------------------------------------------------------
228 Procedure lck
229   (p_plan_id                              in     number
230   ,p_object_version_number                in     number
231   );
232 --
233 -- ----------------------------------------------------------------------------
234 -- |-----------------------------< convert_args >-----------------------------|
235 -- ----------------------------------------------------------------------------
236 -- {Start Of Comments}
237 --
238 -- Description:
239 --   This function is used to turn attribute parameters into the record
240 --   structure parameter g_rec_type.
241 --
242 -- Prerequisites:
243 --   This is a private function and can only be called from the ins or upd
244 --   attribute processes.
245 --
246 -- In Parameters:
247 --
248 -- Post Success:
249 --   A returning record structure will be returned.
250 --
251 -- Post Failure:
252 --   No direct error handling is required within this function.  Any possible
253 --   errors within this function will be a PL/SQL value error due to
254 --   conversion of datatypes or data lengths.
255 --
256 -- Developer Implementation Notes:
257 --   None.
258 --
259 -- Access Status:
260 --   Internal Row Handler Use Only.
261 --
262 -- {End Of Comments}
263 -- ----------------------------------------------------------------------------
264 Function convert_args
265   (p_plan_id                        in number
266   ,p_object_version_number          in number
267   ,p_plan_name                      in varchar2
268   ,p_administrator_person_id        in number
269   ,p_previous_plan_id               in number
270   ,p_start_date                     in date
271   ,p_end_date                       in date
272   ,p_status_code                    in varchar2
273   ,p_hierarchy_type_code            in varchar2
274   ,p_supervisor_id                  in number
275   ,p_supervisor_assignment_id       in number
276   ,p_organization_structure_id      in number
277   ,p_org_structure_version_id       in number
278   ,p_top_organization_id            in number
279   ,p_position_structure_id          in number
280   ,p_pos_structure_version_id       in number
281   ,p_top_position_id                in number
282   ,p_hierarchy_levels               in number
283   ,p_automatic_enrollment_flag      in varchar2
284   ,p_assignment_types_code          in varchar2
285   ,p_primary_asg_only_flag          in varchar2
286   ,p_include_obj_setting_flag       in varchar2
287   ,p_obj_setting_start_date         in date
288   ,p_obj_setting_deadline           in date
289   ,p_obj_set_outside_period_flag    in varchar2
290   ,p_method_code                    in varchar2
291   ,p_notify_population_flag         in varchar2
292   ,p_automatic_allocation_flag      in varchar2
293   ,p_copy_past_objectives_flag      in varchar2
294   ,p_sharing_alignment_task_flag    in varchar2
295   ,p_include_appraisals_flag        in varchar2
299   ,p_attribute2                     in varchar2
296   ,p_change_sc_status_flag     in varchar2
297   ,p_attribute_category             in varchar2
298   ,p_attribute1                     in varchar2
300   ,p_attribute3                     in varchar2
301   ,p_attribute4                     in varchar2
302   ,p_attribute5                     in varchar2
303   ,p_attribute6                     in varchar2
304   ,p_attribute7                     in varchar2
305   ,p_attribute8                     in varchar2
306   ,p_attribute9                     in varchar2
307   ,p_attribute10                    in varchar2
308   ,p_attribute11                    in varchar2
309   ,p_attribute12                    in varchar2
310   ,p_attribute13                    in varchar2
311   ,p_attribute14                    in varchar2
312   ,p_attribute15                    in varchar2
313   ,p_attribute16                    in varchar2
314   ,p_attribute17                    in varchar2
315   ,p_attribute18                    in varchar2
316   ,p_attribute19                    in varchar2
317   ,p_attribute20                    in varchar2
318   ,p_attribute21                    in varchar2
319   ,p_attribute22                    in varchar2
320   ,p_attribute23                    in varchar2
321   ,p_attribute24                    in varchar2
322   ,p_attribute25                    in varchar2
323   ,p_attribute26                    in varchar2
324   ,p_attribute27                    in varchar2
325   ,p_attribute28                    in varchar2
326   ,p_attribute29                    in varchar2
327   ,p_attribute30                    in varchar2
328   )
329   Return g_rec_type;
330 --
331 end per_pmp_shd;