1 Package ame_cal_shd as
2 /* $Header: amcalrhi.pkh 120.0 2005/09/02 03:54 mbocutt noship $ */
3 --
4 -- ----------------------------------------------------------------------------
5 -- | Global Record Type Specification |
6 -- ----------------------------------------------------------------------------
7 --
8 Type g_rec_type Is Record
9 (application_id number
10 ,language varchar2(9) -- Increased length
11 ,source_lang varchar2(9) -- Increased length
12 ,application_name varchar2(240)
13 );
14 --
15 -- ----------------------------------------------------------------------------
16 -- | Global Definitions - Internal Development Use Only |
17 -- ----------------------------------------------------------------------------
18 --
19 g_old_rec g_rec_type; -- Global record definition
20 -- Global table name
21 g_tab_nam constant varchar2(30) := 'AME_CALLING_APPS_TL';
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 (p_application_id in number
118 ,p_language in varchar2
119 ) Return Boolean;
120 --
121 -- ----------------------------------------------------------------------------
122 -- |---------------------------------< lck >----------------------------------|
123 -- ----------------------------------------------------------------------------
124 -- {Start of comments}
125 --
126 -- Description:
127 -- The Lck process has two main functions to perform. Firstly, the row to be
128 -- updated or deleted must be locked. The locking of the row will only be
129 -- successful if the row is not currently locked by another user.
130 -- Secondly, during the locking of the row, the row is selected into
131 -- the g_old_rec data structure which enables the current row values from
132 -- the server to be available to the api.
133 --
134 -- Prerequisites:
135 -- When attempting to call the lock the object version number (if defined)
136 -- is mandatory.
137 --
138 -- In Parameters:
139 -- The arguments to the Lck process are the primary key(s) which uniquely
140 -- identify the row and the object version number of row.
141 --
142 -- Post Success:
143 -- On successful completion of the Lck process the row to be updated or
144 -- deleted will be locked and selected into the global data structure
145 -- g_old_rec.
146 --
147 -- Post Failure:
148 -- The Lck process can fail for three reasons:
149 -- 1) When attempting to lock the row the row could already be locked by
150 -- another user. This will raise the HR_Api.Object_Locked exception.
151 -- 2) The row which is required to be locked doesn't exist in the HR Schema.
152 -- This error is trapped and reported using the message name
153 -- 'HR_7220_INVALID_PRIMARY_KEY'.
154 -- 3) The row although existing in the HR Schema has a different object
155 -- version number than the object version number specified.
156 -- This error is trapped and reported using the message name
157 -- 'HR_7155_OBJECT_INVALID'.
158 --
159 -- Developer Implementation Notes:
160 -- For each primary key and the object version number arguments add a
161 -- call to hr_api.mandatory_arg_error procedure to ensure that these
162 -- argument values are not null.
163 --
164 -- Access Status:
165 -- Internal Development Use Only.
166 --
167 -- {End of comments}
168 -- ----------------------------------------------------------------------------
169 Procedure lck
170 (p_application_id in number
171 ,p_language in varchar2
172 );
173 --
174 -- ----------------------------------------------------------------------------
175 -- |----------------------------< add_language >------------------------------|
176 -- ----------------------------------------------------------------------------
177 -- {Start of Comments}
178 --
179 -- Description:
180 -- Maintains the _TL table. Ensures there is a translation for every
181 -- installed language, removes any orphaned translation rows and
182 -- corrects and translations which have got out of synchronisation.
183 --
184 -- Pre-requisites:
185 --
186 -- In Parameters:
187 --
188 -- Post Success:
189 -- A translation row exists for every installed language.
190 --
191 -- Post Failure:
192 -- Maintenance is aborted.
193 --
194 -- Developer Implementation Notes:
195 -- None.
196 --
197 -- Access Status:
198 -- Internal Development Use Only.
199 --
200 -- {End of Comments}
201 -- ----------------------------------------------------------------------------
202 Procedure add_language;
203 --
204 -- ----------------------------------------------------------------------------
205 -- |-----------------------------< convert_args >-----------------------------|
206 -- ----------------------------------------------------------------------------
207 -- {Start Of Comments}
208 --
209 -- Description:
210 -- This function is used to turn attribute parameters into the record
211 -- structure parameter g_rec_type.
212 --
213 -- Prerequisites:
214 -- This is a private function and can only be called from the ins or upd
215 -- attribute processes.
216 --
217 -- In Parameters:
218 --
219 -- Post Success:
220 -- A returning record structure will be returned.
221 --
222 -- Post Failure:
223 -- No direct error handling is required within this function. Any possible
224 -- errors within this function will be a PL/SQL value error due to
225 -- conversion of datatypes or data lengths.
226 --
227 -- Developer Implementation Notes:
228 -- None.
229 --
230 -- Access Status:
231 -- Internal Row Handler Use Only.
232 --
233 -- {End Of Comments}
234 -- ----------------------------------------------------------------------------
235 Function convert_args
236 (p_application_id in number
237 ,p_language in varchar2
238 ,p_source_lang in varchar2
239 ,p_application_name in varchar2
240 )
241 Return g_rec_type;
242 --
243 end ame_cal_shd;
[Home] [Help]