DBA Data[Home] [Help]

PACKAGE: APPS.WSH_CUSTOM_PUB

Source


1 PACKAGE WSH_CUSTOM_PUB as
2 /* $Header: WSHCSPBS.pls 120.2.12010000.2 2008/10/17 07:26:42 brana ship $ */
3 
4 --
5 -- Package type declarations
6 --
7 
8 --
9 --  Function:		Delivery_Name
10 --  Parameters:		p_delivery_id   - Delivery_Id
11 --			p_delivery_info - Other attributes specified
12 --					  in the delivery entity
13 --  Description:	This function is designed for the user to
14 --			customize the name of the delivery when
15 --			creating it. It accepts all the related information
16 --			of the delivery entity from which customizations
17 --			can be designed.
18 --			Oracle Default: Provide a character version of the
19 --					delivery_id
20 --
21 
22   FUNCTION Delivery_Name
23 		  (
24 		    p_delivery_id	IN	NUMBER,
25 		    p_delivery_info	IN	WSH_NEW_DELIVERIES_PVT.Delivery_Rec_Type
26 		  ) RETURN VARCHAR2;
27 
28 --
29 --  Function:		Trip_Name
30 --  Parameters:		p_trip_id   - trip_id
31 --					p_trip_info - Other attributes specified
32 --					  in the delivery entity
33 --  Description:	This function is designed for the user to
34 --			customize the name of the trip when
35 --			creating it. It accepts all the related information
36 --			of the trip entity from which customizations
37 --			can be designed.
38 --			Oracle Default: Provide a character version of the
39 --					delivery_id
40 --
41 
42 
43 FUNCTION Trip_Name(
44   		  p_trip_id  IN NUMBER,
45 		  p_trip_info IN wsh_trips_pvt.trip_rec_type
46 		 ) RETURN VARCHAR2;
47 
48 --
49 --  Function:           Run_PR_SMC_SS_Parallel
50 --  Description:        This function is designed for the user to
51 --                      customize the running of Pick Release for Ship Sets and SMCs
52 --                      in parallel with Regular Items.
53 --                      If this is set to 'Y', then Ship Sets/SMCs are not given a
54 --                      priority over Regular Items. This can lead to scenarios where
55 --                      Ship Sets/SMCs are backordered while Regular Items are picked.
56 --                      Oracle Default: Ship Sets/SMCs are not run in Parallel
57 --                      Function Default: 'N'
58 --
59 
60 FUNCTION Run_PR_SMC_SS_Parallel
61                   RETURN VARCHAR2;
62 
63 --
64 --  Function:           Credit_Check_Details_Option
65 --  Description:        This function is designed for the user to
66 --                      customize credit checking for details.
67 --                      By default, credit check will be done for all details ('A')
68 --                      If the credit check is to be run only for Non-Backordered details,
69 --                      then this is set to 'R'.
70 --                      If the credit check is to be run only for Backordered details,
71 --                      then this is set to 'B'.
72 --                      Oracle Default: Credit check for all details.
73 --                      Function Default: 'A'
74 --
75 
76 FUNCTION Credit_Check_Details_Option
77                   RETURN VARCHAR2;
78 
79 --Added as a part of bugfix4995478
80 --  PROCEDURE: 	ui_location_code
81 --  Parameters: p_location_type        IN  VARCHAR2,
82 --		p_location_idTbl       IN  WSH_LOCATIONS_PKG.ID_Tbl_Type,
83 --    	        p_address_1Tbl         IN  WSH_LOCATIONS_PKG.Address_Tbl_Type,
84 --              p_address_2Tbl         IN  WSH_LOCATIONS_PKG.Address_Tbl_Type ,
85 --		p_countryTbl           IN  WSH_LOCATIONS_PKG.Address_Tbl_Type ,
86 --		p_stateTbl             IN  WSH_LOCATIONS_PKG.Address_Tbl_Type ,
87 --              p_provinceTbl          IN  WSH_LOCATIONS_PKG.Address_Tbl_Type ,
88 --              p_countyTbl            IN  WSH_LOCATIONS_PKG.Address_Tbl_Type ,
89 --             	p_cityTbl              IN  WSH_LOCATIONS_PKG.Address_Tbl_Type ,
90 --              p_postal_codeTbl       IN  WSH_LOCATIONS_PKG.Address_Tbl_Type ,
91 --              p_party_site_numberTbl OUT NOCOPY WSH_LOCATIONS_PKG.LocationCode_Tbl_Type,
92 --              p_location_codeTbl     OUT NOCOPY WSH_LOCATIONS_PKG.LocationCode_Tbl_Type,
93 --              x_use_custom_ui_location  OUT VARCHAR2,
94 --	        x_custom_ui_loc_codeTbl OUT WSH_LOCATIONS_PKG.LocationCode_Tbl_Type
95 -- This procedure is designed for the user to customize the location (ui_location_code)
96 -- information displayed in Shipping Forms.
97 -- To use this procedure user has to set the value of PL/SQL variable
98 -- x_use_custom_ui_location to 'Y' in package body.
99 --
100 PROCEDURE ui_location_code(
101                 p_location_type          IN  VARCHAR2,
102 		p_location_idTbl         IN  WSH_LOCATIONS_PKG.ID_Tbl_Type,
103     	        p_address_1Tbl           IN  WSH_LOCATIONS_PKG.Address_Tbl_Type,
104                 p_address_2Tbl           IN  WSH_LOCATIONS_PKG.Address_Tbl_Type ,
105 		p_countryTbl             IN  WSH_LOCATIONS_PKG.Address_Tbl_Type ,
106 		p_stateTbl               IN  WSH_LOCATIONS_PKG.Address_Tbl_Type ,
107                 p_provinceTbl            IN  WSH_LOCATIONS_PKG.Address_Tbl_Type ,
108                 p_countyTbl              IN  WSH_LOCATIONS_PKG.Address_Tbl_Type ,
109                	p_cityTbl                IN  WSH_LOCATIONS_PKG.Address_Tbl_Type ,
110                 p_postal_codeTbl         IN  WSH_LOCATIONS_PKG.Address_Tbl_Type ,
111 		p_party_site_numberTbl   IN  WSH_LOCATIONS_PKG.LocationCode_Tbl_Type,
112                 p_location_codeTbl       IN  WSH_LOCATIONS_PKG.LocationCode_Tbl_Type,
113                 x_use_custom_ui_location OUT NOCOPY VARCHAR2,
114 	        x_custom_ui_loc_codeTbl  OUT NOCOPY WSH_LOCATIONS_PKG.LocationCode_Tbl_Type
115 		           );
116 
117 PROCEDURE Shipped_Lines(
118            p_source_header_id in number,
119            p_source_code      in varchar2,
120            p_contact_type     in varchar2,
121            p_contact_id       in number,
122            p_last_notif_date  in date,
123            p_shipped          out NOCOPY  boolean,
124            p_shipped_lines    out NOCOPY  varchar2);
125 
126 PROCEDURE Backordered_Lines(
127            p_source_header_id in number,
128            p_source_code      in varchar2,
129            p_contact_type     in varchar2,
130            p_contact_id       in number,
131            p_last_notif_date  in date,
132            p_backordered      out NOCOPY  boolean,
133            p_backordered_lines    out NOCOPY  varchar2);
134 
135 PROCEDURE Start_Workflow(
136 		 p_source_header_id in  number,
137 		 p_source_code      in  varchar2,
138 		 p_contact_type     in  varchar2,
139 		 p_contact_id       in  number,
140 		 p_result           out NOCOPY  boolean);
141 
142 --PROCEDURE calculate_tp_dates
143 --Based on different parameters from OM, customers can customize their
144 --calculation of the TP dates (Earliest/Latest Ship Dates and Earliest/Latest Delivery Dates).
145 --These will be then used for population at the delivery detail level and will
146 --get propogated upto container or delivery levels at action points such as
147 --assign/pack etc.
148 --NOTE : x_modified out parameter must be returned as 'Y' in order to use this
149 --customized calculation
150 
151 PROCEDURE calculate_tp_dates(
152               p_source_line_id NUMBER,
153               p_source_code IN     VARCHAR2,
154               x_earliest_pickup_date OUT NOCOPY DATE,
155               x_latest_pickup_date OUT NOCOPY DATE,
156               x_earliest_dropoff_date OUT NOCOPY DATE,
157               x_latest_dropoff_date OUT NOCOPY DATE,
158               x_modified            OUT NOCOPY VARCHAR2
159               );
160 
161 -- Procedure Override_RIQ_XML_Attributes
162 -- Provides a way to override the attributes: Weight, Volume, Item Dimensions: Length, Width and Height
163 -- for any of the following RIQ actions:
164 -- 1) Choose Ship Method
165 -- 2) Get Ship Method
166 -- 3) Get Ship Method and Rates
167 -- 4) Get Freight Rates
168 -- All the attributes values should be Non-Negative.
169 -- For the Header Level (Consolidation), p_line_id_tab will have more than 1
170 -- record containing all the order line_ids that have been consolidated at the header level
171 -- The only attributes that can be overridden at the Header Level are Weight and Volume.
172 -- For the Line Level/Ship Unit Level, p_line_id_tab will have only 1 record
173 -- with the order line_id and all the attributes can be overridden.
174 -- For Item Dimensions values to be sent as part of RIQ XML, the OTM Item Dimension UOM must be defined
175 -- and the Item Dimensions (Length, Width and Height) should all have valid values
176 PROCEDURE Override_RIQ_XML_Attributes(
177               p_line_id_tab IN WSH_UTIL_CORE.Id_Tab_Type,
178               x_weight      IN OUT NOCOPY NUMBER,
179               x_volume      IN OUT NOCOPY NUMBER,
180               x_length      IN OUT NOCOPY NUMBER,
181               x_height      IN OUT NOCOPY NUMBER,
182               x_width       IN OUT NOCOPY NUMBER,
183               x_return_status OUT NOCOPY VARCHAR2
184               );
185 -- Bug 7131800
186 -- This Function is the Custom Hook provided to Customers , When OverShip/UnderShip Tolerances are set
187 -- Purpose :    As part of OM interface, When the tolerance is met for a line set this custom api
188 --         :    can be used to decide if the non-staged delivery details (of all order lines in a
189 --         :    line set) should be cancelled or not.
190 -- Parameters:  p_source_line_id     -  Line id of the Details that are to be Cancelled
191 --           :  p_source_line_set_id -  Lines Set Id of the Details
192 --           :  p_remain_details_id  -  List of Delivery Details (belonging to the p_source_line_id)
193 --           :                          that are going to be cancelled
194 -- Return  :    Return Value should be
195 --         :       - 'Y', if all non-staged details should be cancelled
196 --         :              (the current default behavior)
197 --         :       - 'N', if all the non-staged details should not be cancelled
198 FUNCTION Cancel_Unpicked_Details_At_ITS(
199               p_source_header_id    IN  NUMBER,
200               p_source_line_id      IN  NUMBER,
201               p_source_line_set_id  IN  NUMBER,
202               p_remain_details_id   IN WSH_UTIL_CORE.Id_Tab_Type
203 ) RETURN VARCHAR2;
204 
205 END WSH_CUSTOM_PUB;