DBA Data[Home] [Help]

PACKAGE: APPS.PER_CTK_SHD

Source


1 Package per_ctk_shd as
2 /* $Header: pectkrhi.pkh 120.5 2006/09/06 06:03:49 sturlapa noship $ */
3 --
4 -- ----------------------------------------------------------------------------
5 -- |                    Global Record Type Specification                      |
6 -- ----------------------------------------------------------------------------
7 --
8 Type g_rec_type Is Record
9   (task_in_checklist_id            number(15)
10   ,checklist_id                    number(15)
11   ,checklist_task_name             varchar2(240)
12   ,eligibility_object_id           number(15)
13   ,eligibility_profile_id          number(15)
14   ,ame_attribute_identifier        varchar2(30)
15   ,description                     varchar2(360)
16   ,mandatory_flag                  varchar2(30)
17   ,target_duration                 number(9)
18   ,target_duration_uom             varchar2(30)
19   ,task_sequence                   number(9)
20   ,object_version_number           number(9)
21   ,action_url                      varchar2(1000)
22   ,attribute_category              varchar2(30)
23   ,attribute1                      varchar2(150)
24   ,attribute2                      varchar2(150)
25   ,attribute3                      varchar2(150)
26   ,attribute4                      varchar2(150)
27   ,attribute5                      varchar2(150)
28   ,attribute6                      varchar2(150)
29   ,attribute7                      varchar2(150)
30   ,attribute8                      varchar2(150)
31   ,attribute9                      varchar2(150)
32   ,attribute10                     varchar2(150)
33   ,attribute11                     varchar2(150)
34   ,attribute12                     varchar2(150)
35   ,attribute13                     varchar2(150)
36   ,attribute14                     varchar2(150)
37   ,attribute15                     varchar2(150)
38   ,attribute16                     varchar2(150)
39   ,attribute17                     varchar2(150)
40   ,attribute18                     varchar2(150)
41   ,attribute19                     varchar2(150)
42   ,attribute20                     varchar2(150)
43   ,information_category            varchar2(30)
44   ,information1                    varchar2(150)
45   ,information2                    varchar2(150)
46   ,information3                    varchar2(150)
47   ,information4                    varchar2(150)
48   ,information5                    varchar2(150)
49   ,information6                    varchar2(150)
50   ,information7                    varchar2(150)
51   ,information8                    varchar2(150)
52   ,information9                    varchar2(150)
53   ,information10                   varchar2(150)
54   ,information11                   varchar2(150)
55   ,information12                   varchar2(150)
56   ,information13                   varchar2(150)
57   ,information14                   varchar2(150)
58   ,information15                   varchar2(150)
59   ,information16                   varchar2(150)
60   ,information17                   varchar2(150)
61   ,information18                   varchar2(150)
62   ,information19                   varchar2(150)
63   ,information20                   varchar2(150)
64   );
65 --
66 -- ----------------------------------------------------------------------------
67 -- |           Global Definitions - Internal Development Use Only             |
68 -- ----------------------------------------------------------------------------
69 --
70 g_old_rec  g_rec_type;                            -- Global record definition
71 -- Global table name
72 g_tab_nam  constant varchar2(30) := 'PER_TASKS_IN_CHECKLIST';
73 --
74 -- ----------------------------------------------------------------------------
75 -- |---------------------------< constraint_error >---------------------------|
76 -- ----------------------------------------------------------------------------
77 -- {Start Of Comments}
78 --
79 -- Description:
80 --   This procedure is called when a constraint has been violated (i.e.
81 --   The exception hr_api.check_integrity_violated,
82 --   hr_api.parent_integrity_violated, hr_api.child_integrity_violated or
83 --   hr_api.unique_integrity_violated has been raised).
84 --   The exceptions can only be raised as follows:
85 --   1) A check constraint can only be violated during an INSERT or UPDATE
86 --      dml operation.
87 --   2) A parent integrity constraint can only be violated during an
88 --      INSERT or UPDATE dml operation.
89 --   3) A child integrity constraint can only be violated during an
90 --      DELETE dml operation.
91 --   4) A unique integrity constraint can only be violated during INSERT or
92 --      UPDATE dml operation.
93 --
94 -- Prerequisites:
95 --   1) Either hr_api.check_integrity_violated,
96 --      hr_api.parent_integrity_violated, hr_api.child_integrity_violated or
97 --      hr_api.unique_integrity_violated has been raised with the subsequent
98 --      stripping of the constraint name from the generated error message
99 --      text.
100 --   2) Standalone validation test which corresponds with a constraint error.
101 --
102 -- In Parameter:
103 --   p_constraint_name is in upper format and is just the constraint name
104 --   (e.g. not prefixed by brackets, schema owner etc).
105 --
106 -- Post Success:
107 --   Development dependant.
108 --
109 -- Post Failure:
110 --   Developement dependant.
111 --
112 -- Developer Implementation Notes:
113 --   For each constraint being checked the hr system package failure message
114 --   has been generated as a template only. These system error messages should
115 --   be modified as required (i.e. change the system failure message to a user
116 --   friendly defined error message).
117 --
118 -- Access Status:
119 --   Internal Development Use Only.
120 --
121 -- {End Of Comments}
122 -- ----------------------------------------------------------------------------
123 Procedure constraint_error
124   (p_constraint_name in all_constraints.constraint_name%TYPE);
125 --
126 -- ----------------------------------------------------------------------------
127 -- |-----------------------------< api_updating >-----------------------------|
128 -- ----------------------------------------------------------------------------
129 --  {Start Of Comments}
130 --
131 -- Description:
132 --   This function is used to populate the g_old_rec record with the
133 --   current row from the database for the specified primary key
134 --   provided that the primary key exists and is valid and does not
135 --   already match the current g_old_rec. The function will always return
136 --   a TRUE value if the g_old_rec is populated with the current row.
137 --   A FALSE value will be returned if all of the primary key arguments
138 --   are null.
139 --
140 -- Prerequisites:
141 --   None.
142 --
146 --   A value of TRUE will be returned indiciating that the g_old_rec
143 -- In Parameters:
144 --
145 -- Post Success:
147 --   is current.
148 --   A value of FALSE will be returned if all of the primary key arguments
149 --   have a null value (this indicates that the row has not be inserted into
150 --   the Schema), and therefore could never have a corresponding row.
151 --
152 -- Post Failure:
153 --   A failure can only occur under two circumstances:
154 --   1) The primary key is invalid (i.e. a row does not exist for the
155 --      specified primary key values).
156 --   2) If an object_version_number exists but is NOT the same as the current
157 --      g_old_rec value.
158 --
159 -- Developer Implementation Notes:
160 --   None.
161 --
162 -- Access Status:
163 --   Internal Development Use Only.
164 --
165 -- {End Of Comments}
166 -- ----------------------------------------------------------------------------
167 Function api_updating
168   (p_task_in_checklist_id                 in     number
169   ,p_object_version_number                in     number
170   )      Return Boolean;
171 --
172 -- ----------------------------------------------------------------------------
173 -- |---------------------------------< lck >----------------------------------|
174 -- ----------------------------------------------------------------------------
175 -- {Start of comments}
176 --
177 -- Description:
178 --   The Lck process has two main functions to perform. Firstly, the row to be
179 --   updated or deleted must be locked. The locking of the row will only be
180 --   successful if the row is not currently locked by another user.
181 --   Secondly, during the locking of the row, the row is selected into
182 --   the g_old_rec data structure which enables the current row values from
183 --   the server to be available to the api.
184 --
185 -- Prerequisites:
186 --   When attempting to call the lock the object version number (if defined)
187 --   is mandatory.
188 --
189 -- In Parameters:
190 --   The arguments to the Lck process are the primary key(s) which uniquely
191 --   identify the row and the object version number of row.
192 --
193 -- Post Success:
194 --   On successful completion of the Lck process the row to be updated or
195 --   deleted will be locked and selected into the global data structure
196 --   g_old_rec.
197 --
198 -- Post Failure:
199 --   The Lck process can fail for three reasons:
200 --   1) When attempting to lock the row the row could already be locked by
201 --      another user. This will raise the HR_Api.Object_Locked exception.
202 --   2) The row which is required to be locked doesn't exist in the HR Schema.
203 --      This error is trapped and reported using the message name
204 --      'HR_7220_INVALID_PRIMARY_KEY'.
205 --   3) The row although existing in the HR Schema has a different object
206 --      version number than the object version number specified.
207 --      This error is trapped and reported using the message name
208 --      'HR_7155_OBJECT_INVALID'.
209 --
210 -- Developer Implementation Notes:
211 --   For each primary key and the object version number arguments add a
212 --   call to hr_api.mandatory_arg_error procedure to ensure that these
213 --   argument values are not null.
214 --
215 -- Access Status:
216 --   Internal Development Use Only.
217 --
218 -- {End of comments}
219 -- ----------------------------------------------------------------------------
220 Procedure lck
221   (p_task_in_checklist_id                 in     number
222   ,p_object_version_number                in     number
223   );
224 --
225 -- ----------------------------------------------------------------------------
226 -- |-----------------------------< convert_args >-----------------------------|
227 -- ----------------------------------------------------------------------------
228 -- {Start Of Comments}
229 --
230 -- Description:
231 --   This function is used to turn attribute parameters into the record
232 --   structure parameter g_rec_type.
233 --
234 -- Prerequisites:
235 --   This is a private function and can only be called from the ins or upd
236 --   attribute processes.
237 --
238 -- In Parameters:
239 --
240 -- Post Success:
241 --   A returning record structure will be returned.
242 --
243 -- Post Failure:
244 --   No direct error handling is required within this function.  Any possible
245 --   errors within this function will be a PL/SQL value error due to
246 --   conversion of datatypes or data lengths.
247 --
248 -- Developer Implementation Notes:
249 --   None.
253 --
250 --
251 -- Access Status:
252 --   Internal Row Handler Use Only.
254 -- {End Of Comments}
255 -- ----------------------------------------------------------------------------
256 Function convert_args
257   (p_task_in_checklist_id           in number
258   ,p_checklist_id                   in number
259   ,p_checklist_task_name            in varchar2
260   ,p_eligibility_object_id          in number
261   ,p_eligibility_profile_id         in number
262   ,p_ame_attribute_identifier       in varchar2
263   ,p_description                    in varchar2
264   ,p_mandatory_flag                 in varchar2
265   ,p_target_duration                in number
266   ,p_target_duration_uom            in varchar2
267   ,p_task_sequence                  in number
268   ,p_object_version_number          in number
269   ,p_action_url                     in varchar2
270   ,p_attribute_category             in varchar2
271   ,p_attribute1                     in varchar2
272   ,p_attribute2                     in varchar2
273   ,p_attribute3                     in varchar2
274   ,p_attribute4                     in varchar2
275   ,p_attribute5                     in varchar2
276   ,p_attribute6                     in varchar2
277   ,p_attribute7                     in varchar2
278   ,p_attribute8                     in varchar2
279   ,p_attribute9                     in varchar2
280   ,p_attribute10                    in varchar2
281   ,p_attribute11                    in varchar2
282   ,p_attribute12                    in varchar2
283   ,p_attribute13                    in varchar2
284   ,p_attribute14                    in varchar2
285   ,p_attribute15                    in varchar2
286   ,p_attribute16                    in varchar2
287   ,p_attribute17                    in varchar2
288   ,p_attribute18                    in varchar2
289   ,p_attribute19                    in varchar2
290   ,p_attribute20                    in varchar2
291   ,p_information_category           in varchar2
292   ,p_information1                   in varchar2
293   ,p_information2                   in varchar2
294   ,p_information3                   in varchar2
295   ,p_information4                   in varchar2
296   ,p_information5                   in varchar2
297   ,p_information6                   in varchar2
298   ,p_information7                   in varchar2
299   ,p_information8                   in varchar2
300   ,p_information9                   in varchar2
301   ,p_information10                  in varchar2
302   ,p_information11                  in varchar2
303   ,p_information12                  in varchar2
304   ,p_information13                  in varchar2
305   ,p_information14                  in varchar2
306   ,p_information15                  in varchar2
307   ,p_information16                  in varchar2
308   ,p_information17                  in varchar2
309   ,p_information18                  in varchar2
310   ,p_information19                  in varchar2
311   ,p_information20                  in varchar2
312   )
313   Return g_rec_type;
314 --
315 end per_ctk_shd;