root/apps/iphone/superbook/trunk/DotTel_SDK/Classes/TelDomain.h @ 864

//
//  TelDomain.h
//  DotTel SDK
//
//  Created by Henri Asseily on 3/17/10.
//  Copyright 2010 Telnic Limited. All rights reserved.
/*
 Redistribution and use in source and binary forms, with or without modification,
 are permitted provided that the following conditions are met:
 
 Redistributions of source code must retain the above copyright notice, this list of conditions
 and the following disclaimer. Redistributions in binary form must reproduce the above copyright
 notice, this list of conditions and the following disclaimer in the documentation and/or other
 materials provided with the distribution.
 Neither the name of the Telnic Ltd. nor the names of its contributors may be used to endorse or
 promote products derived from this software without specific prior written permission.
 THIS DOCUMENTATION IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS
 OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY
 AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
 CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER
 IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
 OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
//

/*
 This class encapsulates all the data for a domain
 You can use the get* methods to acquire NAPTR, TXT and/or LOC records
 It is highly recommended to use getNaptrAndTxtInBackground to acquire both
 NAPTR and TXT together because it merges the two datasets properly, setting
 the NAPTR labels correctly.
 
 Also if you wish to use the caching, you must call archiveToCache when you are done acquiring all
 the data for the domain. Loading of a cached entry is automatic, but archiving (caching) it isn't.
 */

#import <Foundation/Foundation.h>
#import "DnsResolver.h"
#import "NetworkUtility.h"

@protocol TelDomainDelegate <NSObject>
@optional
- (void)didFinishGettingNaptrWithError:(NSError *)error;
- (void)didFinishGettingTxtWithError:(NSError *)error;
- (void)didFinishGettingLocWithError:(NSError *)error;
- (void)didFinishGettingNaptrAndTxtWithError:(NSError *)error;
- (void)didFinishGettingCountryAndTimeZoneWithError:(NSError *)error;

@end


@interface TelDomain : NSObject {
    BOOL isCached;                  // set if the data comes from cache
        NSString *displayName;
        NSString *headerText;
        NSMutableArray *naptrArray;
        NSMutableArray *txtArray;               // only keywords
        NSMutableArray *allTxtArray;    // all txt records
        NSMutableArray *locArray;
        NSString *country;
        NSTimeZone *timeZone;
    NSDate *expiryDate;
        id <TelDomainDelegate> delegate;
@private
        NSString *_telName;
        NSString *_cleanTelName;
        NSURL *_logoUrl;
        BOOL geoLocDidFinish;
}

- (id)initWithTelName:(NSString *)aTelName delegate:(id<TelDomainDelegate>)aDelegate;
- (BOOL)archiveToCache;
- (void)deleteCachedArchive;
- (NSError *)getNaptr;
- (NSError *)getTxt;
- (NSError *)getLocWithReverseGeo:(BOOL)revGeo;
- (void)getNaptrInBackground;
- (void)getNaptrAndTxtInBackground;
- (void)getLocAndReverseGeoInBackground;
- (void)getLocInBackground;
- (void)getCountryAndTimeZoneForLoc:(CLLocation *)aLoc;

//Make sure a .tel is properly filtered
- (NSString *)telFromQueryString:(NSString *)query;

// utility
+ (void)deleteCachedArchiveForTelName:(NSString *)telName;
+ (NSString *)archivesDirectory;

@property (nonatomic, readonly) BOOL isCached;
@property (nonatomic, readonly) NSString *telName;
@property (nonatomic, readonly) NSString *cleanTelName;
@property (nonatomic, copy) NSString *displayName;
@property (nonatomic, copy) NSString *headerText;
@property (nonatomic, readonly) NSURL *logoUrl;
@property (nonatomic, retain) NSMutableArray *naptrArray;
@property (nonatomic, retain) NSMutableArray *txtArray;
@property (nonatomic, retain) NSMutableArray *allTxtArray;
@property (nonatomic, retain) NSMutableArray *locArray;
@property (nonatomic, retain) NSString *country;
@property (nonatomic, retain) NSTimeZone *timeZone;
@property (readonly) BOOL geoLocDidFinish;
@property (nonatomic, readonly) NSDate *expiryDate;
@property (nonatomic, assign) id <TelDomainDelegate> delegate;


@end