/core/externals/update-engine/externals/gdata-objectivec-client/Source/Elements/GDataStructuredPostalAddress.h

  1/* Copyright (c) 2009 Google Inc.
  2 *
  3 * Licensed under the Apache License, Version 2.0 (the "License");
  4 * you may not use this file except in compliance with the License.
  5 * You may obtain a copy of the License at
  6 *
  7 *     http://www.apache.org/licenses/LICENSE-2.0
  8 *
  9 * Unless required by applicable law or agreed to in writing, software
 10 * distributed under the License is distributed on an "AS IS" BASIS,
 11 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 12 * See the License for the specific language governing permissions and
 13 * limitations under the License.
 14 */
 15
 16//
 17//  GDataStructuredPostalAddress.h
 18//
 19
 20#if !GDATA_REQUIRE_SERVICE_INCLUDES || GDATA_INCLUDE_CONTACTS_SERVICE \
 21  || GDATA_INCLUDE_MAPS_SERVICE
 22
 23#import "GDataObject.h"
 24
 25#undef _EXTERN
 26#undef _INITIALIZE_AS
 27#ifdef GDATASTRUCTUREDPOSTALADDRESS_DEFINE_GLOBALS
 28#define _EXTERN
 29#define _INITIALIZE_AS(x) =x
 30#else
 31#define _EXTERN GDATA_EXTERN
 32#define _INITIALIZE_AS(x)
 33#endif
 34
 35// rel values
 36_EXTERN NSString* kGDataPostalAddressHome  _INITIALIZE_AS(@"http://schemas.google.com/g/2005#home");
 37_EXTERN NSString* kGDataPostalAddressWork  _INITIALIZE_AS(@"http://schemas.google.com/g/2005#work");
 38_EXTERN NSString* kGDataPostalAddressOther _INITIALIZE_AS(@"http://schemas.google.com/g/2005#other");
 39
 40// mail class values
 41_EXTERN NSString* kGDataPostalAddressLetters _INITIALIZE_AS(@"http://schemas.google.com/g/2005#letters");
 42_EXTERN NSString* kGDataPostalAddressParcels _INITIALIZE_AS(@"http://schemas.google.com/g/2005#parcels");
 43_EXTERN NSString* kGDataPostalAddressNeither _INITIALIZE_AS(@"http://schemas.google.com/g/2005#neither");
 44_EXTERN NSString* kGDataPostalAddressBoth    _INITIALIZE_AS(@"http://schemas.google.com/g/2005#both");
 45
 46// usage values
 47_EXTERN NSString* kGDataPostalAddressGeneral  _INITIALIZE_AS(@"http://schemas.google.com/g/2005#general");
 48_EXTERN NSString* kGDataPostalAddressLocal    _INITIALIZE_AS(@"http://schemas.google.com/g/2005#local");
 49
 50@interface GDataStructuredPostalAddress : GDataObject <GDataExtension>
 51
 52+ (id)structuredPostalAddress;
 53
 54// receiver of mail, or in care of ("c/o")
 55- (NSString *)agent;
 56- (void)setAgent:(NSString *)str;
 57
 58- (NSString *)city;
 59- (void)setCity:(NSString *)str;
 60
 61// country name and code are in the same element, but we'll expose them
 62// here as if they're independent to keep the interface simpler & KVC-compliant
 63- (NSString *)countryName;
 64- (void)setCountryName:(NSString *)str;
 65
 66// 3166-1 alpha-2 country codes
 67// http://www.iso.org/iso/english_country_names_and_code_elements
 68- (NSString *)countryCode;
 69- (void)setCountryCode:(NSString *)str;
 70
 71// building name
 72- (NSString *)houseName;
 73- (void)setHouseName:(NSString *)str;
 74
 75- (NSString *)neighborhood;
 76- (void)setNeighborhood:(NSString *)str;
 77
 78- (NSString *)POBox;
 79- (void)setPOBox:(NSString *)str;
 80
 81- (NSString *)postCode;
 82- (void)setPostCode:(NSString *)str;
 83
 84// region is a state, province, county (in Ireland), Land (in Germany),
 85// departement (in France), or similar
 86- (NSString *)region;
 87- (void)setRegion:(NSString *)str;
 88
 89- (NSString *)street;
 90- (void)setStreet:(NSString *)str;
 91
 92// subregion is not intended for delivery addresses
 93- (NSString *)subregion;
 94- (void)setSubregion:(NSString *)str;
 95
 96
 97- (NSString *)formattedAddress;
 98- (void)setFormattedAddress:(NSString *)str;
 99
100// attributes
101
102- (NSString *)label;
103- (void)setLabel:(NSString *)str;
104
105- (NSString *)mailClass;
106- (void)setMailClass:(NSString *)str;
107
108- (BOOL)isPrimary;
109- (void)setIsPrimary:(BOOL)flag;
110
111- (NSString *)rel;
112- (void)setRel:(NSString *)str;
113
114- (NSString *)usage;
115- (void)setUsage:(NSString *)str;
116@end
117
118#endif // !GDATA_REQUIRE_SERVICE_INCLUDES || GDATA_INCLUDE_*_SERVICE