DBA Data[Home] [Help]

PACKAGE: APPS.PAY_PGP_INS

Source


1 Package pay_pgp_ins AUTHID CURRENT_USER as
2 /* $Header: pypgprhi.pkh 115.0 99/07/17 06:22:06 porting ship $ */
3 --
4 -- ----------------------------------------------------------------------------
5 -- |---------------------------------< ins >----------------------------------|
6 -- ----------------------------------------------------------------------------
7 -- {Start Of Comments}
8 --
9 -- Description:
10 --   This procedure is the record interface for the insert business process
11 --   for the specified entity. The role of this process is to insert a fully
12 --   validated row, into the HR schema passing back to  the calling process,
13 --   any system generated values (e.g. primary and object version number
14 --   attributes). This process is the main backbone of the ins business
15 --   process. The processing of this procedure is as follows:
16 --   1) If the p_validate argument has been set to true then a savepoint is
17 --      issued.
18 --   2) The controlling validation process insert_validate is then executed
19 --      which will execute all private and public validation business rule
20 --      processes.
21 --   3) The pre_insert business process is then executed which enables any
22 --      logic to be processed before the insert dml process is executed.
23 --   4) The insert_dml process will physical perform the insert dml into the
24 --      specified entity.
25 --   5) The post_insert business process is then executed which enables any
26 --      logic to be processed after the insert dml process.
27 --   6) If the p_validate argument has been set to true an exception is raised
28 --      which is handled and processed by performing a rollback to the
29 --      savepoint which was issued at the beginning of the Ins process.
30 --
31 -- Pre Conditions:
32 --   The main arguments to the business process have to be in the record
33 --   format.
34 --
35 -- In Arguments:
36 --   p_validate
37 --     Determines if the business process is to be validated. Setting this
38 --     boolean value to true will invoke the process to be validated. The
39 --     default is false. The validation is controlled by a savepoint and
40 --     rollback mechanism. The savepoint is issued at the beginning of the
41 --     business process and is rollbacked at the end of the business process
42 --     when all the processing has been completed. The rollback is controlled
43 --     by raising and handling the exception hr_api.validate_enabled. We use
44 --     the exception because, by raising the exception with the business
45 --     process, we can exit successfully without having any of the 'OUT'
46 --     arguments being set.
47 --
48 -- Post Success:
49 --   A fully validated row will be inserted into the specified entity
50 --   without being committed. If the p_validate argument has been set to true
51 --   then all the work will be rolled back.
52 --
53 -- Post Failure:
54 --   If an error has occurred, an error message will be supplied with the work
55 --   rolled back.
56 --
57 -- Developer Implementation Notes:
58 --   None.
59 --
60 -- Access Status:
61 --   Internal Development Use Only.
62 --
63 -- {End Of Comments}
64 -- ----------------------------------------------------------------------------
65 Procedure ins
66   (
67   p_rec        in out pay_pgp_shd.g_rec_type,
68   p_validate   in     boolean default false
69   );
70 --
71 -- ----------------------------------------------------------------------------
72 -- |---------------------------------< ins >----------------------------------|
73 -- ----------------------------------------------------------------------------
74 -- {Start Of Comments}
75 --
76 -- Description:
77 --   This procedure is the attribute interface for the insert business
78 --   process for the specified entity and is the outermost layer. The role
79 --   of this process is to insert a fully validated row into the HR schema
80 --   passing back to the calling process, any system generated values
81 --   (e.g. object version number attributes).The processing of this
82 --   procedure is as follows:
83 --   1) The attributes are converted into a local record structure by
84 --      calling the convert_args function.
85 --   2) After the conversion has taken place, the corresponding record ins
86 --      interface business process is executed.
87 --   3) OUT arguments are then set to their corresponding record arguments.
88 --
89 -- Pre Conditions:
90 --
91 -- In Arguments:
92 --   p_validate
93 --     Determines if the business process is to be validated. Setting this
94 --     Boolean value to true will invoke the process to be validated.
95 --     The default is false.
96 --
97 -- Post Success:
98 --   A fully validated row will be inserted for the specified entity
99 --   without being committed (or rollbacked depending on the p_validate
100 --   status).
101 --
102 -- Post Failure:
103 --   If an error has occurred, an error message will be supplied with the work
104 --   rolled back.
105 --
106 -- Developer Implementation Notes:
107 --   None.
108 --
109 -- Access Status:
110 --   Internal Development Use Only.
111 --
112 -- {End Of Comments}
113 -- ----------------------------------------------------------------------------
114 Procedure ins
115   (
116   p_people_group_id              out number,
117   p_group_name                   out varchar2,
118   p_id_flex_num                  in number,
119   p_summary_flag                 in varchar2,
120   p_enabled_flag                 in varchar2,
121   p_start_date_active            in date             default null,
122   p_end_date_active              in date             default null,
123   p_segment1                     in varchar2         default null,
124   p_segment2                     in varchar2         default null,
125   p_segment3                     in varchar2         default null,
126   p_segment4                     in varchar2         default null,
127   p_segment5                     in varchar2         default null,
128   p_segment6                     in varchar2         default null,
129   p_segment7                     in varchar2         default null,
130   p_segment8                     in varchar2         default null,
131   p_segment9                     in varchar2         default null,
132   p_segment10                    in varchar2         default null,
133   p_segment11                    in varchar2         default null,
134   p_segment12                    in varchar2         default null,
135   p_segment13                    in varchar2         default null,
136   p_segment14                    in varchar2         default null,
137   p_segment15                    in varchar2         default null,
138   p_segment16                    in varchar2         default null,
139   p_segment17                    in varchar2         default null,
140   p_segment18                    in varchar2         default null,
141   p_segment19                    in varchar2         default null,
142   p_segment20                    in varchar2         default null,
143   p_segment21                    in varchar2         default null,
144   p_segment22                    in varchar2         default null,
145   p_segment23                    in varchar2         default null,
146   p_segment24                    in varchar2         default null,
147   p_segment25                    in varchar2         default null,
148   p_segment26                    in varchar2         default null,
149   p_segment27                    in varchar2         default null,
150   p_segment28                    in varchar2         default null,
151   p_segment29                    in varchar2         default null,
152   p_segment30                    in varchar2         default null,
153   p_validate                     in boolean   default false
154   );
155 --
156 -- ----------------------------------------------------------------------------
157 -- |-------------------------------< ins_or_sel >-----------------------------|
158 -- ----------------------------------------------------------------------------
159 -- {Start Of Comments}
160 --
161 -- Description:
162 --   This procedure controls the processing required to insert a new
163 --   combination or return the the ovn and combination id for an existing
164 --   combination.
165 --   1. If a combination does not exist a new combination is inserted
166 --      returning the new p_people_group_id.
167 --   2. If the segments are null (i.e. a null combination) then the out
168 --      arguments are set to null.
169 --   3. If a combination does exist the p_people_group_id is returned.
170 --
171 -- Pre Conditions:
172 --
173 -- In Arguments:
174 --   p_business_group_id     => is specified to enable the derivation of the
175 --                              id_flex_num within the process
176 --                              pay_pgp_shd.segment_combination_check.
177 --
178 -- Post Success:
179 --   If a combination already exists the out arguments are returned.
180 --   If a combination does not exist then the combination is inserted into
181 --   the pay_people_groups  and the out arguments are returned.
182 --   Processing continues.
183 --
184 -- Post Failure:
185 --   This process has no specific error handling and will only error if an
186 --   application error has ocurred at a lower level.
187 --
188 -- Developer Implementation Notes:
189 --   None.
190 --
191 -- Access Status:
192 --   Internal Development Use Only.
193 --
194 -- {End Of Comments}
195 -- ----------------------------------------------------------------------------
196 procedure ins_or_sel
197          (p_segment1              in  varchar2 default null,
198           p_segment2              in  varchar2 default null,
199           p_segment3              in  varchar2 default null,
200           p_segment4              in  varchar2 default null,
201           p_segment5              in  varchar2 default null,
202           p_segment6              in  varchar2 default null,
203           p_segment7              in  varchar2 default null,
204           p_segment8              in  varchar2 default null,
205           p_segment9              in  varchar2 default null,
206           p_segment10             in  varchar2 default null,
207           p_segment11             in  varchar2 default null,
208           p_segment12             in  varchar2 default null,
209           p_segment13             in  varchar2 default null,
210           p_segment14             in  varchar2 default null,
211           p_segment15             in  varchar2 default null,
212           p_segment16             in  varchar2 default null,
213           p_segment17             in  varchar2 default null,
214           p_segment18             in  varchar2 default null,
215           p_segment19             in  varchar2 default null,
216           p_segment20             in  varchar2 default null,
217           p_segment21             in  varchar2 default null,
218           p_segment22             in  varchar2 default null,
219           p_segment23             in  varchar2 default null,
220           p_segment24             in  varchar2 default null,
221           p_segment25             in  varchar2 default null,
222           p_segment26             in  varchar2 default null,
223           p_segment27             in  varchar2 default null,
224           p_segment28             in  varchar2 default null,
225           p_segment29             in  varchar2 default null,
226           p_segment30             in  varchar2 default null,
227           p_business_group_id     in  number,
228           p_people_group_id       out number,
229           p_group_name            out varchar2,
230           p_validate              in boolean default false);
231 --
232 end pay_pgp_ins;