SCNotSupportedException.h

Go to the documentation of this file.

//
//  SCNotSupportedException.h
//  scl
//
//  Created by Viacheslav Smolensky on 03.03.12.
//  Copyright (c) 2007 - 2014 by Samond Development Corporation. All rights reserved.
//

#import <Foundation/Foundation.h>
#import <scl/SCException.h>

#pragma mark Exception supporting types

#define SCNotSupportedExceptionClass @"SCNotSupportedException"

enum _SCNotSupportedError {
    SCNotSupportedErrorUnspecified      = 0,    
    SCNotSupportedErrorCommand      = 1,    
    SCNotSupportedErrorOperation    = 2,    
    SCNotSupportedErrorCall         = 3,    
    SCNotSupportedErrorMethod       = 4,    
    SCNotSupportedErrorMessage      = 5,    
    SCNotSupportedErrorArgument     = 6,    
    SCNotSupportedErrorProcedure    = 7,    
    SCNotSupportedErrorFunction     = 8,    
    SCNotSupportedErrorObject       = 9     
};

typedef enum _SCNotSupportedError SCNotSupportedError;

#pragma mark -
#pragma mark Exception name constant

#define SCNotSupportedErrorName @"SCNotSupported"   ///< Name of exception

#pragma mark -

@interface SCNotSupportedException : SCException {
    SCNotSupportedError fType;  // Exception type
    NSString *fCommand;         // Unsupported command name
    NSString *fOperation;       // Unsupported operation name
    NSString *fCall;            // Unsupported call name
    NSString *fMethod;          // Unsupported method name
    NSString *fMessage;         // Unsupported message name
    NSString *fArgument;        // Unsupported argument name;
    NSString *fProcedure;       // Unsupported procedure name;
    NSString *fFunction;        // Unsupported function name;
    NSString *fObject;          // Unsupported object name;
}
#pragma mark -
#pragma mark Class properties
#if (__MAC_OS_X_VERSION_MIN_REQUIRED > 1040) || IOS_TARGET
// Exception type property
@property (nonatomic, assign, readonly, getter=type) SCNotSupportedError type;
// Unsupported command name property
@property (nonatomic, retain, readonly, getter=command) NSString *command;
// Unsupported operation name property
@property (nonatomic, retain, readonly, getter=operation) NSString *operation;
// Unsupported call name property
@property (nonatomic, retain, readonly, getter=call) NSString *call;
// Unsupported method name property
@property (nonatomic, retain, readonly, getter=method) NSString *method;
// Unsupported message name property
@property (nonatomic, retain, readonly, getter=message) NSString *message;
// Unsupported argument name property
@property (nonatomic, retain, readonly, getter=argument) NSString *argument;
// Unsupported procedure name property
@property (nonatomic, retain, readonly, getter=procedure) NSString *procedure;
// Unsupported function name property
@property (nonatomic, retain, readonly, getter=function) NSString *function;
// Unsupported object name property
@property (nonatomic, retain, readonly, getter=object) NSString *object;
#endif

#pragma mark -
#pragma mark Creating and Initializing Generic Not Supported Exception

+ (SCNotSupportedException *)exception;

+ (SCNotSupportedException *)exceptionWithType:(SCNotSupportedError)type reason:(NSString *)reason;

+ (SCNotSupportedException *)exceptionWithType:(SCNotSupportedError)type;

+ (SCNotSupportedException *)exceptionWithReason:(NSString *)reason;

- (id)init;

- (id)initWithType:(SCNotSupportedError)type reason:(NSString *)reason;

- (id)initWithType:(SCNotSupportedError)type;

- (id)initWithReason:(NSString *)reason;

#pragma mark -
#pragma mark Creating and Initializing Unsupported Command Exception

+ (SCNotSupportedException *)exceptionWithCommand:(NSString *)command reason:(NSString *)reason;

+ (SCNotSupportedException *)exceptionWithCommand:(NSString *)command;

- (id)initWithCommand:(NSString *)command reason:(NSString *)reason;

- (id)initWithCommand:(NSString *)command;

#pragma mark -
#pragma mark Creating and Initializing Unsupported Operation Exception

+ (SCNotSupportedException *)exceptionWithOperation:(NSString *)operation reason:(NSString *)reason;

+ (SCNotSupportedException *)exceptionWithOperation:(NSString *)operation;

- (id)initWithOperation:(NSString *)operation reason:(NSString *)reason;

- (id)initWithOperation:(NSString *)operation;

#pragma mark -
#pragma mark Creating and Initializing Unsupported Call Exception

+ (SCNotSupportedException *)exceptionWithCall:(NSString *)call reason:(NSString *)reason;

+ (SCNotSupportedException *)exceptionWithCall:(NSString *)call;

- (id)initWithCall:(NSString *)call reason:(NSString *)reason;

- (id)initWithCall:(NSString *)call;

#pragma mark -
#pragma mark Creating and Initializing Unsupported Method Exception

+ (SCNotSupportedException *)exceptionWithMethod:(NSString *)method reason:(NSString *)reason;

+ (SCNotSupportedException *)exceptionWithMethod:(NSString *)method;

- (id)initWithMethod:(NSString *)method reason:(NSString *)reason;

- (id)initWithMethod:(NSString *)method;

#pragma mark -
#pragma mark Creating and Initializing Unsupported Message Exception

+ (SCNotSupportedException *)exceptionWithMessage:(NSString *)message reason:(NSString *)reason;

+ (SCNotSupportedException *)exceptionWithMessage:(NSString *)message;

- (id)initWithMessage:(NSString *)message reason:(NSString *)reason;

- (id)initWithMessage:(NSString *)message;

#pragma mark -
#pragma mark Creating and Initializing Unsupported Argument Exception

+ (SCNotSupportedException *)exceptionWithArgument:(NSString *)argument reason:(NSString *)reason;

+ (SCNotSupportedException *)exceptionWithArgument:(NSString *)argument;

- (id)initWithArgument:(NSString *)argument reason:(NSString *)reason;

- (id)initWithArgument:(NSString *)argument;

#pragma mark -
#pragma mark Creating and Initializing Unsupported Procedure Exception

+ (SCNotSupportedException *)exceptionWithProcedure:(NSString *)procedure reason:(NSString *)reason;

+ (SCNotSupportedException *)exceptionWithProcedure:(NSString *)procedure;

- (id)initWithProcedure:(NSString *)procedure reason:(NSString *)reason;

- (id)initWithProcedure:(NSString *)procedure;

#pragma mark -
#pragma mark Creating and Initializing Unsupported Function Exception

+ (SCNotSupportedException *)exceptionWithFunction:(NSString *)function reason:(NSString *)reason;

+ (SCNotSupportedException *)exceptionWithFunction:(NSString *)function;

- (id)initWithFunction:(NSString *)function reason:(NSString *)reason;

- (id)initWithFunction:(NSString *)function;

#pragma mark -
#pragma mark Creating and Initializing Unsupported Object Exception

+ (SCNotSupportedException *)exceptionWithObject:(NSString *)object reason:(NSString *)reason;

+ (SCNotSupportedException *)exceptionWithObject:(NSString *)object;

- (id)initWithObject:(NSString *)object reason:(NSString *)reason;

- (id)initWithObject:(NSString *)object;

#pragma mark -
#pragma mark Querying Exception Properties

- (SCNotSupportedError)type;

- (NSString *)command;

- (NSString *)operation;

- (NSString *)call;

- (NSString *)method;

- (NSString *)message;

- (NSString *)argument;

- (NSString *)procedure;

- (NSString *)function;

- (NSString *)object;

@end