AGSField.h

Go to the documentation of this file.

/*
 COPYRIGHT 1995-2020 ESRI
 
 TRADE SECRETS: ESRI PROPRIETARY AND CONFIDENTIAL
 Unpublished material - all rights reserved under the
 Copyright Laws of the United States and applicable international
 laws, treaties, and conventions.
 
 For additional information, contact:
 Environmental Systems Research Institute, Inc.
 Attn: Contracts and Legal Services Department
 380 New York Street
 Redlands, California, 92373
 USA
 
 email: contracts@esri.com
 */
 //Required for Globals API doc

#import <ArcGIS/AGSObject.h>
#import <ArcGIS/AGSJSONSerializable.h>



typedef NS_ENUM(NSInteger, AGSFieldType) {
    AGSFieldTypeUnknown = -1,       
    AGSFieldTypeInt16 = 0,          
    AGSFieldTypeInt32 = 1,          
    AGSFieldTypeGUID = 3,           
    AGSFieldTypeFloat = 4,          
    AGSFieldTypeDouble = 5,         
    AGSFieldTypeDate = 6,           
    AGSFieldTypeText = 7,           
    AGSFieldTypeOID = 8,            
    AGSFieldTypeGlobalID = 9,       
    AGSFieldTypeBlob = 10,          
    AGSFieldTypeGeometry = 11,      
    AGSFieldTypeRaster = 12,        
    AGSFieldTypeXML = 13            
};

@class AGSDomain;

@interface AGSField : AGSObject <AGSJSONSerializable>

#pragma mark -
#pragma mark initializers



-(instancetype)initWithFieldType:(AGSFieldType)fieldType
                             name:(NSString *)name
                            alias:(NSString *)alias
                           length:(NSInteger)length
                           domain:(nullable AGSDomain *)domain
                         editable:(BOOL)editable
                        allowNull:(BOOL)allowNull;


+(instancetype)fieldWithFieldType:(AGSFieldType)fieldType
                             name:(NSString *)name
                            alias:(NSString *)alias
                           length:(NSInteger)length
                           domain:(nullable AGSDomain *)domain
                         editable:(BOOL)editable
                        allowNull:(BOOL)allowNull;

+(instancetype)dateFieldWithName:(NSString *)name alias:(NSString *)alias;

+(instancetype)doubleFieldWithName:(NSString *)name alias:(NSString *)alias;

+(instancetype)floatFieldWithName:(NSString *)name alias:(NSString *)alias;

+(instancetype)longIntFieldWithName:(NSString *)name alias:(NSString *)alias;

+(instancetype)shortIntFieldWithName:(NSString *)name alias:(NSString *)alias;

+(instancetype)textFieldWithName:(NSString *)name alias:(NSString *)alias length:(NSInteger)length;

#pragma mark -
#pragma mark properties

@property (nonatomic, copy, readonly) NSString *name;

@property (nonatomic, assign, readonly) AGSFieldType type;

@property (nonatomic, copy, readonly) NSString *alias;

@property (nullable, nonatomic, strong, readonly) AGSDomain *domain;

@property (nonatomic, assign, readonly, getter=isEditable) BOOL editable;

@property (nonatomic, assign, readonly) BOOL allowNull;

@property (nonatomic, assign, readonly) NSInteger length;

#pragma mark -
#pragma mark methods

@end