Merge 2.2 to Master branch

Author: ogubariev

Classes/Core/JSConstants.h

@@ -28,10 +28,8 @@
 //  Jaspersoft Corporation
 //
 
-#import <Foundation/Foundation.h>
 #import "JSErrors.h"
 
-
 @class JSRequest;
 
 /**
@@ -49,23 +47,23 @@
 /**
  A list of objects coming from the call
  */
-@property (nonatomic, strong) NSArray *objects;
+@property (nonatomic, strong, null_unspecified) NSArray *objects;
 
 /**
  The downloaded response as binary data
  */
-@property (nonatomic, strong) NSData *body;
+@property (nonatomic, strong, null_unspecified) NSData *body;
 
 /**
  The sent request associated with this result. This is an additional parameter
  which helps to determine which request was sent (because all they are asynchronous).
  */
-@property (nonatomic, strong) JSRequest *request;
+@property (nonatomic, strong, nonnull) JSRequest *request;
 
 /**
  The error returned from the request call, if any.
  */
-@property (nonatomic, strong) NSError *error;
+@property (nonatomic, strong, nullable) NSError *error;
 
 /**
  The response HTTP code. This is a standard HTTP protocol code. Codes like 2xx are all ok.
@@ -77,17 +75,17 @@
 /**
  A dictionary of the response's headers.
  */
-@property (nonatomic, readonly) NSDictionary *allHeaderFields;
+@property (nonatomic, readonly, nonnull) NSDictionary *allHeaderFields;
 
 /**
  The MIME Type of the response body
  */
-@property (nonatomic, readonly) NSString *MIMEType;
+@property (nonatomic, readonly, nonnull) NSString *MIMEType;
 
 /**
  The downloaded response as string
  */
-@property (nonatomic, strong, readonly) NSString *bodyAsString;
+@property (nonatomic, strong, readonly, null_unspecified) NSString *bodyAsString;
 
 /**
  Returns a result with the specified request parameters
@@ -98,7 +96,7 @@
  @param error The error returned from the request call, if any.
  @return A configured JSOperationResult instance
  */
-- (id)initWithStatusCode:(NSInteger)statusCode allHeaderFields:(NSDictionary *)allHeaderFields MIMEType:(NSString *)MIMEType;
+- (nonnull instancetype)initWithStatusCode:(NSInteger)statusCode allHeaderFields:(nonnull NSDictionary *)allHeaderFields MIMEType:(nonnull NSString *)MIMEType;
 
 /**
  Indicates an HTTP response code between 200 and 299

Classes/Core/JSConstants.m

@@ -38,8 +38,9 @@ @interface JSOperationResult()
 
 @implementation JSOperationResult
 
-- (id)initWithStatusCode:(NSInteger)statusCode allHeaderFields:(NSDictionary *)allHeaderFields
-                MIMEType:(NSString *)MIMEType{
+- (nonnull instancetype)initWithStatusCode:(NSInteger)statusCode
+                           allHeaderFields:(nonnull NSDictionary *)allHeaderFields
+                                  MIMEType:(nonnull NSString *)MIMEType{
     if (self = [super init]) {
         _statusCode = statusCode;
         _allHeaderFields = allHeaderFields;

Classes/Core/JSOperationResult.h

@@ -28,8 +28,6 @@
 //  Jaspersoft Corporation
 //
 
-#import <Foundation/Foundation.h>
-
 /**
  Uses to store connection details for JasperReports server
  
@@ -48,35 +46,35 @@
  The alias is mainly used to display profile's name in UI (i.e. when displays
  a list of available servers)
  */
-@property (nonatomic, readonly) NSString *alias;
+@property (nonatomic, readonly, nonnull) NSString *alias;
 
 /**
  The URL of JasperReports Server.
  URL should match next pattern http://hostname:port/jasperserver
  port parameter is not required (i.e. http://mobiledemo.jaspersoft.com/jasperserver-pro)
  */
-@property (nonatomic, readonly) NSString *serverUrl;
+@property (nonatomic, readonly, nonnull) NSString *serverUrl;
 
 /**
  The username, must be a valid account on JasperReports Server
  */
-@property (nonatomic, readonly) NSString *username;
+@property (nonatomic, readonly, nullable) NSString *username;
 
 /**
  The account password
  */
-@property (nonatomic, readonly) NSString *password;
+@property (nonatomic, readonly, nullable) NSString *password;
 
 /**
  The name of an organization. Used in JasperReport Server Professional
  which supports multi-tenancy. May be <code>nil</code> or empty
  */
-@property (nonatomic, readonly) NSString *organization;
+@property (nonatomic, readonly, nullable) NSString *organization;
 
 /**
  The version of JasperReports server
  */
-@property (nonatomic, strong) JSServerInfo *serverInfo;
+@property (nonatomic, strong, nonnull) JSServerInfo *serverInfo;
 
 /**
  Returns a profile with the specified parameters
@@ -88,7 +86,7 @@
  @param password The account password
  @return A configured JSProfile instance
  */
