//
//  ErrorFactory.h
//  DynamicEngine
//
//  Created by Mobile3D on 22/09/14.
//  Copyright (c) 2014 Mobile3D. All rights reserved.
//

#import <Foundation/Foundation.h>

@interface ErrorFactory : NSObject

/**
 *  Class method used to create a new error configured with some parameters.
 *
 *  @param domain               The domain of the rror, this is mandatory.
 *  @param errorCode            The error code of the error.
 *  @param localizedDescription The localized description of the error. This is optional.
 *  @param failureReason        Th failure reason. This is optional.
 *  @param recoverySuggestion   The recovery suggestion. This is optional.
 *
 *  @return An NSError instance configured with the passed parameters.
 */
+ (NSError *) buildErrorWithDomain:(NSString *) domain
                         errorCode:(NSInteger) errorCode
              localizedDescription:(NSString *) localizedDescription
                     failureReason:(NSString *) failureReason
                recoverySuggestion:(NSString *) recoverySuggestion;

@end