1 PACKAGE WSH_TRIP_STOPS_PUB AUTHID CURRENT_USER as
2 /* $Header: WSHSTPBS.pls 120.2.12020000.2 2013/02/12 22:58:58 adagur ship $ */
3 /*#
4 * This is the Stop Public Application Program Interface. It allows Creation
5 * of Stops, Updation of exisiting Stops and perform various Actions on Stops.
6 * @rep:scope public
7 * @rep:product WSH
8 * @rep:displayname Trip Stop
9 * @rep:lifecycle active
10 * @rep:compatibility S
11 * @rep:category BUSINESS_ENTITY WSH_TRIP_STOPS_PUB
12 */
13
14 --===================
15 -- PUBLIC VARS
16 --===================
17
18 TYPE Trip_Stop_Pub_Rec_Type IS RECORD (
19 STOP_ID NUMBER DEFAULT FND_API.G_MISS_NUM,
20 TRIP_ID NUMBER DEFAULT FND_API.G_MISS_NUM,
21 TRIP_NAME VARCHAR2(30) DEFAULT FND_API.G_MISS_CHAR,
22 STOP_LOCATION_ID NUMBER DEFAULT FND_API.G_MISS_NUM,
23 /* When this is called for Update need to populate status code
24 and stop sequence number */
25 /* H integration for FTE- anxsharm */
26 STOP_SEQUENCE_NUMBER NUMBER DEFAULT FND_API.G_MISS_NUM,
27 --commented status code for H integration
28 -- never give user access to status code update directly
29 -- STATUS_CODE VARCHAR2(2) DEFAULT FND_API.G_MISS_CHAR,
30 /* End of H integration for FTE- anxsharm */
31 STOP_LOCATION_CODE wsh_locations.UI_LOCATION_CODE%TYPE DEFAULT FND_API.G_MISS_CHAR,
32 PLANNED_ARRIVAL_DATE DATE DEFAULT FND_API.G_MISS_DATE,
33 PLANNED_DEPARTURE_DATE DATE DEFAULT FND_API.G_MISS_DATE,
34 ACTUAL_ARRIVAL_DATE DATE DEFAULT FND_API.G_MISS_DATE,
35 ACTUAL_DEPARTURE_DATE DATE DEFAULT FND_API.G_MISS_DATE,
36 DEPARTURE_GROSS_WEIGHT NUMBER DEFAULT FND_API.G_MISS_NUM,
37 DEPARTURE_NET_WEIGHT NUMBER DEFAULT FND_API.G_MISS_NUM,
38 WEIGHT_UOM_CODE VARCHAR2(3) DEFAULT FND_API.G_MISS_CHAR,
39 WEIGHT_UOM_DESC VARCHAR2(25) DEFAULT FND_API.G_MISS_CHAR,
40 DEPARTURE_VOLUME NUMBER DEFAULT FND_API.G_MISS_NUM,
41 VOLUME_UOM_CODE VARCHAR2(3) DEFAULT FND_API.G_MISS_CHAR,
42 VOLUME_UOM_DESC VARCHAR2(25) DEFAULT FND_API.G_MISS_CHAR,
43 DEPARTURE_SEAL_CODE VARCHAR2(30) DEFAULT FND_API.G_MISS_CHAR,
44 DEPARTURE_FILL_PERCENT NUMBER DEFAULT FND_API.G_MISS_NUM,
45 TP_ATTRIBUTE_CATEGORY VARCHAR2(150) DEFAULT FND_API.G_MISS_CHAR,
46 TP_ATTRIBUTE1 VARCHAR2(150) DEFAULT FND_API.G_MISS_CHAR,
47 TP_ATTRIBUTE2 VARCHAR2(150) DEFAULT FND_API.G_MISS_CHAR,
48 TP_ATTRIBUTE3 VARCHAR2(150) DEFAULT FND_API.G_MISS_CHAR,
49 TP_ATTRIBUTE4 VARCHAR2(150) DEFAULT FND_API.G_MISS_CHAR,
50 TP_ATTRIBUTE5 VARCHAR2(150) DEFAULT FND_API.G_MISS_CHAR,
51 TP_ATTRIBUTE6 VARCHAR2(150) DEFAULT FND_API.G_MISS_CHAR,
52 TP_ATTRIBUTE7 VARCHAR2(150) DEFAULT FND_API.G_MISS_CHAR,
53 TP_ATTRIBUTE8 VARCHAR2(150) DEFAULT FND_API.G_MISS_CHAR,
54 TP_ATTRIBUTE9 VARCHAR2(150) DEFAULT FND_API.G_MISS_CHAR,
55 TP_ATTRIBUTE10 VARCHAR2(150) DEFAULT FND_API.G_MISS_CHAR,
56 TP_ATTRIBUTE11 VARCHAR2(150) DEFAULT FND_API.G_MISS_CHAR,
57 TP_ATTRIBUTE12 VARCHAR2(150) DEFAULT FND_API.G_MISS_CHAR,
58 TP_ATTRIBUTE13 VARCHAR2(150) DEFAULT FND_API.G_MISS_CHAR,
59 TP_ATTRIBUTE14 VARCHAR2(150) DEFAULT FND_API.G_MISS_CHAR,
60 TP_ATTRIBUTE15 VARCHAR2(150) DEFAULT FND_API.G_MISS_CHAR,
61 ATTRIBUTE_CATEGORY VARCHAR2(150) DEFAULT FND_API.G_MISS_CHAR,
62 ATTRIBUTE1 VARCHAR2(150) DEFAULT FND_API.G_MISS_CHAR,
63 ATTRIBUTE2 VARCHAR2(150) DEFAULT FND_API.G_MISS_CHAR,
64 ATTRIBUTE3 VARCHAR2(150) DEFAULT FND_API.G_MISS_CHAR,
65 ATTRIBUTE4 VARCHAR2(150) DEFAULT FND_API.G_MISS_CHAR,
66 ATTRIBUTE5 VARCHAR2(150) DEFAULT FND_API.G_MISS_CHAR,
67 ATTRIBUTE6 VARCHAR2(150) DEFAULT FND_API.G_MISS_CHAR,
68 ATTRIBUTE7 VARCHAR2(150) DEFAULT FND_API.G_MISS_CHAR,
69 ATTRIBUTE8 VARCHAR2(150) DEFAULT FND_API.G_MISS_CHAR,
70 ATTRIBUTE9 VARCHAR2(150) DEFAULT FND_API.G_MISS_CHAR,
71 ATTRIBUTE10 VARCHAR2(150) DEFAULT FND_API.G_MISS_CHAR,
72 ATTRIBUTE11 VARCHAR2(150) DEFAULT FND_API.G_MISS_CHAR,
73 ATTRIBUTE12 VARCHAR2(150) DEFAULT FND_API.G_MISS_CHAR,
74 ATTRIBUTE13 VARCHAR2(150) DEFAULT FND_API.G_MISS_CHAR,
75 ATTRIBUTE14 VARCHAR2(150) DEFAULT FND_API.G_MISS_CHAR,
76 ATTRIBUTE15 VARCHAR2(150) DEFAULT FND_API.G_MISS_CHAR,
77 CREATION_DATE DATE DEFAULT FND_API.G_MISS_DATE,
78 CREATED_BY NUMBER DEFAULT FND_API.G_MISS_NUM,
79 LAST_UPDATE_DATE DATE DEFAULT FND_API.G_MISS_DATE,
80 LAST_UPDATED_BY NUMBER DEFAULT FND_API.G_MISS_NUM,
81 LAST_UPDATE_LOGIN NUMBER DEFAULT FND_API.G_MISS_NUM,
82 PROGRAM_APPLICATION_ID NUMBER DEFAULT FND_API.G_MISS_NUM,
83 PROGRAM_ID NUMBER DEFAULT FND_API.G_MISS_NUM,
84 PROGRAM_UPDATE_DATE DATE DEFAULT FND_API.G_MISS_DATE,
85 REQUEST_ID NUMBER DEFAULT FND_API.G_MISS_NUM,
86 -- csun 10+ internal location change
87 PHYSICAL_LOCATION_ID NUMBER DEFAULT FND_API.G_MISS_NUM,
88 PHYSICAL_STOP_ID NUMBER DEFAULT FND_API.G_MISS_NUM);
89
90 --===================
91 -- PROCEDURES
92 --===================
93
94 --========================================================================
95 -- PROCEDURE : Create_Update_Stop PUBLIC
96 --
97 -- PARAMETERS: p_api_version_number known api versionerror buffer
98 -- p_init_msg_list FND_API.G_TRUE to reset list
99 -- x_return_status return status
100 -- x_msg_count number of messages in the list
101 -- x_msg_data text of messages
102 -- p_stop_info Attributes for the stop entity
103 -- p_trip_id Trip id for update
104 -- p_trip_name Trip name for update
105 -- p_stop_location_id Stop location id for update
106 -- p_stop_location_code Stop location code for update
107 -- p_planned_dep_date Planned departure date for update
108 -- x_stop_id - stop id of new stop
109 -- VERSION : current version 1.0
110 -- initial version 1.0
111 -- COMMENT : Creates or updates a record in wsh_trip_stops table with information
112 -- specified in p_stop_info. Use p_trip_id, p_trip_name, p_stop_location_id,
113 -- p_stop_location_code or p_planned_dep_date to update these values
114 -- on an existing stop.
115 --========================================================================
116 /*#
117 * The Create_Update_Stop procedure enables you to create a new Stop record or
118 * update an existing Stop Record in the WSH_TRIP_STOPS table. The STOP_ID and return
119 * status of a new Stop are passed as OUT parameters, while the TRIP_ID of an existing
120 * stop for update is passed as an IN parameter.
121 * @param p_api_version_number Version number of the API
122 * @param p_init_msg_list Messages will be initialized, if set as true
123 * @param x_return_status Return Status of the API
124 * @param x_msg_count Number of Messages, if any
125 * @param x_msg_data Message Text, if any
126 * @param p_action_code Action Code
127 * @param p_stop_info Stop Information (or) Attributes of Stop Entity
128 * @param p_trip_id Trip ID
129 * @param p_trip_name Trip Name
130 * @param p_stop_location_id Stop Location ID
131 * @param p_stop_location_code Stop Location Code
132 * @param p_planned_dep_date Planned Date of Departure
133 * @param x_stop_id New Stop ID
134 * @rep:scope public
135 * @rep:lifecycle active
136 * @rep:displayname Create Update Stop
137 */
138
139 PROCEDURE Create_Update_Stop
140 ( p_api_version_number IN NUMBER,
141 p_init_msg_list IN VARCHAR2,
142 x_return_status OUT NOCOPY VARCHAR2,
143 x_msg_count OUT NOCOPY NUMBER,
144 x_msg_data OUT NOCOPY VARCHAR2,
145 p_action_code IN VARCHAR2,
146 p_stop_info IN OUT NOCOPY Trip_Stop_Pub_Rec_Type,
147 p_trip_id IN NUMBER DEFAULT FND_API.G_MISS_NUM,
148 p_trip_name IN VARCHAR2 DEFAULT FND_API.G_MISS_CHAR,
149 p_stop_location_id IN NUMBER DEFAULT FND_API.G_MISS_NUM,
150 p_stop_location_code IN VARCHAR2 DEFAULT FND_API.G_MISS_CHAR,
151 p_planned_dep_date IN DATE DEFAULT FND_API.G_MISS_DATE,
152 x_stop_id OUT NOCOPY NUMBER);
153
154
155 --========================================================================
156 -- PROCEDURE : Stop_Action PUBLIC
157 --
158 -- PARAMETERS: p_api_version_number known api version error number
159 -- p_init_msg_list FND_API.G_TRUE to reset list
160 -- p_commit To commit the data or not
161 -- x_return_status return status
162 -- x_msg_count number of messages in the list
163 -- x_msg_data text of messages
164 -- p_action_code Stop action code. Valid action codes are
165 -- 'PLAN','UNPLAN',
166 -- 'ARRIVE','CLOSE'
167 -- 'PICK-RELEASE'
168 -- 'DELETE'
169 -- p_stop_id Stop identifier
170 -- p_trip_id Stop identifier - trip id it belongs to
171 -- p_trip_name Stop identifier - trip name it belongs to
172 -- p_stop_location_id Stop identifier - stop location id
173 -- p_stop_location_code Stop identifier - stop location code
174 -- p_planned_dep_date Stop identifier - stop planned dep date
175 -- p_actual_date Actual arrival/departure date of the stop
176 -- VERSION : current version 1.0
177 -- initial version 1.0
178 -- COMMENT : This procedure is used to perform an action specified in p_action_code
179 -- on an existing stop identified by p_stop_id or a unique combination of
180 -- trip_id/trip_name, stop_location_id/stop_location_code or planned_departure_date.
181 --
182 --========================================================================
183 /*#
184 * The Stop_Action procedure enables you to carry out various Actions on a Stop.
185 * It accepts as IN parameters the Stop and Trip identifiers, an action code and
186 * any additional parameters needed for specific actions, and returns a completion
187 * status.
188 * @param p_api_version_number Version number of the API
189 * @param p_init_msg_list Messages will be initialized, if set as true
190 * @param p_commit Commit the data is not passed or passed as 'T'
191 * @param x_return_status Return Status of the API
192 * @param x_msg_count Number of Messages, if any
193 * @param x_msg_data Message Text, if any
194 * @param p_action_code Stop Action Code
195 * @param p_stop_id Stop ID
196 * @param p_trip_id Trip ID
197 * @param p_trip_name Trip Name
198 * @param p_stop_location_id Stop Location ID
199 * @param p_stop_location_code Stop Location Code
200 * @param p_planned_dep_date Planned Departure Date
201 * @param p_actual_date Actual Date of Arrival/Departure
202 * @param p_defer_interface_flag Submit/Defer Concurrent Request
203 * @rep:scope public
204 * @rep:lifecycle active
205 * @rep:displayname Stop Actions
206 */
207
208 PROCEDURE Stop_Action
209 ( p_api_version_number IN NUMBER,
210 p_init_msg_list IN VARCHAR2,
211 p_commit IN VARCHAR2 DEFAULT FND_API.G_TRUE,
212 x_return_status OUT NOCOPY VARCHAR2,
213 x_msg_count OUT NOCOPY NUMBER,
214 x_msg_data OUT NOCOPY VARCHAR2,
215 p_action_code IN VARCHAR2,
216 p_stop_id IN NUMBER DEFAULT NULL,
217 p_trip_id IN NUMBER DEFAULT NULL,
218 p_trip_name IN VARCHAR2 DEFAULT NULL,
219 p_stop_location_id IN NUMBER DEFAULT NULL,
220 p_stop_location_code IN VARCHAR2 DEFAULT NULL,
221 p_planned_dep_date IN DATE DEFAULT NULL,
222 p_actual_date IN DATE DEFAULT NULL,
223 p_defer_interface_flag IN VARCHAR2 DEFAULT 'Y');
224
225 END WSH_TRIP_STOPS_PUB;
[Home] [Help]