PACKAGE: APPS.ZX_TAX_VERTEX_GEO_STUB

Source

1 PACKAGE ZX_TAX_VERTEX_GEO_STUB AUTHID CURRENT_USER AS
2 /* $Header: zxvtxges.pls 120.0 2005/09/09 08:24:53 asengupt noship $ */
3 /* *********************** Constant Declarations *********************** */
4 
5 /* constants returned from the GeoGetLevel function and passed into the GeoSet...Criteria procedures */
6 cGeoCodeLevelState  CONSTANT BINARY_INTEGER := 0;
7 cGeoCodeLevelCounty CONSTANT BINARY_INTEGER := 1;
8 cGeoCodeLevelCity   CONSTANT BINARY_INTEGER := 2;
9 
10 /* GeoCoder String Lengths */
11 cGeoLocGeoCdLen CONSTANT BINARY_INTEGER := 9;
12 cGeoLocGeoStLen CONSTANT BINARY_INTEGER := 2;
13 cGeoLocGeoCoLen CONSTANT BINARY_INTEGER := 3;
14 cGeoLocGeoCiLen CONSTANT BINARY_INTEGER := 4;
15 
16 /* GeoCoder City APO/FPO Codes */
17 cGeoLocPOTypeAPO       CONSTANT BINARY_INTEGER := 1;
18 cGeoLocPOTypeFPO       CONSTANT BINARY_INTEGER := 2;
19 cGeoLocPOTypeNonApoFpo CONSTANT BINARY_INTEGER := 0;
20 
21 /* GeoCoder City Record Type Codes */
22 cGeoLocCiRecTypeNA       CONSTANT BINARY_INTEGER := 0;
23 cGeoLocCiRecTypeActual   CONSTANT BINARY_INTEGER := 3;
24 cGeoLocCiRecTypeZipRange CONSTANT BINARY_INTEGER := 4;
25 cGeoLocCiRecTypeTwnshp   CONSTANT BINARY_INTEGER := 5;
26 cGeoLocCiRecTypeAlt      CONSTANT BINARY_INTEGER := 8;
27 
28 cGeoErrCd20500 CONSTANT NUMBER := -20500;
29 cGeoErrMsg20500 CONSTANT VARCHAR2(100) := 'An invalid GeoCode level was provided.';
30 
31 cGeoErrCd20501 CONSTANT NUMBER := -20501;
32 cGeoErrMsg20501 CONSTANT VARCHAR2(100) := 'An invalid city record type was provided.';
33 
34 cGeoErrCd20000 CONSTANT NUMBER := -20000;
35 cGeoErrMsg20000 CONSTANT VARCHAR2(34) := 'An Oracle exception was raised in ';
36 
37 /* ************************** Type Definitions ************************* */
38 
39 /* Version information record type. */
40 TYPE tGeoVersionRecord IS RECORD (
41     fVersionNumber VARCHAR2(19) := NULL,
42     fReleaseDate   DATE         := NULL);
43 
44 /* GeoCode search record type. */
45 TYPE tGeoSearchRecord IS RECORD (
46     /* the query criteria */
47     fGeoState           NUMBER(2),
48     fGeoCounty          NUMBER(3),
49     fGeoCity            NUMBER(4),
50     fGeoLevel           BINARY_INTEGER,
51 
52     fStateAbbrev        VARCHAR2(2),
53     fStateNamePrefix    BOOLEAN,
54     fStateName          VARCHAR2(25),
55 
56     fCountyNamePrefix   BOOLEAN,
57     fCountyName         VARCHAR2(20),
58 
59     fCityNamePrefix     BOOLEAN,
60     fCityNameCompress   BOOLEAN,
61     fCityName           VARCHAR2(25),
62 
63     fZipCodePrefix      BOOLEAN,
64     fZipCode            VARCHAR2(6),
65 
66     fCityRecType        BINARY_INTEGER,
67 
68     fUseGeoLookup       BOOLEAN,
69 
70     fCursorIsOpen       BOOLEAN := NULL,
71 
72     fCursorId           INTEGER
73     );
74 
75 TYPE tGeoResultsRecord IS RECORD (
76     /* the query results */
77     fResGeoState            NUMBER(2),
78     fResGeoCounty           NUMBER(3),
79     fResGeoCity             NUMBER(4),
80 
81     fResStateName           CHAR(25),
82     fResStateAbbrev         CHAR(2),
83 
84     fResCountyName          CHAR(20),
85     fResCountyAbbrev        CHAR(5),
86 
87     fResCityName            CHAR(25),
88     fResCityNameCompressed  CHAR(25),
89     fResCityNameAbbrev      CHAR(6),
90     fResCityNameType        BINARY_INTEGER,
91 
92     fResZipCodeStart        CHAR(6),
93     fResZipCodeEnd          CHAR(6),
94 
95     fResApoFpoInd           BINARY_INTEGER
96     );
97 
98 /* ************** Procedure and Function Specifications *************** */
99 PROCEDURE GeoSetGeoCodeCriteria (pGeoSearchRec IN OUT NOCOPY tGeoSearchRecord,
100                  pGeoLevel      IN      BINARY_INTEGER,
101                  pGeoState      IN      NUMBER,
102                  pGeoCounty     IN      NUMBER,
103                  pGeoCity       IN      NUMBER,
104                  pCityRecType   IN      BINARY_INTEGER);
105 
106 PROCEDURE GeoSetGeoCodeCriteria (pGeoSearchRec IN OUT  NOCOPY tGeoSearchRecord,
107                  pGeoLevel      IN      BINARY_INTEGER,
108                  pFullGeoCode   IN      NUMBER,
109                  pCityRecType   IN      BINARY_INTEGER);
110 
111 PROCEDURE GeoSetNameCriteria (pGeoSearchRec IN OUT  NOCOPY tGeoSearchRecord,
112                  pGeoLevel          IN      BINARY_INTEGER,
113                  pStateAbbrev       IN      VARCHAR2,
114                  pStateNamePrefix   IN      BOOLEAN,
115                  pStateName         IN      VARCHAR2,
116                  pCountyNamePrefix  IN      BOOLEAN,
117                  pCountyName        IN      VARCHAR2,
118                  pCityNamePrefix    IN      BOOLEAN,
119                  pCityNameCompress  IN      BOOLEAN,
120                  pCityName          IN      VARCHAR2,
121                  pZipCodePrefix     IN      BOOLEAN,
122                  pZipCode           IN      VARCHAR2,
123                  pCityRecType       IN      BINARY_INTEGER);
124 
125 FUNCTION GeoRetrieveFirst (pGeoSearchRec IN OUT NOCOPY tGeoSearchRecord,
126                        pGeoResultsRec IN OUT NOCOPY tGeoResultsRecord) RETURN BOOLEAN;
127 
128 FUNCTION GeoRetrieveNext (pGeoSearchRec IN OUT NOCOPY tGeoSearchRecord,
129                        pGeoResultsRec IN OUT NOCOPY tGeoResultsRecord) RETURN BOOLEAN;
130 
131 PROCEDURE GeoGetVersionInfo (pVersionRec OUT NOCOPY tGeoVersionRecord);
132 
133 FUNCTION GeoGetLevel (pGeoCode IN NUMBER) RETURN BINARY_INTEGER;
134 
135 FUNCTION GeoPackGeoCode (pGeoState IN NUMBER,
136                         pGeoCounty IN NUMBER,
137                         pGeoCity IN NUMBER) RETURN NUMBER;
138 
139 PROCEDURE GeoUnPackGeoCode (pGeoState OUT NOCOPY NUMBER,
140                         pGeoCounty OUT NOCOPY NUMBER,
141                         pGeoCity OUT NOCOPY NUMBER,
142                         pFullGeoCode IN NUMBER);
143 
144 PROCEDURE GeoCloseSearch (pGeoSearchRec IN OUT NOCOPY tGeoSearchRecord);
145 
146 FUNCTION GeoCompressCityName(pCompressCityStr IN VARCHAR2) RETURN VARCHAR2;
147 
148 END ZX_TAX_VERTEX_GEO_STUB;