DBA Data[Home] [Help]

PACKAGE: APPS.PAY_PBF_BUS

Source


1 Package pay_pbf_bus as
2 /* $Header: pypbfrhi.pkh 120.0 2005/05/29 07:23:13 appldev noship $ */
3 --
4 -- ----------------------------------------------------------------------------
5 -- |           Global Definitions - Internal Development Use Only             |
6 -- ----------------------------------------------------------------------------
7 --
8 -- The following global variable should only be used
9 -- by the get_balance_init_flag() function
10 --
11 g_balance_init_flag boolean default null;
12 --
13 -- ---------------------------------------------------------------------------
14 -- |----------------------< set_security_group_id >--------------------------|
15 -- ---------------------------------------------------------------------------
16 -- {Start Of Comments}
17 --
18 --  Description:
19 --    Sets the security_group_id in CLIENT_INFO for the appropriate business
20 --    group context.
21 --    It is only valid to call this procedure when the primary key
22 --    is within a buisiness group context.
23 --
24 --  Prerequisites:
25 --    The primary key identified by p_balance_feed_id
26 --     already exists.
27 --
28 --  In Arguments:
29 --    p_balance_feed_id
30 --
31 --
32 --  Post Success:
33 --    The security_group_id will be set in CLIENT_INFO.
34 --
35 --  Post Failure:
36 --    An error is raised if the value does not exist.
37 --    An error is also raised when the primary key data is outside
38 --    of a buisiness group context.
39 --
40 --  Access Status:
41 --    Internal Development Use Only.
42 --
43 -- {End Of Comments}
44 -- ---------------------------------------------------------------------------
45 procedure set_security_group_id
46   (p_balance_feed_id                      in number
47   ,p_associated_column1                   in varchar2 default null
48   );
49 --
50 --
51 -- ---------------------------------------------------------------------------
52 -- |---------------------< return_legislation_code >-------------------------|
53 -- ---------------------------------------------------------------------------
54 -- {Start Of Comments}
55 --
56 --  Description:
57 --    Return the legislation code for a specific primary key value
58 --
59 --  Prerequisites:
60 --    The primary key identified by p_balance_feed_id
61 --     already exists.
62 --
63 --  In Arguments:
64 --    p_balance_feed_id
65 --
66 --
67 --  Post Success:
68 --    The business group's legislation code will be returned.
69 --
70 --  Post Failure:
71 --    An error is raised if the value does not exist.
72 --
73 --  Access Status:
74 --    Internal Development Use Only.
75 --
76 -- {End Of Comments}
77 -- ---------------------------------------------------------------------------
78 FUNCTION return_legislation_code
79   (p_balance_feed_id                      in     number
80   ) RETURN varchar2;
81 --
82 --
83 -- ----------------------------------------------------------------------------
84 -- |---------------------------< insert_validate >----------------------------|
85 -- ----------------------------------------------------------------------------
86 -- {Start Of Comments}
87 --
88 -- Description:
89 --   This procedure controls the execution of all insert business rules
90 --   validation.
91 --
92 -- Prerequisites:
93 --   This private procedure is called from ins procedure.
94 --
95 -- In Parameters:
96 --   A Pl/Sql record structre.
97 --
98 --   p_initial_feed
99 --    The parameter p_initial_feed is obsolete and hence the value
100 --    passed here will not be used.
101 --    This parameter is no longer used because from the input value id
102 --    provided it can be derived whether the feed is for initial
103 --    balance feed or not.
104 --
105 --
106 -- Post Success:
107 --   Processing continues.
108 --
109 -- Post Failure:
110 --   If a business rules fails the error will not be handled by this procedure
111 --   unless explicity coded.
112 --
113 -- Developer Implementation Notes:
114 --   For insert, your business rules should be executed from this procedure and
115 --   should ideally (unless really necessary) just be straight procedure or
116 --   function calls. Try and avoid using conditional branching logic.
117 --
118 -- Access Status:
119 --   Internal Row Handler Use Only.
120 --
121 -- {End Of Comments}
122 -- ----------------------------------------------------------------------------
123 Procedure insert_validate
124   (p_rec                   in pay_pbf_shd.g_rec_type
125   ,p_effective_date        in date
126   ,p_datetrack_mode        in varchar2
127   ,p_validation_start_date in date
128   ,p_validation_end_date   in date
129   ,p_initial_feed	   in boolean
130   ,p_exist_run_result_warning out nocopy boolean
131   );
132 --
133 -- ----------------------------------------------------------------------------
134 -- |---------------------------< update_validate >----------------------------|
135 -- ----------------------------------------------------------------------------
136 -- {Start Of Comments}
137 --
138 -- Description:
139 --   This procedure controls the execution of all update business rules
140 --   validation.
141 --
142 -- Prerequisites:
143 --   This private procedure is called from upd procedure.
144 --
145 -- In Parameters:
146 --   A Pl/Sql record structre.
147 --
148 -- Post Success:
149 --   Processing continues.
150 --
151 -- Post Failure:
152 --   If a business rules fails the error will not be handled by this procedure
153 --   unless explicity coded.
154 --
155 -- Developer Implementation Notes:
156 --   For update, your business rules should be executed from this procedure and
157 --   should ideally (unless really necessary) just be straight procedure or
158 --   function calls. Try and avoid using conditional branching logic.
159 --
160 -- Access Status:
161 --   Internal Row Handler Use Only.
162 --
163 -- {End Of Comments}
164 -- ----------------------------------------------------------------------------
165 Procedure update_validate
166   (p_rec                     in pay_pbf_shd.g_rec_type
167   ,p_effective_date          in date
168   ,p_datetrack_mode          in varchar2
169   ,p_validation_start_date   in date
170   ,p_validation_end_date     in date
171   ,p_exist_run_result_warning out nocopy boolean
172   );
173 --
174 -- ----------------------------------------------------------------------------
175 -- |---------------------------< delete_validate >----------------------------|
176 -- ----------------------------------------------------------------------------
177 -- {Start Of Comments}
178 --
179 -- Description:
180 --   This procedure controls the execution of all delete business rules
181 --   validation.
182 --
183 -- Prerequisites:
184 --   This private procedure is called from del procedure.
185 --
186 -- In Parameters:
187 --   A Pl/Sql record structure.
188 --
189 -- Post Success:
190 --   Processing continues.
191 --
192 -- Post Failure:
193 --   If a business rules fails the error will not be handled by this procedure
194 --   unless explicity coded.
195 --
196 -- Developer Implementation Notes:
197 --   For delete, your business rules should be executed from this procedure and
198 --   should ideally (unless really necessary) just be straight procedure or
199 --   function calls. Try and avoid using conditional branching logic.
200 --
201 -- Access Status:
202 --   Internal Row Handler Use Only.
203 --
204 -- {End Of Comments}
205 -- ----------------------------------------------------------------------------
206 Procedure delete_validate
207   (p_rec                   in pay_pbf_shd.g_rec_type
208   ,p_effective_date        in date
209   ,p_datetrack_mode        in varchar2
210   ,p_validation_start_date in date
211   ,p_validation_end_date   in date
212   ,p_exist_run_result_warning out nocopy boolean
213   );
214 --
215 -- ----------------------------------------------------------------------------
216 -- |--------------------------< get_balance_init_flag >-----------------------|
217 -- ----------------------------------------------------------------------------
218 -- {Start Of Comments}
219 --
220 -- Description:
221 --   This functions derives whether the balance feed being created is
222 --   an initial balance feed or not
223 --
224 -- Prerequisites:
225 --   The input value being passed is valid.
226 --
227 -- In Parameters:
228 --   Input value id which feeds the balance.
229 --
230 -- Post Success:
231 --   Processing continues. If the initial balance feed is being created then
232 --   the function returns TRUE else returns FALSE.
233 --
234 -- Post Failure:
235 --   No Direct error handling is required
236 --
237 --
238 -- Developer Implementation Notes:
239 --   None.
240 --
241 --
242 --
243 -- Access Status:
244 --   Internal Development Use Only.
245 --
246 -- {End Of Comments}
247 -- ----------------------------------------------------------------------------
248 Function get_balance_init_flag
249   (p_input_value_id  in  number
250   ) return boolean;
251 --
252 end pay_pbf_bus;