DBA Data[Home] [Help]

PACKAGE: APPS.PAY_PPM_DEL

Source


1 Package pay_ppm_del AUTHID CURRENT_USER as
2 /* $Header: pyppmrhi.pkh 120.1 2008/12/05 13:44:37 abanand ship $ */
3 --
4 -- ----------------------------------------------------------------------------
5 -- |------------------------------< delete_dml >------------------------------|
6 -- ----------------------------------------------------------------------------
7 -- {Start Of Comments}
8 --
9 -- Description:
10 --   This procedure calls the dt_delete_dml control logic which handles
11 --   the actual datetrack dml.
12 --
13 -- Pre Conditions:
14 --   This is an internal private procedure which must be called from the del
15 --   procedure.
16 --
17 -- In Arguments:
18 --   A Pl/Sql record structre.
19 --
20 -- Post Success:
21 --   Processing contines.
22 --
23 -- Post Failure:
24 --   No specific error handling is required within this procedure.
25 --
26 -- Developer Implementation Notes:
27 --   None.
28 --
29 -- Access Status:
30 --   Internal Table Handler Use Only.
31 --
32 -- {End Of Comments}
33 -- ----------------------------------------------------------------------------
34 Procedure delete_dml
35 	(p_rec 			 in out nocopy pay_ppm_shd.g_rec_type,
36 	 p_effective_date	 in	date,
37 	 p_datetrack_mode	 in	varchar2,
38 	 p_validation_start_date in	date,
39 	 p_validation_end_date	 in	date);
40 --
41 -- ----------------------------------------------------------------------------
42 -- |---------------------------------< del >----------------------------------|
43 -- ----------------------------------------------------------------------------
44 -- {Start Of Comments}
45 --
46 -- Description:
47 --   This procedure is the record interface for the datetrack delete
48 --   business process for the specified entity. The role of this
49 --   process is to delete the dateracked row from the HR schema.
50 --   This process is the main backbone of the del business process. The
51 --   processing of this procedure is as follows:
52 --   1) Ensure that the datetrack delete mode is valid.
53 --   2) If the p_validate argument has been set to true then a savepoint is
54 --      issued.
55 --   3) The controlling validation process delete_validate is then executed
56 --      which will execute all private and public validation business rule
57 --      processes.
58 --   4) The pre_delete business process is then executed which enables any
59 --      logic to be processed before the delete dml process is executed.
60 --   5) The delete_dml process will physical perform the delete dml for the
61 --      specified row.
62 --   6) The post_delete business process is then executed which enables any
63 --      logic to be processed after the delete dml process.
64 --   7) If the p_validate argument has been set to true an exception is raised
65 --      which is handled and processed by performing a rollback to the
66 --      savepoint which was issued at the beginning of the del process.
67 --
68 -- Pre Conditions:
69 --   The main arguments to the business process have to be in the record
70 --   format.
71 --
72 -- In Arguments:
73 --   p_effective_date
74 --     Specifies the date of the datetrack update operation.
75 --   p_datetrack_mode
76 --     Determines the datetrack update mode.
77 --   p_validate
78 --     Determines if the business process is to be validated. Setting this
79 --     boolean value to true will invoke the process to be validated. The
80 --     default is false. The validation is controlled by a savepoint and
81 --     rollback mechanism. The savepoint is issued at the beginning of the
82 --     business process and is rollbacked at the end of the business process
83 --     when all the processing has been completed. The rollback is controlled
84 --     by raising and handling the exception hr_api.validate_enabled. We use
85 --     the exception because, by raising the exception with the business
86 --     process, we can exit successfully without having any of the 'OUT'
87 --     arguments being set.
88 --
89 -- Post Success:
90 --   The specified row will be fully validated and deleted for the specified
91 --   entity without being committed. If the p_validate argument has been set
92 --   to true then all the work will be rolled back.
93 --
94 -- Post Failure:
95 --   If an error has occurred, an error message will be supplied with the work
96 --   rolled back.
97 --   A failure will occur if any of the following conditions are found:
98 --   1) Delete mode is DELETE and related rows exist in PAY_PRE_PAYMENTS
99 --      for PAY_PAYROLL_ACTION effective dates that are effective beyond
100 --      the session effective date
101 --   2) Delete mode is ZAP and related rows exist in PAY_PRE_PAYMENTS
102 --
103 -- Developer Implementation Notes:
104 --   None.
105 --
106 -- Access Status:
107 --   Internal Development Use Only.
108 --
109 -- {End Of Comments}
110 -- ----------------------------------------------------------------------------
111 Procedure del
112   (
113   p_rec			in out nocopy 	pay_ppm_shd.g_rec_type,
114   p_effective_date	in 	date,
115   p_datetrack_mode	in 	varchar2,
116   p_validate   		in 	boolean default false
117   );
118 --
119 -- ----------------------------------------------------------------------------
120 -- |---------------------------------< del >----------------------------------|
121 -- ----------------------------------------------------------------------------
122 -- {Start Of Comments}
123 --
124 -- Description:
125 --   This procedure is the attribute interface for the delete business
126 --   process for the specified entity and is the outermost layer. The role
127 --   of this process is to validate and delete the specified row from the
128 --   HR schema. The processing of this procedure is as follows:
129 --   1) The attributes are converted into a local record structure by
130 --      explicitly coding the attribute arguments into the g_rec_type
131 --      datatype.
132 --   2) After the conversion has taken place, the corresponding record del
133 --      interface business process is executed.
134 --
135 -- Pre Conditions:
136 --
137 -- In Arguments:
138 --   p_effective_date
139 --     Specifies the date of the datetrack update operation.
140 --   p_datetrack_mode
141 --     Determines the datetrack update mode.
142 --   p_validate
143 --     Determines if the business process is to be validated. Setting this
144 --     Boolean value to true will invoke the process to be validated.
145 --     The default is false.
146 --
147 -- Post Success:
148 --   The specified row will be fully validated and deleted for the specified
149 --   entity without being committed (or rollbacked depending on the
150 --   p_validate status).
151 --
152 -- Post Failure:
153 --   If an error has occurred, an error message will be supplied with the work
154 --   rolled back. Refer to the del record interface for details of possible
155 --   failures
156 --
157 -- Developer Implementation Notes:
158 --   The attrbute in arguments should be modified as to the business process
159 --   requirements.
160 --
161 -- Access Status:
162 --   Internal Development Use Only.
163 --
164 -- {End Of Comments}
165 -- ----------------------------------------------------------------------------
166 Procedure del
167   (
168   p_personal_payment_method_id	  in 	 number,
169   p_effective_start_date     out nocopy date,
170   p_effective_end_date	     out nocopy date,
171   p_object_version_number in out nocopy number,
172   p_effective_date	  in     date,
173   p_datetrack_mode  	  in     varchar2,
174   p_validate		  in     boolean default false
175   );
176 --
177 end pay_ppm_del;