DBA Data[Home] [Help]

PACKAGE: APPS.PAY_BATCH_BALANCE_ADJ_PKG

Source


1 PACKAGE PAY_BATCH_BALANCE_ADJ_PKG AUTHID CURRENT_USER AS
2 /* $Header: pybbautl.pkh 120.2 2006/01/20 05:54 jabubaka noship $ */
3 --
4 -- ----------------------------------------------------------------------------
5 -- |---------------------------< submit_conc_request >------------------------|
6 -- ----------------------------------------------------------------------------
7 --
8 -- Description:
9 -- This function is called from the BBA webadi interface to submit the
10 -- concurrent request for batch balance adjustment.
11 -- Returns the request if of the submitted request.
12 --
13 -- ----------------------------------------------------------------------------
14 
15 function submit_conc_request
16 (
17   p_business_group_id      in  number,
18   p_mode                   in  varchar2,
19   p_batch_id               in  number,
20   p_wait                   in  varchar2 default 'N',
21   p_act_parameter_group_id in  number   default null
22 ) return number;
23 --
24 -- ----------------------------------------------------------------------------
25 -- |---------------------------< batch_overall_status >-----------------------|
26 -- ----------------------------------------------------------------------------
27 --
28 -- Description:
29 -- This function derives the overall stauts of the batch. The overall status
30 -- is not just the batch status but also considers the status of the
31 -- batch groups.
32 --
33 -- ----------------------------------------------------------------------------
34 function batch_overall_status (p_batch_id in  number)
35 return varchar2;
36 --
37 -- ----------------------------------------------------------------------------
38 -- |-------------------------< batch_group_overall_status >-------------------|
39 -- ----------------------------------------------------------------------------
40 --
41 -- Description:
42 -- This function derives the overall status of the batch group. The overall
43 -- status is not just the batch group status but also considers the status of
44 -- the batch lines.
45 --
46 -- ----------------------------------------------------------------------------
47 function batch_group_overall_status
48   ( p_batch_id       in  number
49    ,p_batch_group_id in  number )
50 return varchar2;
51 --
52 -- ----------------------------------------------------------------------------
53 -- |---------------------------------< purge >--------------------------------|
54 -- ----------------------------------------------------------------------------
55 --
56 -- Description:
57 -- This procedures deletes all records associated with the batch balance
58 -- adjustment tables and the pay_message_lines table.
59 --
60 -- ----------------------------------------------------------------------------
61 --
62 procedure purge
63   ( p_batch_id       in  number,
64     p_batch_group_id in  number);
65 --
66 -- ----------------------------------------------------------------------------
67 -- |---------------------------< check_operation_allowed >--------------------|
68 -- ----------------------------------------------------------------------------
69 --
70 -- Description:
71 -- Given the current batch status and the required processing mode this
72 -- function determines if its a valid operation or not.
73 --
74 -- ----------------------------------------------------------------------------
75 --
76 function check_operation_allowed
77    ( p_batch_status in varchar2 ,
78      p_process_mode in varchar2 )
79 return boolean;
80 ------------------------------------------------------------------------------
81 -- |--------------------------------< rollback_batch >------------------------|
82 -- ----------------------------------------------------------------------------
83 --
84 -- Description:
85 -- This procedures rollbacks all the actions of the given batch id.
86 --
87 -- ----------------------------------------------------------------------------
88 --
89 procedure rollback_batch
90   ( p_batch_id       in  number,
91     p_batch_group_id in  number);
92 --
93 ------------------------------------------------------------------------------
94 --|---------------------------< validate_and_transfer >-----------------------|
95 -- ----------------------------------------------------------------------------
96 --
97 -- Description:
98 -- This procedures does validate or transfer based on the batch_process_mode
99 --   specified. This is internally called by validate and transfer
100 -- ----------------------------------------------------------------------------
101 --
102 procedure validate_and_transfer
103    (p_batch_id       in  number,
104     p_batch_group_id in  number,
105     p_batch_process_mode varchar2);
106 --
107 ------------------------------------------------------------------------------
108 -- |--------------------------------< transfer_batch >------------------------|
109 -- ----------------------------------------------------------------------------
110 --
111 -- Description:
112 -- This procedure transfers the batch specified
113 --
114 -- ----------------------------------------------------------------------------
115 --
116 procedure transfer_batch
117   ( p_batch_id       in  number,
118     p_batch_group_id in  number);
119 --
120 -- ----------------------------------------------------------------------------
121 -- |--------------------------------< validate_batch >-------------------------|
122 -- ----------------------------------------------------------------------------
123 --
124 -- Description:
125 -- This procedures validates the batch specified
126 --
127 -- ----------------------------------------------------------------------------
128 --
129 procedure validate_batch
130   ( p_batch_id       in  number,
131     p_batch_group_id in  number);
132 --
133 -- ----------------------------------------------------------------------------
134 -- |-----------------------------< run_process >------------------------------|
135 -- ----------------------------------------------------------------------------
136 --
137 -- Description:
138 -- This procedure is used in the executable of the bba process.
139 --
140 -- ----------------------------------------------------------------------------
141 --
142 
143 procedure run_process
144 (errbuf                  out     nocopy varchar2,
145  retcode                 out     nocopy number,
146  p_batch_operation       in      varchar2,
147  p_batch_id              in      number,
148  p_batch_group_id        in      number
149 );
150 --
151 END PAY_BATCH_BALANCE_ADJ_PKG;