DBA Data[Home] [Help]

PACKAGE: APPS.PQP_ATD_UPD

Source


1 Package pqp_atd_upd AUTHID CURRENT_USER as
2 /* $Header: pqatdrhi.pkh 120.0 2005/05/29 01:42:49 appldev noship $ */
3 --
4 -- ----------------------------------------------------------------------------
5 -- |---------------------------------< upd >----------------------------------|
6 -- ----------------------------------------------------------------------------
7 -- {Start Of Comments}
8 --
9 -- Description:
10 --   This procedure is the record interface for the update
11 --   process for the specified entity. The role of this process is
12 --   to update a fully validated row for the HR schema passing back
13 --   to the calling process, any system generated values (e.g.
14 --   object version number attribute). This process is the main
15 --   backbone of the upd business process. The processing of this
16 --   procedure is as follows:
17 --   1) The row to be updated is locked and selected into the record
18 --      structure g_old_rec.
19 --   2) Because on update parameters which are not part of the update do not
20 --      have to be defaulted, we need to build up the updated row by
21 --      converting any system defaulted parameters to their corresponding
22 --      value.
23 --   3) The controlling validation process update_validate is then executed
24 --      which will execute all private and public validation business rule
25 --      processes.
26 --   4) The pre_update process is then executed which enables any
27 --      logic to be processed before the update dml process is executed.
28 --   5) The update_dml process will physical perform the update dml into the
29 --      specified entity.
30 --   6) The post_update process is then executed which enables any
31 --      logic to be processed after the update dml process.
32 --
33 -- Prerequisites:
34 --   The main parameters to the business process have to be in the record
35 --   format.
36 --
37 -- In Parameters:
38 --
39 -- Post Success:
40 --   The specified row will be fully validated and updated for the specified
41 --   entity without being committed.
42 --
43 -- Post Failure:
44 --   If an error has occurred, an error message will be supplied with the work
45 --   rolled back.
46 --
47 -- Developer Implementation Notes:
48 --   None.
49 --
50 -- Access Status:
51 --   Internal Development Use Only.
52 --
53 -- {End Of Comments}
54 -- ----------------------------------------------------------------------------
55 Procedure upd
56   (
57   p_effective_date               in date,
58   p_rec        in out nocopy pqp_atd_shd.g_rec_type
59   );
60 --
61 -- ----------------------------------------------------------------------------
62 -- |---------------------------------< upd >----------------------------------|
63 -- ----------------------------------------------------------------------------
64 -- {Start Of Comments}
65 --
66 -- Description:
67 --   This procedure is the attribute interface for the update
68 --   process for the specified entity and is the outermost layer. The role
69 --   of this process is to update a fully validated row into the HR schema
70 --   passing back to the calling process, any system generated values
71 --   (e.g. object version number attributes). The processing of this
72 --   procedure is as follows:
73 --   1) The attributes are converted into a local record structure by
74 --      calling the convert_args function.
75 --   2) After the conversion has taken place, the corresponding record upd
76 --      interface process is executed.
77 --   3) OUT parameters are then set to their corresponding record attributes.
78 --
79 -- Prerequisites:
80 --
81 -- In Parameters:
82 --
83 -- Post Success:
84 --   A fully validated row will be updated for the specified entity
85 --   without being committed.
86 --
87 -- Post Failure:
88 --   If an error has occurred, an error message will be supplied with the work
89 --   rolled back.
90 --
91 -- Developer Implementation Notes:
92 --   None.
93 --
94 -- Access Status:
95 --   Internal Development Use Only.
96 --
97 -- {End Of Comments}
98 -- ----------------------------------------------------------------------------
99 Procedure upd
100   (
101   p_effective_date               in date,
102   p_alien_transaction_id         in number,
103   p_person_id                    in number           default hr_api.g_number,
104   p_data_source_type             in varchar2         default hr_api.g_varchar2,
105   p_tax_year                     in number           default hr_api.g_number,
106   p_income_code                  in varchar2         default hr_api.g_varchar2,
107   p_withholding_rate             in number           default hr_api.g_number,
108   p_income_code_sub_type         in varchar2         default hr_api.g_varchar2,
109   p_exemption_code               in varchar2         default hr_api.g_varchar2,
110   p_maximum_benefit_amount       in number           default hr_api.g_number,
111   p_retro_lose_ben_amt_flag      in varchar2         default hr_api.g_varchar2,
112   p_date_benefit_ends            in date             default hr_api.g_date,
113   p_retro_lose_ben_date_flag     in varchar2         default hr_api.g_varchar2,
114   p_current_residency_status     in varchar2         default hr_api.g_varchar2,
115   p_nra_to_ra_date               in date             default hr_api.g_date,
116   p_target_departure_date        in date             default hr_api.g_date,
117   p_tax_residence_country_code   in varchar2         default hr_api.g_varchar2,
118   p_treaty_info_update_date      in date             default hr_api.g_date,
119   p_nra_exempt_from_fica         in varchar2         default hr_api.g_varchar2,
120   p_student_exempt_from_fica     in varchar2         default hr_api.g_varchar2,
121   p_addl_withholding_flag        in varchar2         default hr_api.g_varchar2,
122   p_addl_withholding_amt         in number           default hr_api.g_number,
123   p_addl_wthldng_amt_period_type in varchar2         default hr_api.g_varchar2,
124   p_personal_exemption           in number           default hr_api.g_number,
125   p_addl_exemption_allowed       in number           default hr_api.g_number,
126   p_number_of_days_in_usa        in number           default hr_api.g_number,
127   p_wthldg_allow_eligible_flag   in varchar2         default hr_api.g_varchar2,
128   p_treaty_ben_allowed_flag      in varchar2         default hr_api.g_varchar2,
129   p_treaty_benefits_start_date   in date             default hr_api.g_date,
130   p_ra_effective_date            in date             default hr_api.g_date,
131   p_state_code                   in varchar2         default hr_api.g_varchar2,
132   p_state_honors_treaty_flag     in varchar2         default hr_api.g_varchar2,
133   p_ytd_payments                 in number           default hr_api.g_number,
134   p_ytd_w2_payments              in number           default hr_api.g_number,
135   p_ytd_w2_withholding           in number           default hr_api.g_number,
136   p_ytd_withholding_allowance    in number           default hr_api.g_number,
137   p_ytd_treaty_payments          in number           default hr_api.g_number,
138   p_ytd_treaty_withheld_amt      in number           default hr_api.g_number,
139   p_record_source                in varchar2         default hr_api.g_varchar2,
140   p_visa_type                    in varchar2         default hr_api.g_varchar2,
141   p_j_sub_type                   in varchar2         default hr_api.g_varchar2,
142   p_primary_activity             in varchar2         default hr_api.g_varchar2,
143   p_non_us_country_code          in varchar2         default hr_api.g_varchar2,
144   p_citizenship_country_code     in varchar2         default hr_api.g_varchar2,
145   p_constant_addl_tax            in number           default hr_api.g_number,
146   p_date_8233_signed             in date             default hr_api.g_date,
147   p_date_w4_signed               in date             default hr_api.g_date,
148   p_error_indicator              in varchar2         default hr_api.g_varchar2,
149   p_prev_er_treaty_benefit_amt   in number           default hr_api.g_number,
150   p_error_text                   in varchar2         default hr_api.g_varchar2,
151   p_object_version_number        in out nocopy number,
152   p_current_analysis             in  varchar2        default hr_api.g_varchar2,
153   p_forecast_income_code         in  varchar2        default hr_api.g_varchar2
154 
155   );
156 --
157 end pqp_atd_upd;