1 PACKAGE IBE_ADDRESS_V2PVT AUTHID CURRENT_USER AS
2 /* $Header: IBEVADS.pls 120.1 2005/11/23 04:59:14 mannamra noship $ */
3
4 --
5 -- Create an address by creating a location, a party site,
6 -- a tax location assignment.
7 --
8 -- If p_primary_billto is true, a party site use whose
9 -- site_use_type is 'BILL_TO' is created. Same thing
10 -- happens when p_primary_shipto is true.
11 --
12 -- If this is the first address for the party,
13 -- the address will be the primary shipping and billing
14 -- address.
15 --
16 -- If p_check_primary is true and there isn't any primary
17 -- address, create the address as primary billing or shipping.
18 --
19 --
20 -- Required:
21 -- p_location.address1
22 -- p_location.country
23 -- p_party_site.party_id
24 --
25
26 PROCEDURE create_address(
27 p_api_version IN NUMBER,
28 p_init_msg_list IN VARCHAR2 := FND_API.G_FALSE,
29 p_commit IN VARCHAR2 := FND_API.G_FALSE,
30 p_location IN HZ_LOCATION_V2PUB.LOCATION_REC_TYPE,
31 p_party_site IN HZ_PARTY_SITE_V2PUB.PARTY_SITE_REC_TYPE,
32 p_primary_billto IN VARCHAR2 := FND_API.G_FALSE,
33 p_primary_shipto IN VARCHAR2 := FND_API.G_FALSE,
34 p_billto IN VARCHAR2 := FND_API.G_FALSE,
35 p_shipto IN VARCHAR2 := FND_API.G_FALSE,
36 p_default_primary IN VARCHAR2 := FND_API.G_TRUE,
37 x_return_status OUT NOCOPY VARCHAR2,
38 x_msg_count OUT NOCOPY NUMBER,
39 x_msg_data OUT NOCOPY VARCHAR2,
40 x_location_id OUT NOCOPY NUMBER,
41 x_party_site_id OUT NOCOPY NUMBER);
42
43
44 --
45 -- Update an address by end dating the party site and then
46 -- creating a new location and party site.
47 --
48 -- This API also update the ibe_ord_oneclick table.
49 --
50 -- Required:
51 -- p_location.address1
52 -- p_location.country
53 -- p_party_site.party_id
54 --
55
56 PROCEDURE update_address(
57 p_api_version IN NUMBER,
58 p_init_msg_list IN VARCHAR2 := FND_API.G_FALSE,
59 p_commit IN VARCHAR2 := FND_API.G_FALSE,
60 p_party_site_id IN NUMBER,
61 p_ps_object_version_number IN NUMBER,
62 p_bill_object_version_number IN NUMBER,
63 p_ship_object_version_number IN NUMBER,
64 p_location IN HZ_LOCATION_V2PUB.LOCATION_REC_TYPE,
65 p_party_site IN HZ_PARTY_SITE_V2PUB.PARTY_SITE_REC_TYPE,
66 p_primary_billto IN VARCHAR2 := NULL,
67 p_primary_shipto IN VARCHAR2 := NULL,
68 p_billto IN VARCHAR2 := NULL,
69 p_shipto IN VARCHAR2 := NULL,
70 x_return_status OUT NOCOPY VARCHAR2,
71 x_msg_count OUT NOCOPY NUMBER,
72 x_msg_data OUT NOCOPY VARCHAR2,
73 x_location_id OUT NOCOPY NUMBER,
74 x_party_site_id OUT NOCOPY NUMBER);
75
76 --
77 -- Delete an address by end dating a party site.
78 -- Any party site use has foreign key to the party site
79 -- is also end dated.
80 --
81 -- This API also set the bill_to_pty_site_id or
82 -- ship_to_pty_site_id to null in table ibe_ord_oneclick.
83 --
84 PROCEDURE delete_address(
85 p_api_version IN NUMBER,
86 p_init_msg_list IN VARCHAR2 := FND_API.G_FALSE,
87 p_commit IN VARCHAR2 := FND_API.G_FALSE,
88 p_party_id IN NUMBER,
89 p_party_site_id IN NUMBER,
90 p_ps_object_version_number IN NUMBER,
91 p_bill_object_version_number IN NUMBER,
92 p_ship_object_version_number IN NUMBER,
93 x_return_status OUT NOCOPY VARCHAR2,
94 x_msg_count OUT NOCOPY NUMBER,
95 x_msg_data OUT NOCOPY VARCHAR2);
96
97 --
98 -- Set an address to primary or not.
99 --
100 -- Requried:
101 -- p_site_use_type = 'SHIP_TO' or 'BILL_TO'
102 -- p_primary = true if primary, otherwise false
103 --
104
105 procedure set_address_usage(
106 p_api_version IN NUMBER,
107 p_init_msg_list IN VARCHAR2 := FND_API.G_FALSE,
108 p_commit IN VARCHAR2 := FND_API.G_FALSE,
109 p_party_site_id IN NUMBER,
110 p_primary_flag IN VARCHAR2 := FND_API.G_FALSE,
111 p_site_use_type IN VARCHAR2,
112 p_createdby IN VARCHAR2 := 'User Management',
113 x_return_status OUT NOCOPY VARCHAR2,
114 x_msg_count OUT NOCOPY NUMBER,
115 x_msg_data OUT NOCOPY VARCHAR2,
116 x_party_site_use_id OUT NOCOPY NUMBER
117 );
118
119 --
120 -- Get the party site ID of the primary address
121 -- whose site use type is the value of p_site_use_type.
122 --
123
124 procedure get_primary_address(
125 p_api_version IN NUMBER,
126 p_init_msg_list IN VARCHAR2 := FND_API.G_FALSE,
127 p_commit IN VARCHAR2 := FND_API.G_FALSE,
128 p_party_id IN NUMBER,
129 p_site_use_type IN VARCHAR2,
130 x_return_status OUT NOCOPY VARCHAR2,
131 x_msg_count OUT NOCOPY NUMBER,
132 x_msg_data OUT NOCOPY VARCHAR2,
133 x_party_site_id OUT NOCOPY NUMBER,
134 x_location_id OUT NOCOPY NUMBER
135 );
136
137 --
138 -- Get the party Site Id of the primary address
139 -- whose site use type is the value of p_site_use_type
140 -- In this query we are trying to address 2 possible scenarios
141 -- 1. if nothing is defined for hz_organization_information,
142 -- any country is allowed.
143 -- 2. if country is defined for hz_organization_information,
144 -- country from hz_party_sites_v needs to be defined in
145 -- hz_organization_information
146 --
147 -- added by madesai 7/29/02
148 --
149
150 procedure get_primary_addr_id(
151 p_api_version IN NUMBER,
152 p_init_msg_list IN VARCHAR2 := FND_API.G_FALSE,
153 p_commit IN VARCHAR2 := FND_API.G_FALSE,
154 p_party_id IN NUMBER,
155 p_site_use_type IN VARCHAR2,
156 p_org_id IN NUMBER,
157 p_get_org_prim_addr IN VARCHAR2 := FND_API.G_FALSE,
158 x_return_status OUT NOCOPY VARCHAR2,
159 x_msg_count OUT NOCOPY NUMBER,
160 x_msg_data OUT NOCOPY VARCHAR2,
161 x_party_site_id OUT NOCOPY NUMBER
162 );
163
164 procedure get_primary_addr_details(
165 p_api_version IN NUMBER,
166 p_init_msg_list IN VARCHAR2 := FND_API.G_FALSE,
167 p_commit IN VARCHAR2 := FND_API.G_FALSE,
168 p_party_id IN NUMBER,
169 p_site_use_type IN VARCHAR2,
170 p_org_id IN NUMBER,
171 p_alt_party_id IN NUMBER,
172 x_return_status OUT NOCOPY VARCHAR2,
173 x_msg_count OUT NOCOPY NUMBER,
174 x_msg_data OUT NOCOPY VARCHAR2,
175 x_party_site_id OUT NOCOPY NUMBER,
176 x_party_id OUT NOCOPY NUMBER
177 );
178
179 procedure valid_usages (
180 p_api_version IN NUMBER,
181 p_init_msg_list IN VARCHAR2 := FND_API.G_FALSE,
182 p_party_site_id IN NUMBER,
183 p_operating_unit_id IN NUMBER,
184 p_usage_codes IN JTF_VARCHAR2_TABLE_100,
185 x_return_codes OUT NOCOPY JTF_VARCHAR2_TABLE_100,
186 x_return_status OUT NOCOPY VARCHAR2,
187 x_msg_count OUT NOCOPY NUMBER,
188 x_msg_data OUT NOCOPY VARCHAR2
189 );
190
191 PROCEDURE copy_party_site (
192 p_api_version IN NUMBER,
193 p_init_msg_list IN VARCHAR2 := FND_API.G_FALSE,
194 p_commit IN VARCHAR2 := FND_API.G_FALSE,
195 p_party_site IN HZ_PARTY_SITE_V2PUB.PARTY_SITE_REC_TYPE,
196 p_location IN HZ_LOCATION_V2PUB.LOCATION_REC_TYPE,
197 x_party_site_id OUT NOCOPY NUMBER,
198 x_return_status OUT NOCOPY VARCHAR2,
199 x_msg_count OUT NOCOPY NUMBER,
200 x_msg_data OUT NOCOPY VARCHAR2);
201
202
203
204
205 END IBE_ADDRESS_V2PVT;