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