-- (id)initWithAlias:(NSString *)alias serverUrl:(NSString *)serverUrl organization:(NSString *)organization
-           username:(NSString *)username password:(NSString *)password;
+- (nonnull instancetype)initWithAlias:(nonnull NSString *)alias serverUrl:(nonnull NSString *)serverUrl organization:(nullable NSString *)organization
+           username:(nullable nullable NSString *)username password:(nullable NSString *)password;
 
 @end

Classes/Core/JSOperationResult.m

@@ -43,8 +43,8 @@
 @implementation JSProfile
 
 
-- (id)initWithAlias:(NSString *)alias serverUrl:(NSString *)serverUrl organization:(NSString *)organization
-           username:(NSString *)username password:(NSString *)password {
+- (nonnull instancetype)initWithAlias:(nonnull NSString *)alias serverUrl:(nonnull NSString *)serverUrl organization:(nullable NSString *)organization
+                             username:(nullable nullable NSString *)username password:(nullable NSString *)password {
     if (self = [super init]) {
         _alias = alias;
         _organization = organization;

Classes/Core/JSProfile.h

@@ -29,10 +29,10 @@
 //
 
 #import "JSRESTBase.h"
-#import "JSResourceDescriptor.h"
-#import "JSReportDescriptor.h"
 #import "JSInputControlDescriptor.h"
-#import <Foundation/Foundation.h>
+#import "JSReportOption.h"
+#import "JSReportParameter.h"
+
 
 /**
  Extention to <code>JSRESTBase</code> class for working with reports by REST calls. 
@@ -49,7 +49,7 @@
 //---------------------------------------------------------------------
 
 /**
- Generates the report url to receive all pages report output in HTML format.
+ Generates the report url to receive all pages report output in selected format.
  
  @param uri The resource descriptor uri
  @param reportParams list of report parameter/input control values
@@ -59,7 +59,7 @@
  
  @since 1.4
  */
-- (NSString *)generateReportUrl:(NSString *)uri reportParams:(NSDictionary *)reportParams page:(NSInteger)page format:(NSString *)format;
+- (nonnull NSString *)generateReportUrl:(nonnull NSString *)uri reportParams:(nullable NSArray <JSReportParameter *> *)reportParams page:(NSInteger)page format:(nonnull NSString *)format;
 
 /**
  Gets the list of states of input controls with specified IDs for the report with specified URI and according to selected values
@@ -71,7 +71,7 @@
  
  @since 1.6
  */
-- (void)inputControlsForReport:(NSString *)reportUri ids:(NSArray /*<NSString>*/ *)ids selectedValues:(NSArray /*<JSReportParameter>*/ *)selectedValues completionBlock:(JSRequestCompletionBlock)block;
+- (void)inputControlsForReport:(nonnull NSString *)reportUri ids:(nullable NSArray <NSString *> *)ids selectedValues:(nullable NSArray <JSReportParameter *> *)selectedValues completionBlock:(nullable JSRequestCompletionBlock)block;
 
 /**
  Gets the states with updated values for input controls with specified IDs and according to selected values
@@ -83,8 +83,8 @@
  
  @since 1.4
  */
-- (void)updatedInputControlsValues:(NSString *)reportUri ids:(NSArray /*<NSString>*/ *)ids
-                    selectedValues:(NSArray /*<JSReportParameter>*/ *)selectedValues completionBlock:(JSRequestCompletionBlock)block;
+- (void)updatedInputControlsValues:(nonnull NSString *)reportUri ids:(nonnull NSArray <NSString *> *)ids
+                    selectedValues:(nonnull NSArray <JSReportParameter *> *)selectedValues completionBlock:(nullable JSRequestCompletionBlock)block;
 
 /**
  Executes report
@@ -104,10 +104,10 @@
  
  @since 1.8
  */
-- (void)runReportExecution:(NSString *)reportUnitUri async:(BOOL)async outputFormat:(NSString *)outputFormat
+- (void)runReportExecution:(nonnull NSString *)reportUnitUri async:(BOOL)async outputFormat:(nonnull NSString *)outputFormat
                interactive:(BOOL)interactive freshData:(BOOL)freshData saveDataSnapshot:(BOOL)saveDataSnapshot
-          ignorePagination:(BOOL)ignorePagination transformerKey:(NSString *)transformerKey pages:(NSString *)pages
-         attachmentsPrefix:(NSString *)attachmentsPrefix parameters:(NSArray /*<JSReportParameter>*/ *)parameters completionBlock:(JSRequestCompletionBlock)block;
+          ignorePagination:(BOOL)ignorePagination transformerKey:(nullable NSString *)transformerKey pages:(nullable NSString *)pages
+         attachmentsPrefix:(nullable NSString *)attachmentsPrefix parameters:(nullable NSArray <JSReportParameter *> *)parameters completionBlock:(nullable JSRequestCompletionBlock)block;
 
 /**
  Cancel Report Execution
@@ -117,7 +117,7 @@
  
  @since 1.9
  */
-- (void)cancelReportExecution:(NSString *)requestId completionBlock:(JSRequestCompletionBlock)block;
+- (void)cancelReportExecution:(nonnull NSString *)requestId completionBlock:(nullable JSRequestCompletionBlock)block;
 
 /**
  Run Export Execution
@@ -130,8 +130,8 @@
  
  @since 1.9
  */
-- (void)runExportExecution:(NSString *)requestId outputFormat:(NSString *)outputFormat pages:(NSString *)pages
-         attachmentsPrefix:(NSString *)attachmentsPrefix completionBlock:(JSRequestCompletionBlock)block;
+- (void)runExportExecution:(nonnull NSString *)requestId outputFormat:(nonnull NSString *)outputFormat pages:(nullable NSString *)pages
+         attachmentsPrefix:(nullable NSString *)attachmentsPrefix completionBlock:(nullable JSRequestCompletionBlock)block;
 
 /**
  Generates the report output url
@@ -142,7 +142,7 @@
 
  @since 1.8
 */
-- (NSString *)generateReportOutputUrl:(NSString *)requestId exportOutput:(NSString *)exportOutput;
+- (nonnull NSString *)generateReportOutputUrl:(nonnull NSString *)requestId exportOutput:(nonnull NSString *)exportOutput;
 
 /**
  Gets report execution metadata by request id
@@ -152,7 +152,7 @@
  
  @since 1.8
  */
-- (void)reportExecutionMetadataForRequestId:(NSString *)requestId completionBlock:(JSRequestCompletionBlock)block;
+- (void)reportExecutionMetadataForRequestId:(nonnull NSString *)requestId completionBlock:(nullable JSRequestCompletionBlock)block;
 
 /**
  Gets report execution status by request id
@@ -162,7 +162,7 @@
  
  @since 1.8
  */
-- (void)reportExecutionStatusForRequestId:(NSString *)requestId completionBlock:(JSRequestCompletionBlock)block;
+- (void)reportExecutionStatusForRequestId:(nonnull NSString *)requestId completionBlock:(nullable JSRequestCompletionBlock)block;
 
 /**
  Gets report export status by execution id and export output id.
@@ -172,9 +172,9 @@
 
  @since 2.1
 */
-- (void)exportExecutionStatusWithExecutionID:(NSString *)executionID
-                                exportOutput:(NSString *)exportOutput
-                                  completion:(JSRequestCompletionBlock)block;
+- (void)exportExecutionStatusWithExecutionID:(nonnull NSString *)executionID
+                                exportOutput:(nonnull NSString *)exportOutput
+                                  completion:(nullable JSRequestCompletionBlock)block;
 
 /**
  Loads report output and saves it by specified path if needed
@@ -189,8 +189,8 @@
 
  @since 1.9
  */
-- (void)loadReportOutput:(NSString *)requestId exportOutput:(NSString *)exportOutput
-           loadForSaving:(BOOL)loadForSaving path:(NSString *)path completionBlock:(JSRequestCompletionBlock)block;
+- (void)loadReportOutput:(nonnull NSString *)requestId exportOutput:(nonnull NSString *)exportOutput
+           loadForSaving:(BOOL)loadForSaving path:(nullable NSString *)path completionBlock:(nullable JSRequestCompletionBlock)block;
 
 
 /**
@@ -204,6 +204,41 @@
  
  @since 1.8
  */
-- (void)saveReportAttachment:(NSString *)requestId exportOutput:(NSString *)exportOutput attachmentName:(NSString *)attachmentName path:(NSString *)path completionBlock:(JSRequestCompletionBlock)block;
+- (void)saveReportAttachment:(nonnull NSString *)requestId exportOutput:(nonnull NSString *)exportOutput attachmentName:(nonnull NSString *)attachmentName path:(nonnull NSString *)path completionBlock:(nullable JSRequestCompletionBlock)block;
+
+/**
+ Gets the report options array for report
+ 
+ @param reportUri repository URI of the report
+ @param block The block to inform of the results
+ 
+ @since 2.2
+ */
+- (void)reportOptionsForReportURI:(nonnull NSString *)reportURI completion:(nullable JSRequestCompletionBlock)block;
+
+/**
+ Delete existed report option
+ 
+ @param reportOption the report option for deleting
+ @param reportUri repository URI of the report
+ @param block The block to inform of the results
+ 
+ @since 2.2
+ */
+
+- (void)deleteReportOption:(nonnull JSReportOption *)reportOption withReportURI:(nonnull NSString *)reportURI completion:(nullable JSRequestCompletionBlock)completion;
+
+/**
+ Create new report option
+ 
+ @param reportUri repository URI of the report
+ @param optionLabel the name for new report option
+ @param reportParameters parameters for new report option creating
+ @param block The block to inform of the results
+ 
+ @since 2.2
+ */
+
+- (void)createReportOptionWithReportURI:(nonnull NSString *)reportURI optionLabel:(nonnull NSString *)optionLabel reportParameters:(nonnull NSArray <JSReportParameter *> *)reportParameters completion:(nullable JSRequestCompletionBlock)completion;
 
 @end