DBA Data[Home] [Help]

PACKAGE: APPS.OZF_SYS_PARAMETERS_PVT

Source


1 PACKAGE OZF_Sys_Parameters_PVT AS
2 /* $Header: ozfvsyss.pls 120.3 2007/12/21 07:48:04 gdeepika ship $ */
3 
4 TYPE sys_parameters_rec_type IS RECORD
5 (
6   set_of_books_id            NUMBER,
7   object_version_number      NUMBER,
8   last_update_date           DATE,
9   last_updated_by            NUMBER,
10   creation_date              DATE,
11   created_by                 NUMBER,
12   last_update_login          NUMBER,
13   request_id                 NUMBER,
14   program_application_id     NUMBER,
15   program_update_date        DATE,
16   program_id                 NUMBER,
17   created_from               VARCHAR2(30),
18   post_to_gl                 VARCHAR2(1),
19   transfer_to_gl_in          VARCHAR2(1),
20   ap_payment_term_id         NUMBER,
21   rounding_level_flag        VARCHAR2(1),
22   gl_id_rounding             NUMBER,
23   gl_id_ded_clearing         NUMBER,
24   gl_id_ded_adj              NUMBER,
25   gl_id_accr_promo_liab      NUMBER,
26   gl_id_ded_adj_clearing     NUMBER,
27   gl_rec_ded_account         NUMBER,
28   gl_rec_clearing_account    NUMBER,
29   gl_cost_adjustment_acct    NUMBER,
30   gl_contra_liability_acct   NUMBER ,
31   gl_pp_accrual_acct         NUMBER,
32   gl_date_type               VARCHAR2(30),
33   days_due                   NUMBER,
34   claim_type_id              NUMBER,
35   reason_code_id             NUMBER,
36   autopay_claim_type_id      NUMBER,
37   autopay_reason_code_id     NUMBER,
38   autopay_flag               VARCHAR2(1),
39   autopay_periodicity        NUMBER,
40   autopay_periodicity_type   VARCHAR2(30),
41   accounting_method_option   VARCHAR2(25),
42   billback_trx_type_id       NUMBER,
43   cm_trx_type_id             NUMBER,
44   attribute_category         VARCHAR2(150),
45   attribute1                 VARCHAR2(150),
46   attribute2                 VARCHAR2(150),
47   attribute3                 VARCHAR2(150),
48   attribute4                 VARCHAR2(150),
49   attribute5                 VARCHAR2(150),
50   attribute6                 VARCHAR2(150),
51   attribute7                 VARCHAR2(150),
52   attribute8                 VARCHAR2(150),
53   attribute9                 VARCHAR2(150),
54   attribute10                VARCHAR2(150),
55   attribute11                VARCHAR2(150),
56   attribute12                VARCHAR2(150),
57   attribute13                VARCHAR2(150),
58   attribute14                VARCHAR2(150),
59   attribute15                VARCHAR2(150),
60   org_id                     NUMBER,
61   batch_source_id            NUMBER,
62   payables_source            VARCHAR2(30),
63   default_owner_id           NUMBER,
64   auto_assign_flag           VARCHAR2(1),
65   exchange_rate_type         VARCHAR2(30),
66   order_type_id              NUMBER,
67   --11.5.10 enhancements
68   gl_acct_for_offinv_flag VARCHAR2(1),
69   --short_payment_reason_code_id NUMBER,
70   cb_trx_type_id NUMBER,
71   pos_write_off_threshold NUMBER,
72   neg_write_off_threshold NUMBER,
73   adj_rec_trx_id NUMBER,
74   wo_rec_trx_id NUMBER,
75   neg_wo_rec_trx_id NUMBER,
76   un_earned_pay_allow_to VARCHAR2(30),
77   un_earned_pay_thold_type VARCHAR2(30),
78   un_earned_pay_threshold NUMBER,
79   un_earned_pay_thold_flag  VARCHAR2(1),
80   header_tolerance_calc_code VARCHAR2(30),
81   header_tolerance_operand NUMBER,
82   line_tolerance_calc_code VARCHAR2(30),
83   line_tolerance_operand NUMBER,
84 
85   ship_debit_accrual_flag                   varchar2(1),
86   ship_debit_calc_type                      varchar2(30),
87   inventory_tracking_flag                   varchar2(1),
88   end_cust_relation_flag                    varchar2(1),
89   auto_tp_accrual_flag                      varchar2(1),
90   gl_balancing_flex_value                   VARCHAR2(150),
91   prorate_earnings_flag                     VARCHAR2(1),
92   sales_credit_default_type                 VARCHAR2(30),
93   net_amt_for_mass_settle_flag              VARCHAR2(1),
94 
95   claim_tax_incl_flag                       VARCHAR2(1)
96 );
97 
98 
99 
100 ---------------------------------------------------------------------
101 -- PROCEDURE
102 --    Create_Sys_Parameters
103 --
104 -- PURPOSE
105 --    Create a new record of system parameters.
106 --
107 -- PARAMETERS
108 --    p_sys_parameters_rec: the new record to be inserted
109 --    x_set_of_books_id: return the set_of_books_id of the new system parameters record.
110 --
111 -- NOTES
112 --    1. object_version_number will be set to 1.
113 --    2. If set_of_books_id is passed in, the uniqueness will be checked.
114 --       Raise exception in case of duplicates.
115 --    3. If set_of_books_id is not passed in, get one from org definition.
116 --    4. If a flag column is passed in, check if it is FND_API.g_true/false.
117 --       Raise exception for invalid flag.
118 --    5. If a flag column is not passed in, default it to FND_API.g_false.
119 --    6. Please don't pass in any FND_API.g_mess_char/num/date.
120 ---------------------------------------------------------------------
121 PROCEDURE Create_Sys_Parameters(
122    p_api_version          IN  NUMBER
123   ,p_init_msg_list        IN  VARCHAR2  := FND_API.g_false
124   ,p_commit               IN  VARCHAR2  := FND_API.g_false
125   ,p_validation_level     IN  NUMBER    := FND_API.g_valid_level_full
126 
127   ,x_return_status        OUT NOCOPY VARCHAR2
128   ,x_msg_count            OUT NOCOPY NUMBER
129   ,x_msg_data             OUT NOCOPY VARCHAR2
130 
131   ,p_sys_parameters_rec   IN  sys_parameters_rec_type
132   ,x_set_of_books_id      OUT NOCOPY NUMBER
133 );
134 
135 
136 --------------------------------------------------------------------
137 -- PROCEDURE
138 --    Delete_Sys_Parameters
139 --
140 -- PURPOSE
141 --    Delete a record of system parameters.
142 --
143 -- PARAMETERS
144 --    p_set_of_books_id: the set_of_books_id
145 --    p_object_version: the object_version_number
146 --
147 -- NOTES
148 --    1. Raise exception if the object_version_number doesn't match.
149 --------------------------------------------------------------------
150 PROCEDURE Delete_Sys_Parameters(
151    p_api_version       IN  NUMBER
152   ,p_init_msg_list     IN  VARCHAR2 := FND_API.g_false
153   ,p_commit            IN  VARCHAR2 := FND_API.g_false
154 
155   ,x_return_status     OUT NOCOPY VARCHAR2
156   ,x_msg_count         OUT NOCOPY NUMBER
157   ,x_msg_data          OUT NOCOPY VARCHAR2
158 
159   ,p_set_of_books_id   IN  NUMBER
160   ,p_object_version    IN  NUMBER
161 );
162 
163 
164 -------------------------------------------------------------------
165 -- PROCEDURE
166 --    Lock_Sys_Parameters
167 --
168 -- PURPOSE
169 --    Lock a system parameters record.
170 --
171 -- PARAMETERS
172 --    p_set_of_books_id: the set_of_books_id
173 --    p_object_version : the object_version_number
174 --
175 -- NOTES
176 --    1. Raise exception if the object_version_number doesn't match.
177 --------------------------------------------------------------------
178 PROCEDURE Lock_Sys_Parameters(
179    p_api_version       IN  NUMBER
180   ,p_init_msg_list     IN  VARCHAR2 := FND_API.g_false
181 
182   ,x_return_status     OUT NOCOPY VARCHAR2
183   ,x_msg_count         OUT NOCOPY NUMBER
184   ,x_msg_data          OUT NOCOPY VARCHAR2
185 
186   ,p_set_of_books_id   IN  NUMBER
187   ,p_object_version    IN  NUMBER
188 );
189 
190 
191 ---------------------------------------------------------------------
192 -- PROCEDURE
193 --    Update_Sys_Parameters
194 --
195 -- PURPOSE
196 --    Update a system parameters record.
197 --
198 -- PARAMETERS
199 --    p_sys_parameters_rec: the record with new items.
200 --    p_mode    : determines what sort of validation is to be performed during update.
201 --
202 -- NOTES
203 --    1. Raise exception if the object_version_number doesn't match.
204 --    2. If an attribute is passed in as FND_API.g_miss_char/num/date,
205 --       that column won't be updated.
206 ----------------------------------------------------------------------
207 PROCEDURE Update_Sys_Parameters(
208    p_api_version           IN  NUMBER
209   ,p_init_msg_list         IN  VARCHAR2  := FND_API.g_false
210   ,p_commit                IN  VARCHAR2  := FND_API.g_false
211   ,p_validation_level      IN  NUMBER    := FND_API.g_valid_level_full
212 
213   ,x_return_status         OUT NOCOPY VARCHAR2
214   ,x_msg_count             OUT NOCOPY NUMBER
215   ,x_msg_data              OUT NOCOPY VARCHAR2
216 
217   ,p_sys_parameters_rec    IN  sys_parameters_rec_type
218   ,p_mode                  IN  VARCHAR2 := JTF_PLSQL_API.g_update
219   ,x_object_version_number OUT NOCOPY NUMBER
220 );
221 
222 
223 ---------------------------------------------------------------------
224 -- PROCEDURE
225 --    Validate_Sys_Parameters
226 --
227 -- PURPOSE
228 --    Validate a fund utilization record.
229 --
230 -- PARAMETERS
231 --    p_sys_parameters: the system parameters record to be validated
232 --
233 -- NOTES
234 --    1. p_sys_parameters_rec should be a complete record. There
235 --       should not be any FND_API.g_miss_char/num/date in it.
236 ----------------------------------------------------------------------
237 PROCEDURE Validate_Sys_Parameters(
238    p_api_version          IN  NUMBER
239   ,p_init_msg_list        IN  VARCHAR2  := FND_API.g_false
240   ,p_validation_level     IN  NUMBER    := FND_API.g_valid_level_full
241 
242   ,x_return_status        OUT NOCOPY VARCHAR2
243   ,x_msg_count            OUT NOCOPY NUMBER
244   ,x_msg_data             OUT NOCOPY VARCHAR2
245 
246   ,p_sys_parameters_rec   IN  sys_parameters_rec_type
247 );
248 
249 
250 ---------------------------------------------------------------------
251 -- PROCEDURE
252 --    Check_Sys_Parameters_Items
253 --
254 -- PURPOSE
255 --    Perform the item level checking including unique keys,
256 --    required columns, foreign keys, domain constraints.
257 --
258 -- PARAMETERS
259 --    p_sys_parameters_rec: the record to be validated
260 --    p_validation_mode: JTF_PLSQL_API.g_create/g_update
261 ---------------------------------------------------------------------
262 PROCEDURE Check_Sys_Parameters_Items(
263    p_sys_parameters_rec IN  sys_parameters_rec_type
264   ,p_validation_mode IN  VARCHAR2 := JTF_PLSQL_API.g_create
265   ,x_return_status   OUT NOCOPY VARCHAR2
266 
267 );
268 
269 
270 ---------------------------------------------------------------------
271 -- PROCEDURE
272 --    Check_Sys_Parameters_Record
273 --
274 -- PURPOSE
275 --    Check the record level business rules.
276 --
277 -- PARAMETERS
278 --    p_sys_parameters_rec: the record to be validated; may contain attributes
279 --       as FND_API.g_miss_char/num/date
280 --    p_complete_rec: the complete record after all "g_miss" items
281 --       have been replaced by current database values
282 ---------------------------------------------------------------------
283 PROCEDURE Check_Sys_Parameters_Record(
284    p_sys_parameters_rec IN  sys_parameters_rec_type
285   ,p_complete_rec       IN  sys_parameters_rec_type := NULL
286   ,p_mode               IN  VARCHAR2 := JTF_PLSQL_API.g_create
287   ,x_return_status      OUT NOCOPY VARCHAR2
288 );
289 
290 
291 ---------------------------------------------------------------------
292 -- PROCEDURE
293 --    Init_Sys_Parameters_Rec
294 --
295 -- PURPOSE
296 --    Initialize all attributes to be FND_API.g_miss_char/num/date.
297 ---------------------------------------------------------------------
298 PROCEDURE Init_Sys_Parameters_Rec(
299    x_sys_parameters_rec   OUT NOCOPY  sys_parameters_rec_type
300 );
301 
302 
303 ---------------------------------------------------------------------
304 -- PROCEDURE
305 --    Complete_Sys_Parameters_Rec
306 --
307 -- PURPOSE
308 --    For update_sys_parameters, some attributes may be passed in as
309 --    FND_API.g_miss_char/num/date if the user doesn't want to
310 --    update those attributes. This procedure will replace the
311 --    "g_miss" attributes with current database values.
312 --
313 -- PARAMETERS
314 --    p_sys_parameters_rec: the record which may contain attributes as
315 --       FND_API.g_miss_char/num/date
316 --    x_complete_rec: the complete record after all "g_miss" items
317 --       have been replaced by current database values
318 ---------------------------------------------------------------------
319 PROCEDURE Complete_Sys_Parameters_Rec(
320    p_sys_parameters_rec IN  sys_parameters_rec_type
321   ,x_complete_rec       OUT NOCOPY sys_parameters_rec_type
322 );
323 
324 
325 END OZF_Sys_Parameters_PVT;