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