1 PACKAGE HZ_LOCATION_SERVICES_PUB AUTHID CURRENT_USER AS
2 /*$Header: ARHLCSVS.pls 120.11 2006/08/17 10:19:22 idali noship $*/
3 /*#
4 * This package contains the public APIs for submitting address validation requests.
5 * @rep:scope public
6 * @rep:product HZ
7 * @rep:displayname Location Service
8 * @rep:category BUSINESS_ENTITY HZ_ADDRESS
9 * @rep:lifecycle active
10 * @rep:doccd 120hztig.pdf Location Service APIs, Oracle Trading Community Architecture Technical Implementation Guide
11 */
12
13 -- This procedure set proxy
14 PROCEDURE set_proxy (
15 p_proxy_host VARCHAR2 DEFAULT NULL,
16 p_proxy_port VARCHAR2 DEFAULT NULL,
17 p_proxy_bypass VARCHAR2 DEFAULT NULL);
18
19 PROCEDURE set_authentication (
20 p_req IN OUT NOCOPY UTL_HTTP.REQ,
21 p_adapter_id IN NUMBER );
22
23 PROCEDURE address_validation (
24 Errbuf OUT NOCOPY VARCHAR2,
25 Retcode OUT NOCOPY VARCHAR2,
26 p_validation_status_op IN VARCHAR2,
27 p_validation_status_code IN VARCHAR2,
28 p_date_validated_op IN VARCHAR2,
29 p_date_validated IN VARCHAR2,
30 p_last_update_date_op IN VARCHAR2,
31 p_last_update_date IN VARCHAR2,
32 p_country IN VARCHAR2,
33 p_adapter_content_source IN VARCHAR2,
34 p_overwrite_threshold IN VARCHAR2 );
35
36 PROCEDURE address_validation_worker (
37 Errbuf OUT NOCOPY VARCHAR2,
38 Retcode OUT NOCOPY VARCHAR2,
39 p_adapter_id IN NUMBER,
40 p_overwrite_threshold IN VARCHAR2,
41 p_country IN VARCHAR2,
42 p_nvl_vsc IN VARCHAR2,
43 p_from_vsc IN VARCHAR2,
44 p_to_vsc IN VARCHAR2,
45 p_from_lud IN VARCHAR2,
46 p_to_lud IN VARCHAR2,
47 p_nvl_dv IN VARCHAR2,
48 p_from_dv IN VARCHAR2,
49 p_to_dv IN VARCHAR2,
50 p_num_batch IN NUMBER,
51 p_batch_sequence IN NUMBER );
52
53 PROCEDURE get_validated_xml (
54 p_adapter_id IN NUMBER,
55 p_overwrite_threshold IN VARCHAR2,
56 p_location_id IN NUMBER,
57 p_country IN VARCHAR2,
58 p_address1 IN VARCHAR2,
59 p_address2 IN VARCHAR2,
60 p_address3 IN VARCHAR2,
61 p_address4 IN VARCHAR2,
62 p_county IN VARCHAR2,
63 p_city IN VARCHAR2,
64 p_prov_state_admin_code IN VARCHAR2,
65 p_postal_code IN VARCHAR2,
66 p_validation_status_code IN VARCHAR2 );
67
68 PROCEDURE submit_addrval_request (
69 p_adapter_log_id IN NUMBER,
70 p_adapter_id IN NUMBER DEFAULT NULL,
71 p_country_code IN VARCHAR2 DEFAULT NULL,
72 p_module IN VARCHAR2 DEFAULT NULL,
73 p_module_id IN NUMBER DEFAULT NULL,
74 x_return_status OUT NOCOPY VARCHAR2,
75 x_msg_count OUT NOCOPY NUMBER,
76 x_msg_data OUT NOCOPY VARCHAR2 );
77
78 /*#
79 * Use this API to send an XML document to a vendor's adapter to validate and to receive the
80 * validated address in XML format. This API requires an adapter_id or country_code to call
81 * address validation against different vendor adapters.
82 * @rep:scope public
83 * @rep:lifecycle active
84 * @rep:displayname Address Validation
85 * @rep:doccd 120hztig.pdf Location Service APIs, Oracle Trading Community Architecture Technical Implementation Guide
86 */
87 PROCEDURE submit_addrval_doc (
88 p_addrval_doc IN OUT NOCOPY NCLOB,
89 p_adapter_id IN NUMBER DEFAULT NULL,
90 p_country_code IN VARCHAR2 DEFAULT NULL,
91 p_module IN VARCHAR2 DEFAULT NULL,
92 p_module_id IN NUMBER DEFAULT NULL,
93 x_return_status OUT NOCOPY VARCHAR2,
94 x_msg_count OUT NOCOPY NUMBER,
95 x_msg_data OUT NOCOPY VARCHAR2 );
96
97 FUNCTION get_adapter_id(p_adapter_id IN NUMBER DEFAULT NULL,
98 p_country_code IN VARCHAR2 DEFAULT NULL) RETURN NUMBER;
99
100 FUNCTION outdoc_rule(p_subscription_guid IN RAW,
101 p_event IN OUT NOCOPY wf_event_t ) RETURN VARCHAR2;
102
103 FUNCTION indoc_rule(p_subscription_guid IN RAW,
104 p_event IN OUT NOCOPY wf_event_t ) RETURN VARCHAR2;
105
106 END HZ_LOCATION_SERVICES_PUB;