DBA Data[Home] [Help]

PACKAGE: APPS.PO_DOCUMENT_CONTROL_PVT

Source


1 PACKAGE PO_Document_Control_PVT AS
2 /* $Header: POXVDCOS.pls 120.7 2006/07/06 11:53:34 asista noship $ */
3 
4 g_pkg_name CONSTANT VARCHAR2(30) := 'PO_DOCUMENT_CONTROL_PVT';
5 
6 -- Global constants to identify the level of the control action
7 g_header_level       CONSTANT NUMBER := 0;
8 g_line_level         CONSTANT NUMBER := 1;
9 g_shipment_level     CONSTANT NUMBER := 2;
10 g_rel_header_level   CONSTANT NUMBER := 3;
11 g_rel_shipment_level CONSTANT NUMBER := 4;
12 
13 --< Bug 3194665 Start >
14 TYPE g_lookup_code_tbl_type IS TABLE OF PO_LOOKUP_CODES.lookup_code%TYPE
15     INDEX BY BINARY_INTEGER;
16 TYPE g_displayed_field_tbl_type IS TABLE OF PO_LOOKUP_CODES.displayed_field%TYPE
17     INDEX BY BINARY_INTEGER;
18 --< Bug 3194665 End >
19 
20 PROCEDURE control_document
21    (p_api_version           IN   NUMBER,
22     p_init_msg_list         IN   VARCHAR2,
23     p_commit                IN   VARCHAR2,
24     x_return_status         OUT  NOCOPY VARCHAR2,
25     p_doc_type              IN   VARCHAR2,
26     p_doc_subtype           IN   VARCHAR2,
27     p_doc_id                IN   NUMBER,
28     p_doc_line_id           IN   NUMBER,
29     p_doc_line_loc_id       IN   NUMBER,
30     p_source                IN   VARCHAR2,
31     p_action                IN   VARCHAR2,
32     p_action_date           IN   DATE,
33     p_cancel_reason         IN   VARCHAR2,
34     p_cancel_reqs_flag      IN   VARCHAR2,
35     p_print_flag            IN   VARCHAR2,
36     p_note_to_vendor        IN   VARCHAR2,
37     p_use_gldate            IN   VARCHAR2 DEFAULT NULL,   -- <ENCUMBRANCE FPJ>
38     p_launch_approvals_flag IN   VARCHAR2 := 'Y', -- <CancelPO FPJ>
39     p_communication_method_option  IN   VARCHAR2 DEFAULT NULL, --<HTML Agreements R12>
40     p_communication_method_value   IN   VARCHAR2 DEFAULT NULL);  --<HTML Agreements R12>
41 
42 PROCEDURE init_action_date
43    (p_api_version    IN     NUMBER,
44     p_init_msg_list  IN     VARCHAR2,
45     x_return_status  OUT    NOCOPY VARCHAR2,
46     p_doc_type       IN     PO_DOCUMENT_TYPES.document_type_code%TYPE,
47     p_doc_subtype    IN     PO_DOCUMENT_TYPES.document_subtype%TYPE,
48     p_doc_id         IN     NUMBER,
49     x_action_date    IN OUT NOCOPY DATE,
50     x_cbc_enabled    OUT    NOCOPY VARCHAR2);
51 
52 
53 PROCEDURE get_action_date
54    (p_api_version    IN   NUMBER,
55     p_init_msg_list  IN   VARCHAR2,
56     x_return_status  OUT  NOCOPY VARCHAR2,
57     p_doc_type       IN   PO_DOCUMENT_TYPES.document_type_code%TYPE,
58     p_doc_subtype    IN   PO_DOCUMENT_TYPES.document_subtype%TYPE,
59     p_doc_id         IN   NUMBER,
60     p_cbc_enabled    IN   VARCHAR2,
61     x_action_date    OUT  NOCOPY DATE);
62 
63 
64 PROCEDURE val_action_date
65    (p_api_version          IN   NUMBER,
66     p_init_msg_list        IN   VARCHAR2,
67     x_return_status        OUT  NOCOPY VARCHAR2,
68     p_doc_type             IN   PO_DOCUMENT_TYPES.document_type_code%TYPE,
69     p_doc_subtype          IN   PO_DOCUMENT_TYPES.document_subtype%TYPE,
70     p_doc_id               IN   NUMBER,
71     p_action               IN   VARCHAR2,
72     p_action_date          IN   DATE,
73     p_cbc_enabled          IN   VARCHAR2,
74     p_po_encumbrance_flag  IN   VARCHAR2,
75     p_req_encumbrance_flag IN   VARCHAR2,
76     p_skip_valid_cbc_acct_date IN VARCHAR2 DEFAULT NULL); --Bug#4569120
77 
78 
79 PROCEDURE val_control_action
80    (p_api_version      IN   NUMBER,
81     p_init_msg_list    IN   VARCHAR2,
82     x_return_status    OUT  NOCOPY VARCHAR2,
83     p_doc_type         IN   PO_DOCUMENT_TYPES.document_type_code%TYPE,
84     p_doc_subtype      IN   PO_DOCUMENT_TYPES.document_subtype%TYPE,
85     p_doc_id           IN   NUMBER,
86     p_doc_line_id      IN   NUMBER,
87     p_doc_line_loc_id  IN   NUMBER,
88     p_action           IN   VARCHAR2,
89     p_agent_id         IN   PO_HEADERS.agent_id%TYPE,
90     x_control_level    OUT  NOCOPY NUMBER);
91 
92 
93 PROCEDURE po_stop_wf_process
94    (p_api_version    IN   NUMBER,
95     p_init_msg_list  IN   VARCHAR2,
96     x_return_status  OUT  NOCOPY VARCHAR2,
97     p_doc_type       IN   PO_DOCUMENT_TYPES.document_type_code%TYPE,
98     p_doc_subtype    IN   PO_DOCUMENT_TYPES.document_subtype%TYPE,
99     p_doc_id         IN   NUMBER);
100 
101 
102 PROCEDURE rel_stop_wf_process
103    (p_api_version    IN   NUMBER,
104     p_init_msg_list  IN   VARCHAR2,
105     x_return_status  OUT  NOCOPY VARCHAR2,
106     p_doc_type       IN   PO_DOCUMENT_TYPES.document_type_code%TYPE,
107     p_doc_subtype    IN   PO_DOCUMENT_TYPES.document_subtype%TYPE,
108     p_doc_id         IN   NUMBER);
109 
110 
111 PROCEDURE create_print_request
112    (p_api_version    IN   NUMBER,
113     p_init_msg_list  IN   VARCHAR2,
114     x_return_status  OUT  NOCOPY VARCHAR2,
115     p_doc_type       IN   PO_DOCUMENT_TYPES.document_type_code%TYPE,
116     p_doc_num        IN   VARCHAR2,
117     p_rel_doc_num    IN   VARCHAR2,
118     x_request_id     OUT  NOCOPY NUMBER);
119 
120 
121 PROCEDURE update_note_to_vendor
122    (p_api_version    IN   NUMBER,
123     p_init_msg_list  IN   VARCHAR2,
124     p_commit         IN   VARCHAR2,
125     x_return_status  OUT  NOCOPY VARCHAR2,
126     p_doc_type       IN   PO_DOCUMENT_TYPES.document_type_code%TYPE,
127     p_doc_id         IN   NUMBER,
128     p_doc_line_id    IN   NUMBER,
129     p_note_to_vendor IN   PO_HEADERS.note_to_vendor%TYPE);
130 
131 
132 FUNCTION pass_security_check
133    (p_api_version    IN   NUMBER,
134     p_init_msg_list  IN   VARCHAR2,
135     x_return_status  OUT  NOCOPY VARCHAR2,
136     p_doc_type       IN   PO_DOCUMENT_TYPES.document_type_code%TYPE,
137     p_doc_subtype    IN   PO_DOCUMENT_TYPES.document_subtype%TYPE,
138     p_doc_id         IN   NUMBER,
139     p_agent_id       IN   PO_HEADERS.agent_id%TYPE)
140 RETURN BOOLEAN;
141 
142 
143 FUNCTION has_shipments
144    (p_api_version    IN   NUMBER,
145     p_init_msg_list  IN   VARCHAR2,
146     x_return_status  OUT  NOCOPY VARCHAR2,
147     p_doc_type       IN   PO_DOCUMENT_TYPES.document_type_code%TYPE,
148     p_doc_id         IN   NUMBER)
149 RETURN BOOLEAN;
150 
151 
152 FUNCTION has_unencumbered_shipments
153    (p_api_version    IN   NUMBER,
154     p_init_msg_list  IN   VARCHAR2,
155     x_return_status  OUT  NOCOPY VARCHAR2,
156     p_doc_type       IN   PO_DOCUMENT_TYPES.document_type_code%TYPE,
157     p_doc_id         IN   NUMBER)
158 RETURN BOOLEAN;
159 
160 
161 FUNCTION in_open_gl_period
162    (p_api_version    IN   NUMBER,
163     p_init_msg_list  IN   VARCHAR2,
164     x_return_status  OUT  NOCOPY VARCHAR2,
165     p_date           IN   DATE)
166 RETURN BOOLEAN;
167 
168 
169 PROCEDURE add_online_report_msgs
170    (p_api_version      IN   NUMBER,
171     p_init_msg_list    IN   VARCHAR2,
172     x_return_status    OUT  NOCOPY VARCHAR2,
173     p_online_report_id IN   NUMBER);
174 
175 --< Bug 3194665 Start >
176 PROCEDURE get_header_actions
177     ( p_doc_subtype         IN   VARCHAR2
178     , p_doc_id              IN   NUMBER
179     , p_agent_id            IN   NUMBER
180     , x_lookup_code_tbl     OUT  NOCOPY g_lookup_code_tbl_type
181     , x_displayed_field_tbl OUT  NOCOPY g_displayed_field_tbl_type
182     , x_return_status       OUT  NOCOPY VARCHAR2
183     , p_mode                 IN  VARCHAR2 DEFAULT NULL);--<HTML Agreements R12>
184 
185 PROCEDURE get_line_actions
186     ( p_doc_subtype         IN   VARCHAR2
187     , p_doc_line_id         IN   NUMBER
188     , p_agent_id            IN   NUMBER
189     , x_lookup_code_tbl     OUT  NOCOPY g_lookup_code_tbl_type
190     , x_displayed_field_tbl OUT  NOCOPY g_displayed_field_tbl_type
191     , x_return_status       OUT  NOCOPY VARCHAR2
192     , p_mode                 IN  VARCHAR2 DEFAULT NULL);--<HTML Agreements R12>
193 
194 PROCEDURE get_shipment_actions
195     ( p_doc_type            IN   VARCHAR2
196     , p_doc_subtype         IN   VARCHAR2
197     , p_doc_line_loc_id     IN   NUMBER
198     , p_agent_id            IN   NUMBER
199     , x_lookup_code_tbl     OUT  NOCOPY g_lookup_code_tbl_type
200     , x_displayed_field_tbl OUT  NOCOPY g_displayed_field_tbl_type
201     , x_return_status       OUT  NOCOPY VARCHAR2
202     , p_mode                 IN  VARCHAR2 DEFAULT NULL);--<HTML Agreements R12>
203 
204 PROCEDURE get_rel_header_actions
205     ( p_doc_subtype         IN   VARCHAR2
206     , p_doc_id              IN   NUMBER
207     , p_agent_id            IN   NUMBER
208     , x_lookup_code_tbl     OUT  NOCOPY g_lookup_code_tbl_type
209     , x_displayed_field_tbl OUT  NOCOPY g_displayed_field_tbl_type
210     , x_return_status       OUT  NOCOPY VARCHAR2
211     );
212 
213 PROCEDURE get_rel_shipment_actions
214     ( p_doc_subtype         IN   VARCHAR2
215     , p_doc_line_loc_id     IN   NUMBER
216     , p_agent_id            IN   NUMBER
217     , x_lookup_code_tbl     OUT  NOCOPY g_lookup_code_tbl_type
218     , x_displayed_field_tbl OUT  NOCOPY g_displayed_field_tbl_type
219     , x_return_status       OUT  NOCOPY VARCHAR2
220     );
221 --< Bug 3194665 End >
222  --<HTML Agreements R12 Start>
223 procedure get_valid_control_actions( p_mode                IN   VARCHAR2
224                                     ,p_doc_level           IN   VARCHAR2
225                                     ,p_doc_type            IN   VARCHAR2
226                                     ,p_doc_header_id       IN   NUMBER
227                                     ,p_doc_level_id        IN   NUMBER
228                                     ,x_return_status       OUT  NOCOPY VARCHAR2
229                                     ,x_valid_ctrl_ctn_tbl  OUT  NOCOPY PO_TBL_VARCHAR30);
230 
231 -- Bug 5000165 Added the x_is_encumbrance_error parameter.
232 procedure process_doc_control_action( p_control_action         IN  VARCHAR2
233                                      ,p_mode                   IN  VARCHAR2
234                                      ,p_doc_level              IN  VARCHAR2
235                                      ,p_doc_header_id          IN  NUMBER
236                                      ,p_doc_org_id             IN  NUMBER
237                                      ,p_doc_line_id            IN  NUMBER
238                                      ,p_doc_line_loc_id        IN  NUMBER
239                                      ,p_doc_type               IN  VARCHAR2
240                                      ,p_doc_subtype            IN  VARCHAR2
241                                      ,p_gl_date                IN  DATE
242                                      ,p_po_encumbrance_flag    IN  VARCHAR2
243                                      ,p_req_encumbrance_flag   IN  VARCHAR2
244                                      ,p_use_gldate             IN  VARCHAR2
245                                      ,p_reason                 IN  VARCHAR2
246                                      ,p_note_to_vendor         IN  VARCHAR2
247                                      ,p_communication_method   IN  VARCHAR2
248                                      ,p_communication_value    IN  VARCHAR2
249                                      ,p_cancel_reqs            IN  VARCHAR2
250                                      ,x_return_status          OUT NOCOPY VARCHAR2
251                                      ,x_approval_initiated     OUT NOCOPY VARCHAR2
252                                      ,x_cancel_req_flag_reset  OUT NOCOPY VARCHAR2
253                                      ,x_error_msg_tbl          OUT NOCOPY PO_TBL_VARCHAR2000
254                                      ,x_is_encumbrance_error   OUT NOCOPY VARCHAR2
255                                      ,x_online_report_id       OUT NOCOPY NUMBER --bug#5055417
256                                      );
257 
258 procedure get_cancel_req_chkbox_attr( p_doc_level_id                 IN NUMBER
259                                      ,p_doc_header_id                IN NUMBER
260                                      ,p_doc_level                    IN VARCHAR2
261                                      ,p_doc_subtype                  IN VARCHAR2
262                                      ,p_cancel_req_on_cancel_po      IN VARCHAR2
263                                      ,x_drop_ship_flag               OUT NOCOPY VARCHAR2
264                                      ,x_labor_expense_req_flag       OUT NOCOPY VARCHAR2
265                                      ,x_svc_line_with_req_flag       OUT NOCOPY VARCHAR2
266                                      ,x_fps_line_ship_with_req_flag  OUT NOCOPY VARCHAR2
267                                      ,x_return_status                OUT NOCOPY VARCHAR2);
268  --<HTML Agreements R12 End>
269 
270 END PO_Document_Control_PVT;