DBA Data[Home] [Help]

PACKAGE: APPS.OTA_TFH_API_INS

Source


1 Package ota_tfh_api_ins AUTHID CURRENT_USER as
2 /* $Header: ottfh01t.pkh 120.0 2005/05/29 07:40:27 appldev noship $ */
3 ---- ----------------------------------------------------------------------------
4 -- |------------------------< set_base_key_value >----------------------------|
5 -- ----------------------------------------------------------------------------
6 -- {Start of Comments}
7 -- Description:
8 --   This procedure is called to register the next ID value from the database
9 --   sequence.
10 --
11 -- Prerequisites:
12 --
13 -- In Parameters:
14 --   Primary Key
15 --
16 -- Post Success:
17 --
18 -- Post Failure:
19 --
20 -- Developer Implementation Notes:
21 --   None.
22 --
23 -- Access Status:
24 --   Internal Development Use Only.
25 --
26 -- {End of Comments}
27 -- ----------------------------------------------------------------------------
28 procedure set_base_key_value
29   (finance_header_id  in  number);
30 --
31 --
32 -- ----------------------------------------------------------------------------
33 -- |---------------------------------< ins >----------------------------------|
34 -- ----------------------------------------------------------------------------
35 -- {Start Of Comments}
36 --
37 -- Description:
38 --   This procedure is the record interface for the insert business process
39 --   for the specified entity. The role of this process is to insert a fully
40 --   validated row, into the HR schema passing back to  the calling process,
41 --   any system generated values (e.g. primary and object version number
42 --   attributes). This process is the main backbone of the ins business
43 --   process. The processing of this procedure is as follows:
44 --   1) If the p_validate argument has been set to true then a savepoint is
45 --      issued.
46 --   2) The controlling validation process insert_validate is then executed
47 --      which will execute all private and public validation business rule
48 --      processes.
49 --   3) The pre_insert business process is then executed which enables any
50 --      logic to be processed before the insert dml process is executed.
51 --   4) The insert_dml process will physical perform the insert dml into the
52 --      specified entity.
53 --   5) The post_insert business process is then executed which enables any
54 --      logic to be processed after the insert dml process.
55 --   6) If the p_validate argument has been set to true an exception is raised
56 --      which is handled and processed by performing a rollback to the
57 --      savepoint which was issued at the beginning of the Ins process.
58 --
59 -- Pre Conditions:
60 --   The main arguments to the business process have to be in the record
61 --   format.
62 --
63 -- In Arguments:
64 --   p_validate
65 --     Determines if the business process is to be validated. Setting this
66 --     boolean value to true will invoke the process to be validated. The
67 --     default is false. The validation is controlled by a savepoint and
68 --     rollback mechanism. The savepoint is issued at the beginning of the
69 --     business process and is rollbacked at the end of the business process
70 --     when all the processing has been completed. The rollback is controlled
71 --     by raising and handling the exception hr_api.validate_enabled. We use
72 --     the exception because, by raising the exception with the business
73 --     process, we can exit successfully without having any of the 'OUT'
74 --     arguments being set.
75 --
76 -- Post Success:
77 --   A fully validated row will be inserted into the specified entity
78 --   without being committed. If the p_validate argument has been set to true
79 --   then all the work will be rolled back.
80 --
81 -- Post Failure:
82 --   If an error has occurred, an error message will be supplied with the work
83 --   rolled back.
84 --
85 -- Developer Implementation Notes:
86 --   None.
87 --
88 -- Access Status:
89 --   Public.
90 --
91 -- {End Of Comments}
92 -- ----------------------------------------------------------------------------
93 Procedure ins
94   (
95   p_rec                 in out nocopy ota_tfh_api_shd.g_rec_type,
96   p_validate            in     boolean default false,
97   p_transaction_type   in varchar2 default 'INSERT'
98   );
99 --
100 -- ----------------------------------------------------------------------------
101 -- |---------------------------------< ins >----------------------------------|
102 -- ----------------------------------------------------------------------------
103 -- {Start Of Comments}
104 --
105 -- Description:
106 --   This procedure is the attribute interface for the insert business
107 --   process for the specified entity and is the outermost layer. The role
108 --   of this process is to insert a fully validated row into the HR schema
109 --   passing back to the calling process, any system generated values
110 --   (e.g. object version number attributes).The processing of this
111 --   procedure is as follows:
112 --   1) The attributes are converted into a local record structure by
113 --      calling the convert_args function.
114 --   2) After the conversion has taken place, the corresponding record ins
115 --      interface business process is executed.
116 --   3) OUT arguments are then set to their corresponding record arguments.
117 --
118 -- Pre Conditions:
119 --
120 -- In Arguments:
121 --   p_validate
122 --     Determines if the business process is to be validated. Setting this
123 --     Boolean value to true will invoke the process to be validated.
124 --     The default is false.
125 --
126 -- Post Success:
127 --   A fully validated row will be inserted for the specified entity
128 --   without being committed (or rollbacked depending on the p_validate
129 --   status).
130 --
131 -- Post Failure:
132 --   If an error has occurred, an error message will be supplied with the work
133 --   rolled back.
134 --
135 -- Developer Implementation Notes:
136 --   None.
137 --
138 -- Access Status:
139 --   Public.
140 --
141 -- {End Of Comments}
142 -- ----------------------------------------------------------------------------
143 Procedure ins
144   (
145   p_finance_header_id            out nocopy number,
146   p_superceding_header_id        in number           default null,
147   p_authorizer_person_id         in number           default null,
148   p_organization_id              in number,
149   p_administrator                in number,
150   p_cancelled_flag               in varchar2,
151   p_currency_code                in varchar2,
152   p_date_raised                  in date,
153   p_object_version_number        out nocopy number,
154   p_payment_status_flag          in varchar2,
155   p_transfer_status              in varchar2,
156   p_type                         in varchar2,
157   p_receivable_type              in varchar2,
158   p_comments                     in varchar2         default null,
159   p_external_reference           in varchar2         default null,
160   p_invoice_address              in varchar2         default null,
161   p_invoice_contact              in varchar2         default null,
162   p_payment_method               in varchar2         default null,
163   p_pym_attribute1               in varchar2         default null,
164   p_pym_attribute10              in varchar2         default null,
165   p_pym_attribute11              in varchar2         default null,
166   p_pym_attribute12              in varchar2         default null,
167   p_pym_attribute13              in varchar2         default null,
168   p_pym_attribute14              in varchar2         default null,
169   p_pym_attribute15              in varchar2         default null,
170   p_pym_attribute16              in varchar2         default null,
171   p_pym_attribute17              in varchar2         default null,
172   p_pym_attribute18              in varchar2         default null,
173   p_pym_attribute19              in varchar2         default null,
174   p_pym_attribute2               in varchar2         default null,
175   p_pym_attribute20              in varchar2         default null,
176   p_pym_attribute3               in varchar2         default null,
177   p_pym_attribute4               in varchar2         default null,
178   p_pym_attribute5               in varchar2         default null,
179   p_pym_attribute6               in varchar2         default null,
180   p_pym_attribute7               in varchar2         default null,
181   p_pym_attribute8               in varchar2         default null,
182   p_pym_attribute9               in varchar2         default null,
183   p_pym_information_category     in varchar2         default null,
184   p_transfer_date                in date             default null,
185   p_transfer_message             in varchar2         default null,
186   p_vendor_id                    in number           default null,
187   p_contact_id                   in number           default null,
188   p_address_id                   in number           default null,
189   p_customer_id                  in number           default null,
190   p_tfh_information_category     in varchar2         default null,
191   p_tfh_information1             in varchar2         default null,
192   p_tfh_information2             in varchar2         default null,
193   p_tfh_information3             in varchar2         default null,
194   p_tfh_information4             in varchar2         default null,
195   p_tfh_information5             in varchar2         default null,
196   p_tfh_information6             in varchar2         default null,
197   p_tfh_information7             in varchar2         default null,
198   p_tfh_information8             in varchar2         default null,
199   p_tfh_information9             in varchar2         default null,
200   p_tfh_information10            in varchar2         default null,
201   p_tfh_information11            in varchar2         default null,
202   p_tfh_information12            in varchar2         default null,
203   p_tfh_information13            in varchar2         default null,
204   p_tfh_information14            in varchar2         default null,
205   p_tfh_information15            in varchar2         default null,
206   p_tfh_information16            in varchar2         default null,
207   p_tfh_information17            in varchar2         default null,
208   p_tfh_information18            in varchar2         default null,
209   p_tfh_information19            in varchar2         default null,
210   p_tfh_information20            in varchar2         default null,
211   p_paying_cost_center           in varchar2         default null,
212   p_receiving_cost_center        in varchar2         default null,
213   p_transfer_from_set_of_book_id in number		default null,
214   p_transfer_to_set_of_book_id   in number		default null,
215   p_from_segment1                 in varchar2		default null,
216   p_from_segment2                 in varchar2		default null,
217   p_from_segment3                 in varchar2		default null,
218   p_from_segment4                 in varchar2		default null,
219   p_from_segment5                 in varchar2		default null,
220   p_from_segment6                 in varchar2		default null,
221   p_from_segment7                 in varchar2		default null,
222   p_from_segment8                 in varchar2		default null,
223   p_from_segment9                 in varchar2		default null,
224   p_from_segment10                in varchar2		default null,
225   p_from_segment11                 in varchar2		default null,
226   p_from_segment12                 in varchar2		default null,
227   p_from_segment13                 in varchar2		default null,
228   p_from_segment14                 in varchar2		default null,
229   p_from_segment15                 in varchar2		default null,
230   p_from_segment16                 in varchar2		default null,
231   p_from_segment17                 in varchar2		default null,
232   p_from_segment18                 in varchar2		default null,
233   p_from_segment19                 in varchar2		default null,
234   p_from_segment20                in varchar2		default null,
235   p_from_segment21                 in varchar2		default null,
236   p_from_segment22                 in varchar2		default null,
237   p_from_segment23                 in varchar2		default null,
238   p_from_segment24                 in varchar2		default null,
239   p_from_segment25                 in varchar2		default null,
240   p_from_segment26                 in varchar2		default null,
241   p_from_segment27                 in varchar2		default null,
242   p_from_segment28                 in varchar2		default null,
243   p_from_segment29                 in varchar2		default null,
244   p_from_segment30                 in varchar2		default null,
245   p_to_segment1                    in varchar2		default null,
246   p_to_segment2                    in varchar2		default null,
247   p_to_segment3                    in varchar2		default null,
248   p_to_segment4                    in varchar2		default null,
249   p_to_segment5                    in varchar2		default null,
250   p_to_segment6                    in varchar2		default null,
251   p_to_segment7                    in varchar2		default null,
252   p_to_segment8                    in varchar2		default null,
253   p_to_segment9                    in varchar2		default null,
254   p_to_segment10                   in varchar2		default null,
255   p_to_segment11                   in varchar2	default null,
256   p_to_segment12                   in varchar2	default null,
257   p_to_segment13                   in varchar2	default null,
258   p_to_segment14                   in varchar2	default null,
259   p_to_segment15                   in varchar2	default null,
260   p_to_segment16                 in varchar2	default null,
261   p_to_segment17                 in varchar2	default null,
262   p_to_segment18                 in varchar2	default null,
263   p_to_segment19                 in varchar2	default null,
264   p_to_segment20                 in varchar2		default null,
265   p_to_segment21                 in varchar2	default null,
266   p_to_segment22                 in varchar2	default null,
267   p_to_segment23                 in varchar2	default null,
268   p_to_segment24                 in varchar2	default null,
269   p_to_segment25                 in varchar2	default null,
270   p_to_segment26                 in varchar2	default null,
271   p_to_segment27                 in varchar2	default null,
272   p_to_segment28                 in varchar2	default null,
273   p_to_segment29                 in varchar2	default null,
274   p_to_segment30                 in varchar2 	default null,
275   p_transfer_from_cc_id          in number         default null,
276   p_transfer_to_cc_id            in number         default null,
277   p_validate                     in boolean          default false,
278   p_transaction_type             in varchar2         default 'INSERT'
279   );
280 --
281 end ota_tfh_api_ins;