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