1 Package ben_bcd_shd as
2 /* $Header: bebcdrhi.pkh 120.0.12010000.1 2008/07/29 10:53:24 appldev ship $ */
3 --
4 -- ----------------------------------------------------------------------------
5 -- | Global Record Type Specification |
6 -- ----------------------------------------------------------------------------
7 --
8 Type g_rec_type Is Record
9 (cwb_matrix_dtl_id number(15)
10 ,cwb_matrix_id number(15)
11 ,row_crit_val varchar2(150)
12 ,col_crit_val varchar2(150)
13 ,pct_emp_cndr number
14 ,pct_val number
15 ,emp_amt number
16 ,business_group_id number(15)
17 ,object_version_number number(9)
18 );
19 --
20 -- ----------------------------------------------------------------------------
21 -- | Global Definitions - Internal Development Use Only |
22 -- ----------------------------------------------------------------------------
23 --
24 g_old_rec g_rec_type; -- Global record definition
25 -- Global table name
26 g_tab_nam constant varchar2(30) := 'BEN_CWB_MATRIX_DTL';
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 (p_cwb_matrix_dtl_id in number
123 ,p_object_version_number in number
124 ) Return Boolean;
125 --
126 -- ----------------------------------------------------------------------------
127 -- |---------------------------------< lck >----------------------------------|
128 -- ----------------------------------------------------------------------------
129 -- {Start of comments}
130 --
131 -- Description:
132 -- The Lck process has two main functions to perform. Firstly, the row to be
133 -- updated or deleted must be locked. The locking of the row will only be
134 -- successful if the row is not currently locked by another user.
135 -- Secondly, during the locking of the row, the row is selected into
136 -- the g_old_rec data structure which enables the current row values from
137 -- the server to be available to the api.
138 --
139 -- Prerequisites:
140 -- When attempting to call the lock the object version number (if defined)
141 -- is mandatory.
142 --
143 -- In Parameters:
144 -- The arguments to the Lck process are the primary key(s) which uniquely
145 -- identify the row and the object version number of row.
146 --
147 -- Post Success:
148 -- On successful completion of the Lck process the row to be updated or
149 -- deleted will be locked and selected into the global data structure
150 -- g_old_rec.
151 --
152 -- Post Failure:
153 -- The Lck process can fail for three reasons:
154 -- 1) When attempting to lock the row the row could already be locked by
155 -- another user. This will raise the HR_Api.Object_Locked exception.
156 -- 2) The row which is required to be locked doesn't exist in the HR Schema.
157 -- This error is trapped and reported using the message name
158 -- 'HR_7220_INVALID_PRIMARY_KEY'.
159 -- 3) The row although existing in the HR Schema has a different object
160 -- version number than the object version number specified.
161 -- This error is trapped and reported using the message name
162 -- 'HR_7155_OBJECT_INVALID'.
163 --
164 -- Developer Implementation Notes:
165 -- For each primary key and the object version number arguments add a
166 -- call to hr_api.mandatory_arg_error procedure to ensure that these
167 -- argument values are not null.
168 --
169 -- Access Status:
170 -- Internal Development Use Only.
171 --
172 -- {End of comments}
173 -- ----------------------------------------------------------------------------
174 Procedure lck
175 (p_cwb_matrix_dtl_id in number
176 ,p_object_version_number in number
177 );
178 --
179 -- ----------------------------------------------------------------------------
180 -- |-----------------------------< convert_args >-----------------------------|
181 -- ----------------------------------------------------------------------------
182 -- {Start Of Comments}
183 --
184 -- Description:
185 -- This function is used to turn attribute parameters into the record
186 -- structure parameter g_rec_type.
187 --
188 -- Prerequisites:
189 -- This is a private function and can only be called from the ins or upd
190 -- attribute processes.
191 --
192 -- In Parameters:
193 --
194 -- Post Success:
195 -- A returning record structure will be returned.
196 --
197 -- Post Failure:
198 -- No direct error handling is required within this function. Any possible
199 -- errors within this function will be a PL/SQL value error due to
200 -- conversion of datatypes or data lengths.
201 --
202 -- Developer Implementation Notes:
203 -- None.
204 --
205 -- Access Status:
206 -- Internal Row Handler Use Only.
207 --
208 -- {End Of Comments}
209 -- ----------------------------------------------------------------------------
210 Function convert_args
211 (p_cwb_matrix_dtl_id in number
212 ,p_cwb_matrix_id in number
213 ,p_row_crit_val in varchar2
214 ,p_col_crit_val in varchar2
215 ,p_pct_emp_cndr in number
216 ,p_pct_val in number
217 ,p_emp_amt in number
218 ,p_business_group_id in number
219 ,p_object_version_number in number
220 )
221 Return g_rec_type;
222 --
223 end ben_bcd_shd;
[Home] [Help]