1 PACKAGE JTF_TTY_GEOSOURCE_PUB AUTHID CURRENT_USER AS
2 /* $Header: jtftgsps.pls 120.0 2005/06/02 18:21:16 appldev ship $ */
3 /*#
4 * This package provides a public API for inserting geographic
5 * data into the JTF_TTY_GEOGRAPHIES table that is used by
6 * self service geographic territories.
7 * @rep:scope public
8 * @rep:product JTY
9 * @rep:lifecycle active
10 * @rep:displayname Create Geography Data
11 * @rep:category BUSINESS_ENTITY JTY_TERRITORY
12 */
13
14 /*#
15 * Use this API to create a geography definition that can be used
16 * as a source for geographic territories.
17 * @param p_geo_type Geography Type ('POSTAL_CODE', 'CITY', 'STATE',
18 * 'COUNTY', 'PROVINCE', 'COUNTRY')
19 * @param p_geo_name Geography Name (for example 'Sunnyvale' for the city,
20 * 'United States' for the country)
21 * @param p_geo_code Geography Code (for example 'SUNNYVALE' for the city, 'CA'
22 * for California state)
23 * @param p_country_code Country Code (for example 'US' for United States)
24 * @param p_state_code State Code (for example 'NJ' for New Jersey)
25 * @param p_province_code Province Code (for example 'ALBERTA' for Alberta)
26 * @param p_county_code County Code (for example 'SAN_JOSE' for San Jose)
27 * @param p_city_code City Code (for example 'SEATTLE' for Seattle)
28 * @param p_postal_code Postal Code (for example '94065' for 94065)
29 * @param x_return_status API return status stating success,
30 * failure or unexpected error
31 * @param x_error_msg Error message indicating why the create operation failed
32 * @rep:scope public
33 * @rep:lifecycle active
34 * @rep:displayname Create Geography
35 */
36 PROCEDURE create_geo(
37 p_geo_type IN VARCHAR2,
38 p_geo_name IN VARCHAR2,
39 p_geo_code IN VARCHAR2,
40 p_country_code IN VARCHAR2,
41 p_state_code IN VARCHAR2 default null,
42 p_province_code IN VARCHAR2 default null,
43 p_county_code IN VARCHAR2 default null,
44 p_city_code IN VARCHAR2 default null,
45 p_postal_code IN VARCHAR2 default null,
46 x_return_status IN OUT NOCOPY VARCHAR2,
47 x_error_msg IN OUT NOCOPY VARCHAR2);
48 PROCEDURE update_geo(
49 p_geo_id IN VARCHAR2,
50 p_geo_name IN VARCHAR2,
51 x_return_status IN OUT NOCOPY VARCHAR2,
52 x_error_msg IN OUT NOCOPY VARCHAR2);
53 PROCEDURE delete_geo(
54 p_geo_type IN VARCHAR2,
55 p_geo_code IN VARCHAR2,
56 p_country_code IN VARCHAR2,
57 p_state_code IN VARCHAR2 default null,
58 p_province_code IN VARCHAR2 default null,
59 p_county_code IN VARCHAR2 default null,
60 p_city_code IN VARCHAR2 default null,
61 p_postal_code IN VARCHAR2 default null,
62 p_delete_cascade_flag IN VARCHAR2 default 'N',
63 x_return_status IN OUT NOCOPY VARCHAR2,
64 x_error_msg IN OUT NOCOPY VARCHAR2);
65 END JTF_TTY_GEOSOURCE_PUB;
[Home] [Help]