1 PACKAGE PO_DOCUMENT_UPDATE_GRP AS
2 /* $Header: POXGCPOS.pls 120.2 2005/10/26 12:21:25 joswong noship $*/
3
4 -- <PO_CHANGE_API_FPJ START>
5 -- In file version 115.4, added an overloaded update_document procedure that
6 -- takes in changes as a PO_CHANGES_REC_TYPE object. This allows the caller to
7 -- request changes to multiple lines, shipments, and distributions at once.
8
9 -------------------------------------------------------------------------------
10 --Start of Comments
11 --Name: update_document
12 --Function:
13 -- Validates and applies the requested changes and any derived
14 -- changes to the Purchase Order, Purchase Agreement, or Release.
15 --Note:
16 -- For details, see the package body comments for
17 -- PO_DOCUMENT_UPDATE_PVT.update_document.
18 --End of Comments
19 --------------------------------------------------------------------------------
20
21 g_process_param_chge_only VARCHAR2(1) := 'N'; --<INVCONV R12>
22
23 PROCEDURE update_document (
24 p_api_version IN NUMBER,
25 p_init_msg_list IN VARCHAR2,
26 x_return_status OUT NOCOPY VARCHAR2,
27 p_changes IN OUT NOCOPY PO_CHANGES_REC_TYPE,
28 p_run_submission_checks IN VARCHAR2,
29 p_launch_approvals_flag IN VARCHAR2,
30 p_buyer_id IN NUMBER,
31 p_update_source IN VARCHAR2,
32 p_override_date IN DATE,
33 x_api_errors OUT NOCOPY PO_API_ERRORS_REC_TYPE,
34 p_approval_background_flag IN VARCHAR2 DEFAULT NULL,
35 p_mass_update_releases IN VARCHAR2 DEFAULT NULL -- Bug 3373453
36 );
37
38 -- Bug 3605355 START
39 -------------------------------------------------------------------------------
40 --Start of Comments
41 --Name: launch_po_approval_wf
42 --Function:
43 -- Launches the Document Approval workflow for the given document.
44 --Note:
45 -- For details, see the package body comments for
46 -- PO_DOCUMENT_UPDATE_PVT.launch_po_approval_wf.
47 --End of Comments
48 -------------------------------------------------------------------------------
49 PROCEDURE launch_po_approval_wf (
50 p_api_version IN NUMBER,
51 p_init_msg_list IN VARCHAR2,
52 x_return_status OUT NOCOPY VARCHAR2,
53 p_document_id IN NUMBER,
54 p_document_type IN PO_DOCUMENT_TYPES_ALL_B.document_type_code%TYPE,
55 p_document_subtype IN PO_DOCUMENT_TYPES_ALL_B.document_subtype%TYPE,
56 p_preparer_id IN NUMBER,
57 p_approval_background_flag IN VARCHAR2,
58 p_mass_update_releases IN VARCHAR2
59 );
60 -- Bug 3605355 END
61
62 -- Parameter value constants:
63
64 G_PARAMETER_YES VARCHAR2(1) := PO_CORE_S.G_PARAMETER_YES;
65 G_PARAMETER_NO VARCHAR2(1) := PO_CORE_S.G_PARAMETER_NO;
66
67 -- Constants for the p_update_source parameter of update_document:
68
69 G_UPDATE_SOURCE_OM CONSTANT VARCHAR2(20)
70 := PO_DOCUMENT_UPDATE_PVT.G_UPDATE_SOURCE_OM; -- OM (Drop Ship Integration)
71
72 -- Entity type constants:
73
74 G_ENTITY_TYPE_CHANGES CONSTANT VARCHAR2(30)
75 := PO_DOCUMENT_UPDATE_PVT.G_ENTITY_TYPE_CHANGES;
76 G_ENTITY_TYPE_LINES CONSTANT VARCHAR2(30)
77 := PO_DOCUMENT_UPDATE_PVT.G_ENTITY_TYPE_LINES;
78 G_ENTITY_TYPE_SHIPMENTS CONSTANT VARCHAR2(30)
79 := PO_DOCUMENT_UPDATE_PVT.G_ENTITY_TYPE_SHIPMENTS;
80 G_ENTITY_TYPE_DISTRIBUTIONS CONSTANT VARCHAR2(30)
81 := PO_DOCUMENT_UPDATE_PVT.G_ENTITY_TYPE_DISTRIBUTIONS;
82
83 -- Use this constant in the change object to indicate that a field should be
84 -- set to NULL.
85 G_NULL_NUM CONSTANT NUMBER := PO_DOCUMENT_UPDATE_PVT.G_NULL_NUM;
86
87 -- <PO_CHANGE_API_FPJ END>
88
89 -- <PO_CHANGE_API_FPJ START>
90 -- In file version 115.3, removed the P_INTERFACE_TYPE and P_TRANSACTION_ID
91 -- parameters from UPDATE_DOCUMENT and added an X_API_ERRORS parameter.
92 -- The PO Change API will no longer write error messages to the
93 -- PO_INTERFACE_ERRORS table. Instead, all of the errors will be returned
94 -- in the x_api_errors object.
95 -- <PO_CHANGE_API_FPJ END>
96
97 /*=====================================================================
98 * PROCEDURE update_document
99 * API that updates qty, price or/and promised_date of a document.
100 * Parameters:
101 * - p_PO_NUMBER: po number of the document
102 * - p_RELEASE_NUMBER: Null if not a release, otherwise, release number
103 * - p_REVISION_NUMBER: should be the latest revision
104 * - p_LINE_NUMBER: Line number of the doc.
105 * - p_SHIPMENT_NUMBER: Shipment number
106 * - p_NEW_QUANTITY : desired new quantity for a line/shipment
107 * - p_NEW_PRICE : desired new price for a line/shipment
108 * - p_NEW_PROMISED_DATE: desired new promised date for a shipment
109 * - p_NEW_NEED_BY_DATE: desired new need-by date for a shipment
110 * - p_LAUNCH_APPROVALS_FLAG: determines whether approval workflow is
111 * executed or not after update
112 * - p_UPDATE_SOURCE: for future usage
113 * - p_OVERRIDE_DATE: If funds are reserved for the document, this
114 * parameter is to speicify the date that is used
115 * to unreserve the doc. It's meaningless if
116 * encumbrance is not used.
117 * - p_VERSION: version of the API that is intended to be used
118 * - x_result: return status of the call:
119 * 1 if the API completed successfully;
120 * 0 if there will any errors.
121 * - x_api_errors: If x_result = 0, this object will contain all of the error
122 * messages.
123 * - - p_BUYER_NAME: Added as a part of bug fix 2986718.
124 *======================================================================*/
125 PROCEDURE update_document
126 (
127 p_PO_NUMBER IN VARCHAR2,
128 p_RELEASE_NUMBER IN NUMBER,
129 p_REVISION_NUMBER IN NUMBER,
130 p_LINE_NUMBER IN NUMBER,
131 p_SHIPMENT_NUMBER IN NUMBER,
132 p_NEW_QUANTITY IN NUMBER,
133 p_NEW_PRICE IN NUMBER,
134 p_NEW_PROMISED_DATE IN DATE,
135 p_NEW_NEED_BY_DATE IN DATE,
136 p_LAUNCH_APPROVALS_FLAG IN VARCHAR2,
137 p_UPDATE_SOURCE IN VARCHAR2,
138 p_OVERRIDE_DATE IN DATE,
139 p_VERSION IN NUMBER,
140 x_result IN OUT NOCOPY NUMBER,
141 x_api_errors OUT NOCOPY PO_API_ERRORS_REC_TYPE,
142 p_BUYER_NAME IN VARCHAR2 default NULL,
143 --<INVCONV R12 START>
144 p_secondary_qty IN NUMBER ,
145 p_preferred_grade IN VARCHAR2
146 --<INVCONV R12 END>
147 );
148
149 END PO_DOCUMENT_UPDATE_GRP;