root/apps/iphone/superbook/trunk/DotTel_SDK/Classes/RecordNaptr.h @ 483

//
//  RecordNaptr.h
//  DotTel SDK
//
//  Created by Henri Asseily on 9/12/08.
/*
 Copyright (c) 2008-2009, Telnic Ltd. 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.
 */
//

#import <UIKit/UIKit.h>
#import "ldns.h"

// Shorthand for getting localized strings
#define LocTelStr(key) [[NSBundle mainBundle] localizedStringForKey:(key) value:@"" table:@"DotTel"]

@interface RecordNaptr : NSObject {

        // All string tokens in a NAPTR
        NSNumber *order;
        NSNumber *preference;
        NSString *flags;
        NSString *services;
        NSString *regexp;
        NSString *replacement;
        
        // Parsed services string for .tel-specific tokens
        NSMutableArray *serviceTypeArray;       // e.g. "voice:tel", "web:http"...
        NSMutableArray *labelArray;                     // x-lbl values
        NSMutableArray *lihArray;                       // Location Indicator Hints (x-mobile, x-work, ...)
        
        // Useful properties of a NAPTR
        BOOL isTerminal;
        BOOL isPrivate;
        BOOL isEncrypted;
        BOOL isHidden;
        BOOL isValid;

        // Derived attributes
        NSString *serviceDescription;           // descriptive services token element + LIH
        NSString *labelDescription;                     // descriptive label
        NSString *uriContent;                           // value of the NAPTR after regexp has been applied
        NSDate *expiryDate;                                     // Expiry date of the record, based on time-to-live
        
}

/**
 * Class methods to initialize a NAPTR record from a ldns resource record
 * This method calls recordWithRr:date: using the current date and time
 * 
 * @return     the record
 */
+ (id)recordWithRr:(ldns_rr *)rr;

/**
 * Class methods to initialize a NAPTR record from a ldns resource record
 * Sets property isValid=NO on error or if the provided ldns rr is not a NAPTR.
 * 
 * @return     the record
 */
+ (id)recordWithRr:(ldns_rr *)rr date:(NSDate *)lookupDate;

/**
 * Initializer for a NAPTR record from a ldns resource record
 * Sets property isValid=NO on error or if the provided ldns rr is not a NAPTR.
 * You shouldn't need to call this directly. Instead call one of the class methods
 * recordWithRr.
 * 
 * @return     the record
 */
- (id)initWithRr:(ldns_rr *)rr date:(NSDate *)lookupDate;

/**
 * Comparison selector for ordering NAPTR records. Use this to properly sort
 * an array of RecordNaptr. Example usage:
 * [naptrArray sortUsingSelector:@selector(comparator:)];
 *
 * @return     an NSComparisonResult
 */
- (NSComparisonResult)comparator:(RecordNaptr *)aNaptr;

@property (readonly) BOOL isTerminal;
@property (readonly) BOOL isPrivate;
@property (readonly) BOOL isEncrypted;
@property (readonly) BOOL isHidden;
@property (readonly) BOOL isValid;

@property (readonly, nonatomic, retain) NSMutableArray *serviceTypeArray;
@property (readonly, nonatomic, retain) NSMutableArray *labelArray;
@property (readonly, nonatomic, retain) NSMutableArray *lihArray;

@property (readonly, nonatomic, retain) NSNumber *order; 
@property (readonly, nonatomic, retain) NSNumber *preference; 
@property (readonly, nonatomic, retain) NSString *serviceDescription;
@property (readonly, nonatomic, retain) NSString *labelDescription;
@property (readonly, nonatomic, retain) NSString *uriContent;
@property (readonly, nonatomic, retain) NSDate *expiryDate;

@end