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