1 PACKAGE FTE_FREIGHT_RATING_DLVY_GRP AS
2 /* $Header: FTEFRDTS.pls 120.1 2005/06/30 12:39:27 susurend noship $ */
3
4 -- types for Rate_Delivery
5 TYPE rate_del_in_param_rec IS RECORD(
6 delivery_id_list WSH_UTIL_CORE.id_tab_type,
7 action VARCHAR2(30),
8 seq_tender_flag VARCHAR2(1)
9 );
10
11 TYPE rate_del_out_param_rec IS RECORD(
12 failed_delivery_id_list WSH_UTIL_CORE.id_tab_type);
13
14 --type for public rating API
15 TYPE delivery_in_rec_type IS RECORD (
16 name VARCHAR2(30),
17 carrier_name VARCHAR2(360),
18 mode_of_transport VARCHAR2(30),
19 service_level VARCHAR2(30)
20 );
21
22
23
24
25
26 -- this is the wrapper for STF get-freight-costs action
27 PROCEDURE Rate_Delivery (
28 p_api_version IN NUMBER DEFAULT 1.0,
29 p_init_msg_list VARCHAR2 DEFAULT FND_API.G_FALSE,
30 p_commit IN VARCHAR2 DEFAULT FND_API.G_FALSE,
31 p_in_param_rec IN rate_del_in_param_rec,
32 x_out_param_rec OUT NOCOPY rate_del_out_param_rec,
33 x_return_status OUT NOCOPY VARCHAR2,
34 x_msg_count OUT NOCOPY NUMBER,
35 x_msg_data OUT NOCOPY VARCHAR2);
36
37 -- Procedure : Delivery_Rating
38 -- Parameters :
39 -- p_delivery_id
40 -- p_action (valid values : 'RATE')
41 -- -- J+ enhancement
42 -- p_carrier_id, p_mode_of_transport, p_service_level are added in J+
43 -- if any of carrier, mode or service level is passed in
44 -- Rate_delivery will use there instead of trip's shipmethod
45 -- to search services
46 -- -- end of J+ enhancement
47 -- Description : This is the main api for the wsh delivery rating (demo) flow
48 -- Will be invoked from wsh_fte_integration package for use with the shipping
49 -- transaction form and the delivery rating concurrent program.
50 -- Searches for lanes, creates trip and rates.
51 --
52
53 PROCEDURE Rate_Delivery (
54 p_api_version IN NUMBER DEFAULT 1.0,
55 p_init_msg_list VARCHAR2 DEFAULT FND_API.G_FALSE,
56 p_delivery_id IN NUMBER DEFAULT NULL,
57 p_trip_id IN NUMBER DEFAULT NULL,
58 p_action IN VARCHAR2 DEFAULT 'RATE',
59 p_commit IN VARCHAR2 DEFAULT FND_API.G_FALSE,
60 p_init_prc_log IN VARCHAR2 DEFAULT 'Y',
61 p_carrier_id IN NUMBER DEFAULT NULL,
62 p_mode_of_transport IN VARCHAR2 DEFAULT NULL,
63 p_service_level IN VARCHAR2 DEFAULT NULL,
64 p_seq_tender_flag IN VARCHAR2 DEFAULT 'N',
65 x_return_status OUT NOCOPY VARCHAR2,
66 x_msg_count OUT NOCOPY NUMBER,
67 x_msg_data OUT NOCOPY VARCHAR2);
68
69 -- This procedure is called by 10+ rating public API
70 --========================================================================
71 -- PARAMETERS:
72 -- p_api_version API version number
73 -- p_init_msg_list FND_API.G_TRUE to reset the list,
74 -- or FND_API.G_FLASE not to reset the list
75 -- p_commit FND_API.G_TRUE to commit the work,
76 -- or FND_API.G_FLASE not to commit the work
77 -- x_return_status API return status,
78 -- FND_API.G_RET_STS_SUCCESS, if delivery is rated
79 -- successfully,
80 -- FND_API.G_RET_STS_ERROR, if delivery failed to rate
81 -- FND_API.G_RET_STS_UNEXP_ERROR, unexpected error
82 -- x_msg_count number of messages on the list
83 -- x_msg_data message text if x_msg_count = 1
84 -- p_action_code 'RATE'
85 -- p_delivery_in_rec delivery input, delivery name is required;
86 -- carrier_name, mode_of_transport, service_level are optional
87 -- COMMENT : This procedure is used to rate an input delivery
88 -- If delivery is on multiple trips,
89 -- API will error out;
90 -- If delivery is on a trip with multiple deliveries,
91 -- API will error out;
92 -- If delivery has no trip and input ship method is null,
93 -- API will do LCCS using delivery ship method;
94 -- If delivery has no trip and input ship method is not null,
95 -- API will do LCCS using input ship method;
96 -- If delivery has one trip and input ship method is null,
97 -- API will rate delivery on existing service.
98 -- If delivery has one trip and input ship method is not null,
99 -- API will do LCCS using input ship method.
100 --
101 -- API will not update delivery with input ship method
102 --
103 -- If delivery is rated successfully, trip ship method will be
104 -- LCCS result ship method.
105 --========================================================================
106
107 PROCEDURE Rate_Delivery2 (
108 p_api_version IN NUMBER DEFAULT 1.0,
109 p_init_msg_list IN VARCHAR2 DEFAULT FND_API.G_FALSE,
110 p_commit IN VARCHAR2 DEFAULT FND_API.G_FALSE,
111 x_return_status OUT NOCOPY VARCHAR2,
112 x_msg_count OUT NOCOPY NUMBER,
113 x_msg_data OUT NOCOPY VARCHAR2,
114 p_init_prc_log IN VARCHAR2 DEFAULT 'Y',
115 p_delivery_in_rec IN delivery_in_rec_type
116 );
117
118
119 PROCEDURE Cancel_Service (
120 p_api_version IN NUMBER DEFAULT 1.0,
121 p_init_msg_list VARCHAR2 DEFAULT FND_API.G_FALSE,
122 p_delivery_id IN NUMBER,
123 p_action IN VARCHAR2 DEFAULT 'CANCEL',
124 p_commit IN VARCHAR2 DEFAULT FND_API.G_FALSE,
125 x_return_status OUT NOCOPY VARCHAR2,
126 x_msg_count OUT NOCOPY NUMBER,
127 x_msg_data OUT NOCOPY VARCHAR2);
128
129 PROCEDURE Cancel_Service (
130 p_api_version IN NUMBER DEFAULT 1.0,
131 p_init_msg_list VARCHAR2 DEFAULT FND_API.G_FALSE,
132 p_delivery_list IN WSH_UTIL_CORE.id_tab_type,
133 p_action IN VARCHAR2 DEFAULT 'CANCEL',
134 p_commit IN VARCHAR2 DEFAULT FND_API.G_FALSE,
135 x_return_status OUT NOCOPY VARCHAR2,
136 x_msg_count OUT NOCOPY NUMBER,
137 x_msg_data OUT NOCOPY VARCHAR2);
138
139 PROCEDURE api_post_call
140 (
141 p_api_name IN VARCHAR2,
142 p_api_return_status IN VARCHAR2,
143 p_message_name IN VARCHAR2,
144 p_trip_id IN VARCHAR2 DEFAULT NULL,
145 p_delivery_id IN VARCHAR2 DEFAULT NULL,
146 p_delivery_leg_id IN VARCHAR2 DEFAULT NULL,
147 x_number_of_errors IN OUT NOCOPY NUMBER,
148 x_number_of_warnings IN OUT NOCOPY NUMBER,
149 x_return_status OUT NOCOPY VARCHAR2
150 );
151
152 END FTE_FREIGHT_RATING_DLVY_GRP;