1 Package ghr_nla_shd as
2 /* $Header: ghnlarhi.pkh 120.1 2005/07/01 02:40:41 sumarimu noship $ */
3 --
4 -- ----------------------------------------------------------------------------
5 -- | Global Record Type Specification |
6 -- ----------------------------------------------------------------------------
7 --
8 Type g_rec_type Is Record
9 (
10 noac_la_id number(15),
11 nature_of_action_id number(15),
12 lac_lookup_code varchar2(30),
13 enabled_flag varchar2(9), -- Increased length
14 date_from date,
15 date_to date,
16 object_version_number number(9),
17 valid_first_lac_flag varchar2(9), -- Increased length
18 valid_second_lac_flag varchar2(9)
19 );
20 --
21 -- ----------------------------------------------------------------------------
22 -- | Global Definitions - Internal Development Use Only |
23 -- ----------------------------------------------------------------------------
24 --
25 g_old_rec g_rec_type; -- Global record definition
26 --
27 --
28 -- ----------------------------------------------------------------------------
29 -- |---------------------------< constraint_error >---------------------------|
30 -- ----------------------------------------------------------------------------
31 -- {Start Of Comments}
32 --
33 -- Description:
34 -- This procedure is called when a constraint has been violated (i.e.
35 -- The exception hr_api.check_integrity_violated,
36 -- hr_api.parent_integrity_violated, hr_api.child_integrity_violated or
37 -- hr_api.unique_integrity_violated has been raised).
38 -- The exceptions can only be raised as follows:
39 -- 1) A check constraint can only be violated during an INSERT or UPDATE
40 -- dml operation.
41 -- 2) A parent integrity constraint can only be violated during an
42 -- INSERT or UPDATE dml operation.
43 -- 3) A child integrity constraint can only be violated during an
44 -- DELETE dml operation.
45 -- 4) A unique integrity constraint can only be violated during INSERT or
46 -- UPDATE dml operation.
47 --
48 -- Prerequisites:
49 -- 1) Either hr_api.check_integrity_violated,
50 -- hr_api.parent_integrity_violated, hr_api.child_integrity_violated or
51 -- hr_api.unique_integrity_violated has been raised with the subsequent
52 -- stripping of the constraint name from the generated error message
53 -- text.
54 -- 2) Standalone validation test which corresponds with a constraint error.
55 --
56 -- In Parameter:
57 -- p_constraint_name is in upper format and is just the constraint name
58 -- (e.g. not prefixed by brackets, schema owner etc).
59 --
60 -- Post Success:
61 -- Development dependant.
62 --
63 -- Post Failure:
64 -- Developement dependant.
65 --
66 -- Developer Implementation Notes:
67 -- For each constraint being checked the hr system package failure message
68 -- has been generated as a template only. These system error messages should
69 -- be modified as required (i.e. change the system failure message to a user
70 -- friendly defined error message).
71 --
72 -- Access Status:
73 -- Internal Development Use Only.
74 --
75 -- {End Of Comments}
76 -- ----------------------------------------------------------------------------
77 Procedure constraint_error
78 (p_constraint_name in all_constraints.constraint_name%TYPE);
79 --
80 -- ----------------------------------------------------------------------------
81 -- |-----------------------------< api_updating >-----------------------------|
82 -- ----------------------------------------------------------------------------
83 -- {Start Of Comments}
84 --
85 -- Description:
86 -- This function is used to populate the g_old_rec record with the
87 -- current row from the database for the specified primary key
88 -- provided that the primary key exists and is valid and does not
89 -- already match the current g_old_rec. The function will always return
90 -- a TRUE value if the g_old_rec is populated with the current row.
91 -- A FALSE value will be returned if all of the primary key arguments
92 -- are null.
93 --
94 -- Prerequisites:
95 -- None.
96 --
97 -- In Parameters:
98 --
99 -- Post Success:
100 -- A value of TRUE will be returned indiciating that the g_old_rec
101 -- is current.
102 -- A value of FALSE will be returned if all of the primary key arguments
103 -- have a null value (this indicates that the row has not be inserted into
104 -- the Schema), and therefore could never have a corresponding row.
105 --
106 -- Post Failure:
107 -- A failure can only occur under two circumstances:
108 -- 1) The primary key is invalid (i.e. a row does not exist for the
109 -- specified primary key values).
110 -- 2) If an object_version_number exists but is NOT the same as the current
111 -- g_old_rec value.
112 --
113 -- Developer Implementation Notes:
114 -- None.
115 --
116 -- Access Status:
117 -- Internal Development Use Only.
118 --
119 -- {End Of Comments}
120 -- ----------------------------------------------------------------------------
121 Function api_updating
122 (
123 p_noac_la_id in number,
124 p_object_version_number in number
125 ) Return Boolean;
126 --
127 -- ----------------------------------------------------------------------------
128 -- |---------------------------------< lck >----------------------------------|
129 -- ----------------------------------------------------------------------------
130 -- {Start Of Comments}
131 --
132 -- Description:
133 -- The Lck process has two main functions to perform. Firstly, the row to be
134 -- updated or deleted must be locked. The locking of the row will only be
135 -- successful if the row is not currently locked by another user.
136 -- Secondly, during the locking of the row, the row is selected into
137 -- the g_old_rec data structure which enables the current row values from the
138 -- server to be available to the api.
139 --
140 -- Prerequisites:
141 -- When attempting to call the lock the object version number (if defined)
142 -- is mandatory.
143 --
144 -- In Parameters:
145 -- The arguments to the Lck process are the primary key(s) which uniquely
146 -- identify the row and the object version number of row.
147 --
148 -- Post Success:
149 -- On successful completion of the Lck process the row to be updated or
150 -- deleted will be locked and selected into the global data structure
151 -- g_old_rec.
152 --
153 -- Post Failure:
154 -- The Lck process can fail for three reasons:
155 -- 1) When attempting to lock the row the row could already be locked by
156 -- another user. This will raise the HR_Api.Object_Locked exception.
157 -- 2) The row which is required to be locked doesn't exist in the HR Schema.
158 -- This error is trapped and reported using the message name
159 -- 'HR_7220_INVALID_PRIMARY_KEY'.
160 -- 3) The row although existing in the HR Schema has a different object
161 -- version number than the object version number specified.
162 -- This error is trapped and reported using the message name
163 -- 'HR_7155_OBJECT_INVALID'.
164 --
165 -- Developer Implementation Notes:
166 -- For each primary key and the object version number arguments add a
167 -- call to hr_api.mandatory_arg_error procedure to ensure that these
168 -- argument values are not null.
169 --
170 -- Access Status:
171 -- Internal Development Use Only.
172 --
173 -- {End Of Comments}
174 -- ----------------------------------------------------------------------------
175 Procedure lck
176 (
177 p_noac_la_id in number,
178 p_object_version_number in number
179 );
180 --
181 -- ----------------------------------------------------------------------------
182 -- |-----------------------------< convert_args >-----------------------------|
183 -- ----------------------------------------------------------------------------
184 -- {Start Of Comments}
185 --
186 -- Description:
187 -- This function is used to turn attribute parameters into the record
188 -- structure parameter g_rec_type.
189 --
190 -- Prerequisites:
191 -- This is a private function and can only be called from the ins or upd
192 -- attribute processes.
193 --
194 -- In Parameters:
195 --
196 -- Post Success:
197 -- A returning record structure will be returned.
198 --
199 -- Post Failure:
200 -- No direct error handling is required within this function. Any possible
201 -- errors within this function will be a PL/SQL value error due to conversion
202 -- of datatypes or data lengths.
203 --
204 -- Developer Implementation Notes:
205 -- None.
206 --
207 -- Access Status:
208 -- Internal Row Handler Use Only.
209 --
210 -- {End Of Comments}
211 -- ----------------------------------------------------------------------------
212 Function convert_args
213 (
214 p_noac_la_id in number,
215 p_nature_of_action_id in number,
216 p_lac_lookup_code in varchar2,
217 p_enabled_flag in varchar2,
218 p_date_from in date,
219 p_date_to in date,
220 p_object_version_number in number,
221 p_valid_first_lac_flag in varchar2,
222 p_valid_second_lac_flag in varchar2
223 )
224 Return g_rec_type;
225 --
226 end ghr_nla_shd;
[Home] [Help]