1 PACKAGE WSH_TRIPS_PUB as
2 /* $Header: WSHTRPBS.pls 120.3 2006/11/17 19:54:35 wrudge noship $ */
3 /*#
4 * This is the Trip Public Application Program Interface. It allows Creation
5 * of Trips, Updation of Trips and perform various Actions on Trips.
6 * @rep:scope public
7 * @rep:product WSH
8 * @rep:displayname Trip
9 * @rep:lifecycle active
10 * @rep:compatibility S
11 * @rep:category BUSINESS_ENTITY WSH_TRIP
12 */
13
14 --===================
15 -- PUBLIC VARS
16 --===================
17
18 TYPE Trip_Pub_Rec_Type IS RECORD (
19 TRIP_ID NUMBER DEFAULT FND_API.G_MISS_NUM,
20 NAME VARCHAR2(30) DEFAULT FND_API.G_MISS_CHAR,
21 ARRIVE_AFTER_TRIP_ID NUMBER DEFAULT FND_API.G_MISS_NUM,
22 ARRIVE_AFTER_TRIP_NAME VARCHAR2(30) DEFAULT FND_API.G_MISS_CHAR,
23 VEHICLE_ITEM_ID NUMBER DEFAULT FND_API.G_MISS_NUM,
24 VEHICLE_ITEM_DESC VARCHAR2(240) DEFAULT FND_API.G_MISS_CHAR,
25 VEHICLE_ORGANIZATION_ID NUMBER DEFAULT FND_API.G_MISS_NUM,
26 VEHICLE_ORGANIZATION_CODE VARCHAR2(3) DEFAULT FND_API.G_MISS_CHAR,
27 VEHICLE_NUMBER VARCHAR2(30) DEFAULT FND_API.G_MISS_CHAR,
28 VEHICLE_NUM_PREFIX VARCHAR2(10) DEFAULT FND_API.G_MISS_CHAR,
29 CARRIER_ID NUMBER DEFAULT FND_API.G_MISS_NUM,
30 SHIP_METHOD_CODE VARCHAR2(30) DEFAULT FND_API.G_MISS_CHAR,
31 SHIP_METHOD_NAME VARCHAR2(80) DEFAULT FND_API.G_MISS_CHAR,
32 ROUTE_ID NUMBER DEFAULT FND_API.G_MISS_NUM,
33 ROUTING_INSTRUCTIONS VARCHAR2(2000) DEFAULT FND_API.G_MISS_CHAR,
34 ATTRIBUTE_CATEGORY VARCHAR2(150) DEFAULT FND_API.G_MISS_CHAR,
35 ATTRIBUTE1 VARCHAR2(150) DEFAULT FND_API.G_MISS_CHAR,
36 ATTRIBUTE2 VARCHAR2(150) DEFAULT FND_API.G_MISS_CHAR,
37 ATTRIBUTE3 VARCHAR2(150) DEFAULT FND_API.G_MISS_CHAR,
38 ATTRIBUTE4 VARCHAR2(150) DEFAULT FND_API.G_MISS_CHAR,
39 ATTRIBUTE5 VARCHAR2(150) DEFAULT FND_API.G_MISS_CHAR,
40 ATTRIBUTE6 VARCHAR2(150) DEFAULT FND_API.G_MISS_CHAR,
41 ATTRIBUTE7 VARCHAR2(150) DEFAULT FND_API.G_MISS_CHAR,
42 ATTRIBUTE8 VARCHAR2(150) DEFAULT FND_API.G_MISS_CHAR,
43 ATTRIBUTE9 VARCHAR2(150) DEFAULT FND_API.G_MISS_CHAR,
44 ATTRIBUTE10 VARCHAR2(150) DEFAULT FND_API.G_MISS_CHAR,
45 ATTRIBUTE11 VARCHAR2(150) DEFAULT FND_API.G_MISS_CHAR,
46 ATTRIBUTE12 VARCHAR2(150) DEFAULT FND_API.G_MISS_CHAR,
47 ATTRIBUTE13 VARCHAR2(150) DEFAULT FND_API.G_MISS_CHAR,
48 ATTRIBUTE14 VARCHAR2(150) DEFAULT FND_API.G_MISS_CHAR,
49 ATTRIBUTE15 VARCHAR2(150) DEFAULT FND_API.G_MISS_CHAR,
50 CREATION_DATE DATE DEFAULT FND_API.G_MISS_DATE,
51 CREATED_BY NUMBER DEFAULT FND_API.G_MISS_NUM,
52 LAST_UPDATE_DATE DATE DEFAULT FND_API.G_MISS_DATE,
53 LAST_UPDATED_BY NUMBER DEFAULT FND_API.G_MISS_NUM,
54 LAST_UPDATE_LOGIN NUMBER DEFAULT FND_API.G_MISS_NUM,
55 PROGRAM_APPLICATION_ID NUMBER DEFAULT FND_API.G_MISS_NUM,
56 PROGRAM_ID NUMBER DEFAULT FND_API.G_MISS_NUM,
57 PROGRAM_UPDATE_DATE DATE DEFAULT FND_API.G_MISS_DATE,
58 REQUEST_ID NUMBER DEFAULT FND_API.G_MISS_NUM,
59 SERVICE_LEVEL VARCHAR2(30) DEFAULT FND_API.G_MISS_CHAR,
60 MODE_OF_TRANSPORT VARCHAR2(30) DEFAULT FND_API.G_MISS_CHAR,
61 OPERATOR VARCHAR2(150) DEFAULT FND_API.G_MISS_CHAR,
62 FREIGHT_TERMS_CODE VARCHAR2(30) DEFAULT FND_API.G_MISS_CHAR,
63 FREIGHT_TERMS_NAME VARCHAR2(30) DEFAULT FND_API.G_MISS_CHAR,
64 CARRIER_REFERENCE_NUMBER VARCHAR2(30) DEFAULT FND_API.G_MISS_CHAR,
65 CONSIGNEE_CARRIER_AC_NO VARCHAR2(240) DEFAULT FND_API.G_MISS_CHAR,
66 SEAL_CODE VARCHAR2(30) DEFAULT FND_API.G_MISS_CHAR);
67
68 TYPE Action_Param_Rectype IS RECORD (
69 ACTION_CODE VARCHAR2(500)
70 ,ORGANIZATION_ID NUMBER
71 ,REPORT_SET_NAME VARCHAR2(30)
72 ,REPORT_SET_ID NUMBER
73 ,OVERRIDE_FLAG VARCHAR2(1)
74 ,ACTUAL_DATE DATE
75 ,ACTION_FLAG VARCHAR2(1) DEFAULT 'S'
76 ,AUTOINTRANSIT_FLAG VARCHAR2(1) DEFAULT 'Y'
77 ,AUTOCLOSE_FLAG VARCHAR2(1) DEFAULT 'Y'
78 ,STAGE_DEL_FLAG VARCHAR2(1) DEFAULT 'Y'
79 ,SHIP_METHOD VARCHAR2(30)
80 ,BILL_OF_LADING_FLAG VARCHAR2(1) DEFAULT 'Y'
81 ,DEFER_INTERFACE_FLAG VARCHAR2(1) DEFAULT 'N'
82 ,ACTUAL_DEPARTURE_DATE DATE DEFAULT SYSDATE
83 );
84
85
86 --===================
87 -- PROCEDURES
88 --===================
89
90 --========================================================================
91 -- PROCEDURE : Create_Update_Trip PUBLIC
92 --
93 -- PARAMETERS: p_api_version_number known api versionerror buffer
94 -- p_init_msg_list FND_API.G_TRUE to reset list
95 -- x_return_status return status
96 -- x_msg_count number of messages in the list
97 -- x_msg_data text of messages
98 -- p_trip_info Attributes for the trip entity
99 -- p_trip_name Trip name for update
100 -- x_trip_id Trip id of new trip
101 -- x_trip_name Trip name of new trip
102 -- VERSION : current version 1.0
103 -- initial version 1.0
104 -- COMMENT : Creates or updates a record in wsh_trips table with information
105 -- specified in p_trip_info
106 --========================================================================
107 /*#
108 * The Create_Update_Trip procedure enables you to create a new Trip record or
109 * update an existing Trip Record in the WSH_TRIPS table. The TRIP_ID,NAME and return
110 * status of a new Trip are passed as OUT parameters, while the Trip Name of an
111 * existing Trip for update is passed as IN parameter.
112 * @param p_api_version_number Version number of the API
113 * @param p_init_msg_list Messages will be initialized, if set as true
114 * @param x_return_status Return Status of the API
115 * @param x_msg_count Number of Messages, if any
116 * @param x_msg_data Message Text, if any
117 * @param p_action_code Trip Action Code
118 * @param p_trip_info Trip Information (or) Attributes of Trip Entity
119 * @param p_trip_name Trip Name
120 * @param x_trip_id New Trip ID
121 * @param x_trip_name New Trip Name
122 * @rep:scope public
123 * @rep:lifecycle active
124 * @rep:displayname Create Update Trip
125 */
126
127 PROCEDURE Create_Update_Trip
128 ( p_api_version_number IN NUMBER,
129 p_init_msg_list IN VARCHAR2,
130 x_return_status OUT NOCOPY VARCHAR2,
131 x_msg_count OUT NOCOPY NUMBER,
132 x_msg_data OUT NOCOPY VARCHAR2,
133 p_action_code IN VARCHAR2,
134 p_trip_info IN OUT NOCOPY Trip_Pub_Rec_Type,
135 p_trip_name IN VARCHAR2 DEFAULT FND_API.G_MISS_CHAR,
136 x_trip_id OUT NOCOPY NUMBER,
137 x_trip_name OUT NOCOPY VARCHAR2);
138
139
140 --========================================================================
141 -- PROCEDURE : Trip_Action PUBLIC
142 --
143 -- PARAMETERS: p_api_version_number known api version error number
144 -- p_init_msg_list FND_API.G_TRUE to reset list
145 -- x_return_status return status
146 -- x_msg_count number of messages in the list
147 -- x_msg_data text of messages
148 -- p_action_code Trip action code. Valid action codes are
149 -- 'PLAN','UNPLAN',
150 -- 'WT-VOL'
151 -- 'PICK-RELEASE'
152 -- 'DELETE'
153 -- p_trip_id Trip identifier
154 -- p_trip_name Trip name
155 -- p_wv_override_flag Override flag for weight/volume calc
156 -- VERSION : current version 1.0
157 -- initial version 1.0
158 -- COMMENT : This procedure is used to perform an action specified in p_action_code
159 -- on an existing trip identified by p_trip_id or trip_name
160 --
161 --========================================================================
162 /*#
163 * The Trip_Action procedure enables you to carry out various Actions on a Trip. It
164 * accepts as IN parameters the trip identifiers, an action code and any additional
165 * parameters needed for specific actions, and returns a completion status.
166 * @param p_api_version_number Version number of the API
167 * @param p_init_msg_list Messages will be initialized, if set as true
168 * @param x_return_status Return Status of the API
169 * @param x_msg_count Number of Messages, if any
170 * @param x_msg_data Message Text, if any
171 * @param p_action_code Trip Action Code
172 * @param p_trip_id Trip ID
173 * @param p_trip_name Trip Name
174 * @param p_wv_override_flag Weight/Volume re-calculations flag
175 * @param p_report_set_name Name of Report set
176 * @rep:scope public
177 * @rep:lifecycle active
178 * @rep:displayname Trip Actions
179 */
180
181 PROCEDURE Trip_Action
182 ( p_api_version_number IN NUMBER,
183 p_init_msg_list IN VARCHAR2,
184 x_return_status OUT NOCOPY VARCHAR2,
185 x_msg_count OUT NOCOPY NUMBER,
186 x_msg_data OUT NOCOPY VARCHAR2,
187 p_action_code IN VARCHAR2,
188 p_trip_id IN NUMBER DEFAULT NULL,
189 p_trip_name IN VARCHAR2 DEFAULT NULL,
190 p_wv_override_flag IN VARCHAR2 DEFAULT 'N',
191 p_report_set_name IN VARCHAR2 DEFAULT NULL);
192
193
194 --========================================================================
195 -- PROCEDURE : Trip_Action PUBLIC
196 --
197 -- PARAMETERS: p_api_version_number known api version error number
198 -- p_init_msg_list FND_API.G_TRUE to reset list
199 -- p_commit FND_API.G_TRUE to commit
200 -- x_return_status return status
201 -- x_msg_count number of messages in the list
202 -- x_msg_data text of messages
203 -- p_action_param_rec Record of Parameters for various actions
207 -- 'PICK-RELEASE'
204 -- Valid action codes are
205 -- 'PLAN','UNPLAN',
206 -- 'WT-VOL'
208 -- 'DELETE'
209 -- 'TRIP-CONFIRM'
210 -- p_trip_id Trip identifier
211 -- p_trip_name Trip name
212 -- VERSION : current version 1.0
213 -- initial version 1.0
214 -- COMMENT : This procedure is used to perform an action specified in p_action_param_rec
215 -- on an existing trip identified by p_trip_id or trip_name
216 --
217 --========================================================================
218 /*#
219 * The Over-Loaded Trip_Action procedure enables you to carry out various Actions on
220 * a Trip. It accepts as IN parameters the trip identifiers, an action parameters
221 * Record and any additional parameters needed for specific actions, and returns a
222 * completion status.
223 * @param p_api_version_number Version number of the API
224 * @param p_init_msg_list Messages will be initialized, if set as true
225 * @param p_commit commits the transaction, if set as true
226 * @param x_return_status Return Status of the API
227 * @param x_msg_count Number of Messages, if any
228 * @param x_msg_data Message Text, if any
229 * @param p_action_param_rec Action Parameters Record
230 * @param p_trip_id Trip ID
231 * @param p_trip_name Trip Name
232 * @rep:scope public
233 * @rep:lifecycle active
234 * @rep:displayname Trip Actions
235 */
236
237 PROCEDURE Trip_Action
238 ( p_api_version_number IN NUMBER,
239 p_init_msg_list IN VARCHAR2,
240 p_commit IN VARCHAR2 DEFAULT FND_API.G_FALSE,
241 x_return_status OUT NOCOPY VARCHAR2,
242 x_msg_count OUT NOCOPY NUMBER,
243 x_msg_data OUT NOCOPY VARCHAR2,
244 p_action_param_rec IN WSH_TRIPS_PUB.Action_Param_Rectype,
245 p_trip_id IN NUMBER DEFAULT NULL,
246 p_trip_name IN VARCHAR2 DEFAULT NULL );
247
248 END WSH_TRIPS_PUB;
[Home] [Help]