1 PACKAGE WSH_FREIGHT_COSTS_PUB as
2 /* $Header: WSHFCPBS.pls 120.0 2005/05/26 17:29:25 appldev noship $ */
3 /*#
4 * This is the public interface for freight costs. It has APIs to create,
5 * update and delete freight costs for delivery lines, deliveries, trips
6 * and to validate freight cost types.
7 * @rep:scope public
8 * @rep:product WSH
9 * @rep:displayname Freight Cost
10 * @rep:lifecycle active
11 * @rep:category BUSINESS_ENTITY WSH_DELIVERY_LINE
12 * @rep:category BUSINESS_ENTITY WSH_DELIVERY
13 * @rep:category BUSINESS_ENTITY WSH_TRIP
14
15 */
16
17 --===================
18 -- PROCEDURES
19 --===================
20 --========================================================================
21 -- PROCEDURE : Create_Update_Freight_Costs
22 --
23 -- PARAMETERS: p_api_version_number known api versionerror buffer
24 -- p_init_msg_list initialize message stack
25 -- x_return_status return status
26 -- x_msg_count number of messages in the list
27 -- x_msg_data text of messages
28 -- p_freight_cost_rec freight cost record
29 -- p_source_code source system
30 --
31 --
32 -- COMMENT : Create or Update freight costs
33 -- org_organization_definitions. If both values are
34 -- specified then only Org_Id is used
35 --========================================================================
36
37 TYPE PubFreightCostRecType IS RECORD(
38 FREIGHT_COST_ID NUMBER DEFAULT FND_API.G_MISS_NUM
39 , FREIGHT_COST_TYPE_ID NUMBER DEFAULT FND_API.G_MISS_NUM
40 , UNIT_AMOUNT NUMBER DEFAULT FND_API.G_MISS_NUM
41 , CURRENCY_CODE VARCHAR2(15) DEFAULT FND_API.G_MISS_CHAR
42 , CONVERSION_DATE DATE DEFAULT FND_API.G_MISS_DATE
43 , CONVERSION_RATE NUMBER DEFAULT FND_API.G_MISS_NUM
44 , CONVERSION_TYPE_CODE VARCHAR2(30) DEFAULT FND_API.G_MISS_CHAR
45 , TRIP_ID NUMBER DEFAULT FND_API.G_MISS_NUM
46 , TRIP_NAME VARCHAR2(30) DEFAULT FND_API.G_MISS_CHAR
47 , STOP_ID NUMBER DEFAULT FND_API.G_MISS_NUM
48 , STOP_LOCATION_ID NUMBER DEFAULT FND_API.G_MISS_NUM
49 , PLANNED_DEP_DATE DATE DEFAULT FND_API.G_MISS_DATE
50 , DELIVERY_ID NUMBER DEFAULT FND_API.G_MISS_NUM
51 , DELIVERY_NAME VARCHAR2(30) DEFAULT FND_API.G_MISS_CHAR
52 , DELIVERY_LEG_ID NUMBER DEFAULT FND_API.G_MISS_NUM
53 , DELIVERY_DETAIL_ID NUMBER DEFAULT FND_API.G_MISS_NUM
54 , ATTRIBUTE_CATEGORY VARCHAR2(150) DEFAULT FND_API.G_MISS_CHAR
55 , ATTRIBUTE1 VARCHAR2(150) DEFAULT FND_API.G_MISS_CHAR
56 , ATTRIBUTE2 VARCHAR2(150) DEFAULT FND_API.G_MISS_CHAR
57 , ATTRIBUTE3 VARCHAR2(150) DEFAULT FND_API.G_MISS_CHAR
58 , ATTRIBUTE4 VARCHAR2(150) DEFAULT FND_API.G_MISS_CHAR
59 , ATTRIBUTE5 VARCHAR2(150) DEFAULT FND_API.G_MISS_CHAR
60 , ATTRIBUTE6 VARCHAR2(150) DEFAULT FND_API.G_MISS_CHAR
61 , ATTRIBUTE7 VARCHAR2(150) DEFAULT FND_API.G_MISS_CHAR
62 , ATTRIBUTE8 VARCHAR2(150) DEFAULT FND_API.G_MISS_CHAR
63 , ATTRIBUTE9 VARCHAR2(150) DEFAULT FND_API.G_MISS_CHAR
64 , ATTRIBUTE10 VARCHAR2(150) DEFAULT FND_API.G_MISS_CHAR
65 , ATTRIBUTE11 VARCHAR2(150) DEFAULT FND_API.G_MISS_CHAR
66 , ATTRIBUTE12 VARCHAR2(150) DEFAULT FND_API.G_MISS_CHAR
67 , ATTRIBUTE13 VARCHAR2(150) DEFAULT FND_API.G_MISS_CHAR
68 , ATTRIBUTE14 VARCHAR2(150) DEFAULT FND_API.G_MISS_CHAR
69 , ATTRIBUTE15 VARCHAR2(150) DEFAULT FND_API.G_MISS_CHAR
70 , CREATION_DATE DATE DEFAULT FND_API.G_MISS_DATE
71 , CREATED_BY NUMBER DEFAULT FND_API.G_MISS_NUM
72 , LAST_UPDATE_DATE DATE DEFAULT FND_API.G_MISS_DATE
73 , LAST_UPDATED_BY NUMBER DEFAULT FND_API.G_MISS_NUM
74 , LAST_UPDATE_LOGIN NUMBER DEFAULT FND_API.G_MISS_NUM
75 , PROGRAM_APPLICATION_ID NUMBER DEFAULT FND_API.G_MISS_NUM
76 , PROGRAM_ID NUMBER DEFAULT FND_API.G_MISS_NUM
77 , PROGRAM_UPDATE_DATE DATE DEFAULT FND_API.G_MISS_DATE
78 , REQUEST_ID NUMBER DEFAULT FND_API.G_MISS_NUM
79 , FREIGHT_COST_TYPE VARCHAR2(30) DEFAULT FND_API.G_MISS_CHAR
80 , ACTION_CODE VARCHAR2(30) DEFAULT FND_API.G_MISS_CHAR
81 );
82
83 TYPE PubFreightCostTabType IS TABLE OF PubFreightCostRecType INDEX BY BINARY_INTEGER;
84
85 /*#
86 * This procedure is used to create and update freight costs.
87 * @param p_api_version_number version number of the API
88 * @param p_init_msg_list messages will be initialized, if set as true
89 * @param p_commit commits the transaction, if set as true
90 * @param x_return_status return status of the API
91 * @param x_msg_count number of messages, if any
92 * @param x_msg_data message text, if any
93 * @param p_pub_freight_costs record structure for freight cost attributes to be created/updated
94 * @param p_action_code 'CREATE' or 'UPDATE'
95 * @param x_freight_cost_id output freight cost id for the freight cost record created if the action is 'CREATE'
96 * @rep:scope public
97 * @rep:lifecycle active
98 * @rep:displayname Create/Update Freight Costs
99 */
100 PROCEDURE Create_Update_Freight_Costs (
101 p_api_version_number IN NUMBER
102 , p_init_msg_list IN VARCHAR2
103 , p_commit IN VARCHAR2
104 , x_return_status OUT NOCOPY VARCHAR2
105 , x_msg_count OUT NOCOPY NUMBER
106 , x_msg_data OUT NOCOPY VARCHAR2
107 , p_pub_freight_costs IN WSH_FREIGHT_COSTS_PUB.PubFreightCostRecType
108 , p_action_code IN VARCHAR2
109 , x_freight_cost_id OUT NOCOPY NUMBER
110 );
111
112 /*#
113 * This procedure is used to validate the freight cost type
114 * @param p_freight_cost_type freight cost type to be validated
115 * @param x_freight_cost_type_id freight cost type id used for validation if passed in or will be output if freight cost type is passed
116 * @param x_return_status return status of the API
117 * @rep:scope internal
118 * @rep:lifecycle active
119 * @rep:displayname Validate Freight Cost Type
120 */
121 PROCEDURE Validate_freight_Cost_type(
122 p_freight_cost_type IN VARCHAR2
123 , x_freight_cost_type_id IN OUT NOCOPY NUMBER
124 , x_return_status OUT NOCOPY VARCHAR2
125 );
126
127 /*#
128 * This procedure is used to delete freight costs.
129 * @param p_api_version_number version number of the API
130 * @param p_init_msg_list messages will be initialized, if set as true
131 * @param p_commit commits the transaction, if set as true
132 * @param x_return_status return status of the API
133 * @param x_msg_count number of messages, if any
134 * @param x_msg_data message text, if any
135 * @param p_pub_freight_costs record structure for freight cost record to be deleted
136 * @rep:scope public
137 * @rep:lifecycle active
138 * @rep:displayname Delete Freight Costs
139 */
140 PROCEDURE Delete_Freight_costs(
141 p_api_version_number IN NUMBER
142 , p_init_msg_list IN VARCHAR2
143 , p_commit IN VARCHAR2
144 , x_return_status OUT NOCOPY VARCHAR2
145 , x_msg_count OUT NOCOPY NUMBER
146 , x_msg_data OUT NOCOPY VARCHAR2
147 , p_pub_freight_costs IN WSH_FREIGHT_COSTS_PUB.PubFreightCostRecType
148 );
149
150 END WSH_FREIGHT_COSTS_PUB;
[Home] [Help]