From b0ed1bded1fc07c861c9b1f8014723d856a4203d Mon Sep 17 00:00:00 2001 From: Thorsten Kummerow Date: Mon, 13 Jun 2016 09:39:02 +0200 Subject: [PATCH 01/20] Creating gh-pages branch. --- allclasses-frame.html | 31 + allclasses-noframe.html | 31 + constant-values.html | 122 +++ deprecated-list.html | 122 +++ help-doc.html | 223 +++++ index-files/index-1.html | 137 +++ index-files/index-10.html | 157 ++++ index-files/index-11.html | 129 +++ index-files/index-12.html | 147 ++++ index-files/index-2.html | 129 +++ index-files/index-3.html | 137 +++ index-files/index-4.html | 195 +++++ index-files/index-5.html | 129 +++ index-files/index-6.html | 129 +++ index-files/index-7.html | 171 ++++ index-files/index-8.html | 142 +++ index-files/index-9.html | 153 ++++ index.html | 74 ++ overview-frame.html | 22 + overview-summary.html | 137 +++ overview-tree.html | 159 ++++ package-list | 2 + script.js | 30 + stylesheet.css | 574 ++++++++++++ .../reportingcloud/AccountSettings.html | 349 ++++++++ txtextcontrol/reportingcloud/ImageFormat.html | 380 ++++++++ txtextcontrol/reportingcloud/MergeBody.html | 384 ++++++++ .../reportingcloud/MergeSettings.html | 495 +++++++++++ .../reportingcloud/ReportingCloud.html | 824 ++++++++++++++++++ .../reportingcloud/ReturnFormat.html | 425 +++++++++ txtextcontrol/reportingcloud/Template.html | 304 +++++++ .../reportingcloud/TemplateDataValidator.html | 274 ++++++ .../reportingcloud/TemplateNameValidator.html | 279 ++++++ .../gson/AccountSettingsDeserializer.html | 290 ++++++ .../gson/MergeBodySerializer.html | 288 ++++++ .../gson/MergeSettingsSerializer.html | 288 ++++++ .../gson/TemplateDeserializer.html | 290 ++++++ .../reportingcloud/gson/package-frame.html | 23 + .../reportingcloud/gson/package-summary.html | 162 ++++ .../reportingcloud/gson/package-tree.html | 138 +++ .../reportingcloud/package-frame.html | 31 + .../reportingcloud/package-summary.html | 201 +++++ .../reportingcloud/package-tree.html | 154 ++++ 43 files changed, 8861 insertions(+) create mode 100644 allclasses-frame.html create mode 100644 allclasses-noframe.html create mode 100644 constant-values.html create mode 100644 deprecated-list.html create mode 100644 help-doc.html create mode 100644 index-files/index-1.html create mode 100644 index-files/index-10.html create mode 100644 index-files/index-11.html create mode 100644 index-files/index-12.html create mode 100644 index-files/index-2.html create mode 100644 index-files/index-3.html create mode 100644 index-files/index-4.html create mode 100644 index-files/index-5.html create mode 100644 index-files/index-6.html create mode 100644 index-files/index-7.html create mode 100644 index-files/index-8.html create mode 100644 index-files/index-9.html create mode 100644 index.html create mode 100644 overview-frame.html create mode 100644 overview-summary.html create mode 100644 overview-tree.html create mode 100644 package-list create mode 100644 script.js create mode 100644 stylesheet.css create mode 100644 txtextcontrol/reportingcloud/AccountSettings.html create mode 100644 txtextcontrol/reportingcloud/ImageFormat.html create mode 100644 txtextcontrol/reportingcloud/MergeBody.html create mode 100644 txtextcontrol/reportingcloud/MergeSettings.html create mode 100644 txtextcontrol/reportingcloud/ReportingCloud.html create mode 100644 txtextcontrol/reportingcloud/ReturnFormat.html create mode 100644 txtextcontrol/reportingcloud/Template.html create mode 100644 txtextcontrol/reportingcloud/TemplateDataValidator.html create mode 100644 txtextcontrol/reportingcloud/TemplateNameValidator.html create mode 100644 txtextcontrol/reportingcloud/gson/AccountSettingsDeserializer.html create mode 100644 txtextcontrol/reportingcloud/gson/MergeBodySerializer.html create mode 100644 txtextcontrol/reportingcloud/gson/MergeSettingsSerializer.html create mode 100644 txtextcontrol/reportingcloud/gson/TemplateDeserializer.html create mode 100644 txtextcontrol/reportingcloud/gson/package-frame.html create mode 100644 txtextcontrol/reportingcloud/gson/package-summary.html create mode 100644 txtextcontrol/reportingcloud/gson/package-tree.html create mode 100644 txtextcontrol/reportingcloud/package-frame.html create mode 100644 txtextcontrol/reportingcloud/package-summary.html create mode 100644 txtextcontrol/reportingcloud/package-tree.html diff --git a/allclasses-frame.html b/allclasses-frame.html new file mode 100644 index 0000000..c5efa60 --- /dev/null +++ b/allclasses-frame.html @@ -0,0 +1,31 @@ + + + + + +All Classes + + + + + +

All Classes

+
+ +
+ + diff --git a/allclasses-noframe.html b/allclasses-noframe.html new file mode 100644 index 0000000..ed93bd1 --- /dev/null +++ b/allclasses-noframe.html @@ -0,0 +1,31 @@ + + + + + +All Classes + + + + + +

All Classes

+
+ +
+ + diff --git a/constant-values.html b/constant-values.html new file mode 100644 index 0000000..a0074f1 --- /dev/null +++ b/constant-values.html @@ -0,0 +1,122 @@ + + + + + +Constant Field Values + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Constant Field Values

+

Contents

+
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/deprecated-list.html b/deprecated-list.html new file mode 100644 index 0000000..1b3af88 --- /dev/null +++ b/deprecated-list.html @@ -0,0 +1,122 @@ + + + + + +Deprecated List + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Deprecated API

+

Contents

+
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/help-doc.html b/help-doc.html new file mode 100644 index 0000000..f572a76 --- /dev/null +++ b/help-doc.html @@ -0,0 +1,223 @@ + + + + + +API Help + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

How This API Document Is Organized

+
This API (Application Programming Interface) document has pages corresponding to the items in the navigation bar, described as follows.
+
+
+ +This help file applies to API documentation generated using the standard doclet.
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/index-files/index-1.html b/index-files/index-1.html new file mode 100644 index 0000000..86ff997 --- /dev/null +++ b/index-files/index-1.html @@ -0,0 +1,137 @@ + + + + + +A-Index + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
A C D G I L M R S T U V  + + +

A

+
+
AccountSettings - Class in txtextcontrol.reportingcloud
+
+
Represents ReportingCloud account settings.
+
+
AccountSettings(String, int, int, int, int, String) - Constructor for class txtextcontrol.reportingcloud.AccountSettings
+
 
+
AccountSettingsDeserializer - Class in txtextcontrol.reportingcloud.gson
+
+
Needed by GSON to create AccountSettings objects from JSON data.
+
+
AccountSettingsDeserializer() - Constructor for class txtextcontrol.reportingcloud.gson.AccountSettingsDeserializer
+
 
+
+A C D G I L M R S T U V 
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/index-files/index-10.html b/index-files/index-10.html new file mode 100644 index 0000000..0f8c4b8 --- /dev/null +++ b/index-files/index-10.html @@ -0,0 +1,157 @@ + + + + + +T-Index + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
A C D G I L M R S T U V  + + +

T

+
+
Template - Class in txtextcontrol.reportingcloud
+
+
Holds information about a template in the template storage.
+
+
Template(String, String, int) - Constructor for class txtextcontrol.reportingcloud.Template
+
 
+
TemplateDataValidator - Class in txtextcontrol.reportingcloud
+
+
Internal method parameter validator class.
+
+
TemplateDataValidator() - Constructor for class txtextcontrol.reportingcloud.TemplateDataValidator
+
 
+
TemplateDeserializer - Class in txtextcontrol.reportingcloud.gson
+
+
Needed by GSON to create Template objects from JSON data.
+
+
TemplateDeserializer() - Constructor for class txtextcontrol.reportingcloud.gson.TemplateDeserializer
+
 
+
templateExists(String) - Method in class txtextcontrol.reportingcloud.ReportingCloud
+
+
Checks whether a template exists in the template storage.
+
+
TemplateNameValidator - Class in txtextcontrol.reportingcloud
+
+
Internal method parameter validator class.
+
+
TemplateNameValidator() - Constructor for class txtextcontrol.reportingcloud.TemplateNameValidator
+
 
+
txtextcontrol.reportingcloud - package txtextcontrol.reportingcloud
+
 
+
txtextcontrol.reportingcloud.gson - package txtextcontrol.reportingcloud.gson
+
 
+
+A C D G I L M R S T U V 
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/index-files/index-11.html b/index-files/index-11.html new file mode 100644 index 0000000..5545a2d --- /dev/null +++ b/index-files/index-11.html @@ -0,0 +1,129 @@ + + + + + +U-Index + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
A C D G I L M R S T U V  + + +

U

+
+
uploadTemplate(String, byte[]) - Method in class txtextcontrol.reportingcloud.ReportingCloud
+
+
Stores an uploaded template in the template storage (*.doc, *.docx, *.rtf and *.tx).
+
+
+A C D G I L M R S T U V 
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/index-files/index-12.html b/index-files/index-12.html new file mode 100644 index 0000000..c05f91e --- /dev/null +++ b/index-files/index-12.html @@ -0,0 +1,147 @@ + + + + + +V-Index + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
A C D G I L M R S T U V  + + +

V

+
+
validate(byte[]) - Static method in class txtextcontrol.reportingcloud.TemplateDataValidator
+
 
+
validate(String) - Static method in class txtextcontrol.reportingcloud.TemplateNameValidator
+
 
+
valueOf(String) - Static method in enum txtextcontrol.reportingcloud.ImageFormat
+
+
Returns the enum constant of this type with the specified name.
+
+
valueOf(String) - Static method in enum txtextcontrol.reportingcloud.ReturnFormat
+
+
Returns the enum constant of this type with the specified name.
+
+
values() - Static method in enum txtextcontrol.reportingcloud.ImageFormat
+
+
Returns an array containing the constants of this enum type, in +the order they are declared.
+
+
values() - Static method in enum txtextcontrol.reportingcloud.ReturnFormat
+
+
Returns an array containing the constants of this enum type, in +the order they are declared.
+
+
+A C D G I L M R S T U V 
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/index-files/index-2.html b/index-files/index-2.html new file mode 100644 index 0000000..28e1810 --- /dev/null +++ b/index-files/index-2.html @@ -0,0 +1,129 @@ + + + + + +C-Index + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
A C D G I L M R S T U V  + + +

C

+
+
convertDocument(byte[], ReturnFormat) - Method in class txtextcontrol.reportingcloud.ReportingCloud
+
+
Converts a document to another format.
+
+
+A C D G I L M R S T U V 
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/index-files/index-3.html b/index-files/index-3.html new file mode 100644 index 0000000..7d457ec --- /dev/null +++ b/index-files/index-3.html @@ -0,0 +1,137 @@ + + + + + +D-Index + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
A C D G I L M R S T U V  + + +

D

+
+
deleteTemplate(String) - Method in class txtextcontrol.reportingcloud.ReportingCloud
+
+
Deletes a template from the template storage.
+
+
deserialize(JsonElement, Type, JsonDeserializationContext) - Method in class txtextcontrol.reportingcloud.gson.AccountSettingsDeserializer
+
 
+
deserialize(JsonElement, Type, JsonDeserializationContext) - Method in class txtextcontrol.reportingcloud.gson.TemplateDeserializer
+
 
+
downloadTemplate(String) - Method in class txtextcontrol.reportingcloud.ReportingCloud
+
+
Returns the selected template from the storage.
+
+
+A C D G I L M R S T U V 
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/index-files/index-4.html b/index-files/index-4.html new file mode 100644 index 0000000..658392f --- /dev/null +++ b/index-files/index-4.html @@ -0,0 +1,195 @@ + + + + + +G-Index + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
A C D G I L M R S T U V  + + +

G

+
+
getAccountSettings() - Method in class txtextcontrol.reportingcloud.ReportingCloud
+
+
Gets the current user's account settings.
+
+
getAuthor() - Method in class txtextcontrol.reportingcloud.MergeSettings
+
 
+
getCreatedDocuments() - Method in class txtextcontrol.reportingcloud.AccountSettings
+
 
+
getCreatorApplication() - Method in class txtextcontrol.reportingcloud.MergeSettings
+
 
+
getDocumentSubject() - Method in class txtextcontrol.reportingcloud.MergeSettings
+
 
+
getdocumentTitle() - Method in class txtextcontrol.reportingcloud.MergeSettings
+
 
+
getMaxDocuments() - Method in class txtextcontrol.reportingcloud.AccountSettings
+
 
+
getMaxTemplates() - Method in class txtextcontrol.reportingcloud.AccountSettings
+
 
+
getMergeData() - Method in class txtextcontrol.reportingcloud.MergeBody
+
 
+
getMergeSettings() - Method in class txtextcontrol.reportingcloud.MergeBody
+
 
+
getModified() - Method in class txtextcontrol.reportingcloud.Template
+
 
+
getRemoveEmptyBlocks() - Method in class txtextcontrol.reportingcloud.MergeSettings
+
 
+
getRemoveEmptyFields() - Method in class txtextcontrol.reportingcloud.MergeSettings
+
 
+
getRemoveEmptyImages() - Method in class txtextcontrol.reportingcloud.MergeSettings
+
 
+
getRemoveTrailingWhitespace() - Method in class txtextcontrol.reportingcloud.MergeSettings
+
 
+
getSerialNumber() - Method in class txtextcontrol.reportingcloud.AccountSettings
+
 
+
getSize() - Method in class txtextcontrol.reportingcloud.Template
+
 
+
getTemplate() - Method in class txtextcontrol.reportingcloud.MergeBody
+
 
+
getTemplateCount() - Method in class txtextcontrol.reportingcloud.ReportingCloud
+
+
Returns the number of templates in the template storage.
+
+
getTemplateName() - Method in class txtextcontrol.reportingcloud.Template
+
 
+
getTemplatePageCount(String) - Method in class txtextcontrol.reportingcloud.ReportingCloud
+
+
Returns the number of pages of a template in the template storage.
+
+
getTemplateThumbnails(String, int) - Method in class txtextcontrol.reportingcloud.ReportingCloud
+
+
Returns a list of thumbnails of a specific template.
+
+
getTemplateThumbnails(String, int, int) - Method in class txtextcontrol.reportingcloud.ReportingCloud
+
+
Returns a list of thumbnails of a specific template.
+
+
getTemplateThumbnails(String, int, int, int) - Method in class txtextcontrol.reportingcloud.ReportingCloud
+
+
Returns a list of thumbnails of a specific template.
+
+
getTemplateThumbnails(String, int, int, int, ImageFormat) - Method in class txtextcontrol.reportingcloud.ReportingCloud
+
+
Returns a list of thumbnails of a specific template.
+
+
getUploadedTemplates() - Method in class txtextcontrol.reportingcloud.AccountSettings
+
 
+
getUserPassword() - Method in class txtextcontrol.reportingcloud.MergeSettings
+
 
+
getValidUntil() - Method in class txtextcontrol.reportingcloud.AccountSettings
+
 
+
+A C D G I L M R S T U V 
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/index-files/index-5.html b/index-files/index-5.html new file mode 100644 index 0000000..16f0f45 --- /dev/null +++ b/index-files/index-5.html @@ -0,0 +1,129 @@ + + + + + +I-Index + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
A C D G I L M R S T U V  + + +

I

+
+
ImageFormat - Enum in txtextcontrol.reportingcloud
+
+
This enum lists all possible image formats for the thumbnails
+
+
+A C D G I L M R S T U V 
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/index-files/index-6.html b/index-files/index-6.html new file mode 100644 index 0000000..0bac1ad --- /dev/null +++ b/index-files/index-6.html @@ -0,0 +1,129 @@ + + + + + +L-Index + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
A C D G I L M R S T U V  + + +

L

+
+
listTemplates() - Method in class txtextcontrol.reportingcloud.ReportingCloud
+
+
Lists all templates from the template storage.
+
+
+A C D G I L M R S T U V 
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/index-files/index-7.html b/index-files/index-7.html new file mode 100644 index 0000000..fe2278d --- /dev/null +++ b/index-files/index-7.html @@ -0,0 +1,171 @@ + + + + + +M-Index + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
A C D G I L M R S T U V  + + +

M

+
+
MergeBody - Class in txtextcontrol.reportingcloud
+
+
Used to pass data to the merge method.
+
+
MergeBody(List<Object>) - Constructor for class txtextcontrol.reportingcloud.MergeBody
+
 
+
MergeBody(List<Object>, MergeSettings) - Constructor for class txtextcontrol.reportingcloud.MergeBody
+
 
+
MergeBody(List<Object>, MergeSettings, byte[]) - Constructor for class txtextcontrol.reportingcloud.MergeBody
+
 
+
MergeBodySerializer - Class in txtextcontrol.reportingcloud.gson
+
+
Needed by GSON to serialize MergeBody objects to + JSON.
+
+
MergeBodySerializer() - Constructor for class txtextcontrol.reportingcloud.gson.MergeBodySerializer
+
 
+
mergeDocument(MergeBody) - Method in class txtextcontrol.reportingcloud.ReportingCloud
+
+
Merges and returns a template from the template storage or an uploaded template with JSON data.
+
+
mergeDocument(MergeBody, String) - Method in class txtextcontrol.reportingcloud.ReportingCloud
+
+
Merges and returns a template from the template storage or an uploaded template with JSON data.
+
+
mergeDocument(MergeBody, String, ReturnFormat) - Method in class txtextcontrol.reportingcloud.ReportingCloud
+
+
Merges and returns a template from the template storage or an uploaded template with JSON data.
+
+
mergeDocument(MergeBody, String, ReturnFormat, boolean) - Method in class txtextcontrol.reportingcloud.ReportingCloud
+
+
Merges and returns a template from the template storage or an uploaded template with JSON data.
+
+
MergeSettings - Class in txtextcontrol.reportingcloud
+
+
Holds the merge settings needed by the merge method.
+
+
MergeSettings() - Constructor for class txtextcontrol.reportingcloud.MergeSettings
+
 
+
MergeSettingsSerializer - Class in txtextcontrol.reportingcloud.gson
+
+
Needed by GSON to serialize MergeSettings objects to + JSON.
+
+
MergeSettingsSerializer() - Constructor for class txtextcontrol.reportingcloud.gson.MergeSettingsSerializer
+
 
+
+A C D G I L M R S T U V 
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/index-files/index-8.html b/index-files/index-8.html new file mode 100644 index 0000000..cf81059 --- /dev/null +++ b/index-files/index-8.html @@ -0,0 +1,142 @@ + + + + + +R-Index + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
A C D G I L M R S T U V  + + +

R

+
+
ReportingCloud - Class in txtextcontrol.reportingcloud
+
+
The ReportingCloud API wrapper class.
+
+
ReportingCloud(String, String, String) - Constructor for class txtextcontrol.reportingcloud.ReportingCloud
+
+
Creates a new ReportingCloud wrapper instance.
+
+
ReportingCloud(String, String) - Constructor for class txtextcontrol.reportingcloud.ReportingCloud
+
+
Creates a new ReportingCloud wrapper instance with the API base URL + set to "http://api.reporting.cloud".
+
+
ReturnFormat - Enum in txtextcontrol.reportingcloud
+
+
This enum lists all possible return formats for the Merge method.
+
+
+A C D G I L M R S T U V 
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/index-files/index-9.html b/index-files/index-9.html new file mode 100644 index 0000000..c42a9d6 --- /dev/null +++ b/index-files/index-9.html @@ -0,0 +1,153 @@ + + + + + +S-Index + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
A C D G I L M R S T U V  + + +

S

+
+
serialize(MergeBody, Type, JsonSerializationContext) - Method in class txtextcontrol.reportingcloud.gson.MergeBodySerializer
+
 
+
serialize(MergeSettings, Type, JsonSerializationContext) - Method in class txtextcontrol.reportingcloud.gson.MergeSettingsSerializer
+
 
+
setAuthor(String) - Method in class txtextcontrol.reportingcloud.MergeSettings
+
 
+
setCreatorApplication(String) - Method in class txtextcontrol.reportingcloud.MergeSettings
+
 
+
setDocumentSubject(String) - Method in class txtextcontrol.reportingcloud.MergeSettings
+
 
+
setDocumentTitle(String) - Method in class txtextcontrol.reportingcloud.MergeSettings
+
 
+
setMergeData(List<Object>) - Method in class txtextcontrol.reportingcloud.MergeBody
+
 
+
setMergeSettings(MergeSettings) - Method in class txtextcontrol.reportingcloud.MergeBody
+
 
+
setRemoveEmptyBlocks(boolean) - Method in class txtextcontrol.reportingcloud.MergeSettings
+
 
+
setRemoveEmptyFields(boolean) - Method in class txtextcontrol.reportingcloud.MergeSettings
+
 
+
setRemoveEmptyImages(boolean) - Method in class txtextcontrol.reportingcloud.MergeSettings
+
 
+
setRemoveTrailingWhitespace(boolean) - Method in class txtextcontrol.reportingcloud.MergeSettings
+
 
+
setTemplate(byte[]) - Method in class txtextcontrol.reportingcloud.MergeBody
+
 
+
setUserPassword(String) - Method in class txtextcontrol.reportingcloud.MergeSettings
+
 
+
+A C D G I L M R S T U V 
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/index.html b/index.html new file mode 100644 index 0000000..b7bb95d --- /dev/null +++ b/index.html @@ -0,0 +1,74 @@ + + + + + +Generated Documentation (Untitled) + + + + + + + + + +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<h2>Frame Alert</h2> +<p>This document is designed to be viewed using the frames feature. If you see this message, you are using a non-frame-capable web client. Link to <a href="overview-summary.html">Non-frame version</a>.</p> + + + diff --git a/overview-frame.html b/overview-frame.html new file mode 100644 index 0000000..9f3d4bc --- /dev/null +++ b/overview-frame.html @@ -0,0 +1,22 @@ + + + + + +Overview List + + + + + +
All Classes
+
+

Packages

+ +
+

 

+ + diff --git a/overview-summary.html b/overview-summary.html new file mode 100644 index 0000000..b440943 --- /dev/null +++ b/overview-summary.html @@ -0,0 +1,137 @@ + + + + + +Overview + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+ + + + + + + + + + + + + + + + +
Packages 
PackageDescription
txtextcontrol.reportingcloud 
txtextcontrol.reportingcloud.gson 
+
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/overview-tree.html b/overview-tree.html new file mode 100644 index 0000000..eaa7600 --- /dev/null +++ b/overview-tree.html @@ -0,0 +1,159 @@ + + + + + +Class Hierarchy + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Hierarchy For All Packages

+Package Hierarchies: + +
+
+

Class Hierarchy

+ +

Enum Hierarchy

+ +
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/package-list b/package-list new file mode 100644 index 0000000..257873e --- /dev/null +++ b/package-list @@ -0,0 +1,2 @@ +txtextcontrol.reportingcloud +txtextcontrol.reportingcloud.gson diff --git a/script.js b/script.js new file mode 100644 index 0000000..b346356 --- /dev/null +++ b/script.js @@ -0,0 +1,30 @@ +function show(type) +{ + count = 0; + for (var key in methods) { + var row = document.getElementById(key); + if ((methods[key] & type) != 0) { + row.style.display = ''; + row.className = (count++ % 2) ? rowColor : altColor; + } + else + row.style.display = 'none'; + } + updateTabs(type); +} + +function updateTabs(type) +{ + for (var value in tabs) { + var sNode = document.getElementById(tabs[value][0]); + var spanNode = sNode.firstChild; + if (value == type) { + sNode.className = activeTableTab; + spanNode.innerHTML = tabs[value][1]; + } + else { + sNode.className = tableTab; + spanNode.innerHTML = "" + tabs[value][1] + ""; + } + } +} diff --git a/stylesheet.css b/stylesheet.css new file mode 100644 index 0000000..98055b2 --- /dev/null +++ b/stylesheet.css @@ -0,0 +1,574 @@ +/* Javadoc style sheet */ +/* +Overall document style +*/ + +@import url('resources/fonts/dejavu.css'); + +body { + background-color:#ffffff; + color:#353833; + font-family:'DejaVu Sans', Arial, Helvetica, sans-serif; + font-size:14px; + margin:0; +} +a:link, a:visited { + text-decoration:none; + color:#4A6782; +} +a:hover, a:focus { + text-decoration:none; + color:#bb7a2a; +} +a:active { + text-decoration:none; + color:#4A6782; +} +a[name] { + color:#353833; +} +a[name]:hover { + text-decoration:none; + color:#353833; +} +pre { + font-family:'DejaVu Sans Mono', monospace; + font-size:14px; +} +h1 { + font-size:20px; +} +h2 { + font-size:18px; +} +h3 { + font-size:16px; + font-style:italic; +} +h4 { + font-size:13px; +} +h5 { + font-size:12px; +} +h6 { + font-size:11px; +} +ul { + list-style-type:disc; +} +code, tt { + font-family:'DejaVu Sans Mono', monospace; + font-size:14px; + padding-top:4px; + margin-top:8px; + line-height:1.4em; +} +dt code { + font-family:'DejaVu Sans Mono', monospace; + font-size:14px; + padding-top:4px; +} +table tr td dt code { + font-family:'DejaVu Sans Mono', monospace; + font-size:14px; + vertical-align:top; + padding-top:4px; +} +sup { + font-size:8px; +} +/* +Document title and Copyright styles +*/ +.clear { + clear:both; + height:0px; + overflow:hidden; +} +.aboutLanguage { + float:right; + padding:0px 21px; + font-size:11px; + z-index:200; + margin-top:-9px; +} +.legalCopy { + margin-left:.5em; +} +.bar a, .bar a:link, .bar a:visited, .bar a:active { + color:#FFFFFF; + text-decoration:none; +} +.bar a:hover, .bar a:focus { + color:#bb7a2a; +} +.tab { + background-color:#0066FF; + color:#ffffff; + padding:8px; + width:5em; + font-weight:bold; +} +/* +Navigation bar styles +*/ +.bar { + background-color:#4D7A97; + color:#FFFFFF; + padding:.8em .5em .4em .8em; + height:auto;/*height:1.8em;*/ + font-size:11px; + margin:0; +} +.topNav { + background-color:#4D7A97; + color:#FFFFFF; + float:left; + padding:0; + width:100%; + clear:right; + height:2.8em; + padding-top:10px; + overflow:hidden; + font-size:12px; +} +.bottomNav { + margin-top:10px; + background-color:#4D7A97; + color:#FFFFFF; + float:left; + padding:0; + width:100%; + clear:right; + height:2.8em; + padding-top:10px; + overflow:hidden; + font-size:12px; +} +.subNav { + background-color:#dee3e9; + float:left; + width:100%; + overflow:hidden; + font-size:12px; +} +.subNav div { + clear:left; + float:left; + padding:0 0 5px 6px; + text-transform:uppercase; +} +ul.navList, ul.subNavList { + float:left; + margin:0 25px 0 0; + padding:0; +} +ul.navList li{ + list-style:none; + float:left; + padding: 5px 6px; + text-transform:uppercase; +} +ul.subNavList li{ + list-style:none; + float:left; +} +.topNav a:link, .topNav a:active, .topNav a:visited, .bottomNav a:link, .bottomNav a:active, .bottomNav a:visited { + color:#FFFFFF; + text-decoration:none; + text-transform:uppercase; +} +.topNav a:hover, .bottomNav a:hover { + text-decoration:none; + color:#bb7a2a; + text-transform:uppercase; +} +.navBarCell1Rev { + background-color:#F8981D; + color:#253441; + margin: auto 5px; +} +.skipNav { + position:absolute; + top:auto; + left:-9999px; + overflow:hidden; +} +/* +Page header and footer styles +*/ +.header, .footer { + clear:both; + margin:0 20px; + padding:5px 0 0 0; +} +.indexHeader { + margin:10px; + position:relative; +} +.indexHeader span{ + margin-right:15px; +} +.indexHeader h1 { + font-size:13px; +} +.title { + color:#2c4557; + margin:10px 0; +} +.subTitle { + margin:5px 0 0 0; +} +.header ul { + margin:0 0 15px 0; + padding:0; +} +.footer ul { + margin:20px 0 5px 0; +} +.header ul li, .footer ul li { + list-style:none; + font-size:13px; +} +/* +Heading styles +*/ +div.details ul.blockList ul.blockList ul.blockList li.blockList h4, div.details ul.blockList ul.blockList ul.blockListLast li.blockList h4 { + background-color:#dee3e9; + border:1px solid #d0d9e0; + margin:0 0 6px -8px; + padding:7px 5px; +} +ul.blockList ul.blockList ul.blockList li.blockList h3 { + background-color:#dee3e9; + border:1px solid #d0d9e0; + margin:0 0 6px -8px; + padding:7px 5px; +} +ul.blockList ul.blockList li.blockList h3 { + padding:0; + margin:15px 0; +} +ul.blockList li.blockList h2 { + padding:0px 0 20px 0; +} +/* +Page layout container styles +*/ +.contentContainer, .sourceContainer, .classUseContainer, .serializedFormContainer, .constantValuesContainer { + clear:both; + padding:10px 20px; + position:relative; +} +.indexContainer { + margin:10px; + position:relative; + font-size:12px; +} +.indexContainer h2 { + font-size:13px; + padding:0 0 3px 0; +} +.indexContainer ul { + margin:0; + padding:0; +} +.indexContainer ul li { + list-style:none; + padding-top:2px; +} +.contentContainer .description dl dt, .contentContainer .details dl dt, .serializedFormContainer dl dt { + font-size:12px; + font-weight:bold; + margin:10px 0 0 0; + color:#4E4E4E; +} +.contentContainer .description dl dd, .contentContainer .details dl dd, .serializedFormContainer dl dd { + margin:5px 0 10px 0px; + font-size:14px; + font-family:'DejaVu Sans Mono',monospace; +} +.serializedFormContainer dl.nameValue dt { + margin-left:1px; + font-size:1.1em; + display:inline; + font-weight:bold; +} +.serializedFormContainer dl.nameValue dd { + margin:0 0 0 1px; + font-size:1.1em; + display:inline; +} +/* +List styles +*/ +ul.horizontal li { + display:inline; + font-size:0.9em; +} +ul.inheritance { + margin:0; + padding:0; +} +ul.inheritance li { + display:inline; + list-style:none; +} +ul.inheritance li ul.inheritance { + margin-left:15px; + padding-left:15px; + padding-top:1px; +} +ul.blockList, ul.blockListLast { + margin:10px 0 10px 0; + padding:0; +} +ul.blockList li.blockList, ul.blockListLast li.blockList { + list-style:none; + margin-bottom:15px; + line-height:1.4; +} +ul.blockList ul.blockList li.blockList, ul.blockList ul.blockListLast li.blockList { + padding:0px 20px 5px 10px; + border:1px solid #ededed; + background-color:#f8f8f8; +} +ul.blockList ul.blockList ul.blockList li.blockList, ul.blockList ul.blockList ul.blockListLast li.blockList { + padding:0 0 5px 8px; + background-color:#ffffff; + border:none; +} +ul.blockList ul.blockList ul.blockList ul.blockList li.blockList { + margin-left:0; + padding-left:0; + padding-bottom:15px; + border:none; +} +ul.blockList ul.blockList ul.blockList ul.blockList li.blockListLast { + list-style:none; + border-bottom:none; + padding-bottom:0; +} +table tr td dl, table tr td dl dt, table tr td dl dd { + margin-top:0; + margin-bottom:1px; +} +/* +Table styles +*/ +.overviewSummary, .memberSummary, .typeSummary, .useSummary, .constantsSummary, .deprecatedSummary { + width:100%; + border-left:1px solid #EEE; + border-right:1px solid #EEE; + border-bottom:1px solid #EEE; +} +.overviewSummary, .memberSummary { + padding:0px; +} +.overviewSummary caption, .memberSummary caption, .typeSummary caption, +.useSummary caption, .constantsSummary caption, .deprecatedSummary caption { + position:relative; + text-align:left; + background-repeat:no-repeat; + color:#253441; + font-weight:bold; + clear:none; + overflow:hidden; + padding:0px; + padding-top:10px; + padding-left:1px; + margin:0px; + white-space:pre; +} +.overviewSummary caption a:link, .memberSummary caption a:link, .typeSummary caption a:link, +.useSummary caption a:link, .constantsSummary caption a:link, .deprecatedSummary caption a:link, +.overviewSummary caption a:hover, .memberSummary caption a:hover, .typeSummary caption a:hover, +.useSummary caption a:hover, .constantsSummary caption a:hover, .deprecatedSummary caption a:hover, +.overviewSummary caption a:active, .memberSummary caption a:active, .typeSummary caption a:active, +.useSummary caption a:active, .constantsSummary caption a:active, .deprecatedSummary caption a:active, +.overviewSummary caption a:visited, .memberSummary caption a:visited, .typeSummary caption a:visited, +.useSummary caption a:visited, .constantsSummary caption a:visited, .deprecatedSummary caption a:visited { + color:#FFFFFF; +} +.overviewSummary caption span, .memberSummary caption span, .typeSummary caption span, +.useSummary caption span, .constantsSummary caption span, .deprecatedSummary caption span { + white-space:nowrap; + padding-top:5px; + padding-left:12px; + padding-right:12px; + padding-bottom:7px; + display:inline-block; + float:left; + background-color:#F8981D; + border: none; + height:16px; +} +.memberSummary caption span.activeTableTab span { + white-space:nowrap; + padding-top:5px; + padding-left:12px; + padding-right:12px; + margin-right:3px; + display:inline-block; + float:left; + background-color:#F8981D; + height:16px; +} +.memberSummary caption span.tableTab span { + white-space:nowrap; + padding-top:5px; + padding-left:12px; + padding-right:12px; + margin-right:3px; + display:inline-block; + float:left; + background-color:#4D7A97; + height:16px; +} +.memberSummary caption span.tableTab, .memberSummary caption span.activeTableTab { + padding-top:0px; + padding-left:0px; + padding-right:0px; + background-image:none; + float:none; + display:inline; +} +.overviewSummary .tabEnd, .memberSummary .tabEnd, .typeSummary .tabEnd, +.useSummary .tabEnd, .constantsSummary .tabEnd, .deprecatedSummary .tabEnd { + display:none; + width:5px; + position:relative; + float:left; + background-color:#F8981D; +} +.memberSummary .activeTableTab .tabEnd { + display:none; + width:5px; + margin-right:3px; + position:relative; + float:left; + background-color:#F8981D; +} +.memberSummary .tableTab .tabEnd { + display:none; + width:5px; + margin-right:3px; + position:relative; + background-color:#4D7A97; + float:left; + +} +.overviewSummary td, .memberSummary td, .typeSummary td, +.useSummary td, .constantsSummary td, .deprecatedSummary td { + text-align:left; + padding:0px 0px 12px 10px; +} +th.colOne, th.colFirst, th.colLast, .useSummary th, .constantsSummary th, +td.colOne, td.colFirst, td.colLast, .useSummary td, .constantsSummary td{ + vertical-align:top; + padding-right:0px; + padding-top:8px; + padding-bottom:3px; +} +th.colFirst, th.colLast, th.colOne, .constantsSummary th { + background:#dee3e9; + text-align:left; + padding:8px 3px 3px 7px; +} +td.colFirst, th.colFirst { + white-space:nowrap; + font-size:13px; +} +td.colLast, th.colLast { + font-size:13px; +} +td.colOne, th.colOne { + font-size:13px; +} +.overviewSummary td.colFirst, .overviewSummary th.colFirst, +.useSummary td.colFirst, .useSummary th.colFirst, +.overviewSummary td.colOne, .overviewSummary th.colOne, +.memberSummary td.colFirst, .memberSummary th.colFirst, +.memberSummary td.colOne, .memberSummary th.colOne, +.typeSummary td.colFirst{ + width:25%; + vertical-align:top; +} +td.colOne a:link, td.colOne a:active, td.colOne a:visited, td.colOne a:hover, td.colFirst a:link, td.colFirst a:active, td.colFirst a:visited, td.colFirst a:hover, td.colLast a:link, td.colLast a:active, td.colLast a:visited, td.colLast a:hover, .constantValuesContainer td a:link, .constantValuesContainer td a:active, .constantValuesContainer td a:visited, .constantValuesContainer td a:hover { + font-weight:bold; +} +.tableSubHeadingColor { + background-color:#EEEEFF; +} +.altColor { + background-color:#FFFFFF; +} +.rowColor { + background-color:#EEEEEF; +} +/* +Content styles +*/ +.description pre { + margin-top:0; +} +.deprecatedContent { + margin:0; + padding:10px 0; +} +.docSummary { + padding:0; +} + +ul.blockList ul.blockList ul.blockList li.blockList h3 { + font-style:normal; +} + +div.block { + font-size:14px; + font-family:'DejaVu Serif', Georgia, "Times New Roman", Times, serif; +} + +td.colLast div { + padding-top:0px; +} + + +td.colLast a { + padding-bottom:3px; +} +/* +Formatting effect styles +*/ +.sourceLineNo { + color:green; + padding:0 30px 0 0; +} +h1.hidden { + visibility:hidden; + overflow:hidden; + font-size:10px; +} +.block { + display:block; + margin:3px 10px 2px 0px; + color:#474747; +} +.deprecatedLabel, .descfrmTypeLabel, .memberNameLabel, .memberNameLink, +.overrideSpecifyLabel, .packageHierarchyLabel, .paramLabel, .returnLabel, +.seeLabel, .simpleTagLabel, .throwsLabel, .typeNameLabel, .typeNameLink { + font-weight:bold; +} +.deprecationComment, .emphasizedPhrase, .interfaceName { + font-style:italic; +} + +div.block div.block span.deprecationComment, div.block div.block span.emphasizedPhrase, +div.block div.block span.interfaceName { + font-style:normal; +} + +div.contentContainer ul.blockList li.blockList h2{ + padding-bottom:0px; +} diff --git a/txtextcontrol/reportingcloud/AccountSettings.html b/txtextcontrol/reportingcloud/AccountSettings.html new file mode 100644 index 0000000..5219860 --- /dev/null +++ b/txtextcontrol/reportingcloud/AccountSettings.html @@ -0,0 +1,349 @@ + + + + + +AccountSettings + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
txtextcontrol.reportingcloud
+

Class AccountSettings

+
+
+ +
+
    +
  • +
    +
    +
    public class AccountSettings
+extends java.lang.Object
    +
    Represents ReportingCloud account settings.
    +
    +
    Author:
    +
    Thorsten Kummerow (@thomerow)
    +
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        AccountSettings

        +
        public AccountSettings(java.lang.String serialNumber,
+                       int createdDocuments,
+                       int uploadedTemplates,
+                       int maxDocuments,
+                       int maxTemplates,
+                       java.lang.String validUntil)
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getSerialNumber

        +
        public java.lang.String getSerialNumber()
        +
        • +
      + + + +
        +
      • +

        getCreatedDocuments

        +
        public int getCreatedDocuments()
        +
        • +
      + + + +
        +
      • +

        getUploadedTemplates

        +
        public int getUploadedTemplates()
        +
        • +
      + + + +
        +
      • +

        getMaxDocuments

        +
        public int getMaxDocuments()
        +
        • +
      + + + +
        +
      • +

        getMaxTemplates

        +
        public int getMaxTemplates()
        +
        • +
      + + + +
        +
      • +

        getValidUntil

        +
        public java.time.LocalDateTime getValidUntil()
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/txtextcontrol/reportingcloud/ImageFormat.html b/txtextcontrol/reportingcloud/ImageFormat.html new file mode 100644 index 0000000..10639f7 --- /dev/null +++ b/txtextcontrol/reportingcloud/ImageFormat.html @@ -0,0 +1,380 @@ + + + + + +ImageFormat + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
txtextcontrol.reportingcloud
+

Enum ImageFormat

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.io.Serializable, java.lang.Comparable<ImageFormat>
    +
    +
    +
    +
    public enum ImageFormat
+extends java.lang.Enum<ImageFormat>
    +
    This enum lists all possible image formats for the thumbnails
    +
    +
    Author:
    +
    Thorsten Kummerow (@thomerow)
    +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Enum Constant Summary

      + + + + + + + + + + + + + + + + + +
      Enum Constants 
      Enum Constant and Description
      BMP +
      Windows Bitmap
      +
      GIF +
      Graphics Interchange Format
      +
      JPG +
      Joint Photographic Experts Group
      +
      PNG +
      Portable Network Graphics
      +
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + +
      All Methods Static Methods Concrete Methods 
      Modifier and TypeMethod and Description
      static ImageFormatvalueOf(java.lang.String name) +
      Returns the enum constant of this type with the specified name.
      +
      static ImageFormat[]values() +
      Returns an array containing the constants of this enum type, in +the order they are declared.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Enum

        +clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +getClass, notify, notifyAll, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Enum Constant Detail

      + + + +
        +
      • +

        JPG

        +
        public static final ImageFormat JPG
        +
        Joint Photographic Experts Group
        +
        • +
      + + + +
        +
      • +

        PNG

        +
        public static final ImageFormat PNG
        +
        Portable Network Graphics
        +
        • +
      + + + +
        +
      • +

        BMP

        +
        public static final ImageFormat BMP
        +
        Windows Bitmap
        +
        • +
      + + + +
        +
      • +

        GIF

        +
        public static final ImageFormat GIF
        +
        Graphics Interchange Format
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        values

        +
        public static ImageFormat[] values()
        +
        Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +
        +for (ImageFormat c : ImageFormat.values())
+    System.out.println(c);
+
        +
        +
        Returns:
        +
        an array containing the constants of this enum type, in the order they are declared
        +
        +
        • +
      + + + +
        +
      • +

        valueOf

        +
        public static ImageFormat valueOf(java.lang.String name)
        +
        Returns the enum constant of this type with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.)
        +
        +
        Parameters:
        +
        name - the name of the enum constant to be returned.
        +
        Returns:
        +
        the enum constant with the specified name
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        +
        java.lang.NullPointerException - if the argument is null
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/txtextcontrol/reportingcloud/MergeBody.html b/txtextcontrol/reportingcloud/MergeBody.html new file mode 100644 index 0000000..6bc0a20 --- /dev/null +++ b/txtextcontrol/reportingcloud/MergeBody.html @@ -0,0 +1,384 @@ + + + + + +MergeBody + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
txtextcontrol.reportingcloud
+

Class MergeBody

+
+
+ +
+
    +
  • +
    +
    +
    public class MergeBody
+extends java.lang.Object
    +
    Used to pass data to the merge method.
    +
    +
    Author:
    +
    Thorsten Kummerow (@thomerow)
    +
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        MergeBody

        +
        public MergeBody(java.util.List<java.lang.Object> mergeData)
+          throws java.security.InvalidParameterException
        +
        +
        Throws:
        +
        java.security.InvalidParameterException
        +
        +
        • +
      + + + +
        +
      • +

        MergeBody

        +
        public MergeBody(java.util.List<java.lang.Object> mergeData,
+                 MergeSettings mergeSettings)
+          throws java.security.InvalidParameterException
        +
        +
        Throws:
        +
        java.security.InvalidParameterException
        +
        +
        • +
      + + + +
        +
      • +

        MergeBody

        +
        public MergeBody(java.util.List<java.lang.Object> mergeData,
+                 MergeSettings mergeSettings,
+                 byte[] template)
+          throws java.security.InvalidParameterException
        +
        +
        Throws:
        +
        java.security.InvalidParameterException
        +
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getTemplate

        +
        public byte[] getTemplate()
        +
        • +
      + + + +
        +
      • +

        setTemplate

        +
        public void setTemplate(byte[] template)
        +
        • +
      + + + +
        +
      • +

        getMergeSettings

        +
        public MergeSettings getMergeSettings()
        +
        • +
      + + + +
        +
      • +

        setMergeSettings

        +
        public void setMergeSettings(MergeSettings mergeSettings)
        +
        • +
      + + + +
        +
      • +

        getMergeData

        +
        public java.util.List<java.lang.Object> getMergeData()
        +
        • +
      + + + +
        +
      • +

        setMergeData

        +
        public void setMergeData(java.util.List<java.lang.Object> mergeData)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/txtextcontrol/reportingcloud/MergeSettings.html b/txtextcontrol/reportingcloud/MergeSettings.html new file mode 100644 index 0000000..529a374 --- /dev/null +++ b/txtextcontrol/reportingcloud/MergeSettings.html @@ -0,0 +1,495 @@ + + + + + +MergeSettings + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
txtextcontrol.reportingcloud
+

Class MergeSettings

+
+
+ +
+
    +
  • +
    +
    +
    public class MergeSettings
+extends java.lang.Object
    +
    Holds the merge settings needed by the merge method.
    +
    +
    Author:
    +
    Thorsten Kummerow
    +
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        MergeSettings

        +
        public MergeSettings()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getRemoveEmptyFields

        +
        public boolean getRemoveEmptyFields()
        +
        • +
      + + + +
        +
      • +

        setRemoveEmptyFields

        +
        public void setRemoveEmptyFields(boolean removeEmptyFields)
        +
        • +
      + + + +
        +
      • +

        getRemoveEmptyBlocks

        +
        public boolean getRemoveEmptyBlocks()
        +
        • +
      + + + +
        +
      • +

        setRemoveEmptyBlocks

        +
        public void setRemoveEmptyBlocks(boolean removeEmptyBlocks)
        +
        • +
      + + + +
        +
      • +

        getRemoveEmptyImages

        +
        public boolean getRemoveEmptyImages()
        +
        • +
      + + + +
        +
      • +

        setRemoveEmptyImages

        +
        public void setRemoveEmptyImages(boolean removeEmptyImages)
        +
        • +
      + + + +
        +
      • +

        getRemoveTrailingWhitespace

        +
        public boolean getRemoveTrailingWhitespace()
        +
        • +
      + + + +
        +
      • +

        setRemoveTrailingWhitespace

        +
        public void setRemoveTrailingWhitespace(boolean removeTrailingWhitespace)
        +
        • +
      + + + +
        +
      • +

        getAuthor

        +
        public java.lang.String getAuthor()
        +
        • +
      + + + +
        +
      • +

        setAuthor

        +
        public void setAuthor(java.lang.String author)
        +
        • +
      + + + +
        +
      • +

        getCreatorApplication

        +
        public java.lang.String getCreatorApplication()
        +
        • +
      + + + +
        +
      • +

        setCreatorApplication

        +
        public void setCreatorApplication(java.lang.String creatorApplication)
        +
        • +
      + + + +
        +
      • +

        getDocumentSubject

        +
        public java.lang.String getDocumentSubject()
        +
        • +
      + + + +
        +
      • +

        setDocumentSubject

        +
        public void setDocumentSubject(java.lang.String documentSubject)
        +
        • +
      + + + +
        +
      • +

        getdocumentTitle

        +
        public java.lang.String getdocumentTitle()
        +
        • +
      + + + +
        +
      • +

        setDocumentTitle

        +
        public void setDocumentTitle(java.lang.String documentTitle)
        +
        • +
      + + + +
        +
      • +

        getUserPassword

        +
        public java.lang.String getUserPassword()
        +
        • +
      + + + +
        +
      • +

        setUserPassword

        +
        public void setUserPassword(java.lang.String userPassword)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/txtextcontrol/reportingcloud/ReportingCloud.html b/txtextcontrol/reportingcloud/ReportingCloud.html new file mode 100644 index 0000000..bd76759 --- /dev/null +++ b/txtextcontrol/reportingcloud/ReportingCloud.html @@ -0,0 +1,824 @@ + + + + + +ReportingCloud + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
txtextcontrol.reportingcloud
+

Class ReportingCloud

+
+
+ +
+
    +
  • +
    +
    +
    public class ReportingCloud
+extends java.lang.Object
    +
    The ReportingCloud API wrapper class.
    +
    +
    Author:
    +
    Thorsten Kummerow (@thomerow)
    +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + + +
      Constructors 
      Constructor and Description
      ReportingCloud(java.lang.String username, + java.lang.String password) +
      Creates a new ReportingCloud wrapper instance with the API base URL + set to "http://api.reporting.cloud".
      +
      ReportingCloud(java.lang.String username, + java.lang.String password, + java.lang.String baseUrl) +
      Creates a new ReportingCloud wrapper instance.
      +
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      byte[]convertDocument(byte[] templateData, + ReturnFormat returnFormat) +
      Converts a document to another format.
      +
      voiddeleteTemplate(java.lang.String templateName) +
      Deletes a template from the template storage.
      +
      byte[]downloadTemplate(java.lang.String templateName) +
      Returns the selected template from the storage.
      +
      AccountSettingsgetAccountSettings() +
      Gets the current user's account settings.
      +
      intgetTemplateCount() +
      Returns the number of templates in the template storage.
      +
      intgetTemplatePageCount(java.lang.String templateName) +
      Returns the number of pages of a template in the template storage.
      +
      java.util.List<byte[]>getTemplateThumbnails(java.lang.String templateName, + int zoomFactor) +
      Returns a list of thumbnails of a specific template.
      +
      java.util.List<byte[]>getTemplateThumbnails(java.lang.String templateName, + int zoomFactor, + int fromPage) +
      Returns a list of thumbnails of a specific template.
      +
      java.util.List<byte[]>getTemplateThumbnails(java.lang.String templateName, + int zoomFactor, + int fromPage, + int toPage) +
      Returns a list of thumbnails of a specific template.
      +
      java.util.List<byte[]>getTemplateThumbnails(java.lang.String templateName, + int zoomFactor, + int fromPage, + int toPage, + ImageFormat imageFormat) +
      Returns a list of thumbnails of a specific template.
      +
      java.util.List<Template>listTemplates() +
      Lists all templates from the template storage.
      +
      java.util.List<byte[]>mergeDocument(MergeBody mergeBody) +
      Merges and returns a template from the template storage or an uploaded template with JSON data.
      +
      java.util.List<byte[]>mergeDocument(MergeBody mergeBody, + java.lang.String templateName) +
      Merges and returns a template from the template storage or an uploaded template with JSON data.
      +
      java.util.List<byte[]>mergeDocument(MergeBody mergeBody, + java.lang.String templateName, + ReturnFormat returnFormat) +
      Merges and returns a template from the template storage or an uploaded template with JSON data.
      +
      java.util.List<byte[]>mergeDocument(MergeBody mergeBody, + java.lang.String templateName, + ReturnFormat returnFormat, + boolean append) +
      Merges and returns a template from the template storage or an uploaded template with JSON data.
      +
      booleantemplateExists(java.lang.String templateName) +
      Checks whether a template exists in the template storage.
      +
      voiduploadTemplate(java.lang.String templateName, + byte[] templateData) +
      Stores an uploaded template in the template storage (*.doc, *.docx, *.rtf and *.tx).
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        ReportingCloud

        +
        public ReportingCloud(java.lang.String username,
+                      java.lang.String password,
+                      java.lang.String baseUrl)
        +
        Creates a new ReportingCloud wrapper instance.
        +
        +
        Parameters:
        +
        username - The username.
        +
        password - The password.
        +
        baseUrl - The API base URL.
        +
        +
        • +
      + + + +
        +
      • +

        ReportingCloud

        +
        public ReportingCloud(java.lang.String username,
+                      java.lang.String password)
        +
        Creates a new ReportingCloud wrapper instance with the API base URL + set to "http://api.reporting.cloud".
        +
        +
        Parameters:
        +
        username - The username.
        +
        password - The password.
        +
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getTemplateCount

        +
        public int getTemplateCount()
+                     throws java.lang.IllegalArgumentException,
+                            java.io.IOException
        +
        Returns the number of templates in the template storage.
        +
        +
        Returns:
        +
        The number of templates in the template storage.
        +
        Throws:
        +
        java.io.IOException - If an I/O error occurs.
        +
        java.lang.IllegalArgumentException - If something went wrong concerning the HTTP request.
        +
        +
        • +
      + + + +
        +
      • +

        getAccountSettings

        +
        public AccountSettings getAccountSettings()
+                                   throws java.lang.IllegalArgumentException,
+                                          java.io.IOException
        +
        Gets the current user's account settings.
        +
        +
        Returns:
        +
        The account settings.
        +
        Throws:
        +
        java.io.IOException - If an I/O error occurs.
        +
        java.lang.IllegalArgumentException - If something went wrong concerning the HTTP request.
        +
        +
        • +
      + + + +
        +
      • +

        listTemplates

        +
        public java.util.List<Template> listTemplates()
+                                       throws java.lang.IllegalArgumentException,
+                                              java.io.IOException
        +
        Lists all templates from the template storage.
        +
        +
        Returns:
        +
        A list of Template objects.
        +
        Throws:
        +
        java.lang.IllegalArgumentException - If something went wrong concerning the HTTP request.
        +
        java.io.IOException - If an I/O error occurs.
        +
        +
        • +
      + + + +
        +
      • +

        getTemplatePageCount

        +
        public int getTemplatePageCount(java.lang.String templateName)
+                         throws java.lang.IllegalArgumentException,
+                                java.io.IOException
        +
        Returns the number of pages of a template in the template storage.
        +
        +
        Parameters:
        +
        templateName - The filename of the template in the template + storage to retrieve the number of pages for.
        +
        Returns:
        +
        The number of pages in the template.
        +
        Throws:
        +
        java.io.IOException - If an I/O error occurs.
        +
        java.lang.IllegalArgumentException - If something went wrong concerning the HTTP request.
        +
        +
        • +
      + + + +
        +
      • +

        getTemplateThumbnails

        +
        public java.util.List<byte[]> getTemplateThumbnails(java.lang.String templateName,
+                                                    int zoomFactor)
+                                             throws java.lang.IllegalArgumentException,
+                                                    java.io.IOException
        +
        Returns a list of thumbnails of a specific template.
        +
        +
        Parameters:
        +
        templateName - The filename of the template in the template storage.
        +
        zoomFactor - An Integer value between 1 and 400 to set the percentage + zoom factor of the created thumbnail images.
        +
        Returns:
        +
        An array of binary image data.
        +
        Throws:
        +
        java.lang.IllegalArgumentException - If something went wrong concerning the HTTP request.
        +
        java.io.IOException - If an I/O error occurs.
        +
        +
        • +
      + + + +
        +
      • +

        getTemplateThumbnails

        +
        public java.util.List<byte[]> getTemplateThumbnails(java.lang.String templateName,
+                                                    int zoomFactor,
+                                                    int fromPage)
+                                             throws java.lang.IllegalArgumentException,
+                                                    java.io.IOException
        +
        Returns a list of thumbnails of a specific template.
        +
        +
        Parameters:
        +
        templateName - The filename of the template in the template storage.
        +
        zoomFactor - An Integer value between +1+ and +400+ to set the percentage + zoom factor of the created thumbnail images.
        +
        fromPage - An Integer value that specifies the first page.
        +
        Returns:
        +
        An array of binary image data.
        +
        Throws:
        +
        java.lang.IllegalArgumentException - If something went wrong concerning the HTTP request.
        +
        java.io.IOException - If an I/O error occurs.
        +
        +
        • +
      + + + +
        +
      • +

        getTemplateThumbnails

        +
        public java.util.List<byte[]> getTemplateThumbnails(java.lang.String templateName,
+                                                    int zoomFactor,
+                                                    int fromPage,
+                                                    int toPage)
+                                             throws java.lang.IllegalArgumentException,
+                                                    java.io.IOException
        +
        Returns a list of thumbnails of a specific template.
        +
        +
        Parameters:
        +
        templateName - The filename of the template in the template storage.
        +
        zoomFactor - An Integer value between +1+ and +400+ to set the percentage + zoom factor of the created thumbnail images.
        +
        fromPage - An Integer value that specifies the first page.
        +
        toPage - An Integer value that specifies the last page.
        +
        Returns:
        +
        An array of binary image data.
        +
        Throws:
        +
        java.lang.IllegalArgumentException - If something went wrong concerning the HTTP request.
        +
        java.io.IOException - If an I/O error occurs.
        +
        +
        • +
      + + + +
        +
      • +

        getTemplateThumbnails

        +
        public java.util.List<byte[]> getTemplateThumbnails(java.lang.String templateName,
+                                                    int zoomFactor,
+                                                    int fromPage,
+                                                    int toPage,
+                                                    ImageFormat imageFormat)
+                                             throws java.lang.IllegalArgumentException,
+                                                    java.io.IOException
        +
        Returns a list of thumbnails of a specific template.
        +
        +
        Parameters:
        +
        templateName - The filename of the template in the template storage.
        +
        zoomFactor - An Integer value between +1+ and +400+ to set the percentage + zoom factor of the created thumbnail images.
        +
        fromPage - An Integer value that specifies the first page.
        +
        toPage - An Integer value that specifies the last page.
        +
        imageFormat - Defines the image format of the returned thumbnails.
        +
        Returns:
        +
        An array of binary image data.
        +
        Throws:
        +
        java.lang.IllegalArgumentException - If something went wrong concerning the HTTP request.
        +
        java.io.IOException - If an I/O error occurs.
        +
        +
        • +
      + + + +
        +
      • +

        uploadTemplate

        +
        public void uploadTemplate(java.lang.String templateName,
+                           byte[] templateData)
+                    throws java.lang.IllegalArgumentException,
+                           java.io.IOException
        +
        Stores an uploaded template in the template storage (*.doc, *.docx, *.rtf and *.tx).
        +
        +
        Parameters:
        +
        templateName - The filename of the template in the template storage. Existing + files with the same filename will be overwritten.
        +
        templateData - Binary document data. The supported formats are DOC, DOCX, RTF + and TX.
        +
        Throws:
        +
        java.lang.IllegalArgumentException - If something went wrong concerning the HTTP request.
        +
        java.io.IOException - If an I/O error occurs.
        +
        +
        • +
      + + + +
        +
      • +

        templateExists

        +
        public boolean templateExists(java.lang.String templateName)
+                       throws java.lang.IllegalArgumentException,
+                              java.io.IOException
        +
        Checks whether a template exists in the template storage.
        +
        +
        Parameters:
        +
        templateName - The filename of the template to be checked for + availability in the template storage.
        +
        Returns:
        +
        Returns if the template with the given name exists in the template + storage.
        +
        Throws:
        +
        java.lang.IllegalArgumentException - If something went wrong concerning the HTTP request.
        +
        java.io.IOException - If an I/O error occurs.
        +
        +
        • +
      + + + +
        +
      • +

        downloadTemplate

        +
        public byte[] downloadTemplate(java.lang.String templateName)
+                        throws java.lang.IllegalArgumentException,
+                               java.io.IOException
        +
        Returns the selected template from the storage.
        +
        +
        Parameters:
        +
        templateName - The filename of the template in the template storage.
        +
        Returns:
        +
        The template document data.
        +
        Throws:
        +
        java.io.IOException - If an I/O error occurs.
        +
        java.lang.IllegalArgumentException - If something went wrong concerning the HTTP request.
        +
        +
        • +
      + + + +
        +
      • +

        deleteTemplate

        +
        public void deleteTemplate(java.lang.String templateName)
+                    throws java.lang.IllegalArgumentException,
+                           java.io.IOException
        +
        Deletes a template from the template storage.
        +
        +
        Parameters:
        +
        templateName - The filename of the template to be deleted + from the template storage.
        +
        Throws:
        +
        java.lang.IllegalArgumentException - If something went wrong concerning the HTTP request.
        +
        java.io.IOException - If an I/O error occurs.
        +
        +
        • +
      + + + +
        +
      • +

        convertDocument

        +
        public byte[] convertDocument(byte[] templateData,
+                              ReturnFormat returnFormat)
+                       throws java.lang.IllegalArgumentException,
+                              java.io.IOException
        +
        Converts a document to another format.
        +
        +
        Parameters:
        +
        templateData - The source document encoded as a Base64 string. + The supported document formats are .rtf, .doc, .docx, + .html, .pdf and .tx.
        +
        returnFormat - The format of the created document.
        +
        Returns:
        +
        The created document encoded as a Base64 string.
        +
        Throws:
        +
        java.lang.IllegalArgumentException - If something went wrong concerning the HTTP request.
        +
        java.io.IOException - If an I/O error occurs.
        +
        +
        • +
      + + + +
        +
      • +

        mergeDocument

        +
        public java.util.List<byte[]> mergeDocument(MergeBody mergeBody)
+                                     throws java.lang.IllegalArgumentException,
+                                            java.io.IOException
        +
        Merges and returns a template from the template storage or an uploaded template with JSON data.
        +
        +
        Parameters:
        +
        mergeBody - The MergeBody object contains the datasource + as a JSON data object and optionally, a template encoded as a Base64 string.
        +
        Returns:
        +
        The response body contains an array of the created documents.
        +
        Throws:
        +
        java.lang.IllegalArgumentException - If something went wrong concerning the HTTP request.
        +
        java.io.IOException - If an I/O error occurs.
        +
        +
        • +
      + + + +
        +
      • +

        mergeDocument

        +
        public java.util.List<byte[]> mergeDocument(MergeBody mergeBody,
+                                            java.lang.String templateName)
+                                     throws java.lang.IllegalArgumentException,
+                                            java.io.IOException
        +
        Merges and returns a template from the template storage or an uploaded template with JSON data.
        +
        +
        Parameters:
        +
        mergeBody - The MergeBody object contains the datasource + as a JSON data object and optionally, a template encoded as a Base64 string.
        +
        templateName - The name of the template in the template storage. If no template + name is specified, the template must be uploaded in the MergeBody + object of this request.
        +
        Returns:
        +
        The response body contains an array of the created documents.
        +
        Throws:
        +
        java.lang.IllegalArgumentException - If something went wrong concerning the HTTP request.
        +
        java.io.IOException - If an I/O error occurs.
        +
        +
        • +
      + + + +
        +
      • +

        mergeDocument

        +
        public java.util.List<byte[]> mergeDocument(MergeBody mergeBody,
+                                            java.lang.String templateName,
+                                            ReturnFormat returnFormat)
+                                     throws java.lang.IllegalArgumentException,
+                                            java.io.IOException
        +
        Merges and returns a template from the template storage or an uploaded template with JSON data.
        +
        +
        Parameters:
        +
        mergeBody - The MergeBody object contains the datasource + as a JSON data object and optionally, a template encoded as a Base64 string.
        +
        templateName - The name of the template in the template storage. If no template + name is specified, the template must be uploaded in the MergeBody + object of this request.
        +
        returnFormat - The format of the created document.
        +
        Returns:
        +
        The response body contains an array of the created documents.
        +
        Throws:
        +
        java.lang.IllegalArgumentException - If something went wrong concerning the HTTP request.
        +
        java.io.IOException - If an I/O error occurs.
        +
        +
        • +
      + + + +
        +
      • +

        mergeDocument

        +
        public java.util.List<byte[]> mergeDocument(MergeBody mergeBody,
+                                            java.lang.String templateName,
+                                            ReturnFormat returnFormat,
+                                            boolean append)
+                                     throws java.lang.IllegalArgumentException,
+                                            java.io.IOException
        +
        Merges and returns a template from the template storage or an uploaded template with JSON data.
        +
        +
        Parameters:
        +
        mergeBody - The MergeBody object contains the datasource + as a JSON data object and optionally, a template encoded as a Base64 string.
        +
        templateName - The name of the template in the template storage. If no template + name is specified, the template must be uploaded in the MergeBody + object of this request.
        +
        returnFormat - The format of the created document.
        +
        append - Specifies whether the documents should be appened to one resulting + document when more than 1 data row is passed.
        +
        Returns:
        +
        The response body contains an array of the created documents.
        +
        Throws:
        +
        java.lang.IllegalArgumentException - If something went wrong concerning the HTTP request.
        +
        java.io.IOException - If an I/O error occurs.
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/txtextcontrol/reportingcloud/ReturnFormat.html b/txtextcontrol/reportingcloud/ReturnFormat.html new file mode 100644 index 0000000..75c903b --- /dev/null +++ b/txtextcontrol/reportingcloud/ReturnFormat.html @@ -0,0 +1,425 @@ + + + + + +ReturnFormat + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
txtextcontrol.reportingcloud
+

Enum ReturnFormat

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.io.Serializable, java.lang.Comparable<ReturnFormat>
    +
    +
    +
    +
    public enum ReturnFormat
+extends java.lang.Enum<ReturnFormat>
    +
    This enum lists all possible return formats for the Merge method.
    +
    +
    Author:
    +
    Thorsten Kummerow (@thomerow)
    +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Enum Constant Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Enum Constants 
      Enum Constant and Description
      DOC +
      Microsoft Word 97-2003
      +
      DOCX +
      Microsoft Office Open XML
      +
      HMTL +
      Hypertext Markup Language
      +
      PDF +
      Adobe PDF
      +
      PDFA +
      Adobe PDF/A
      +
      RTF +
      Rich Text Format
      +
      TX +
      TX Text Control Internal Format
      +
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + +
      All Methods Static Methods Concrete Methods 
      Modifier and TypeMethod and Description
      static ReturnFormatvalueOf(java.lang.String name) +
      Returns the enum constant of this type with the specified name.
      +
      static ReturnFormat[]values() +
      Returns an array containing the constants of this enum type, in +the order they are declared.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Enum

        +clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +getClass, notify, notifyAll, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Enum Constant Detail

      + + + +
        +
      • +

        PDF

        +
        public static final ReturnFormat PDF
        +
        Adobe PDF
        +
        • +
      + + + +
        +
      • +

        PDFA

        +
        public static final ReturnFormat PDFA
        +
        Adobe PDF/A
        +
        • +
      + + + +
        +
      • +

        DOC

        +
        public static final ReturnFormat DOC
        +
        Microsoft Word 97-2003
        +
        • +
      + + + +
        +
      • +

        DOCX

        +
        public static final ReturnFormat DOCX
        +
        Microsoft Office Open XML
        +
        • +
      + + + +
        +
      • +

        RTF

        +
        public static final ReturnFormat RTF
        +
        Rich Text Format
        +
        • +
      + + + +
        +
      • +

        TX

        +
        public static final ReturnFormat TX
        +
        TX Text Control Internal Format
        +
        • +
      + + + +
        +
      • +

        HMTL

        +
        public static final ReturnFormat HMTL
        +
        Hypertext Markup Language
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        values

        +
        public static ReturnFormat[] values()
        +
        Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +
        +for (ReturnFormat c : ReturnFormat.values())
+    System.out.println(c);
+
        +
        +
        Returns:
        +
        an array containing the constants of this enum type, in the order they are declared
        +
        +
        • +
      + + + +
        +
      • +

        valueOf

        +
        public static ReturnFormat valueOf(java.lang.String name)
        +
        Returns the enum constant of this type with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.)
        +
        +
        Parameters:
        +
        name - the name of the enum constant to be returned.
        +
        Returns:
        +
        the enum constant with the specified name
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        +
        java.lang.NullPointerException - if the argument is null
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/txtextcontrol/reportingcloud/Template.html b/txtextcontrol/reportingcloud/Template.html new file mode 100644 index 0000000..9931f4d --- /dev/null +++ b/txtextcontrol/reportingcloud/Template.html @@ -0,0 +1,304 @@ + + + + + +Template + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
txtextcontrol.reportingcloud
+

Class Template

+
+
+ +
+
    +
  • +
    +
    +
    public class Template
+extends java.lang.Object
    +
    Holds information about a template in the template storage.
    +
    +
    Author:
    +
    Thorsten Kummerow (@thomerow)
    +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      Template(java.lang.String templateName, + java.lang.String modified, + int size) 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      java.time.LocalDateTimegetModified() 
      intgetSize() 
      java.lang.StringgetTemplateName() 
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        Template

        +
        public Template(java.lang.String templateName,
+                java.lang.String modified,
+                int size)
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getTemplateName

        +
        public java.lang.String getTemplateName()
        +
        • +
      + + + +
        +
      • +

        getSize

        +
        public int getSize()
        +
        • +
      + + + +
        +
      • +

        getModified

        +
        public java.time.LocalDateTime getModified()
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/txtextcontrol/reportingcloud/TemplateDataValidator.html b/txtextcontrol/reportingcloud/TemplateDataValidator.html new file mode 100644 index 0000000..8d79410 --- /dev/null +++ b/txtextcontrol/reportingcloud/TemplateDataValidator.html @@ -0,0 +1,274 @@ + + + + + +TemplateDataValidator + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
txtextcontrol.reportingcloud
+

Class TemplateDataValidator

+
+
+ +
+
    +
  • +
    +
    +
    public class TemplateDataValidator
+extends java.lang.Object
    +
    Internal method parameter validator class.
    +
    +
    Author:
    +
    Thorsten Kummerow (@thomerow)
    +
    +
    • +
+
+
+
    +
  • + + + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + +
      All Methods Static Methods Concrete Methods 
      Modifier and TypeMethod and Description
      static voidvalidate(byte[] templateData) 
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        TemplateDataValidator

        +
        public TemplateDataValidator()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        validate

        +
        public static void validate(byte[] templateData)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/txtextcontrol/reportingcloud/TemplateNameValidator.html b/txtextcontrol/reportingcloud/TemplateNameValidator.html new file mode 100644 index 0000000..10fee7f --- /dev/null +++ b/txtextcontrol/reportingcloud/TemplateNameValidator.html @@ -0,0 +1,279 @@ + + + + + +TemplateNameValidator + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
txtextcontrol.reportingcloud
+

Class TemplateNameValidator

+
+
+ +
+
    +
  • +
    +
    +
    public class TemplateNameValidator
+extends java.lang.Object
    +
    Internal method parameter validator class.
    +
    +
    Author:
    +
    Thorsten Kummerow (@thomerow)
    +
    +
    • +
+
+
+
    +
  • + + + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + +
      All Methods Static Methods Concrete Methods 
      Modifier and TypeMethod and Description
      static voidvalidate(java.lang.String templateName) 
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        TemplateNameValidator

        +
        public TemplateNameValidator()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        validate

        +
        public static void validate(java.lang.String templateName)
+                     throws java.security.InvalidParameterException
        +
        +
        Throws:
        +
        java.security.InvalidParameterException
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/txtextcontrol/reportingcloud/gson/AccountSettingsDeserializer.html b/txtextcontrol/reportingcloud/gson/AccountSettingsDeserializer.html new file mode 100644 index 0000000..4c18368 --- /dev/null +++ b/txtextcontrol/reportingcloud/gson/AccountSettingsDeserializer.html @@ -0,0 +1,290 @@ + + + + + +AccountSettingsDeserializer + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
txtextcontrol.reportingcloud.gson
+

Class AccountSettingsDeserializer

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    com.google.gson.JsonDeserializer<AccountSettings>
    +
    +
    +
    +
    public class AccountSettingsDeserializer
+extends java.lang.Object
+implements com.google.gson.JsonDeserializer<AccountSettings>
    +
    Needed by GSON to create AccountSettings objects from JSON data.
    +
    +
    Author:
    +
    Thorsten Kummerow
    +
    +
    • +
+
+
+
    +
  • + + + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      AccountSettingsdeserialize(com.google.gson.JsonElement json, + java.lang.reflect.Type typeOfT, + com.google.gson.JsonDeserializationContext context) 
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        AccountSettingsDeserializer

        +
        public AccountSettingsDeserializer()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        deserialize

        +
        public AccountSettings deserialize(com.google.gson.JsonElement json,
+                                   java.lang.reflect.Type typeOfT,
+                                   com.google.gson.JsonDeserializationContext context)
+                            throws com.google.gson.JsonParseException
        +
        +
        Specified by:
        +
        deserialize in interface com.google.gson.JsonDeserializer<AccountSettings>
        +
        Throws:
        +
        com.google.gson.JsonParseException
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/txtextcontrol/reportingcloud/gson/MergeBodySerializer.html b/txtextcontrol/reportingcloud/gson/MergeBodySerializer.html new file mode 100644 index 0000000..7559996 --- /dev/null +++ b/txtextcontrol/reportingcloud/gson/MergeBodySerializer.html @@ -0,0 +1,288 @@ + + + + + +MergeBodySerializer + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
txtextcontrol.reportingcloud.gson
+

Class MergeBodySerializer

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    com.google.gson.JsonSerializer<MergeBody>
    +
    +
    +
    +
    public class MergeBodySerializer
+extends java.lang.Object
+implements com.google.gson.JsonSerializer<MergeBody>
    +
    Needed by GSON to serialize MergeBody objects to + JSON.
    +
    +
    Author:
    +
    Thorsten Kummerow (@thomerow)
    +
    +
    • +
+
+
+
    +
  • + + + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      com.google.gson.JsonElementserialize(MergeBody src, + java.lang.reflect.Type typeOfSrc, + com.google.gson.JsonSerializationContext context) 
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        MergeBodySerializer

        +
        public MergeBodySerializer()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        serialize

        +
        public com.google.gson.JsonElement serialize(MergeBody src,
+                                             java.lang.reflect.Type typeOfSrc,
+                                             com.google.gson.JsonSerializationContext context)
        +
        +
        Specified by:
        +
        serialize in interface com.google.gson.JsonSerializer<MergeBody>
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/txtextcontrol/reportingcloud/gson/MergeSettingsSerializer.html b/txtextcontrol/reportingcloud/gson/MergeSettingsSerializer.html new file mode 100644 index 0000000..7502e6b --- /dev/null +++ b/txtextcontrol/reportingcloud/gson/MergeSettingsSerializer.html @@ -0,0 +1,288 @@ + + + + + +MergeSettingsSerializer + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
txtextcontrol.reportingcloud.gson
+

Class MergeSettingsSerializer

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    com.google.gson.JsonSerializer<MergeSettings>
    +
    +
    +
    +
    public class MergeSettingsSerializer
+extends java.lang.Object
+implements com.google.gson.JsonSerializer<MergeSettings>
    +
    Needed by GSON to serialize MergeSettings objects to + JSON.
    +
    +
    Author:
    +
    Thorsten Kummerow (@thomerow)
    +
    +
    • +
+
+
+
    +
  • + + + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      com.google.gson.JsonElementserialize(MergeSettings src, + java.lang.reflect.Type typeOfSrc, + com.google.gson.JsonSerializationContext context) 
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        MergeSettingsSerializer

        +
        public MergeSettingsSerializer()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        serialize

        +
        public com.google.gson.JsonElement serialize(MergeSettings src,
+                                             java.lang.reflect.Type typeOfSrc,
+                                             com.google.gson.JsonSerializationContext context)
        +
        +
        Specified by:
        +
        serialize in interface com.google.gson.JsonSerializer<MergeSettings>
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/txtextcontrol/reportingcloud/gson/TemplateDeserializer.html b/txtextcontrol/reportingcloud/gson/TemplateDeserializer.html new file mode 100644 index 0000000..d34d588 --- /dev/null +++ b/txtextcontrol/reportingcloud/gson/TemplateDeserializer.html @@ -0,0 +1,290 @@ + + + + + +TemplateDeserializer + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
txtextcontrol.reportingcloud.gson
+

Class TemplateDeserializer

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    com.google.gson.JsonDeserializer<Template>
    +
    +
    +
    +
    public class TemplateDeserializer
+extends java.lang.Object
+implements com.google.gson.JsonDeserializer<Template>
    +
    Needed by GSON to create Template objects from JSON data.
    +
    +
    Author:
    +
    Thorsten Kummerow
    +
    +
    • +
+
+
+
    +
  • + + + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      Templatedeserialize(com.google.gson.JsonElement json, + java.lang.reflect.Type typeOfT, + com.google.gson.JsonDeserializationContext context) 
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        TemplateDeserializer

        +
        public TemplateDeserializer()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        deserialize

        +
        public Template deserialize(com.google.gson.JsonElement json,
+                            java.lang.reflect.Type typeOfT,
+                            com.google.gson.JsonDeserializationContext context)
+                     throws com.google.gson.JsonParseException
        +
        +
        Specified by:
        +
        deserialize in interface com.google.gson.JsonDeserializer<Template>
        +
        Throws:
        +
        com.google.gson.JsonParseException
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/txtextcontrol/reportingcloud/gson/package-frame.html b/txtextcontrol/reportingcloud/gson/package-frame.html new file mode 100644 index 0000000..ff8c5dc --- /dev/null +++ b/txtextcontrol/reportingcloud/gson/package-frame.html @@ -0,0 +1,23 @@ + + + + + +txtextcontrol.reportingcloud.gson + + + + + +

txtextcontrol.reportingcloud.gson

+
+

Classes

+ +
+ + diff --git a/txtextcontrol/reportingcloud/gson/package-summary.html b/txtextcontrol/reportingcloud/gson/package-summary.html new file mode 100644 index 0000000..0c5b348 --- /dev/null +++ b/txtextcontrol/reportingcloud/gson/package-summary.html @@ -0,0 +1,162 @@ + + + + + +txtextcontrol.reportingcloud.gson + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Package txtextcontrol.reportingcloud.gson

+
+
+ +
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/txtextcontrol/reportingcloud/gson/package-tree.html b/txtextcontrol/reportingcloud/gson/package-tree.html new file mode 100644 index 0000000..2ee38e9 --- /dev/null +++ b/txtextcontrol/reportingcloud/gson/package-tree.html @@ -0,0 +1,138 @@ + + + + + +txtextcontrol.reportingcloud.gson Class Hierarchy + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Hierarchy For Package txtextcontrol.reportingcloud.gson

+Package Hierarchies: + +
+
+

Class Hierarchy

+ +
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/txtextcontrol/reportingcloud/package-frame.html b/txtextcontrol/reportingcloud/package-frame.html new file mode 100644 index 0000000..cb9de7e --- /dev/null +++ b/txtextcontrol/reportingcloud/package-frame.html @@ -0,0 +1,31 @@ + + + + + +txtextcontrol.reportingcloud + + + + + +

txtextcontrol.reportingcloud

+
+

Classes

+ +

Enums

+ +
+ + diff --git a/txtextcontrol/reportingcloud/package-summary.html b/txtextcontrol/reportingcloud/package-summary.html new file mode 100644 index 0000000..394b845 --- /dev/null +++ b/txtextcontrol/reportingcloud/package-summary.html @@ -0,0 +1,201 @@ + + + + + +txtextcontrol.reportingcloud + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Package txtextcontrol.reportingcloud

+
+
+ +
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/txtextcontrol/reportingcloud/package-tree.html b/txtextcontrol/reportingcloud/package-tree.html new file mode 100644 index 0000000..2400bd6 --- /dev/null +++ b/txtextcontrol/reportingcloud/package-tree.html @@ -0,0 +1,154 @@ + + + + + +txtextcontrol.reportingcloud Class Hierarchy + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Hierarchy For Package txtextcontrol.reportingcloud

+Package Hierarchies: + +
+
+

Class Hierarchy

+ +

Enum Hierarchy

+ +
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + From ac3f9ff6401808e10b09e0c205fb5ede6d54901b Mon Sep 17 00:00:00 2001 From: Thorsten Kummerow Date: Mon, 13 Jun 2016 10:22:22 +0200 Subject: [PATCH 02/20] Updating javadoc. --- allclasses-frame.html | 2 +- allclasses-noframe.html | 2 +- constant-values.html | 2 +- deprecated-list.html | 2 +- help-doc.html | 2 +- index-files/index-1.html | 2 +- index-files/index-10.html | 6 +- index-files/index-11.html | 5 +- index-files/index-12.html | 10 +- index-files/index-2.html | 2 +- index-files/index-3.html | 2 +- index-files/index-4.html | 90 ++++++--- index-files/index-5.html | 2 +- index-files/index-6.html | 2 +- index-files/index-7.html | 2 +- index-files/index-8.html | 2 +- index-files/index-9.html | 53 ++++-- index.html | 2 +- overview-frame.html | 2 +- overview-summary.html | 2 +- overview-tree.html | 2 +- .../reportingcloud/AccountSettings.html | 60 +++++- txtextcontrol/reportingcloud/ImageFormat.html | 4 +- txtextcontrol/reportingcloud/MergeBody.html | 80 +++++++- .../reportingcloud/MergeSettings.html | 175 ++++++++++++++++-- .../reportingcloud/ReportingCloud.html | 36 ++-- .../reportingcloud/ReturnFormat.html | 4 +- txtextcontrol/reportingcloud/Template.html | 55 ++++-- .../reportingcloud/TemplateDataValidator.html | 13 +- .../reportingcloud/TemplateNameValidator.html | 11 +- .../gson/AccountSettingsDeserializer.html | 2 +- .../gson/MergeBodySerializer.html | 4 +- .../gson/MergeSettingsSerializer.html | 4 +- .../gson/TemplateDeserializer.html | 2 +- .../reportingcloud/gson/package-frame.html | 2 +- .../reportingcloud/gson/package-summary.html | 2 +- .../reportingcloud/gson/package-tree.html | 2 +- .../reportingcloud/package-frame.html | 2 +- .../reportingcloud/package-summary.html | 2 +- .../reportingcloud/package-tree.html | 2 +- 40 files changed, 514 insertions(+), 144 deletions(-) diff --git a/allclasses-frame.html b/allclasses-frame.html index c5efa60..2aa98c8 100644 --- a/allclasses-frame.html +++ b/allclasses-frame.html @@ -2,7 +2,7 @@ - + All Classes diff --git a/allclasses-noframe.html b/allclasses-noframe.html index ed93bd1..39e35e3 100644 --- a/allclasses-noframe.html +++ b/allclasses-noframe.html @@ -2,7 +2,7 @@ - + All Classes diff --git a/constant-values.html b/constant-values.html index a0074f1..dde1845 100644 --- a/constant-values.html +++ b/constant-values.html @@ -2,7 +2,7 @@ - + Constant Field Values diff --git a/deprecated-list.html b/deprecated-list.html index 1b3af88..e130c88 100644 --- a/deprecated-list.html +++ b/deprecated-list.html @@ -2,7 +2,7 @@ - + Deprecated List diff --git a/help-doc.html b/help-doc.html index f572a76..7e744f0 100644 --- a/help-doc.html +++ b/help-doc.html @@ -2,7 +2,7 @@ - + API Help diff --git a/index-files/index-1.html b/index-files/index-1.html index 86ff997..e64558d 100644 --- a/index-files/index-1.html +++ b/index-files/index-1.html @@ -2,7 +2,7 @@ - + A-Index diff --git a/index-files/index-10.html b/index-files/index-10.html index 0f8c4b8..410e28e 100644 --- a/index-files/index-10.html +++ b/index-files/index-10.html @@ -2,7 +2,7 @@ - + T-Index @@ -78,7 +78,9 @@

T

Holds information about a template in the template storage.
Template(String, String, int) - Constructor for class txtextcontrol.reportingcloud.Template
-
 
+
+
Creates a new Template instance.
+
TemplateDataValidator - Class in txtextcontrol.reportingcloud
Internal method parameter validator class.
diff --git a/index-files/index-11.html b/index-files/index-11.html index 5545a2d..a14d0a2 100644 --- a/index-files/index-11.html +++ b/index-files/index-11.html @@ -2,7 +2,7 @@ - + U-Index @@ -75,7 +75,8 @@

U

uploadTemplate(String, byte[]) - Method in class txtextcontrol.reportingcloud.ReportingCloud
-
Stores an uploaded template in the template storage (*.doc, *.docx, *.rtf and *.tx).
+
Stores an uploaded template in the template storage (.doc, .docx, + .rtf and .tx).
A C D G I L M R S T U V  diff --git a/index-files/index-12.html b/index-files/index-12.html index c05f91e..45e3a8e 100644 --- a/index-files/index-12.html +++ b/index-files/index-12.html @@ -2,7 +2,7 @@ - + V-Index @@ -74,9 +74,13 @@

V

validate(byte[]) - Static method in class txtextcontrol.reportingcloud.TemplateDataValidator
-
 
+
+
Checks if a template data buffer contains something.
+
validate(String) - Static method in class txtextcontrol.reportingcloud.TemplateNameValidator
-
 
+
+
Checks if a template name contains something.
+
valueOf(String) - Static method in enum txtextcontrol.reportingcloud.ImageFormat
Returns the enum constant of this type with the specified name.
diff --git a/index-files/index-2.html b/index-files/index-2.html index 28e1810..7bd1884 100644 --- a/index-files/index-2.html +++ b/index-files/index-2.html @@ -2,7 +2,7 @@ - + C-Index diff --git a/index-files/index-3.html b/index-files/index-3.html index 7d457ec..5ff8cb3 100644 --- a/index-files/index-3.html +++ b/index-files/index-3.html @@ -2,7 +2,7 @@ - + D-Index diff --git a/index-files/index-4.html b/index-files/index-4.html index 658392f..9fc7ab6 100644 --- a/index-files/index-4.html +++ b/index-files/index-4.html @@ -2,7 +2,7 @@ - + G-Index @@ -78,45 +78,85 @@

G

Gets the current user's account settings.
getAuthor() - Method in class txtextcontrol.reportingcloud.MergeSettings
-
 
+
+
Gets the document's author.
+
getCreatedDocuments() - Method in class txtextcontrol.reportingcloud.AccountSettings
-
 
+
+
Gets the number of created documents in the current month.
+
getCreatorApplication() - Method in class txtextcontrol.reportingcloud.MergeSettings
-
 
+
+
Gets the application which created the document.
+
getDocumentSubject() - Method in class txtextcontrol.reportingcloud.MergeSettings
-
 
+
+
Gets the document's subject.
+
getdocumentTitle() - Method in class txtextcontrol.reportingcloud.MergeSettings
-
 
+
+
Gets the document's title.
+
getMaxDocuments() - Method in class txtextcontrol.reportingcloud.AccountSettings
-
 
+
+
Gets the maximum number of documents that can be created per month.
+
getMaxTemplates() - Method in class txtextcontrol.reportingcloud.AccountSettings
-
 
+
+
Gets the maximum number of templates that can be uploaded to the template storage.
+
getMergeData() - Method in class txtextcontrol.reportingcloud.MergeBody
-
 
+
+
Gets the merge data.
+
getMergeSettings() - Method in class txtextcontrol.reportingcloud.MergeBody
-
 
+
+
Gets the merge settings to specify merge properties and document properties such + as title and author.
+
getModified() - Method in class txtextcontrol.reportingcloud.Template
-
 
+
+
Gets the date and time the template file was last modified
+
getRemoveEmptyBlocks() - Method in class txtextcontrol.reportingcloud.MergeSettings
-
 
+
+
Gets whether the content of empty merge blocks should be removed from the template + or not.
+
getRemoveEmptyFields() - Method in class txtextcontrol.reportingcloud.MergeSettings
-
 
+
+
Gets whether empty fields should be removed from the template or not.
+
getRemoveEmptyImages() - Method in class txtextcontrol.reportingcloud.MergeSettings
-
 
+
+
Gets whether images which don't have merge data should be removed from + the template or not.
+
getRemoveTrailingWhitespace() - Method in class txtextcontrol.reportingcloud.MergeSettings
-
 
+
+
Gets whether trailing whitespace should be removed before saving a document.
+
getSerialNumber() - Method in class txtextcontrol.reportingcloud.AccountSettings
-
 
+
+
Gets the serial number that is attached to the + account.
+
getSize() - Method in class txtextcontrol.reportingcloud.Template
-
 
+
+
Gets the size of the template file in bytes.
+
getTemplate() - Method in class txtextcontrol.reportingcloud.MergeBody
-
 
+
+
Gets the binary template document data.
+
getTemplateCount() - Method in class txtextcontrol.reportingcloud.ReportingCloud
Returns the number of templates in the template storage.
getTemplateName() - Method in class txtextcontrol.reportingcloud.Template
-
 
+
+
Gets the template file name.
+
getTemplatePageCount(String) - Method in class txtextcontrol.reportingcloud.ReportingCloud
Returns the number of pages of a template in the template storage.
@@ -138,11 +178,17 @@

G

Returns a list of thumbnails of a specific template.
getUploadedTemplates() - Method in class txtextcontrol.reportingcloud.AccountSettings
-
 
+
+
Gets the number of uploaded templates to the template storage.
+
getUserPassword() - Method in class txtextcontrol.reportingcloud.MergeSettings
-
 
+
+
Gets the password needed to open the document.
+
getValidUntil() - Method in class txtextcontrol.reportingcloud.AccountSettings
-
 
+
+
Gets the date until the current subscription is valid.
+
A C D G I L M R S T U V  diff --git a/index-files/index-5.html b/index-files/index-5.html index 16f0f45..d49041c 100644 --- a/index-files/index-5.html +++ b/index-files/index-5.html @@ -2,7 +2,7 @@ - + I-Index diff --git a/index-files/index-6.html b/index-files/index-6.html index 0bac1ad..cce5705 100644 --- a/index-files/index-6.html +++ b/index-files/index-6.html @@ -2,7 +2,7 @@ - + L-Index diff --git a/index-files/index-7.html b/index-files/index-7.html index fe2278d..483e8c5 100644 --- a/index-files/index-7.html +++ b/index-files/index-7.html @@ -2,7 +2,7 @@ - + M-Index diff --git a/index-files/index-8.html b/index-files/index-8.html index cf81059..ba75d4a 100644 --- a/index-files/index-8.html +++ b/index-files/index-8.html @@ -2,7 +2,7 @@ - + R-Index diff --git a/index-files/index-9.html b/index-files/index-9.html index c42a9d6..9f034cc 100644 --- a/index-files/index-9.html +++ b/index-files/index-9.html @@ -2,7 +2,7 @@ - + S-Index @@ -78,29 +78,56 @@

S

serialize(MergeSettings, Type, JsonSerializationContext) - Method in class txtextcontrol.reportingcloud.gson.MergeSettingsSerializer
 
setAuthor(String) - Method in class txtextcontrol.reportingcloud.MergeSettings
-
 
+
+
Sets the document's author.
+
setCreatorApplication(String) - Method in class txtextcontrol.reportingcloud.MergeSettings
-
 
+
+
Sets the application which created the document.
+
setDocumentSubject(String) - Method in class txtextcontrol.reportingcloud.MergeSettings
-
 
+
+
Sets the document's subject.
+
setDocumentTitle(String) - Method in class txtextcontrol.reportingcloud.MergeSettings
-
 
+
+
Sets the document's title.
+
setMergeData(List<Object>) - Method in class txtextcontrol.reportingcloud.MergeBody
-
 
+
+
Sets the merge data.
+
setMergeSettings(MergeSettings) - Method in class txtextcontrol.reportingcloud.MergeBody
-
 
+
+
Sets the merge settings to specify merge properties and document properties such + as title and author.
+
setRemoveEmptyBlocks(boolean) - Method in class txtextcontrol.reportingcloud.MergeSettings
-
 
+
+
Sets whether the content of empty merge blocks should be removed from the template + or not.
+
setRemoveEmptyFields(boolean) - Method in class txtextcontrol.reportingcloud.MergeSettings
-
 
+
+
Sets whether empty fields should be removed from the template or not.
+
setRemoveEmptyImages(boolean) - Method in class txtextcontrol.reportingcloud.MergeSettings
-
 
+
+
Sets whether images which don't have merge data should be removed from + the template or not.
+
setRemoveTrailingWhitespace(boolean) - Method in class txtextcontrol.reportingcloud.MergeSettings
-
 
+
+
Sets whether trailing whitespace should be removed before saving a document.
+
setTemplate(byte[]) - Method in class txtextcontrol.reportingcloud.MergeBody
-
 
+
+
Sets the binary template document data.
+
setUserPassword(String) - Method in class txtextcontrol.reportingcloud.MergeSettings
-
 
+
+
Sets the password needed to open the document.
+
A C D G I L M R S T U V  diff --git a/index.html b/index.html index b7bb95d..beb1021 100644 --- a/index.html +++ b/index.html @@ -2,7 +2,7 @@ - + Generated Documentation (Untitled) + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
com.textcontrol.reportingcloud
+

Class AccountSettings

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • com.textcontrol.reportingcloud.AccountSettings
      • +
    +
    • +
+
+
    +
  • +
    +
    +
    public class AccountSettings
+extends java.lang.Object
    +
    Represents ReportingCloud account settings.
    +
    +
    Author:
    +
    Thorsten Kummerow
    +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      AccountSettings(java.lang.String serialNumber, + int createdDocuments, + int uploadedTemplates, + int maxDocuments, + int maxTemplates, + java.lang.String validUntil) 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      intgetCreatedDocuments() +
      Gets the number of created documents in the current month.
      +
      intgetMaxDocuments() +
      Gets the maximum number of documents that can be created per month.
      +
      intgetMaxTemplates() +
      Gets the maximum number of templates that can be uploaded to the template storage.
      +
      java.lang.StringgetSerialNumber() +
      Gets the serial number that is attached to the + account.
      +
      intgetUploadedTemplates() +
      Gets the number of uploaded templates to the template storage.
      +
      java.time.LocalDateTimegetValidUntil() +
      Gets the date until the current subscription is valid.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        AccountSettings

        +
        public AccountSettings(java.lang.String serialNumber,
+                       int createdDocuments,
+                       int uploadedTemplates,
+                       int maxDocuments,
+                       int maxTemplates,
+                       java.lang.String validUntil)
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getSerialNumber

        +
        public java.lang.String getSerialNumber()
        +
        Gets the serial number that is attached to the + account. Possible values are "FREE", "TRIAL" and a 13 character long serial number.
        +
        +
        Returns:
        +
        The serial number.
        +
        +
        • +
      + + + +
        +
      • +

        getCreatedDocuments

        +
        public int getCreatedDocuments()
        +
        Gets the number of created documents in the current month.
        +
        +
        Returns:
        +
        The number of created documents.
        +
        +
        • +
      + + + +
        +
      • +

        getUploadedTemplates

        +
        public int getUploadedTemplates()
        +
        Gets the number of uploaded templates to the template storage.
        +
        +
        Returns:
        +
        The number of uploaded templates.
        +
        +
        • +
      + + + +
        +
      • +

        getMaxDocuments

        +
        public int getMaxDocuments()
        +
        Gets the maximum number of documents that can be created per month.
        +
        +
        Returns:
        +
        The maximum number of documents.
        +
        +
        • +
      + + + +
        +
      • +

        getMaxTemplates

        +
        public int getMaxTemplates()
        +
        Gets the maximum number of templates that can be uploaded to the template storage.
        +
        +
        Returns:
        +
        The maximum number of templates.
        +
        +
        • +
      + + + +
        +
      • +

        getValidUntil

        +
        public java.time.LocalDateTime getValidUntil()
        +
        Gets the date until the current subscription is valid. Can be nil.
        +
        +
        Returns:
        +
        The date until the current subscription is valid.
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/com/textcontrol/reportingcloud/ImageFormat.html b/com/textcontrol/reportingcloud/ImageFormat.html new file mode 100644 index 0000000..fab4a1d --- /dev/null +++ b/com/textcontrol/reportingcloud/ImageFormat.html @@ -0,0 +1,380 @@ + + + + + +ImageFormat + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
com.textcontrol.reportingcloud
+

Enum ImageFormat

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • java.lang.Enum<ImageFormat>
      • +
    • +
        +
      • com.textcontrol.reportingcloud.ImageFormat
        • +
      +
      • +
    +
    • +
+
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.io.Serializable, java.lang.Comparable<ImageFormat>
    +
    +
    +
    +
    public enum ImageFormat
+extends java.lang.Enum<ImageFormat>
    +
    This enum lists all possible image formats for the thumbnails
    +
    +
    Author:
    +
    Thorsten Kummerow
    +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Enum Constant Summary

      + + + + + + + + + + + + + + + + + +
      Enum Constants 
      Enum Constant and Description
      BMP +
      Windows Bitmap
      +
      GIF +
      Graphics Interchange Format
      +
      JPG +
      Joint Photographic Experts Group
      +
      PNG +
      Portable Network Graphics
      +
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + +
      All Methods Static Methods Concrete Methods 
      Modifier and TypeMethod and Description
      static ImageFormatvalueOf(java.lang.String name) +
      Returns the enum constant of this type with the specified name.
      +
      static ImageFormat[]values() +
      Returns an array containing the constants of this enum type, in +the order they are declared.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Enum

        +clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +getClass, notify, notifyAll, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Enum Constant Detail

      + + + +
        +
      • +

        JPG

        +
        public static final ImageFormat JPG
        +
        Joint Photographic Experts Group
        +
        • +
      + + + +
        +
      • +

        PNG

        +
        public static final ImageFormat PNG
        +
        Portable Network Graphics
        +
        • +
      + + + +
        +
      • +

        BMP

        +
        public static final ImageFormat BMP
        +
        Windows Bitmap
        +
        • +
      + + + +
        +
      • +

        GIF

        +
        public static final ImageFormat GIF
        +
        Graphics Interchange Format
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        values

        +
        public static ImageFormat[] values()
        +
        Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +
        +for (ImageFormat c : ImageFormat.values())
+    System.out.println(c);
+
        +
        +
        Returns:
        +
        an array containing the constants of this enum type, in the order they are declared
        +
        +
        • +
      + + + +
        +
      • +

        valueOf

        +
        public static ImageFormat valueOf(java.lang.String name)
        +
        Returns the enum constant of this type with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.)
        +
        +
        Parameters:
        +
        name - the name of the enum constant to be returned.
        +
        Returns:
        +
        the enum constant with the specified name
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        +
        java.lang.NullPointerException - if the argument is null
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/com/textcontrol/reportingcloud/MergeBody.html b/com/textcontrol/reportingcloud/MergeBody.html new file mode 100644 index 0000000..c4f3c0a --- /dev/null +++ b/com/textcontrol/reportingcloud/MergeBody.html @@ -0,0 +1,448 @@ + + + + + +MergeBody + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
com.textcontrol.reportingcloud
+

Class MergeBody

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • com.textcontrol.reportingcloud.MergeBody
      • +
    +
    • +
+
+
    +
  • +
    +
    +
    public class MergeBody
+extends java.lang.Object
    +
    Used to pass data to the merge method.
    +
    +
    Author:
    +
    Thorsten Kummerow
    +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + + + + + +
      Constructors 
      Constructor and Description
      MergeBody(java.util.List<java.lang.Object> mergeData) 
      MergeBody(java.util.List<java.lang.Object> mergeData, + MergeSettings mergeSettings) 
      MergeBody(java.util.List<java.lang.Object> mergeData, + MergeSettings mergeSettings, + byte[] template) 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      java.util.List<java.lang.Object>getMergeData() +
      Gets the merge data.
      +
      MergeSettingsgetMergeSettings() +
      Gets the merge settings to specify merge properties and document properties such + as title and author.
      +
      byte[]getTemplate() +
      Gets the binary template document data.
      +
      voidsetMergeData(java.util.List<java.lang.Object> mergeData) +
      Sets the merge data.
      +
      voidsetMergeSettings(MergeSettings mergeSettings) +
      Sets the merge settings to specify merge properties and document properties such + as title and author.
      +
      voidsetTemplate(byte[] template) +
      Sets the binary template document data.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        MergeBody

        +
        public MergeBody(java.util.List<java.lang.Object> mergeData)
+          throws java.security.InvalidParameterException
        +
        +
        Parameters:
        +
        mergeData - The merge data. Can be a list of HashMap objects or a list of objects + which can be serialized to JSON by GSON.
        +
        Throws:
        +
        java.security.InvalidParameterException
        +
        +
        • +
      + + + +
        +
      • +

        MergeBody

        +
        public MergeBody(java.util.List<java.lang.Object> mergeData,
+                 MergeSettings mergeSettings)
+          throws java.security.InvalidParameterException
        +
        +
        Parameters:
        +
        mergeData - The merge data. Can be a list of HashMap objects or + a list of objects which can be serialized to JSON by GSON.
        +
        mergeSettings - Merge settings to specify merge properties and document properties + such as title and author.
        +
        Throws:
        +
        java.security.InvalidParameterException
        +
        +
        • +
      + + + +
        +
      • +

        MergeBody

        +
        public MergeBody(java.util.List<java.lang.Object> mergeData,
+                 MergeSettings mergeSettings,
+                 byte[] template)
+          throws java.security.InvalidParameterException
        +
        +
        Parameters:
        +
        mergeData - The merge data. Can be a list of HashMap objects or + a list of objects which can be serialized to JSON by GSON.
        +
        mergeSettings - Merge settings to specify merge properties and document properties + such as title and author.
        +
        template - The binary template document data. Supported formats are .rtf, + .doc, .docx and .tx.
        +
        Throws:
        +
        java.security.InvalidParameterException
        +
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getTemplate

        +
        public byte[] getTemplate()
        +
        Gets the binary template document data. Supported formats are .rtf, .doc, + .docx and .tx.
        +
        +
        Returns:
        +
        The binary template document data.
        +
        +
        • +
      + + + +
        +
      • +

        setTemplate

        +
        public void setTemplate(byte[] template)
        +
        Sets the binary template document data. Supported formats are .rtf, .doc, + .docx and .tx.
        +
        +
        Parameters:
        +
        template - The binary template document data
        +
        +
        • +
      + + + +
        +
      • +

        getMergeSettings

        +
        public MergeSettings getMergeSettings()
        +
        Gets the merge settings to specify merge properties and document properties such + as title and author.
        +
        +
        Returns:
        +
        The merge settings.
        +
        +
        • +
      + + + +
        +
      • +

        setMergeSettings

        +
        public void setMergeSettings(MergeSettings mergeSettings)
        +
        Sets the merge settings to specify merge properties and document properties such + as title and author.
        +
        +
        Parameters:
        +
        mergeSettings - The merge settings.
        +
        +
        • +
      + + + +
        +
      • +

        getMergeData

        +
        public java.util.List<java.lang.Object> getMergeData()
        +
        Gets the merge data.
        +
        +
        Returns:
        +
        The merge data.
        +
        +
        • +
      + + + +
        +
      • +

        setMergeData

        +
        public void setMergeData(java.util.List<java.lang.Object> mergeData)
        +
        Sets the merge data. Can be a list of HashMap objects or a list of objects + which can be serialized to JSON by GSON.
        +
        +
        Parameters:
        +
        mergeData - The merge data.
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/com/textcontrol/reportingcloud/MergeSettings.html b/com/textcontrol/reportingcloud/MergeSettings.html new file mode 100644 index 0000000..47aa813 --- /dev/null +++ b/com/textcontrol/reportingcloud/MergeSettings.html @@ -0,0 +1,632 @@ + + + + + +MergeSettings + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
com.textcontrol.reportingcloud
+

Class MergeSettings

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • com.textcontrol.reportingcloud.MergeSettings
      • +
    +
    • +
+
+
    +
  • +
    +
    +
    public class MergeSettings
+extends java.lang.Object
    +
    Holds the merge settings needed by the merge method.
    +
    +
    Author:
    +
    Thorsten Kummerow
    +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      MergeSettings() 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      java.lang.StringgetAuthor() +
      Gets the document's author.
      +
      java.lang.StringgetCreatorApplication() +
      Gets the application which created the document.
      +
      java.lang.StringgetDocumentSubject() +
      Gets the document's subject.
      +
      java.lang.StringgetdocumentTitle() +
      Gets the document's title.
      +
      booleangetRemoveEmptyBlocks() +
      Gets whether the content of empty merge blocks should be removed from the template + or not.
      +
      booleangetRemoveEmptyFields() +
      Gets whether empty fields should be removed from the template or not.
      +
      booleangetRemoveEmptyImages() +
      Gets whether images which don't have merge data should be removed from + the template or not.
      +
      booleangetRemoveTrailingWhitespace() +
      Gets whether trailing whitespace should be removed before saving a document.
      +
      java.lang.StringgetUserPassword() +
      Gets the password needed to open the document.
      +
      voidsetAuthor(java.lang.String author) +
      Sets the document's author.
      +
      voidsetCreatorApplication(java.lang.String creatorApplication) +
      Sets the application which created the document.
      +
      voidsetDocumentSubject(java.lang.String documentSubject) +
      Sets the document's subject.
      +
      voidsetDocumentTitle(java.lang.String documentTitle) +
      Sets the document's title.
      +
      voidsetRemoveEmptyBlocks(boolean removeEmptyBlocks) +
      Sets whether the content of empty merge blocks should be removed from the template + or not.
      +
      voidsetRemoveEmptyFields(boolean removeEmptyFields) +
      Sets whether empty fields should be removed from the template or not.
      +
      voidsetRemoveEmptyImages(boolean removeEmptyImages) +
      Sets whether images which don't have merge data should be removed from + the template or not.
      +
      voidsetRemoveTrailingWhitespace(boolean removeTrailingWhitespace) +
      Sets whether trailing whitespace should be removed before saving a document.
      +
      voidsetUserPassword(java.lang.String userPassword) +
      Sets the password needed to open the document.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        MergeSettings

        +
        public MergeSettings()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getRemoveEmptyFields

        +
        public boolean getRemoveEmptyFields()
        +
        Gets whether empty fields should be removed from the template or not.
        +
        +
        Returns:
        +
        Empty fields should be removed.
        +
        +
        • +
      + + + +
        +
      • +

        setRemoveEmptyFields

        +
        public void setRemoveEmptyFields(boolean removeEmptyFields)
        +
        Sets whether empty fields should be removed from the template or not.
        +
        +
        Parameters:
        +
        removeEmptyFields - Empty fields should be removed or not.
        +
        +
        • +
      + + + +
        +
      • +

        getRemoveEmptyBlocks

        +
        public boolean getRemoveEmptyBlocks()
        +
        Gets whether the content of empty merge blocks should be removed from the template + or not.
        +
        +
        Returns:
        +
        The content of empty merge blocks should be removed.
        +
        +
        • +
      + + + +
        +
      • +

        setRemoveEmptyBlocks

        +
        public void setRemoveEmptyBlocks(boolean removeEmptyBlocks)
        +
        Sets whether the content of empty merge blocks should be removed from the template + or not.
        +
        +
        Parameters:
        +
        removeEmptyBlocks - The content of empty merge blocks should be removed + from the template or not.
        +
        +
        • +
      + + + +
        +
      • +

        getRemoveEmptyImages

        +
        public boolean getRemoveEmptyImages()
        +
        Gets whether images which don't have merge data should be removed from + the template or not.
        +
        +
        Returns:
        +
        The images which don't have merge data should be removed.
        +
        +
        • +
      + + + +
        +
      • +

        setRemoveEmptyImages

        +
        public void setRemoveEmptyImages(boolean removeEmptyImages)
        +
        Sets whether images which don't have merge data should be removed from + the template or not.
        +
        +
        Parameters:
        +
        removeEmptyImages - images which don't have merge data should be + removed from the template or not.
        +
        +
        • +
      + + + +
        +
      • +

        getRemoveTrailingWhitespace

        +
        public boolean getRemoveTrailingWhitespace()
        +
        Gets whether trailing whitespace should be removed before saving a document.
        +
        +
        Returns:
        +
        Trailing whitespace should be removed.
        +
        +
        • +
      + + + +
        +
      • +

        setRemoveTrailingWhitespace

        +
        public void setRemoveTrailingWhitespace(boolean removeTrailingWhitespace)
        +
        Sets whether trailing whitespace should be removed before saving a document.
        +
        +
        Parameters:
        +
        removeTrailingWhitespace - trailing whitespace should be removed before + saving a document.
        +
        +
        • +
      + + + +
        +
      • +

        getAuthor

        +
        public java.lang.String getAuthor()
        +
        Gets the document's author.
        +
        +
        Returns:
        +
        The document's author.
        +
        +
        • +
      + + + +
        +
      • +

        setAuthor

        +
        public void setAuthor(java.lang.String author)
        +
        Sets the document's author.
        +
        +
        Parameters:
        +
        author - The document's author.
        +
        +
        • +
      + + + +
        +
      • +

        getCreatorApplication

        +
        public java.lang.String getCreatorApplication()
        +
        Gets the application which created the document.
        +
        +
        Returns:
        +
        The application which created the document.
        +
        +
        • +
      + + + +
        +
      • +

        setCreatorApplication

        +
        public void setCreatorApplication(java.lang.String creatorApplication)
        +
        Sets the application which created the document.
        +
        +
        Parameters:
        +
        creatorApplication - The application which created the document.
        +
        +
        • +
      + + + +
        +
      • +

        getDocumentSubject

        +
        public java.lang.String getDocumentSubject()
        +
        Gets the document's subject.
        +
        +
        Returns:
        +
        The document's subject.
        +
        +
        • +
      + + + +
        +
      • +

        setDocumentSubject

        +
        public void setDocumentSubject(java.lang.String documentSubject)
        +
        Sets the document's subject.
        +
        +
        Parameters:
        +
        documentSubject - The document's subject.
        +
        +
        • +
      + + + +
        +
      • +

        getdocumentTitle

        +
        public java.lang.String getdocumentTitle()
        +
        Gets the document's title.
        +
        +
        Returns:
        +
        The document's title.
        +
        +
        • +
      + + + +
        +
      • +

        setDocumentTitle

        +
        public void setDocumentTitle(java.lang.String documentTitle)
        +
        Sets the document's title.
        +
        +
        Parameters:
        +
        documentTitle - The document's title.
        +
        +
        • +
      + + + +
        +
      • +

        getUserPassword

        +
        public java.lang.String getUserPassword()
        +
        Gets the password needed to open the document.
        +
        +
        Returns:
        +
        The password needed to open the document.
        +
        +
        • +
      + + + +
        +
      • +

        setUserPassword

        +
        public void setUserPassword(java.lang.String userPassword)
        +
        Sets the password needed to open the document.
        +
        +
        Parameters:
        +
        userPassword - The password needed to open the document.
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/com/textcontrol/reportingcloud/ReportingCloud.html b/com/textcontrol/reportingcloud/ReportingCloud.html new file mode 100644 index 0000000..26979d4 --- /dev/null +++ b/com/textcontrol/reportingcloud/ReportingCloud.html @@ -0,0 +1,826 @@ + + + + + +ReportingCloud + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
com.textcontrol.reportingcloud
+

Class ReportingCloud

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • com.textcontrol.reportingcloud.ReportingCloud
      • +
    +
    • +
+
+
    +
  • +
    +
    +
    public class ReportingCloud
+extends java.lang.Object
    +
    The ReportingCloud API wrapper class.
    +
    +
    Author:
    +
    Thorsten Kummerow
    +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + + +
      Constructors 
      Constructor and Description
      ReportingCloud(java.lang.String username, + java.lang.String password) +
      Creates a new ReportingCloud wrapper instance with the API base URL + set to "http://api.reporting.cloud".
      +
      ReportingCloud(java.lang.String username, + java.lang.String password, + java.lang.String baseUrl) +
      Creates a new ReportingCloud wrapper instance.
      +
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      byte[]convertDocument(byte[] templateData, + ReturnFormat returnFormat) +
      Converts a document to another format.
      +
      voiddeleteTemplate(java.lang.String templateName) +
      Deletes a template from the template storage.
      +
      byte[]downloadTemplate(java.lang.String templateName) +
      Returns the selected template from the storage.
      +
      AccountSettingsgetAccountSettings() +
      Gets the current user's account settings.
      +
      intgetTemplateCount() +
      Returns the number of templates in the template storage.
      +
      intgetTemplatePageCount(java.lang.String templateName) +
      Returns the number of pages of a template in the template storage.
      +
      java.util.List<byte[]>getTemplateThumbnails(java.lang.String templateName, + int zoomFactor) +
      Returns a list of thumbnails of a specific template.
      +
      java.util.List<byte[]>getTemplateThumbnails(java.lang.String templateName, + int zoomFactor, + int fromPage) +
      Returns a list of thumbnails of a specific template.
      +
      java.util.List<byte[]>getTemplateThumbnails(java.lang.String templateName, + int zoomFactor, + int fromPage, + int toPage) +
      Returns a list of thumbnails of a specific template.
      +
      java.util.List<byte[]>getTemplateThumbnails(java.lang.String templateName, + int zoomFactor, + int fromPage, + int toPage, + ImageFormat imageFormat) +
      Returns a list of thumbnails of a specific template.
      +
      java.util.List<Template>listTemplates() +
      Lists all templates from the template storage.
      +
      java.util.List<byte[]>mergeDocument(MergeBody mergeBody) +
      Merges and returns a template from the template storage or an uploaded template with JSON data.
      +
      java.util.List<byte[]>mergeDocument(MergeBody mergeBody, + java.lang.String templateName) +
      Merges and returns a template from the template storage or an uploaded template with JSON data.
      +
      java.util.List<byte[]>mergeDocument(MergeBody mergeBody, + java.lang.String templateName, + ReturnFormat returnFormat) +
      Merges and returns a template from the template storage or an uploaded template with JSON data.
      +
      java.util.List<byte[]>mergeDocument(MergeBody mergeBody, + java.lang.String templateName, + ReturnFormat returnFormat, + boolean append) +
      Merges and returns a template from the template storage or an uploaded template with JSON data.
      +
      booleantemplateExists(java.lang.String templateName) +
      Checks whether a template exists in the template storage.
      +
      voiduploadTemplate(java.lang.String templateName, + byte[] templateData) +
      Stores an uploaded template in the template storage (.doc, .docx, + .rtf and .tx).
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        ReportingCloud

        +
        public ReportingCloud(java.lang.String username,
+                      java.lang.String password,
+                      java.lang.String baseUrl)
        +
        Creates a new ReportingCloud wrapper instance.
        +
        +
        Parameters:
        +
        username - The username.
        +
        password - The password.
        +
        baseUrl - The API base URL.
        +
        +
        • +
      + + + +
        +
      • +

        ReportingCloud

        +
        public ReportingCloud(java.lang.String username,
+                      java.lang.String password)
        +
        Creates a new ReportingCloud wrapper instance with the API base URL + set to "http://api.reporting.cloud".
        +
        +
        Parameters:
        +
        username - The username.
        +
        password - The password.
        +
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getTemplateCount

        +
        public int getTemplateCount()
+                     throws java.lang.IllegalArgumentException,
+                            java.io.IOException
        +
        Returns the number of templates in the template storage.
        +
        +
        Returns:
        +
        The number of templates in the template storage.
        +
        Throws:
        +
        java.io.IOException - If an I/O error occurs.
        +
        java.lang.IllegalArgumentException - If something went wrong concerning the HTTP request.
        +
        +
        • +
      + + + +
        +
      • +

        getAccountSettings

        +
        public AccountSettings getAccountSettings()
+                                   throws java.lang.IllegalArgumentException,
+                                          java.io.IOException
        +
        Gets the current user's account settings.
        +
        +
        Returns:
        +
        The account settings.
        +
        Throws:
        +
        java.io.IOException - If an I/O error occurs.
        +
        java.lang.IllegalArgumentException - If something went wrong concerning the HTTP request.
        +
        +
        • +
      + + + +
        +
      • +

        listTemplates

        +
        public java.util.List<Template> listTemplates()
+                                       throws java.lang.IllegalArgumentException,
+                                              java.io.IOException
        +
        Lists all templates from the template storage.
        +
        +
        Returns:
        +
        A list of Template objects.
        +
        Throws:
        +
        java.lang.IllegalArgumentException - If something went wrong concerning the HTTP request.
        +
        java.io.IOException - If an I/O error occurs.
        +
        +
        • +
      + + + +
        +
      • +

        getTemplatePageCount

        +
        public int getTemplatePageCount(java.lang.String templateName)
+                         throws java.lang.IllegalArgumentException,
+                                java.io.IOException
        +
        Returns the number of pages of a template in the template storage.
        +
        +
        Parameters:
        +
        templateName - The filename of the template in the template + storage to retrieve the number of pages for.
        +
        Returns:
        +
        The number of pages in the template.
        +
        Throws:
        +
        java.io.IOException - If an I/O error occurs.
        +
        java.lang.IllegalArgumentException - If something went wrong concerning the HTTP request.
        +
        +
        • +
      + + + +
        +
      • +

        getTemplateThumbnails

        +
        public java.util.List<byte[]> getTemplateThumbnails(java.lang.String templateName,
+                                                    int zoomFactor)
+                                             throws java.lang.IllegalArgumentException,
+                                                    java.io.IOException
        +
        Returns a list of thumbnails of a specific template.
        +
        +
        Parameters:
        +
        templateName - The filename of the template in the template storage.
        +
        zoomFactor - An Integer value between 1 and 400 to set the percentage + zoom factor of the created thumbnail images.
        +
        Returns:
        +
        An array of binary image data.
        +
        Throws:
        +
        java.lang.IllegalArgumentException - If something went wrong concerning the HTTP request.
        +
        java.io.IOException - If an I/O error occurs.
        +
        +
        • +
      + + + +
        +
      • +

        getTemplateThumbnails

        +
        public java.util.List<byte[]> getTemplateThumbnails(java.lang.String templateName,
+                                                    int zoomFactor,
+                                                    int fromPage)
+                                             throws java.lang.IllegalArgumentException,
+                                                    java.io.IOException
        +
        Returns a list of thumbnails of a specific template.
        +
        +
        Parameters:
        +
        templateName - The filename of the template in the template storage.
        +
        zoomFactor - An Integer value between 1 and 400 to set the percentage + zoom factor of the created thumbnail images.
        +
        fromPage - An Integer value that specifies the first page.
        +
        Returns:
        +
        An array of binary image data.
        +
        Throws:
        +
        java.lang.IllegalArgumentException - If something went wrong concerning the HTTP request.
        +
        java.io.IOException - If an I/O error occurs.
        +
        +
        • +
      + + + +
        +
      • +

        getTemplateThumbnails

        +
        public java.util.List<byte[]> getTemplateThumbnails(java.lang.String templateName,
+                                                    int zoomFactor,
+                                                    int fromPage,
+                                                    int toPage)
+                                             throws java.lang.IllegalArgumentException,
+                                                    java.io.IOException
        +
        Returns a list of thumbnails of a specific template.
        +
        +
        Parameters:
        +
        templateName - The filename of the template in the template storage.
        +
        zoomFactor - An Integer value between 1 and 400 to set the percentage + zoom factor of the created thumbnail images.
        +
        fromPage - An Integer value that specifies the first page.
        +
        toPage - An Integer value that specifies the last page.
        +
        Returns:
        +
        An array of binary image data.
        +
        Throws:
        +
        java.lang.IllegalArgumentException - If something went wrong concerning the HTTP request.
        +
        java.io.IOException - If an I/O error occurs.
        +
        +
        • +
      + + + +
        +
      • +

        getTemplateThumbnails

        +
        public java.util.List<byte[]> getTemplateThumbnails(java.lang.String templateName,
+                                                    int zoomFactor,
+                                                    int fromPage,
+                                                    int toPage,
+                                                    ImageFormat imageFormat)
+                                             throws java.lang.IllegalArgumentException,
+                                                    java.io.IOException
        +
        Returns a list of thumbnails of a specific template.
        +
        +
        Parameters:
        +
        templateName - The filename of the template in the template storage.
        +
        zoomFactor - An Integer value between 1 and 400 to set the percentage + zoom factor of the created thumbnail images.
        +
        fromPage - An Integer value that specifies the first page.
        +
        toPage - An Integer value that specifies the last page.
        +
        imageFormat - Defines the image format of the returned thumbnails.
        +
        Returns:
        +
        An array of binary image data.
        +
        Throws:
        +
        java.lang.IllegalArgumentException - If something went wrong concerning the HTTP request.
        +
        java.io.IOException - If an I/O error occurs.
        +
        +
        • +
      + + + +
        +
      • +

        uploadTemplate

        +
        public void uploadTemplate(java.lang.String templateName,
+                           byte[] templateData)
+                    throws java.lang.IllegalArgumentException,
+                           java.io.IOException
        +
        Stores an uploaded template in the template storage (.doc, .docx, + .rtf and .tx).
        +
        +
        Parameters:
        +
        templateName - The filename of the template in the template storage. Existing + files with the same filename will be overwritten.
        +
        templateData - Binary document data. The supported formats are .doc, + .docx, .rtf and .tx.
        +
        Throws:
        +
        java.lang.IllegalArgumentException - If something went wrong concerning the HTTP request.
        +
        java.io.IOException - If an I/O error occurs.
        +
        +
        • +
      + + + +
        +
      • +

        templateExists

        +
        public boolean templateExists(java.lang.String templateName)
+                       throws java.lang.IllegalArgumentException,
+                              java.io.IOException
        +
        Checks whether a template exists in the template storage.
        +
        +
        Parameters:
        +
        templateName - The filename of the template to be checked for + availability in the template storage.
        +
        Returns:
        +
        Returns if the template with the given name exists in the template + storage.
        +
        Throws:
        +
        java.lang.IllegalArgumentException - If something went wrong concerning the HTTP request.
        +
        java.io.IOException - If an I/O error occurs.
        +
        +
        • +
      + + + +
        +
      • +

        downloadTemplate

        +
        public byte[] downloadTemplate(java.lang.String templateName)
+                        throws java.lang.IllegalArgumentException,
+                               java.io.IOException
        +
        Returns the selected template from the storage.
        +
        +
        Parameters:
        +
        templateName - The filename of the template in the template storage.
        +
        Returns:
        +
        The template document data.
        +
        Throws:
        +
        java.io.IOException - If an I/O error occurs.
        +
        java.lang.IllegalArgumentException - If something went wrong concerning the HTTP request.
        +
        +
        • +
      + + + +
        +
      • +

        deleteTemplate

        +
        public void deleteTemplate(java.lang.String templateName)
+                    throws java.lang.IllegalArgumentException,
+                           java.io.IOException
        +
        Deletes a template from the template storage.
        +
        +
        Parameters:
        +
        templateName - The filename of the template to be deleted + from the template storage.
        +
        Throws:
        +
        java.lang.IllegalArgumentException - If something went wrong concerning the HTTP request.
        +
        java.io.IOException - If an I/O error occurs.
        +
        +
        • +
      + + + +
        +
      • +

        convertDocument

        +
        public byte[] convertDocument(byte[] templateData,
+                              ReturnFormat returnFormat)
+                       throws java.lang.IllegalArgumentException,
+                              java.io.IOException
        +
        Converts a document to another format.
        +
        +
        Parameters:
        +
        templateData - The source document encoded as a Base64 string. + The supported document formats are .rtf, .doc, + .docx, .html, .pdf and .tx.
        +
        returnFormat - The format of the created document.
        +
        Returns:
        +
        The created document encoded as a Base64 string.
        +
        Throws:
        +
        java.lang.IllegalArgumentException - If something went wrong concerning the HTTP request.
        +
        java.io.IOException - If an I/O error occurs.
        +
        +
        • +
      + + + +
        +
      • +

        mergeDocument

        +
        public java.util.List<byte[]> mergeDocument(MergeBody mergeBody)
+                                     throws java.lang.IllegalArgumentException,
+                                            java.io.IOException
        +
        Merges and returns a template from the template storage or an uploaded template with JSON data.
        +
        +
        Parameters:
        +
        mergeBody - The MergeBody object contains the data source + as a JSON data object and optionally, a template encoded as a Base64 string.
        +
        Returns:
        +
        The response body contains an array of the created documents.
        +
        Throws:
        +
        java.lang.IllegalArgumentException - If something went wrong concerning the HTTP request.
        +
        java.io.IOException - If an I/O error occurs.
        +
        +
        • +
      + + + +
        +
      • +

        mergeDocument

        +
        public java.util.List<byte[]> mergeDocument(MergeBody mergeBody,
+                                            java.lang.String templateName)
+                                     throws java.lang.IllegalArgumentException,
+                                            java.io.IOException
        +
        Merges and returns a template from the template storage or an uploaded template with JSON data.
        +
        +
        Parameters:
        +
        mergeBody - The MergeBody object contains the data source + as a JSON data object and optionally, a template encoded as a Base64 string.
        +
        templateName - The name of the template in the template storage. If no template + name is specified, the template must be uploaded in the MergeBody + object of this request.
        +
        Returns:
        +
        The response body contains an array of the created documents.
        +
        Throws:
        +
        java.lang.IllegalArgumentException - If something went wrong concerning the HTTP request.
        +
        java.io.IOException - If an I/O error occurs.
        +
        +
        • +
      + + + +
        +
      • +

        mergeDocument

        +
        public java.util.List<byte[]> mergeDocument(MergeBody mergeBody,
+                                            java.lang.String templateName,
+                                            ReturnFormat returnFormat)
+                                     throws java.lang.IllegalArgumentException,
+                                            java.io.IOException
        +
        Merges and returns a template from the template storage or an uploaded template with JSON data.
        +
        +
        Parameters:
        +
        mergeBody - The MergeBody object contains the data source + as a JSON data object and optionally, a template encoded as a Base64 string.
        +
        templateName - The name of the template in the template storage. If no template + name is specified, the template must be uploaded in the MergeBody + object of this request.
        +
        returnFormat - The format of the created document.
        +
        Returns:
        +
        The response body contains an array of the created documents.
        +
        Throws:
        +
        java.lang.IllegalArgumentException - If something went wrong concerning the HTTP request.
        +
        java.io.IOException - If an I/O error occurs.
        +
        +
        • +
      + + + +
        +
      • +

        mergeDocument

        +
        public java.util.List<byte[]> mergeDocument(MergeBody mergeBody,
+                                            java.lang.String templateName,
+                                            ReturnFormat returnFormat,
+                                            boolean append)
+                                     throws java.lang.IllegalArgumentException,
+                                            java.io.IOException
        +
        Merges and returns a template from the template storage or an uploaded template with JSON data.
        +
        +
        Parameters:
        +
        mergeBody - The MergeBody object contains the data source + as a JSON data object and optionally, a template encoded as a Base64 string.
        +
        templateName - The name of the template in the template storage. If no template + name is specified, the template must be uploaded in the MergeBody + object of this request.
        +
        returnFormat - The format of the created document.
        +
        append - Specifies whether the documents should be appended to one resulting + document when more than 1 data row is passed.
        +
        Returns:
        +
        The response body contains an array of the created documents.
        +
        Throws:
        +
        java.lang.IllegalArgumentException - If something went wrong concerning the HTTP request.
        +
        java.io.IOException - If an I/O error occurs.
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/com/textcontrol/reportingcloud/ReportingCloudTest.MasterItem.html b/com/textcontrol/reportingcloud/ReportingCloudTest.MasterItem.html new file mode 100644 index 0000000..3839826 --- /dev/null +++ b/com/textcontrol/reportingcloud/ReportingCloudTest.MasterItem.html @@ -0,0 +1,303 @@ + + + + + +ReportingCloudTest.MasterItem + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
com.textcontrol.reportingcloud
+

Class ReportingCloudTest.MasterItem

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • com.textcontrol.reportingcloud.ReportingCloudTest.MasterItem
      • +
    +
    • +
+
+
    +
  • +
    +
    Enclosing class:
    +
    ReportingCloudTest
    +
    +
    +
    +
    public class ReportingCloudTest.MasterItem
+extends java.lang.Object
    +
    • +
+
+
+
    +
  • + + + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      MasterItem(java.lang.String recipient_name, + java.lang.String billto_name) 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + + + + + +
        +
      • +

        recipient_name

        +
        public java.lang.String recipient_name
        +
        • +
      + + + +
        +
      • +

        billto_name

        +
        public java.lang.String billto_name
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        MasterItem

        +
        public MasterItem(java.lang.String recipient_name,
+                  java.lang.String billto_name)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/com/textcontrol/reportingcloud/ReportingCloudTest.NestedItem.html b/com/textcontrol/reportingcloud/ReportingCloudTest.NestedItem.html new file mode 100644 index 0000000..86c2d12 --- /dev/null +++ b/com/textcontrol/reportingcloud/ReportingCloudTest.NestedItem.html @@ -0,0 +1,305 @@ + + + + + +ReportingCloudTest.NestedItem + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
com.textcontrol.reportingcloud
+

Class ReportingCloudTest.NestedItem

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • com.textcontrol.reportingcloud.ReportingCloudTest.NestedItem
      • +
    +
    • +
+
+
    +
  • +
    +
    Enclosing class:
    +
    ReportingCloudTest
    +
    +
    +
    +
    public class ReportingCloudTest.NestedItem
+extends java.lang.Object
    +
    • +
+
+
+
    +
  • + + + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      NestedItem(int item_no, + java.lang.String item_description, + double item_total) 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        item_no

        +
        public int item_no
        +
        • +
      + + + +
        +
      • +

        item_description

        +
        public java.lang.String item_description
        +
        • +
      + + + +
        +
      • +

        item_total

        +
        public double item_total
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        NestedItem

        +
        public NestedItem(int item_no,
+                  java.lang.String item_description,
+                  double item_total)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/com/textcontrol/reportingcloud/ReportingCloudTest.html b/com/textcontrol/reportingcloud/ReportingCloudTest.html new file mode 100644 index 0000000..ff9e928 --- /dev/null +++ b/com/textcontrol/reportingcloud/ReportingCloudTest.html @@ -0,0 +1,505 @@ + + + + + +ReportingCloudTest + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
com.textcontrol.reportingcloud
+

Class ReportingCloudTest

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • com.textcontrol.reportingcloud.ReportingCloudTest
      • +
    +
    • +
+
+
    +
  • +
    +
    +
    public class ReportingCloudTest
+extends java.lang.Object
    +
    The ReportingCloud test class.
    +
    +
    Author:
    +
    Thorsten Kummerow
    +
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        ReportingCloudTest

        +
        public ReportingCloudTest()
+                   throws java.io.IOException
        +
        +
        Throws:
        +
        java.io.IOException
        +
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        initialize

        +
        public void initialize()
+                throws java.io.IOException
        +
        +
        Throws:
        +
        java.io.IOException
        +
        +
        • +
      + + + +
        +
      • +

        getTemplateCount

        +
        public void getTemplateCount()
+                      throws java.lang.Exception
        +
        +
        Throws:
        +
        java.lang.Exception
        +
        +
        • +
      + + + +
        +
      • +

        getTemplatePageCount

        +
        public void getTemplatePageCount()
+                          throws java.lang.Exception
        +
        +
        Throws:
        +
        java.lang.Exception
        +
        +
        • +
      + + + +
        +
      • +

        listTemplates

        +
        public void listTemplates()
+                   throws java.lang.Exception
        +
        +
        Throws:
        +
        java.lang.Exception
        +
        +
        • +
      + + + +
        +
      • +

        convertDocument

        +
        public void convertDocument()
+                     throws java.lang.Exception
        +
        +
        Throws:
        +
        java.lang.Exception
        +
        +
        • +
      + + + +
        +
      • +

        getAccountSettings

        +
        public void getAccountSettings()
+                        throws java.lang.Exception
        +
        +
        Throws:
        +
        java.lang.Exception
        +
        +
        • +
      + + + +
        +
      • +

        mergeDocument

        +
        public void mergeDocument()
+                   throws java.lang.Exception
        +
        +
        Throws:
        +
        java.lang.Exception
        +
        +
        • +
      + + + +
        +
      • +

        uploadTemplate

        +
        public void uploadTemplate()
+                    throws java.lang.Exception
        +
        +
        Throws:
        +
        java.lang.Exception
        +
        +
        • +
      + + + +
        +
      • +

        templateExists

        +
        public void templateExists()
+                    throws java.lang.Exception
        +
        +
        Throws:
        +
        java.lang.Exception
        +
        +
        • +
      + + + +
        +
      • +

        downloadTemplate

        +
        public void downloadTemplate()
+                      throws java.lang.Exception
        +
        +
        Throws:
        +
        java.lang.Exception
        +
        +
        • +
      + + + +
        +
      • +

        getTemplateThumbnails

        +
        public void getTemplateThumbnails()
+                           throws java.lang.Exception
        +
        +
        Throws:
        +
        java.lang.Exception
        +
        +
        • +
      + + + +
        +
      • +

        deleteTemplate

        +
        public void deleteTemplate()
+                    throws java.lang.Exception
        +
        +
        Throws:
        +
        java.lang.Exception
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/com/textcontrol/reportingcloud/ReturnFormat.html b/com/textcontrol/reportingcloud/ReturnFormat.html new file mode 100644 index 0000000..d220182 --- /dev/null +++ b/com/textcontrol/reportingcloud/ReturnFormat.html @@ -0,0 +1,425 @@ + + + + + +ReturnFormat + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
com.textcontrol.reportingcloud
+

Enum ReturnFormat

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • java.lang.Enum<ReturnFormat>
      • +
    • +
        +
      • com.textcontrol.reportingcloud.ReturnFormat
        • +
      +
      • +
    +
    • +
+
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.io.Serializable, java.lang.Comparable<ReturnFormat>
    +
    +
    +
    +
    public enum ReturnFormat
+extends java.lang.Enum<ReturnFormat>
    +
    This enum lists all possible return formats for the Merge method.
    +
    +
    Author:
    +
    Thorsten Kummerow
    +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Enum Constant Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Enum Constants 
      Enum Constant and Description
      DOC +
      Microsoft Word 97-2003
      +
      DOCX +
      Microsoft Office Open XML
      +
      HMTL +
      Hypertext Markup Language
      +
      PDF +
      Adobe PDF
      +
      PDFA +
      Adobe PDF/A
      +
      RTF +
      Rich Text Format
      +
      TX +
      TX Text Control Internal Format
      +
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + +
      All Methods Static Methods Concrete Methods 
      Modifier and TypeMethod and Description
      static ReturnFormatvalueOf(java.lang.String name) +
      Returns the enum constant of this type with the specified name.
      +
      static ReturnFormat[]values() +
      Returns an array containing the constants of this enum type, in +the order they are declared.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Enum

        +clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +getClass, notify, notifyAll, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Enum Constant Detail

      + + + +
        +
      • +

        PDF

        +
        public static final ReturnFormat PDF
        +
        Adobe PDF
        +
        • +
      + + + +
        +
      • +

        PDFA

        +
        public static final ReturnFormat PDFA
        +
        Adobe PDF/A
        +
        • +
      + + + +
        +
      • +

        DOC

        +
        public static final ReturnFormat DOC
        +
        Microsoft Word 97-2003
        +
        • +
      + + + +
        +
      • +

        DOCX

        +
        public static final ReturnFormat DOCX
        +
        Microsoft Office Open XML
        +
        • +
      + + + +
        +
      • +

        RTF

        +
        public static final ReturnFormat RTF
        +
        Rich Text Format
        +
        • +
      + + + +
        +
      • +

        TX

        +
        public static final ReturnFormat TX
        +
        TX Text Control Internal Format
        +
        • +
      + + + +
        +
      • +

        HMTL

        +
        public static final ReturnFormat HMTL
        +
        Hypertext Markup Language
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        values

        +
        public static ReturnFormat[] values()
        +
        Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +
        +for (ReturnFormat c : ReturnFormat.values())
+    System.out.println(c);
+
        +
        +
        Returns:
        +
        an array containing the constants of this enum type, in the order they are declared
        +
        +
        • +
      + + + +
        +
      • +

        valueOf

        +
        public static ReturnFormat valueOf(java.lang.String name)
        +
        Returns the enum constant of this type with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.)
        +
        +
        Parameters:
        +
        name - the name of the enum constant to be returned.
        +
        Returns:
        +
        the enum constant with the specified name
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        +
        java.lang.NullPointerException - if the argument is null
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/com/textcontrol/reportingcloud/Template.html b/com/textcontrol/reportingcloud/Template.html new file mode 100644 index 0000000..b6e5dce --- /dev/null +++ b/com/textcontrol/reportingcloud/Template.html @@ -0,0 +1,335 @@ + + + + + +Template + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
com.textcontrol.reportingcloud
+

Class Template

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • com.textcontrol.reportingcloud.Template
      • +
    +
    • +
+
+
    +
  • +
    +
    +
    public class Template
+extends java.lang.Object
    +
    Holds information about a template in the template storage.
    +
    +
    Author:
    +
    Thorsten Kummerow
    +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      Template(java.lang.String templateName, + java.lang.String modified, + int size) +
      Creates a new Template instance.
      +
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      java.time.LocalDateTimegetModified() +
      Gets the date and time the template file was last modified
      +
      intgetSize() +
      Gets the size of the template file in bytes.
      +
      java.lang.StringgetTemplateName() +
      Gets the template file name.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        Template

        +
        public Template(java.lang.String templateName,
+                java.lang.String modified,
+                int size)
        +
        Creates a new Template instance.
        +
        +
        Parameters:
        +
        templateName - The template file name.
        +
        modified - The date and time the template file was last modified (ISO 8601 date and + time string).
        +
        size - The size of the template file in bytes.
        +
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getTemplateName

        +
        public java.lang.String getTemplateName()
        +
        Gets the template file name.
        +
        +
        Returns:
        +
        The template file name.
        +
        +
        • +
      + + + +
        +
      • +

        getModified

        +
        public java.time.LocalDateTime getModified()
        +
        Gets the date and time the template file was last modified
        +
        +
        Returns:
        +
        The modification date.
        +
        +
        • +
      + + + +
        +
      • +

        getSize

        +
        public int getSize()
        +
        Gets the size of the template file in bytes.
        +
        +
        Returns:
        +
        The template size.
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/com/textcontrol/reportingcloud/TemplateDataValidator.html b/com/textcontrol/reportingcloud/TemplateDataValidator.html new file mode 100644 index 0000000..c1b91b5 --- /dev/null +++ b/com/textcontrol/reportingcloud/TemplateDataValidator.html @@ -0,0 +1,281 @@ + + + + + +TemplateDataValidator + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
com.textcontrol.reportingcloud
+

Class TemplateDataValidator

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • com.textcontrol.reportingcloud.TemplateDataValidator
      • +
    +
    • +
+
+
    +
  • +
    +
    +
    public class TemplateDataValidator
+extends java.lang.Object
    +
    Internal method parameter validator class.
    +
    +
    Author:
    +
    Thorsten Kummerow
    +
    +
    • +
+
+
+
    +
  • + + + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + +
      All Methods Static Methods Concrete Methods 
      Modifier and TypeMethod and Description
      static voidvalidate(byte[] templateData) +
      Checks if a template data buffer contains something.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        TemplateDataValidator

        +
        public TemplateDataValidator()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        validate

        +
        public static void validate(byte[] templateData)
        +
        Checks if a template data buffer contains something. Throws an exception if not.
        +
        +
        Parameters:
        +
        templateData - Template data.
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/com/textcontrol/reportingcloud/TemplateNameValidator.html b/com/textcontrol/reportingcloud/TemplateNameValidator.html new file mode 100644 index 0000000..e47d7b5 --- /dev/null +++ b/com/textcontrol/reportingcloud/TemplateNameValidator.html @@ -0,0 +1,284 @@ + + + + + +TemplateNameValidator + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
com.textcontrol.reportingcloud
+

Class TemplateNameValidator

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • com.textcontrol.reportingcloud.TemplateNameValidator
      • +
    +
    • +
+
+
    +
  • +
    +
    +
    public class TemplateNameValidator
+extends java.lang.Object
    +
    Internal method parameter validator class.
    +
    +
    Author:
    +
    Thorsten Kummerow
    +
    +
    • +
+
+
+
    +
  • + + + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + +
      All Methods Static Methods Concrete Methods 
      Modifier and TypeMethod and Description
      static voidvalidate(java.lang.String templateName) +
      Checks if a template name contains something.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        TemplateNameValidator

        +
        public TemplateNameValidator()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        validate

        +
        public static void validate(java.lang.String templateName)
+                     throws java.security.InvalidParameterException
        +
        Checks if a template name contains something. Throws an exception if not.
        +
        +
        Parameters:
        +
        templateName - The Template name.
        +
        Throws:
        +
        java.security.InvalidParameterException
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/com/textcontrol/reportingcloud/gson/AccountSettingsDeserializer.html b/com/textcontrol/reportingcloud/gson/AccountSettingsDeserializer.html new file mode 100644 index 0000000..2fc1be8 --- /dev/null +++ b/com/textcontrol/reportingcloud/gson/AccountSettingsDeserializer.html @@ -0,0 +1,290 @@ + + + + + +AccountSettingsDeserializer + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
com.textcontrol.reportingcloud.gson
+

Class AccountSettingsDeserializer

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • com.textcontrol.reportingcloud.gson.AccountSettingsDeserializer
      • +
    +
    • +
+
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    com.google.gson.JsonDeserializer<AccountSettings>
    +
    +
    +
    +
    public class AccountSettingsDeserializer
+extends java.lang.Object
+implements com.google.gson.JsonDeserializer<AccountSettings>
    +
    Needed by GSON to create AccountSettings objects from JSON data.
    +
    +
    Author:
    +
    Thorsten Kummerow
    +
    +
    • +
+
+
+
    +
  • + + + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      AccountSettingsdeserialize(com.google.gson.JsonElement json, + java.lang.reflect.Type typeOfT, + com.google.gson.JsonDeserializationContext context) 
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        AccountSettingsDeserializer

        +
        public AccountSettingsDeserializer()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        deserialize

        +
        public AccountSettings deserialize(com.google.gson.JsonElement json,
+                                   java.lang.reflect.Type typeOfT,
+                                   com.google.gson.JsonDeserializationContext context)
+                            throws com.google.gson.JsonParseException
        +
        +
        Specified by:
        +
        deserialize in interface com.google.gson.JsonDeserializer<AccountSettings>
        +
        Throws:
        +
        com.google.gson.JsonParseException
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/com/textcontrol/reportingcloud/gson/MergeBodySerializer.html b/com/textcontrol/reportingcloud/gson/MergeBodySerializer.html new file mode 100644 index 0000000..0e7afab --- /dev/null +++ b/com/textcontrol/reportingcloud/gson/MergeBodySerializer.html @@ -0,0 +1,288 @@ + + + + + +MergeBodySerializer + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
com.textcontrol.reportingcloud.gson
+

Class MergeBodySerializer

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • com.textcontrol.reportingcloud.gson.MergeBodySerializer
      • +
    +
    • +
+
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    com.google.gson.JsonSerializer<MergeBody>
    +
    +
    +
    +
    public class MergeBodySerializer
+extends java.lang.Object
+implements com.google.gson.JsonSerializer<MergeBody>
    +
    Needed by GSON to serialize MergeBody objects to + JSON.
    +
    +
    Author:
    +
    Thorsten Kummerow
    +
    +
    • +
+
+
+
    +
  • + + + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      com.google.gson.JsonElementserialize(MergeBody src, + java.lang.reflect.Type typeOfSrc, + com.google.gson.JsonSerializationContext context) 
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        MergeBodySerializer

        +
        public MergeBodySerializer()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        serialize

        +
        public com.google.gson.JsonElement serialize(MergeBody src,
+                                             java.lang.reflect.Type typeOfSrc,
+                                             com.google.gson.JsonSerializationContext context)
        +
        +
        Specified by:
        +
        serialize in interface com.google.gson.JsonSerializer<MergeBody>
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/com/textcontrol/reportingcloud/gson/MergeSettingsSerializer.html b/com/textcontrol/reportingcloud/gson/MergeSettingsSerializer.html new file mode 100644 index 0000000..119e352 --- /dev/null +++ b/com/textcontrol/reportingcloud/gson/MergeSettingsSerializer.html @@ -0,0 +1,288 @@ + + + + + +MergeSettingsSerializer + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
com.textcontrol.reportingcloud.gson
+

Class MergeSettingsSerializer

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • com.textcontrol.reportingcloud.gson.MergeSettingsSerializer
      • +
    +
    • +
+
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    com.google.gson.JsonSerializer<MergeSettings>
    +
    +
    +
    +
    public class MergeSettingsSerializer
+extends java.lang.Object
+implements com.google.gson.JsonSerializer<MergeSettings>
    +
    Needed by GSON to serialize MergeSettings objects to + JSON.
    +
    +
    Author:
    +
    Thorsten Kummerow
    +
    +
    • +
+
+
+
    +
  • + + + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      com.google.gson.JsonElementserialize(MergeSettings src, + java.lang.reflect.Type typeOfSrc, + com.google.gson.JsonSerializationContext context) 
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        MergeSettingsSerializer

        +
        public MergeSettingsSerializer()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        serialize

        +
        public com.google.gson.JsonElement serialize(MergeSettings src,
+                                             java.lang.reflect.Type typeOfSrc,
+                                             com.google.gson.JsonSerializationContext context)
        +
        +
        Specified by:
        +
        serialize in interface com.google.gson.JsonSerializer<MergeSettings>
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/com/textcontrol/reportingcloud/gson/TemplateDeserializer.html b/com/textcontrol/reportingcloud/gson/TemplateDeserializer.html new file mode 100644 index 0000000..e83aa77 --- /dev/null +++ b/com/textcontrol/reportingcloud/gson/TemplateDeserializer.html @@ -0,0 +1,290 @@ + + + + + +TemplateDeserializer + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
com.textcontrol.reportingcloud.gson
+

Class TemplateDeserializer

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • com.textcontrol.reportingcloud.gson.TemplateDeserializer
      • +
    +
    • +
+
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    com.google.gson.JsonDeserializer<Template>
    +
    +
    +
    +
    public class TemplateDeserializer
+extends java.lang.Object
+implements com.google.gson.JsonDeserializer<Template>
    +
    Needed by GSON to create Template objects from JSON data.
    +
    +
    Author:
    +
    Thorsten Kummerow
    +
    +
    • +
+
+
+
    +
  • + + + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      Templatedeserialize(com.google.gson.JsonElement json, + java.lang.reflect.Type typeOfT, + com.google.gson.JsonDeserializationContext context) 
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        TemplateDeserializer

        +
        public TemplateDeserializer()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        deserialize

        +
        public Template deserialize(com.google.gson.JsonElement json,
+                            java.lang.reflect.Type typeOfT,
+                            com.google.gson.JsonDeserializationContext context)
+                     throws com.google.gson.JsonParseException
        +
        +
        Specified by:
        +
        deserialize in interface com.google.gson.JsonDeserializer<Template>
        +
        Throws:
        +
        com.google.gson.JsonParseException
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/com/textcontrol/reportingcloud/gson/package-frame.html b/com/textcontrol/reportingcloud/gson/package-frame.html new file mode 100644 index 0000000..87b0c73 --- /dev/null +++ b/com/textcontrol/reportingcloud/gson/package-frame.html @@ -0,0 +1,23 @@ + + + + + +com.textcontrol.reportingcloud.gson + + + + + +

com.textcontrol.reportingcloud.gson

+
+

Classes

+ +
+ + diff --git a/com/textcontrol/reportingcloud/gson/package-summary.html b/com/textcontrol/reportingcloud/gson/package-summary.html new file mode 100644 index 0000000..8a8112d --- /dev/null +++ b/com/textcontrol/reportingcloud/gson/package-summary.html @@ -0,0 +1,162 @@ + + + + + +com.textcontrol.reportingcloud.gson + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Package com.textcontrol.reportingcloud.gson

+
+
+ +
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/com/textcontrol/reportingcloud/gson/package-tree.html b/com/textcontrol/reportingcloud/gson/package-tree.html new file mode 100644 index 0000000..8170a9f --- /dev/null +++ b/com/textcontrol/reportingcloud/gson/package-tree.html @@ -0,0 +1,138 @@ + + + + + +com.textcontrol.reportingcloud.gson Class Hierarchy + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Hierarchy For Package com.textcontrol.reportingcloud.gson

+Package Hierarchies: + +
+
+

Class Hierarchy

+
    +
  • java.lang.Object + +
    • +
+
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/com/textcontrol/reportingcloud/package-frame.html b/com/textcontrol/reportingcloud/package-frame.html new file mode 100644 index 0000000..c827e7b --- /dev/null +++ b/com/textcontrol/reportingcloud/package-frame.html @@ -0,0 +1,32 @@ + + + + + +com.textcontrol.reportingcloud + + + + + +

com.textcontrol.reportingcloud

+
+

Classes

+ +

Enums

+ +
+ + diff --git a/com/textcontrol/reportingcloud/package-summary.html b/com/textcontrol/reportingcloud/package-summary.html new file mode 100644 index 0000000..de4d93c --- /dev/null +++ b/com/textcontrol/reportingcloud/package-summary.html @@ -0,0 +1,207 @@ + + + + + +com.textcontrol.reportingcloud + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Package com.textcontrol.reportingcloud

+
+
+
    +
  • + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Class Summary 
    ClassDescription
    AccountSettings +
    Represents ReportingCloud account settings.
    +
    MergeBody +
    Used to pass data to the merge method.
    +
    MergeSettings +
    Holds the merge settings needed by the merge method.
    +
    ReportingCloud +
    The ReportingCloud API wrapper class.
    +
    ReportingCloudTest +
    The ReportingCloud test class.
    +
    Template +
    Holds information about a template in the template storage.
    +
    TemplateDataValidator +
    Internal method parameter validator class.
    +
    TemplateNameValidator +
    Internal method parameter validator class.
    +
    +
    • +
  • + + + + + + + + + + + + + + + + +
    Enum Summary 
    EnumDescription
    ImageFormat +
    This enum lists all possible image formats for the thumbnails
    +
    ReturnFormat +
    This enum lists all possible return formats for the Merge method.
    +
    +
    • +
+
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/com/textcontrol/reportingcloud/package-tree.html b/com/textcontrol/reportingcloud/package-tree.html new file mode 100644 index 0000000..79fa72f --- /dev/null +++ b/com/textcontrol/reportingcloud/package-tree.html @@ -0,0 +1,157 @@ + + + + + +com.textcontrol.reportingcloud Class Hierarchy + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Hierarchy For Package com.textcontrol.reportingcloud

+Package Hierarchies: + +
+
+

Class Hierarchy

+ +

Enum Hierarchy

+
    +
  • java.lang.Object +
      +
    • java.lang.Enum<E> (implements java.lang.Comparable<T>, java.io.Serializable) + +
      • +
    +
    • +
+
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/constant-values.html b/constant-values.html index f3bfb93..ba80eac 100644 --- a/constant-values.html +++ b/constant-values.html @@ -2,7 +2,7 @@ - + Constant Field Values diff --git a/deprecated-list.html b/deprecated-list.html index e46c73e..e1771a5 100644 --- a/deprecated-list.html +++ b/deprecated-list.html @@ -2,7 +2,7 @@ - + Deprecated List diff --git a/help-doc.html b/help-doc.html index 3c9bd76..92ee91f 100644 --- a/help-doc.html +++ b/help-doc.html @@ -2,7 +2,7 @@ - + API Help diff --git a/index-files/index-1.html b/index-files/index-1.html index 049850a..2a61446 100644 --- a/index-files/index-1.html +++ b/index-files/index-1.html @@ -2,7 +2,7 @@ - + A-Index @@ -68,25 +68,25 @@ -
A C D G I L M R S T U V  +
A B C D G I L M N R S T U V 

A

-
AccountSettings - Class in txtextcontrol.reportingcloud
+
AccountSettings - Class in com.textcontrol.reportingcloud
Represents ReportingCloud account settings.
-
AccountSettings(String, int, int, int, int, String) - Constructor for class txtextcontrol.reportingcloud.AccountSettings
+
AccountSettings(String, int, int, int, int, String) - Constructor for class com.textcontrol.reportingcloud.AccountSettings
 
-
AccountSettingsDeserializer - Class in txtextcontrol.reportingcloud.gson
+
AccountSettingsDeserializer - Class in com.textcontrol.reportingcloud.gson
-
Needed by GSON to create AccountSettings objects from JSON data.
+
Needed by GSON to create AccountSettings objects from JSON data.
-
AccountSettingsDeserializer() - Constructor for class txtextcontrol.reportingcloud.gson.AccountSettingsDeserializer
+
AccountSettingsDeserializer() - Constructor for class com.textcontrol.reportingcloud.gson.AccountSettingsDeserializer
 
-A C D G I L M R S T U V 
+A B C D G I L M N R S T U V 
diff --git a/index-files/index-10.html b/index-files/index-10.html index 09534f1..0357eb8 100644 --- a/index-files/index-10.html +++ b/index-files/index-10.html @@ -2,8 +2,8 @@ - -T-Index + +R-Index @@ -12,7 +12,7 @@ @@ -12,7 +12,7 @@ @@ -12,7 +12,7 @@ + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
A B C D G I L M N R S T U V  + + +

U

+
+
uploadTemplate(String, byte[]) - Method in class com.textcontrol.reportingcloud.ReportingCloud
+
+
Stores an uploaded template in the template storage (.doc, .docx, + .rtf and .tx).
+
+
uploadTemplate() - Method in class com.textcontrol.reportingcloud.ReportingCloudTest
+
 
+
+A B C D G I L M N R S T U V 
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/index-files/index-14.html b/index-files/index-14.html new file mode 100644 index 0000000..813e93d --- /dev/null +++ b/index-files/index-14.html @@ -0,0 +1,151 @@ + + + + + +V-Index + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
A B C D G I L M N R S T U V  + + +

V

+
+
validate(byte[]) - Static method in class com.textcontrol.reportingcloud.TemplateDataValidator
+
+
Checks if a template data buffer contains something.
+
+
validate(String) - Static method in class com.textcontrol.reportingcloud.TemplateNameValidator
+
+
Checks if a template name contains something.
+
+
valueOf(String) - Static method in enum com.textcontrol.reportingcloud.ImageFormat
+
+
Returns the enum constant of this type with the specified name.
+
+
valueOf(String) - Static method in enum com.textcontrol.reportingcloud.ReturnFormat
+
+
Returns the enum constant of this type with the specified name.
+
+
values() - Static method in enum com.textcontrol.reportingcloud.ImageFormat
+
+
Returns an array containing the constants of this enum type, in +the order they are declared.
+
+
values() - Static method in enum com.textcontrol.reportingcloud.ReturnFormat
+
+
Returns an array containing the constants of this enum type, in +the order they are declared.
+
+
+A B C D G I L M N R S T U V 
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/index-files/index-2.html b/index-files/index-2.html index d7e1e39..ca25ff8 100644 --- a/index-files/index-2.html +++ b/index-files/index-2.html @@ -2,8 +2,8 @@ - -C-Index + +B-Index @@ -12,7 +12,7 @@ @@ -12,7 +12,7 @@ @@ -12,7 +12,7 @@ @@ -12,7 +12,7 @@ @@ -12,7 +12,7 @@ @@ -12,7 +12,7 @@ @@ -12,7 +12,7 @@ @@ -12,7 +12,7 @@ diff --git a/allclasses-noframe.html b/allclasses-noframe.html index eceeb6e..9016b69 100644 --- a/allclasses-noframe.html +++ b/allclasses-noframe.html @@ -2,9 +2,9 @@ - + All Classes - + diff --git a/com/textcontrol/reportingcloud/AccountSettings.html b/com/textcontrol/reportingcloud/AccountSettings.html index 2f5ef83..37459a2 100644 --- a/com/textcontrol/reportingcloud/AccountSettings.html +++ b/com/textcontrol/reportingcloud/AccountSettings.html @@ -2,9 +2,9 @@ - + AccountSettings - + diff --git a/com/textcontrol/reportingcloud/ImageFormat.html b/com/textcontrol/reportingcloud/ImageFormat.html index fab4a1d..c58287c 100644 --- a/com/textcontrol/reportingcloud/ImageFormat.html +++ b/com/textcontrol/reportingcloud/ImageFormat.html @@ -2,9 +2,9 @@ - + ImageFormat - + diff --git a/com/textcontrol/reportingcloud/MergeBody.html b/com/textcontrol/reportingcloud/MergeBody.html index c4f3c0a..66697f8 100644 --- a/com/textcontrol/reportingcloud/MergeBody.html +++ b/com/textcontrol/reportingcloud/MergeBody.html @@ -2,9 +2,9 @@ - + MergeBody - + @@ -133,14 +133,26 @@

Constructor Summary

Constructor and Description -MergeBody(java.util.List<java.lang.Object> mergeData)  +MergeBody(java.lang.Iterable<java.lang.Object> mergeData)  -MergeBody(java.util.List<java.lang.Object> mergeData, +MergeBody(java.lang.Iterable<java.lang.Object> mergeData, MergeSettings mergeSettings)  -MergeBody(java.util.List<java.lang.Object> mergeData, +MergeBody(java.lang.Iterable<java.lang.Object> mergeData, + MergeSettings mergeSettings, + byte[] template)  + + +MergeBody(java.lang.Object[] mergeData)  + + +MergeBody(java.lang.Object[] mergeData, + MergeSettings mergeSettings)  + + +MergeBody(java.lang.Object[] mergeData, MergeSettings mergeSettings, byte[] template)  @@ -160,7 +172,7 @@

Method Summary

Method and Description -java.util.List<java.lang.Object> +java.lang.Iterable<java.lang.Object> getMergeData()
Gets the merge data.
@@ -180,7 +192,7 @@

Method Summary

void -setMergeData(java.util.List<java.lang.Object> mergeData) +setMergeData(java.lang.Iterable<java.lang.Object> mergeData)
Sets the merge data.
@@ -219,36 +231,53 @@

Methods inherited from class java.lang.Object

Constructor Detail

- +

  • MergeBody

    -
    public MergeBody(java.util.List<java.lang.Object> mergeData)
+
    public MergeBody(java.lang.Iterable<java.lang.Object> mergeData)
           throws java.security.InvalidParameterException
    
 
    
 
    Parameters:
    
-
    mergeData - The merge data. Can be a list of HashMap objects or a list of objects
- which can be serialized to JSON by GSON.
    
+
    mergeData - The merge data. Can be an iterable type of HashMap objects
+                  or an iterable type of objects which can be serialized to JSON by GSON.
    
 
    Throws:
    
 
    java.security.InvalidParameterException
- +

  • MergeBody

    -
    public MergeBody(java.util.List<java.lang.Object> mergeData,
+
    public MergeBody(java.lang.Object[] mergeData)
+          throws java.security.InvalidParameterException
    
+
    
+
    Parameters:
    
+
    mergeData - The merge data. Can be an array of HashMap objects
+                  or an array of objects which can be serialized to JSON by GSON.
    
+
    Throws:
    
+
    java.security.InvalidParameterException
    
+
    
+
    • +
+ + + +
    +
  • +

    MergeBody

    +
    public MergeBody(java.lang.Iterable<java.lang.Object> mergeData,
                  MergeSettings mergeSettings)
           throws java.security.InvalidParameterException
    Parameters:
    -
    mergeData - The merge data. Can be a list of HashMap objects or - a list of objects which can be serialized to JSON by GSON.
    +
    mergeData - The merge data. Can be an iterable type of HashMap objects + or an iterable type of objects which can be serialized to JSON by GSON.
    mergeSettings - Merge settings to specify merge properties and document properties such as title and author.
    Throws:
    @@ -256,20 +285,63 @@

    MergeBody

- + + + +
    +
  • +

    MergeBody

    +
    public MergeBody(java.lang.Object[] mergeData,
+                 MergeSettings mergeSettings)
+          throws java.security.InvalidParameterException
    +
    +
    Parameters:
    +
    mergeData - The merge data. Can be an array of HashMap objects + or an array of objects which can be serialized to JSON by GSON.
    +
    mergeSettings - Merge settings to specify merge properties and document properties + such as title and author.
    +
    Throws:
    +
    java.security.InvalidParameterException
    +
    +
    • +
+ + + +
    +
  • +

    MergeBody

    +
    public MergeBody(java.lang.Iterable<java.lang.Object> mergeData,
+                 MergeSettings mergeSettings,
+                 byte[] template)
+          throws java.security.InvalidParameterException
    +
    +
    Parameters:
    +
    mergeData - The merge data. Can be an iterable type of HashMap objects + or an iterable type of objects which can be serialized to JSON by GSON.
    +
    mergeSettings - Merge settings to specify merge properties and document properties + such as title and author.
    +
    template - The binary template document data. Supported formats are .rtf, + .doc, .docx and .tx.
    +
    Throws:
    +
    java.security.InvalidParameterException
    +
    +
    • +
+

  • MergeBody

    -
    public MergeBody(java.util.List<java.lang.Object> mergeData,
+
    public MergeBody(java.lang.Object[] mergeData,
                  MergeSettings mergeSettings,
                  byte[] template)
           throws java.security.InvalidParameterException
    
 
    
 
    Parameters:
    
-
    mergeData - The merge data. Can be a list of HashMap objects or
-                  a list of objects which can be serialized to JSON by GSON.
    
+
    mergeData - The merge data. Can be an array of HashMap objects
+                  or an array of objects which can be serialized to JSON by GSON.
    
 
    mergeSettings - Merge settings to specify merge properties and document properties
                       such as title and author.
    
 
    template - The binary template document data. Supported formats are .rtf,
@@ -353,7 +425,7 @@ 
    setMergeSettings
    
 
      
 
    • 
 
      getMergeData
      
-
      public java.util.List<java.lang.Object> getMergeData()
      
+
      public java.lang.Iterable<java.lang.Object> getMergeData()
      
 
      Gets the merge data.
      
 
      
 
      Returns:
      
@@ -361,13 +433,13 @@ 
      getMergeData
      
 
      
 
      • 
 
    
-
+
 
 
 
      
 
    • 
 
      setMergeData
      
-
      public void setMergeData(java.util.List<java.lang.Object> mergeData)
      
+
      public void setMergeData(java.lang.Iterable<java.lang.Object> mergeData)
      
 
      Sets the merge data. Can be a list of HashMap objects or a list of objects
  which can be serialized to JSON by GSON.
      
 
      
diff --git a/com/textcontrol/reportingcloud/MergeSettings.html b/com/textcontrol/reportingcloud/MergeSettings.html
index 47aa813..da71ce3 100644
--- a/com/textcontrol/reportingcloud/MergeSettings.html
+++ b/com/textcontrol/reportingcloud/MergeSettings.html
@@ -2,9 +2,9 @@
 
 
 
-
+
 MergeSettings
-
+
 
 
 
diff --git a/com/textcontrol/reportingcloud/ReportingCloud.html b/com/textcontrol/reportingcloud/ReportingCloud.html
index 26979d4..f311ce6 100644
--- a/com/textcontrol/reportingcloud/ReportingCloud.html
+++ b/com/textcontrol/reportingcloud/ReportingCloud.html
@@ -2,9 +2,9 @@
 
 
 
-
+
 ReportingCloud
-
+
 
 
 
diff --git a/com/textcontrol/reportingcloud/ReportingCloudTest.MasterItem.html b/com/textcontrol/reportingcloud/ReportingCloudTest.MasterItem.html
index 3839826..9e86887 100644
--- a/com/textcontrol/reportingcloud/ReportingCloudTest.MasterItem.html
+++ b/com/textcontrol/reportingcloud/ReportingCloudTest.MasterItem.html
@@ -2,9 +2,9 @@
 
 
 
-
+
 ReportingCloudTest.MasterItem
-
+
 
 
 
diff --git a/com/textcontrol/reportingcloud/ReportingCloudTest.NestedItem.html b/com/textcontrol/reportingcloud/ReportingCloudTest.NestedItem.html
index 86c2d12..f317c65 100644
--- a/com/textcontrol/reportingcloud/ReportingCloudTest.NestedItem.html
+++ b/com/textcontrol/reportingcloud/ReportingCloudTest.NestedItem.html
@@ -2,9 +2,9 @@
 
 
 
-
+
 ReportingCloudTest.NestedItem
-
+
 
 
 
diff --git a/com/textcontrol/reportingcloud/ReportingCloudTest.html b/com/textcontrol/reportingcloud/ReportingCloudTest.html
index ff9e928..259fb01 100644
--- a/com/textcontrol/reportingcloud/ReportingCloudTest.html
+++ b/com/textcontrol/reportingcloud/ReportingCloudTest.html
@@ -2,9 +2,9 @@
 
 
 
-
+
 ReportingCloudTest
-
+
 
 
 
@@ -18,7 +18,7 @@
     catch(err) {
     }
 //-->
-var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10};
+var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10};
 var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
 var altColor = "altColor";
 var rowColor = "rowColor";
@@ -211,14 +211,18 @@ 
      Method Summary
      
 
 
 void
-mergeDocument() 
+mergeDocument_usingArray() 
 
 
 void
-templateExists() 
+mergeDocument_usingIterable() 
 
 
 void
+templateExists() 
+
+
+void
 uploadTemplate() 
 
 
@@ -349,14 +353,28 @@ 
      getAccountSettings
      
 
      
 
      • 
 
    
-
+
 
 
 
      
 
    • 
-
      mergeDocument
      
-
      public void mergeDocument()
-                   throws java.lang.Exception
      
+
      mergeDocument_usingIterable
      
+
      public void mergeDocument_usingIterable()
+                                 throws java.lang.Exception
      
+
      
+
      Throws:
      
+
      java.lang.Exception
      
+
      
+
      • 
+
    
+
+
+
+
      
+
    • 
+
      mergeDocument_usingArray
      
+
      public void mergeDocument_usingArray()
+                              throws java.lang.Exception
      
 
      
 
      Throws:
      
 
      java.lang.Exception
      
diff --git a/com/textcontrol/reportingcloud/ReturnFormat.html b/com/textcontrol/reportingcloud/ReturnFormat.html
index d220182..5ccae56 100644
--- a/com/textcontrol/reportingcloud/ReturnFormat.html
+++ b/com/textcontrol/reportingcloud/ReturnFormat.html
@@ -2,9 +2,9 @@
 
 
 
-
+
 ReturnFormat
-
+
 
 
 
diff --git a/com/textcontrol/reportingcloud/Template.html b/com/textcontrol/reportingcloud/Template.html
index b6e5dce..1afc3f4 100644
--- a/com/textcontrol/reportingcloud/Template.html
+++ b/com/textcontrol/reportingcloud/Template.html
@@ -2,9 +2,9 @@
 
 
 
-
+
 Template
-
+
 
 
 
diff --git a/com/textcontrol/reportingcloud/TemplateDataValidator.html b/com/textcontrol/reportingcloud/TemplateDataValidator.html
index c1b91b5..f18e570 100644
--- a/com/textcontrol/reportingcloud/TemplateDataValidator.html
+++ b/com/textcontrol/reportingcloud/TemplateDataValidator.html
@@ -2,9 +2,9 @@
 
 
 
-
+
 TemplateDataValidator
-
+
 
 
 
diff --git a/com/textcontrol/reportingcloud/TemplateNameValidator.html b/com/textcontrol/reportingcloud/TemplateNameValidator.html
index e47d7b5..fe9b2bc 100644
--- a/com/textcontrol/reportingcloud/TemplateNameValidator.html
+++ b/com/textcontrol/reportingcloud/TemplateNameValidator.html
@@ -2,9 +2,9 @@
 
 
 
-
+
 TemplateNameValidator
-
+
 
 
 
diff --git a/com/textcontrol/reportingcloud/gson/AccountSettingsDeserializer.html b/com/textcontrol/reportingcloud/gson/AccountSettingsDeserializer.html
index 2fc1be8..e6b7e1a 100644
--- a/com/textcontrol/reportingcloud/gson/AccountSettingsDeserializer.html
+++ b/com/textcontrol/reportingcloud/gson/AccountSettingsDeserializer.html
@@ -2,9 +2,9 @@
 
 
 
-
+
 AccountSettingsDeserializer
-
+
 
 
 
diff --git a/com/textcontrol/reportingcloud/gson/MergeBodySerializer.html b/com/textcontrol/reportingcloud/gson/MergeBodySerializer.html
index 0e7afab..5577eb6 100644
--- a/com/textcontrol/reportingcloud/gson/MergeBodySerializer.html
+++ b/com/textcontrol/reportingcloud/gson/MergeBodySerializer.html
@@ -2,9 +2,9 @@
 
 
 
-
+
 MergeBodySerializer
-
+
 
 
 
diff --git a/com/textcontrol/reportingcloud/gson/MergeSettingsSerializer.html b/com/textcontrol/reportingcloud/gson/MergeSettingsSerializer.html
index 119e352..8959679 100644
--- a/com/textcontrol/reportingcloud/gson/MergeSettingsSerializer.html
+++ b/com/textcontrol/reportingcloud/gson/MergeSettingsSerializer.html
@@ -2,9 +2,9 @@
 
 
 
-
+
 MergeSettingsSerializer
-
+
 
 
 
diff --git a/com/textcontrol/reportingcloud/gson/TemplateDeserializer.html b/com/textcontrol/reportingcloud/gson/TemplateDeserializer.html
index e83aa77..09d90a3 100644
--- a/com/textcontrol/reportingcloud/gson/TemplateDeserializer.html
+++ b/com/textcontrol/reportingcloud/gson/TemplateDeserializer.html
@@ -2,9 +2,9 @@
 
 
 
-
+
 TemplateDeserializer
-
+
 
 
 
diff --git a/com/textcontrol/reportingcloud/gson/package-frame.html b/com/textcontrol/reportingcloud/gson/package-frame.html
index 87b0c73..c133a1f 100644
--- a/com/textcontrol/reportingcloud/gson/package-frame.html
+++ b/com/textcontrol/reportingcloud/gson/package-frame.html
@@ -2,9 +2,9 @@
 
 
 
-
+
 com.textcontrol.reportingcloud.gson
-
+
 
 
 
diff --git a/com/textcontrol/reportingcloud/gson/package-summary.html b/com/textcontrol/reportingcloud/gson/package-summary.html
index 8a8112d..2653013 100644
--- a/com/textcontrol/reportingcloud/gson/package-summary.html
+++ b/com/textcontrol/reportingcloud/gson/package-summary.html
@@ -2,9 +2,9 @@
 
 
 
-
+
 com.textcontrol.reportingcloud.gson
-
+
 
 
 
diff --git a/com/textcontrol/reportingcloud/gson/package-tree.html b/com/textcontrol/reportingcloud/gson/package-tree.html
index 8170a9f..7d5386c 100644
--- a/com/textcontrol/reportingcloud/gson/package-tree.html
+++ b/com/textcontrol/reportingcloud/gson/package-tree.html
@@ -2,9 +2,9 @@
 
 
 
-
+
 com.textcontrol.reportingcloud.gson Class Hierarchy
-
+
 
 
 
diff --git a/com/textcontrol/reportingcloud/package-frame.html b/com/textcontrol/reportingcloud/package-frame.html
index c827e7b..df32c0c 100644
--- a/com/textcontrol/reportingcloud/package-frame.html
+++ b/com/textcontrol/reportingcloud/package-frame.html
@@ -2,9 +2,9 @@
 
 
 
-
+
 com.textcontrol.reportingcloud
-
+
 
 
 
diff --git a/com/textcontrol/reportingcloud/package-summary.html b/com/textcontrol/reportingcloud/package-summary.html
index de4d93c..9db918e 100644
--- a/com/textcontrol/reportingcloud/package-summary.html
+++ b/com/textcontrol/reportingcloud/package-summary.html
@@ -2,9 +2,9 @@
 
 
 
-
+
 com.textcontrol.reportingcloud
-
+
 
 
 
diff --git a/com/textcontrol/reportingcloud/package-tree.html b/com/textcontrol/reportingcloud/package-tree.html
index 79fa72f..ad7ec9f 100644
--- a/com/textcontrol/reportingcloud/package-tree.html
+++ b/com/textcontrol/reportingcloud/package-tree.html
@@ -2,9 +2,9 @@
 
 
 
-
+
 com.textcontrol.reportingcloud Class Hierarchy
-
+
 
 
 
diff --git a/constant-values.html b/constant-values.html
index ba80eac..1d4d8eb 100644
--- a/constant-values.html
+++ b/constant-values.html
@@ -2,9 +2,9 @@
 
 
 
-
+
 Constant Field Values
-
+
 
 
 
diff --git a/deprecated-list.html b/deprecated-list.html
index e1771a5..f0dea42 100644
--- a/deprecated-list.html
+++ b/deprecated-list.html
@@ -2,9 +2,9 @@
 
 
 
-
+
 Deprecated List
-
+
 
 
 
diff --git a/help-doc.html b/help-doc.html
index 92ee91f..ec13dc9 100644
--- a/help-doc.html
+++ b/help-doc.html
@@ -2,9 +2,9 @@
 
 
 
-
+
 API Help
-
+
 
 
 
diff --git a/index-files/index-1.html b/index-files/index-1.html
index 2a61446..87a6d92 100644
--- a/index-files/index-1.html
+++ b/index-files/index-1.html
@@ -2,9 +2,9 @@
 
 
 
-
+
 A-Index
-
+
 
 
 
diff --git a/index-files/index-10.html b/index-files/index-10.html
index 0357eb8..b86c948 100644
--- a/index-files/index-10.html
+++ b/index-files/index-10.html
@@ -2,9 +2,9 @@
 
 
 
-
+
 R-Index
-
+
 
 
 
diff --git a/index-files/index-11.html b/index-files/index-11.html
index 20365fd..d529065 100644
--- a/index-files/index-11.html
+++ b/index-files/index-11.html
@@ -2,9 +2,9 @@
 
 
 
-
+
 S-Index
-
+
 
 
 
@@ -93,7 +93,7 @@ 
      S
      
 
      
 
      Sets the document's title.
      
 
      
-
      setMergeData(List<Object>) - Method in class com.textcontrol.reportingcloud.MergeBody
      
+
      setMergeData(Iterable<Object>) - Method in class com.textcontrol.reportingcloud.MergeBody
      
 
      
 
      Sets the merge data.
      
 
      
diff --git a/index-files/index-12.html b/index-files/index-12.html
index 447a7fd..bd1202f 100644
--- a/index-files/index-12.html
+++ b/index-files/index-12.html
@@ -2,9 +2,9 @@
 
 
 
-
+
 T-Index
-
+
 
 
 
diff --git a/index-files/index-13.html b/index-files/index-13.html
index 82615dc..eca5d79 100644
--- a/index-files/index-13.html
+++ b/index-files/index-13.html
@@ -2,9 +2,9 @@
 
 
 
-
+
 U-Index
-
+
 
 
 
diff --git a/index-files/index-14.html b/index-files/index-14.html
index 813e93d..c7ca266 100644
--- a/index-files/index-14.html
+++ b/index-files/index-14.html
@@ -2,9 +2,9 @@
 
 
 
-
+
 V-Index
-
+
 
 
 
diff --git a/index-files/index-2.html b/index-files/index-2.html
index ca25ff8..06bc10f 100644
--- a/index-files/index-2.html
+++ b/index-files/index-2.html
@@ -2,9 +2,9 @@
 
 
 
-
+
 B-Index
-
+
 
 
 
diff --git a/index-files/index-3.html b/index-files/index-3.html
index b692e28..acb0001 100644
--- a/index-files/index-3.html
+++ b/index-files/index-3.html
@@ -2,9 +2,9 @@
 
 
 
-
+
 C-Index
-
+
 
 
 
diff --git a/index-files/index-4.html b/index-files/index-4.html
index 98639bb..91a7aa7 100644
--- a/index-files/index-4.html
+++ b/index-files/index-4.html
@@ -2,9 +2,9 @@
 
 
 
-
+
 D-Index
-
+
 
 
 
diff --git a/index-files/index-5.html b/index-files/index-5.html
index e2e4d5d..1357da9 100644
--- a/index-files/index-5.html
+++ b/index-files/index-5.html
@@ -2,9 +2,9 @@
 
 
 
-
+
 G-Index
-
+
 
 
 
diff --git a/index-files/index-6.html b/index-files/index-6.html
index 6e56c95..103f6db 100644
--- a/index-files/index-6.html
+++ b/index-files/index-6.html
@@ -2,9 +2,9 @@
 
 
 
-
+
 I-Index
-
+
 
 
 
diff --git a/index-files/index-7.html b/index-files/index-7.html
index d3f6cf1..2393ca2 100644
--- a/index-files/index-7.html
+++ b/index-files/index-7.html
@@ -2,9 +2,9 @@
 
 
 
-
+
 L-Index
-
+
 
 
 
diff --git a/index-files/index-8.html b/index-files/index-8.html
index 899d3d4..e652bb4 100644
--- a/index-files/index-8.html
+++ b/index-files/index-8.html
@@ -2,9 +2,9 @@
 
 
 
-
+
 M-Index
-
+
 
 
 
@@ -79,11 +79,17 @@ 
      M
      
 
      
 
      Used to pass data to the merge method.
      
 
      
-
      MergeBody(List<Object>) - Constructor for class com.textcontrol.reportingcloud.MergeBody
      
+
      MergeBody(Iterable<Object>) - Constructor for class com.textcontrol.reportingcloud.MergeBody
      
 
       
      
-
      MergeBody(List<Object>, MergeSettings) - Constructor for class com.textcontrol.reportingcloud.MergeBody
      
+
      MergeBody(Object[]) - Constructor for class com.textcontrol.reportingcloud.MergeBody
      
 
       
      
-
      MergeBody(List<Object>, MergeSettings, byte[]) - Constructor for class com.textcontrol.reportingcloud.MergeBody
      
+
      MergeBody(Iterable<Object>, MergeSettings) - Constructor for class com.textcontrol.reportingcloud.MergeBody
      
+
       
      
+
      MergeBody(Object[], MergeSettings) - Constructor for class com.textcontrol.reportingcloud.MergeBody
      
+
       
      
+
      MergeBody(Iterable<Object>, MergeSettings, byte[]) - Constructor for class com.textcontrol.reportingcloud.MergeBody
      
+
       
      
+
      MergeBody(Object[], MergeSettings, byte[]) - Constructor for class com.textcontrol.reportingcloud.MergeBody
      
 
       
      
 
      MergeBodySerializer - Class in com.textcontrol.reportingcloud.gson
      
 
      
@@ -108,7 +114,9 @@ 
      M
      
 
      
 
      Merges and returns a template from the template storage or an uploaded template with JSON data.
      
 
      
-
      mergeDocument() - Method in class com.textcontrol.reportingcloud.ReportingCloudTest
      
+
      mergeDocument_usingArray() - Method in class com.textcontrol.reportingcloud.ReportingCloudTest
      
+
       
      
+
      mergeDocument_usingIterable() - Method in class com.textcontrol.reportingcloud.ReportingCloudTest
      
 
       
      
 
      MergeSettings - Class in com.textcontrol.reportingcloud
      
 
      
diff --git a/index-files/index-9.html b/index-files/index-9.html
index 7cdda6d..74835c9 100644
--- a/index-files/index-9.html
+++ b/index-files/index-9.html
@@ -2,9 +2,9 @@
 
 
 
-
+
 N-Index
-
+
 
 
 
diff --git a/index.html b/index.html
index b01a8cb..a63ec31 100644
--- a/index.html
+++ b/index.html
@@ -2,7 +2,7 @@
 
 
 
-
+
 Generated Documentation (Untitled)
 
 
diff --git a/overview-summary.html b/overview-summary.html
index a6ad9ec..71f87de 100644
--- a/overview-summary.html
+++ b/overview-summary.html
@@ -2,9 +2,9 @@
 
 
 
-
+
 Overview
-
+
 
 
 
diff --git a/overview-tree.html b/overview-tree.html
index d47d4b5..2a66782 100644
--- a/overview-tree.html
+++ b/overview-tree.html
@@ -2,9 +2,9 @@
 
 
 
-
+
 Class Hierarchy
-
+
 
 
 

From de871ab3c8203c0d8fc7af1d77ce061985abb472 Mon Sep 17 00:00:00 2001
From: Thorsten Kummerow 
Date: Tue, 14 Jun 2016 15:26:13 +0200
Subject: [PATCH 06/20] Adding test classes.

---
 allclasses-frame.html                         |  12 +-
 allclasses-noframe.html                       |  12 +-
 .../reportingcloud/AccountSettings.html       |  10 +-
 .../reportingcloud/AccountSettingsTest.html   | 274 ++++++++++++++
 .../reportingcloud/ImageFormat.html           |   6 +-
 com/textcontrol/reportingcloud/MergeBody.html |  41 ++-
 .../reportingcloud/MergeBodyTest.html         | 287 +++++++++++++++
 .../reportingcloud/MergeSettings.html         | 174 +++++++--
 .../reportingcloud/MergeSettingsTest.html     | 339 ++++++++++++++++++
 .../reportingcloud/ReportingCloud.html        |   6 +-
 .../ReportingCloudTest.MasterItem.html        |   2 +-
 .../ReportingCloudTest.NestedItem.html        |   2 +-
 .../reportingcloud/ReportingCloudTest.html    |   2 +-
 .../reportingcloud/ReturnFormat.html          |   2 +-
 com/textcontrol/reportingcloud/Template.html  |   6 +-
 .../reportingcloud/TemplateDataValidator.html |   6 +-
 .../TemplateDataValidatorTest.html            | 310 ++++++++++++++++
 .../reportingcloud/TemplateNameValidator.html |  10 +-
 .../TemplateNameValidatorTest.html            | 310 ++++++++++++++++
 .../reportingcloud/TemplateTest.html          | 274 ++++++++++++++
 .../gson/AccountSettingsDeserializer.html     |   6 +-
 .../gson/AccountSettingsDeserializerTest.html | 274 ++++++++++++++
 .../gson/MergeBodySerializer.html             |  10 +-
 .../gson/MergeBodySerializerTest.html         | 274 ++++++++++++++
 .../gson/MergeSettingsSerializer.html         |  10 +-
 .../gson/MergeSettingsSerializerTest.html     | 274 ++++++++++++++
 .../gson/TemplateDeserializer.html            |  10 +-
 .../gson/TemplateDeserializerTest.html        | 274 ++++++++++++++
 .../reportingcloud/gson/package-frame.html    |   6 +-
 .../reportingcloud/gson/package-summary.html  |  26 +-
 .../reportingcloud/gson/package-tree.html     |   6 +-
 .../reportingcloud/package-frame.html         |   8 +-
 .../reportingcloud/package-summary.html       |  44 ++-
 .../reportingcloud/package-tree.html          |   8 +-
 constant-values.html                          |   2 +-
 deprecated-list.html                          |   2 +-
 help-doc.html                                 |   2 +-
 index-files/index-1.html                      |  14 +-
 index-files/index-10.html                     |   2 +-
 index-files/index-11.html                     |  42 ++-
 index-files/index-12.html                     |  26 +-
 index-files/index-13.html                     |   2 +-
 index-files/index-14.html                     |  14 +-
 index-files/index-2.html                      |   2 +-
 index-files/index-3.html                      |   2 +-
 index-files/index-4.html                      |   6 +-
 index-files/index-5.html                      |  10 +-
 index-files/index-6.html                      |   6 +-
 index-files/index-7.html                      |   2 +-
 index-files/index-8.html                      |  26 +-
 index-files/index-9.html                      |   2 +-
 index.html                                    |   2 +-
 overview-frame.html                           |   2 +-
 overview-summary.html                         |   2 +-
 overview-tree.html                            |  12 +-
 55 files changed, 3389 insertions(+), 106 deletions(-)
 create mode 100644 com/textcontrol/reportingcloud/AccountSettingsTest.html
 create mode 100644 com/textcontrol/reportingcloud/MergeBodyTest.html
 create mode 100644 com/textcontrol/reportingcloud/MergeSettingsTest.html
 create mode 100644 com/textcontrol/reportingcloud/TemplateDataValidatorTest.html
 create mode 100644 com/textcontrol/reportingcloud/TemplateNameValidatorTest.html
 create mode 100644 com/textcontrol/reportingcloud/TemplateTest.html
 create mode 100644 com/textcontrol/reportingcloud/gson/AccountSettingsDeserializerTest.html
 create mode 100644 com/textcontrol/reportingcloud/gson/MergeBodySerializerTest.html
 create mode 100644 com/textcontrol/reportingcloud/gson/MergeSettingsSerializerTest.html
 create mode 100644 com/textcontrol/reportingcloud/gson/TemplateDeserializerTest.html

diff --git a/allclasses-frame.html b/allclasses-frame.html
index ca502e2..ba0213a 100644
--- a/allclasses-frame.html
+++ b/allclasses-frame.html
@@ -2,7 +2,7 @@
 
 
 
-
+
 All Classes
 
 
@@ -14,18 +14,28 @@ 
      All Classes
diff --git a/allclasses-noframe.html b/allclasses-noframe.html index 9016b69..7a297a0 100644 --- a/allclasses-noframe.html +++ b/allclasses-noframe.html @@ -2,7 +2,7 @@ - + All Classes @@ -14,18 +14,28 @@

All Classes

diff --git a/com/textcontrol/reportingcloud/AccountSettings.html b/com/textcontrol/reportingcloud/AccountSettings.html index 37459a2..c193dc4 100644 --- a/com/textcontrol/reportingcloud/AccountSettings.html +++ b/com/textcontrol/reportingcloud/AccountSettings.html @@ -2,7 +2,7 @@ - + AccountSettings @@ -49,7 +49,7 @@
  • Frames
    • @@ -187,7 +187,7 @@

    Method Summary

    -java.time.LocalDateTime +java.time.ZonedDateTime getValidUntil()
    Gets the date until the current subscription is valid.
    @@ -313,7 +313,7 @@

    getMaxTemplates

    • getValidUntil

      -
      public java.time.LocalDateTime getValidUntil()
      +
      public java.time.ZonedDateTime getValidUntil()
      Gets the date until the current subscription is valid. Can be nil.
      Returns:
      @@ -349,7 +349,7 @@

      getValidUntil

      • Frames
        • diff --git a/com/textcontrol/reportingcloud/AccountSettingsTest.html b/com/textcontrol/reportingcloud/AccountSettingsTest.html new file mode 100644 index 0000000..6ed2630 --- /dev/null +++ b/com/textcontrol/reportingcloud/AccountSettingsTest.html @@ -0,0 +1,274 @@ + + + + + +AccountSettingsTest + + + + + + + + +
        + + +
        Skip navigation links
        + + + + +
        +
        + + + +
        + +
        +
        +
          +
        • Summary: 
          • +
        • Nested | 
          • +
        • Field | 
          • +
        • Constr | 
          • +
        • Method
          • +
        + +
        + + +
        + + +
        +
        com.textcontrol.reportingcloud
        +

        Class AccountSettingsTest

        +
        +
        +
          +
        • java.lang.Object
          • +
        • +
            +
          • com.textcontrol.reportingcloud.AccountSettingsTest
            • +
          +
          • +
        +
        +
          +
        • +
          +
          +
          public class AccountSettingsTest
+extends java.lang.Object
          +
          The AccountSettings test class.
          +
          +
          Author:
          +
          Thorsten Kummerow
          +
          +
          • +
        +
        +
        +
          +
        • + + + +
            +
          • + + +

            Method Summary

            + + + + + + + + + + +
            All Methods Instance Methods Concrete Methods 
            Modifier and TypeMethod and Description
            voidisConstructedCorrectly() 
            +
              +
            • + + +

              Methods inherited from class java.lang.Object

              +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
              • +
            +
            • +
          +
          • +
        +
        +
        +
          +
        • + +
            +
          • + + +

            Constructor Detail

            + + + +
              +
            • +

              AccountSettingsTest

              +
              public AccountSettingsTest()
              +
              • +
            +
            • +
          + +
            +
          • + + +

            Method Detail

            + + + +
              +
            • +

              isConstructedCorrectly

              +
              public void isConstructedCorrectly()
              +
              • +
            +
            • +
          +
          • +
        +
        +
        + + +
        + + +
        Skip navigation links
        + + + + +
        +
        + + + +
        + +
        +
        +
          +
        • Summary: 
          • +
        • Nested | 
          • +
        • Field | 
          • +
        • Constr | 
          • +
        • Method
          • +
        + +
        + + +
        + + + diff --git a/com/textcontrol/reportingcloud/ImageFormat.html b/com/textcontrol/reportingcloud/ImageFormat.html index c58287c..de90042 100644 --- a/com/textcontrol/reportingcloud/ImageFormat.html +++ b/com/textcontrol/reportingcloud/ImageFormat.html @@ -2,7 +2,7 @@ - + ImageFormat @@ -48,7 +48,7 @@
        @@ -335,7 +335,7 @@

        valueOf

        diff --git a/com/textcontrol/reportingcloud/MergeBody.html b/com/textcontrol/reportingcloud/MergeBody.html index 66697f8..1595ac5 100644 --- a/com/textcontrol/reportingcloud/MergeBody.html +++ b/com/textcontrol/reportingcloud/MergeBody.html @@ -2,7 +2,7 @@ - + MergeBody @@ -18,7 +18,7 @@ catch(err) { } //--> -var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10}; +var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10}; var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; var altColor = "altColor"; var rowColor = "rowColor"; @@ -49,7 +49,7 @@
        • Frames
          • @@ -198,12 +198,18 @@

          Method Summary

          void +setMergeData(java.lang.Object[] mergeData) +
          Sets the merge data.
          + + + +void setMergeSettings(MergeSettings mergeSettings)
          Sets the merge settings to specify merge properties and document properties such as title and author.
          - + void setTemplate(byte[] template)
          Sets the binary template document data.
          @@ -436,15 +442,36 @@

          getMergeData

          +
            +
          • +

            setMergeData

            +
            public void setMergeData(java.lang.Iterable<java.lang.Object> mergeData)
+                  throws java.security.InvalidParameterException
            +
            Sets the merge data. Can be an iterable type of HashMap objects or an + iterable type of objects which can be serialized to JSON by GSON.
            +
            +
            Parameters:
            +
            mergeData - The merge data.
            +
            Throws:
            +
            java.security.InvalidParameterException
            +
            +
            • +
          + + +

          • setMergeData

            -
            public void setMergeData(java.lang.Iterable<java.lang.Object> mergeData)
            -
            Sets the merge data. Can be a list of HashMap objects or a list of objects +
            public void setMergeData(java.lang.Object[] mergeData)
+                  throws java.security.InvalidParameterException
            +
            Sets the merge data. Can be an array of HashMap objects or an array of objects which can be serialized to JSON by GSON.
            Parameters:
            mergeData - The merge data.
            +
            Throws:
            +
            java.security.InvalidParameterException
          @@ -476,7 +503,7 @@

          setMergeData

          • Frames
            • diff --git a/com/textcontrol/reportingcloud/MergeBodyTest.html b/com/textcontrol/reportingcloud/MergeBodyTest.html new file mode 100644 index 0000000..ecc059b --- /dev/null +++ b/com/textcontrol/reportingcloud/MergeBodyTest.html @@ -0,0 +1,287 @@ + + + + + +MergeBodyTest + + + + + + + + +
            + + +
            Skip navigation links
            + + + + +
            +
            + + + +
            + +
            +
            +
              +
            • Summary: 
              • +
            • Nested | 
              • +
            • Field | 
              • +
            • Constr | 
              • +
            • Method
              • +
            + +
            + + +
            + + +
            +
            com.textcontrol.reportingcloud
            +

            Class MergeBodyTest

            +
            +
            +
              +
            • java.lang.Object
              • +
            • +
                +
              • com.textcontrol.reportingcloud.MergeBodyTest
                • +
              +
              • +
            +
            +
              +
            • +
              +
              +
              public class MergeBodyTest
+extends java.lang.Object
              +
              The MergeBody test class.
              +
              +
              Author:
              +
              Thorsten Kummerow
              +
              +
              • +
            +
            +
            + +
            +
            +
              +
            • + +
                +
              • + + +

                Constructor Detail

                + + + +
                  +
                • +

                  MergeBodyTest

                  +
                  public MergeBodyTest()
                  +
                  • +
                +
                • +
              + +
                +
              • + + +

                Method Detail

                + + + +
                  +
                • +

                  setMergeData_throwsInCaseOfNull

                  +
                  public void setMergeData_throwsInCaseOfNull()
                  +
                  • +
                + + + +
                  +
                • +

                  setMergeData_throwsInCaseOfEmptyArray

                  +
                  public void setMergeData_throwsInCaseOfEmptyArray()
                  +
                  • +
                +
                • +
              +
              • +
            +
            +
            + + +
            + + +
            Skip navigation links
            + + + + +
            +
            + + + +
            + +
            +
            +
              +
            • Summary: 
              • +
            • Nested | 
              • +
            • Field | 
              • +
            • Constr | 
              • +
            • Method
              • +
            + +
            + + +
            + + + diff --git a/com/textcontrol/reportingcloud/MergeSettings.html b/com/textcontrol/reportingcloud/MergeSettings.html index da71ce3..fdd6209 100644 --- a/com/textcontrol/reportingcloud/MergeSettings.html +++ b/com/textcontrol/reportingcloud/MergeSettings.html @@ -2,7 +2,7 @@ - + MergeSettings @@ -18,7 +18,7 @@ catch(err) { } //--> -var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10,"i15":10,"i16":10,"i17":10}; +var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10,"i15":10,"i16":10,"i17":10,"i18":10,"i19":10,"i20":10,"i21":10,"i22":10,"i23":10}; var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; var altColor = "altColor"; var rowColor = "rowColor"; @@ -48,8 +48,8 @@
          • Frames
            • @@ -157,106 +157,142 @@

            Method Summary

            +java.time.ZonedDateTime +getCreationDate() +
            Gets the creation date.
            + + + java.lang.String getCreatorApplication()
            Gets the application which created the document.
            - + java.lang.String getDocumentSubject()
            Gets the document's subject.
            - + java.lang.String getdocumentTitle()
            Gets the document's title.
            - + +java.time.ZonedDateTime +getLastModificationDate() +
            Gets the last modification date.
            + + + boolean getRemoveEmptyBlocks()
            Gets whether the content of empty merge blocks should be removed from the template or not.
            - + boolean getRemoveEmptyFields()
            Gets whether empty fields should be removed from the template or not.
            - + boolean getRemoveEmptyImages()
            Gets whether images which don't have merge data should be removed from the template or not.
            - + boolean getRemoveTrailingWhitespace()
            Gets whether trailing whitespace should be removed before saving a document.
            - + java.lang.String getUserPassword()
            Gets the password needed to open the document.
            - + void setAuthor(java.lang.String author)
            Sets the document's author.
            - + +void +setCreationDate(java.lang.String creationDate) +
            Sets the creation date.
            + + + +void +setCreationDate(java.time.ZonedDateTime creationDate) +
            Sets the creation date.
            + + + void setCreatorApplication(java.lang.String creatorApplication)
            Sets the application which created the document.
            - + void setDocumentSubject(java.lang.String documentSubject)
            Sets the document's subject.
            - + void setDocumentTitle(java.lang.String documentTitle)
            Sets the document's title.
            - + +void +setLastModificationDate(java.lang.String lastModificationDate) +
            Sets the last modification date.
            + + + +void +setLastModificationDate(java.time.ZonedDateTime lastModificationDate) +
            Sets the last modification date.
            + + + void setRemoveEmptyBlocks(boolean removeEmptyBlocks)
            Sets whether the content of empty merge blocks should be removed from the template or not.
            - + void setRemoveEmptyFields(boolean removeEmptyFields)
            Sets whether empty fields should be removed from the template or not.
            - + void setRemoveEmptyImages(boolean removeEmptyImages)
            Sets whether images which don't have merge data should be removed from the template or not.
            - + void setRemoveTrailingWhitespace(boolean removeTrailingWhitespace)
            Sets whether trailing whitespace should be removed before saving a document.
            - + void setUserPassword(java.lang.String userPassword)
            Sets the password needed to open the document.
            @@ -549,7 +585,7 @@

            getUserPassword

            -
              +

              • setUserPassword

                public void setUserPassword(java.lang.String userPassword)
                @@ -560,6 +596,98 @@

                setUserPassword

    + + + +
      +
    • +

      getCreationDate

      +
      public java.time.ZonedDateTime getCreationDate()
      +
      Gets the creation date.
      +
      +
      Returns:
      +
      The creation date.
      +
      +
      • +
    + + + +
      +
    • +

      setCreationDate

      +
      public void setCreationDate(java.lang.String creationDate)
+                     throws java.time.format.DateTimeParseException
      +
      Sets the creation date.
      +
      +
      Parameters:
      +
      creationDate - The creation date (ISO-8601 extended offset date-time format). + Can be null.
      +
      Throws:
      +
      java.time.format.DateTimeParseException
      +
      +
      • +
    + + + +
      +
    • +

      setCreationDate

      +
      public void setCreationDate(java.time.ZonedDateTime creationDate)
      +
      Sets the creation date.
      +
      +
      Parameters:
      +
      creationDate - The creation date. Can be null.
      +
      +
      • +
    + + + +
      +
    • +

      getLastModificationDate

      +
      public java.time.ZonedDateTime getLastModificationDate()
      +
      Gets the last modification date.
      +
      +
      Returns:
      +
      The last modification date.
      +
      +
      • +
    + + + +
      +
    • +

      setLastModificationDate

      +
      public void setLastModificationDate(java.lang.String lastModificationDate)
+                             throws java.time.format.DateTimeParseException
      +
      Sets the last modification date.
      +
      +
      Parameters:
      +
      lastModificationDate - The last modification date (ISO-8601 extended offset date-time format). + Can be null.
      +
      Throws:
      +
      java.time.format.DateTimeParseException
      +
      +
      • +
    + + + +
      +
    • +

      setLastModificationDate

      +
      public void setLastModificationDate(java.time.ZonedDateTime lastModificationDate)
      +
      Sets the last modification date.
      +
      +
      Parameters:
      +
      lastModificationDate - The last modification date. Can be null.
      +
      +
      • +
@@ -587,8 +715,8 @@

setUserPassword

  • Frames
    • diff --git a/com/textcontrol/reportingcloud/MergeSettingsTest.html b/com/textcontrol/reportingcloud/MergeSettingsTest.html new file mode 100644 index 0000000..1e117d3 --- /dev/null +++ b/com/textcontrol/reportingcloud/MergeSettingsTest.html @@ -0,0 +1,339 @@ + + + + + +MergeSettingsTest + + + + + + + + +
    + + +
    Skip navigation links
    + + + + +
    +
    + + + +
    + +
    +
    +
      +
    • Summary: 
      • +
    • Nested | 
      • +
    • Field | 
      • +
    • Constr | 
      • +
    • Method
      • +
    + +
    + + +
    + + +
    +
    com.textcontrol.reportingcloud
    +

    Class MergeSettingsTest

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • com.textcontrol.reportingcloud.MergeSettingsTest
        • +
      +
      • +
    +
    +
      +
    • +
      +
      +
      public class MergeSettingsTest
+extends java.lang.Object
      +
      The MergeSettings test class.
      +
      +
      Author:
      +
      Thorsten Kummerow
      +
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          MergeSettingsTest

          +
          public MergeSettingsTest()
          +
          • +
        +
        • +
      + +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          setCreationDate_throwsOnInvalidFormat

          +
          public void setCreationDate_throwsOnInvalidFormat()
          +
          • +
        + + + +
          +
        • +

          setCreationDate_acceptsValidString

          +
          public void setCreationDate_acceptsValidString()
          +
          • +
        + + + +
          +
        • +

          setCreationDate_acceptsNull

          +
          public void setCreationDate_acceptsNull()
          +
          • +
        + + + +
          +
        • +

          setLastModificationDate_throwsOnInvalidFormat

          +
          public void setLastModificationDate_throwsOnInvalidFormat()
          +
          • +
        + + + +
          +
        • +

          setLastModificationDate_acceptsValidString

          +
          public void setLastModificationDate_acceptsValidString()
          +
          • +
        + + + +
          +
        • +

          setLastModificationDate_acceptsNull

          +
          public void setLastModificationDate_acceptsNull()
          +
          • +
        +
        • +
      +
      • +
    +
    +
    + + +
    + + +
    Skip navigation links
    + + + + +
    +
    + + + +
    + +
    +
    +
      +
    • Summary: 
      • +
    • Nested | 
      • +
    • Field | 
      • +
    • Constr | 
      • +
    • Method
      • +
    + +
    + + +
    + + + diff --git a/com/textcontrol/reportingcloud/ReportingCloud.html b/com/textcontrol/reportingcloud/ReportingCloud.html index f311ce6..d3c40dd 100644 --- a/com/textcontrol/reportingcloud/ReportingCloud.html +++ b/com/textcontrol/reportingcloud/ReportingCloud.html @@ -2,7 +2,7 @@ - + ReportingCloud @@ -48,7 +48,7 @@
    @@ -781,7 +781,7 @@

    mergeDocument

    diff --git a/com/textcontrol/reportingcloud/ReportingCloudTest.MasterItem.html b/com/textcontrol/reportingcloud/ReportingCloudTest.MasterItem.html index 9e86887..679d447 100644 --- a/com/textcontrol/reportingcloud/ReportingCloudTest.MasterItem.html +++ b/com/textcontrol/reportingcloud/ReportingCloudTest.MasterItem.html @@ -2,7 +2,7 @@ - + ReportingCloudTest.MasterItem diff --git a/com/textcontrol/reportingcloud/ReportingCloudTest.NestedItem.html b/com/textcontrol/reportingcloud/ReportingCloudTest.NestedItem.html index f317c65..3b97871 100644 --- a/com/textcontrol/reportingcloud/ReportingCloudTest.NestedItem.html +++ b/com/textcontrol/reportingcloud/ReportingCloudTest.NestedItem.html @@ -2,7 +2,7 @@ - + ReportingCloudTest.NestedItem diff --git a/com/textcontrol/reportingcloud/ReportingCloudTest.html b/com/textcontrol/reportingcloud/ReportingCloudTest.html index 259fb01..8d1bc39 100644 --- a/com/textcontrol/reportingcloud/ReportingCloudTest.html +++ b/com/textcontrol/reportingcloud/ReportingCloudTest.html @@ -2,7 +2,7 @@ - + ReportingCloudTest diff --git a/com/textcontrol/reportingcloud/ReturnFormat.html b/com/textcontrol/reportingcloud/ReturnFormat.html index 5ccae56..3de37e3 100644 --- a/com/textcontrol/reportingcloud/ReturnFormat.html +++ b/com/textcontrol/reportingcloud/ReturnFormat.html @@ -2,7 +2,7 @@ - + ReturnFormat diff --git a/com/textcontrol/reportingcloud/Template.html b/com/textcontrol/reportingcloud/Template.html index 1afc3f4..f9faa93 100644 --- a/com/textcontrol/reportingcloud/Template.html +++ b/com/textcontrol/reportingcloud/Template.html @@ -2,7 +2,7 @@ - + Template @@ -155,7 +155,7 @@

    Method Summary

    Method and Description -java.time.LocalDateTime +java.time.ZonedDateTime getModified()
    Gets the date and time the template file was last modified
    @@ -241,7 +241,7 @@

    getTemplateName

    • getModified

      -
      public java.time.LocalDateTime getModified()
      +
      public java.time.ZonedDateTime getModified()
      Gets the date and time the template file was last modified
      Returns:
      diff --git a/com/textcontrol/reportingcloud/TemplateDataValidator.html b/com/textcontrol/reportingcloud/TemplateDataValidator.html index f18e570..63321e3 100644 --- a/com/textcontrol/reportingcloud/TemplateDataValidator.html +++ b/com/textcontrol/reportingcloud/TemplateDataValidator.html @@ -2,7 +2,7 @@ - + TemplateDataValidator @@ -49,7 +49,7 @@
      • Frames
        • @@ -237,7 +237,7 @@

        validate

        • Frames
          • diff --git a/com/textcontrol/reportingcloud/TemplateDataValidatorTest.html b/com/textcontrol/reportingcloud/TemplateDataValidatorTest.html new file mode 100644 index 0000000..8274223 --- /dev/null +++ b/com/textcontrol/reportingcloud/TemplateDataValidatorTest.html @@ -0,0 +1,310 @@ + + + + + +TemplateDataValidatorTest + + + + + + + + +
          + + +
          Skip navigation links
          + + + + +
          +
          + + + +
          + +
          +
          +
            +
          • Summary: 
            • +
          • Nested | 
            • +
          • Field | 
            • +
          • Constr | 
            • +
          • Method
            • +
          + +
          + + +
          + + +
          +
          com.textcontrol.reportingcloud
          +

          Class TemplateDataValidatorTest

          +
          +
          +
            +
          • java.lang.Object
            • +
          • +
              +
            • com.textcontrol.reportingcloud.TemplateDataValidatorTest
              • +
            +
            • +
          +
          +
            +
          • +
            +
            +
            public class TemplateDataValidatorTest
+extends java.lang.Object
            +
            The TemplateDataValidator test class.
            +
            +
            Author:
            +
            Thorsten Kummerow
            +
            +
            • +
          +
          +
          + +
          +
          +
            +
          • + +
              +
            • + + +

              Constructor Detail

              + + + +
                +
              • +

                TemplateDataValidatorTest

                +
                public TemplateDataValidatorTest()
                +
                • +
              +
              • +
            + +
              +
            • + + +

              Method Detail

              + + + +
                +
              • +

                validate_throwsOnEmptyData

                +
                public void validate_throwsOnEmptyData()
+                                throws java.lang.Exception
                +
                +
                Throws:
                +
                java.lang.Exception
                +
                +
                • +
              + + + +
                +
              • +

                validate_throwsOnNull

                +
                public void validate_throwsOnNull()
+                           throws java.lang.Exception
                +
                +
                Throws:
                +
                java.lang.Exception
                +
                +
                • +
              + + + +
                +
              • +

                validate_validatesNonEmptyData

                +
                public void validate_validatesNonEmptyData()
                +
                • +
              +
              • +
            +
            • +
          +
          +
          + + +
          + + +
          Skip navigation links
          + + + + +
          +
          + + + +
          + +
          +
          +
            +
          • Summary: 
            • +
          • Nested | 
            • +
          • Field | 
            • +
          • Constr | 
            • +
          • Method
            • +
          + +
          + + +
          + + + diff --git a/com/textcontrol/reportingcloud/TemplateNameValidator.html b/com/textcontrol/reportingcloud/TemplateNameValidator.html index fe9b2bc..2a51336 100644 --- a/com/textcontrol/reportingcloud/TemplateNameValidator.html +++ b/com/textcontrol/reportingcloud/TemplateNameValidator.html @@ -2,7 +2,7 @@ - + TemplateNameValidator @@ -48,8 +48,8 @@
        • Frames
          • @@ -239,8 +239,8 @@

          validate

        • Frames
          • diff --git a/com/textcontrol/reportingcloud/TemplateNameValidatorTest.html b/com/textcontrol/reportingcloud/TemplateNameValidatorTest.html new file mode 100644 index 0000000..bc4a407 --- /dev/null +++ b/com/textcontrol/reportingcloud/TemplateNameValidatorTest.html @@ -0,0 +1,310 @@ + + + + + +TemplateNameValidatorTest + + + + + + + + +
          + + +
          Skip navigation links
          + + + + +
          +
          + + + +
          + +
          +
          +
            +
          • Summary: 
            • +
          • Nested | 
            • +
          • Field | 
            • +
          • Constr | 
            • +
          • Method
            • +
          + +
          + + +
          + + +
          +
          com.textcontrol.reportingcloud
          +

          Class TemplateNameValidatorTest

          +
          +
          +
            +
          • java.lang.Object
            • +
          • +
              +
            • com.textcontrol.reportingcloud.TemplateNameValidatorTest
              • +
            +
            • +
          +
          +
            +
          • +
            +
            +
            public class TemplateNameValidatorTest
+extends java.lang.Object
            +
            The TemplateNameValidator test class.
            +
            +
            Author:
            +
            Thorsten Kummerow
            +
            +
            • +
          +
          +
          + +
          +
          +
            +
          • + +
              +
            • + + +

              Constructor Detail

              + + + +
                +
              • +

                TemplateNameValidatorTest

                +
                public TemplateNameValidatorTest()
                +
                • +
              +
              • +
            + +
              +
            • + + +

              Method Detail

              + + + +
                +
              • +

                validate_throwsOnEmptyData

                +
                public void validate_throwsOnEmptyData()
+                                throws java.lang.Exception
                +
                +
                Throws:
                +
                java.lang.Exception
                +
                +
                • +
              + + + +
                +
              • +

                validate_throwsOnNull

                +
                public void validate_throwsOnNull()
+                           throws java.lang.Exception
                +
                +
                Throws:
                +
                java.lang.Exception
                +
                +
                • +
              + + + +
                +
              • +

                validate_validatesNonEmptyData

                +
                public void validate_validatesNonEmptyData()
                +
                • +
              +
              • +
            +
            • +
          +
          +
          + + +
          + + +
          Skip navigation links
          + + + + +
          +
          + + + +
          + +
          +
          +
            +
          • Summary: 
            • +
          • Nested | 
            • +
          • Field | 
            • +
          • Constr | 
            • +
          • Method
            • +
          + +
          + + +
          + + + diff --git a/com/textcontrol/reportingcloud/TemplateTest.html b/com/textcontrol/reportingcloud/TemplateTest.html new file mode 100644 index 0000000..de301b1 --- /dev/null +++ b/com/textcontrol/reportingcloud/TemplateTest.html @@ -0,0 +1,274 @@ + + + + + +TemplateTest + + + + + + + + +
          + + +
          Skip navigation links
          + + + + +
          +
          + + + +
          + +
          +
          +
            +
          • Summary: 
            • +
          • Nested | 
            • +
          • Field | 
            • +
          • Constr | 
            • +
          • Method
            • +
          + +
          + + +
          + + +
          +
          com.textcontrol.reportingcloud
          +

          Class TemplateTest

          +
          +
          +
            +
          • java.lang.Object
            • +
          • +
              +
            • com.textcontrol.reportingcloud.TemplateTest
              • +
            +
            • +
          +
          +
            +
          • +
            +
            +
            public class TemplateTest
+extends java.lang.Object
            +
            The Template test class.
            +
            +
            Author:
            +
            Thorsten Kummerow
            +
            +
            • +
          +
          +
          +
            +
          • + +
              +
            • + + +

              Constructor Summary

              + + + + + + + + +
              Constructors 
              Constructor and Description
              TemplateTest() 
              +
              • +
            + +
              +
            • + + +

              Method Summary

              + + + + + + + + + + +
              All Methods Instance Methods Concrete Methods 
              Modifier and TypeMethod and Description
              voidisConstructedCorrectly() 
              +
                +
              • + + +

                Methods inherited from class java.lang.Object

                +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
                • +
              +
              • +
            +
            • +
          +
          +
          +
            +
          • + +
              +
            • + + +

              Constructor Detail

              + + + +
                +
              • +

                TemplateTest

                +
                public TemplateTest()
                +
                • +
              +
              • +
            + +
              +
            • + + +

              Method Detail

              + + + +
                +
              • +

                isConstructedCorrectly

                +
                public void isConstructedCorrectly()
                +
                • +
              +
              • +
            +
            • +
          +
          +
          + + +
          + + +
          Skip navigation links
          + + + + +
          +
          + + + +
          + +
          +
          +
            +
          • Summary: 
            • +
          • Nested | 
            • +
          • Field | 
            • +
          • Constr | 
            • +
          • Method
            • +
          + +
          + + +
          + + + diff --git a/com/textcontrol/reportingcloud/gson/AccountSettingsDeserializer.html b/com/textcontrol/reportingcloud/gson/AccountSettingsDeserializer.html index e6b7e1a..3e70d1b 100644 --- a/com/textcontrol/reportingcloud/gson/AccountSettingsDeserializer.html +++ b/com/textcontrol/reportingcloud/gson/AccountSettingsDeserializer.html @@ -2,7 +2,7 @@ - + AccountSettingsDeserializer @@ -49,7 +49,7 @@
          • Frames
            • @@ -246,7 +246,7 @@

            deserialize

            • Frames
              • diff --git a/com/textcontrol/reportingcloud/gson/AccountSettingsDeserializerTest.html b/com/textcontrol/reportingcloud/gson/AccountSettingsDeserializerTest.html new file mode 100644 index 0000000..211f877 --- /dev/null +++ b/com/textcontrol/reportingcloud/gson/AccountSettingsDeserializerTest.html @@ -0,0 +1,274 @@ + + + + + +AccountSettingsDeserializerTest + + + + + + + + +
              + + +
              Skip navigation links
              + + + + +
              +
              + + + +
              + +
              +
              +
                +
              • Summary: 
                • +
              • Nested | 
                • +
              • Field | 
                • +
              • Constr | 
                • +
              • Method
                • +
              + +
              + + +
              + + +
              +
              com.textcontrol.reportingcloud.gson
              +

              Class AccountSettingsDeserializerTest

              +
              +
              +
                +
              • java.lang.Object
                • +
              • +
                  +
                • com.textcontrol.reportingcloud.gson.AccountSettingsDeserializerTest
                  • +
                +
                • +
              +
              +
                +
              • +
                +
                +
                public class AccountSettingsDeserializerTest
+extends java.lang.Object
                +
                AccountSettingsDeserializer test class.
                +
                +
                Author:
                +
                Thorsten Kummerow
                +
                +
                • +
              +
              +
              +
                +
              • + + + +
                  +
                • + + +

                  Method Summary

                  + + + + + + + + + + +
                  All Methods Instance Methods Concrete Methods 
                  Modifier and TypeMethod and Description
                  voiddeserialize() 
                  +
                    +
                  • + + +

                    Methods inherited from class java.lang.Object

                    +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
                    • +
                  +
                  • +
                +
                • +
              +
              +
              +
                +
              • + +
                  +
                • + + +

                  Constructor Detail

                  + + + +
                    +
                  • +

                    AccountSettingsDeserializerTest

                    +
                    public AccountSettingsDeserializerTest()
                    +
                    • +
                  +
                  • +
                + +
                  +
                • + + +

                  Method Detail

                  + + + +
                    +
                  • +

                    deserialize

                    +
                    public void deserialize()
                    +
                    • +
                  +
                  • +
                +
                • +
              +
              +
              + + +
              + + +
              Skip navigation links
              + + + + +
              +
              + + + +
              + +
              +
              +
                +
              • Summary: 
                • +
              • Nested | 
                • +
              • Field | 
                • +
              • Constr | 
                • +
              • Method
                • +
              + +
              + + +
              + + + diff --git a/com/textcontrol/reportingcloud/gson/MergeBodySerializer.html b/com/textcontrol/reportingcloud/gson/MergeBodySerializer.html index 5577eb6..bd0544a 100644 --- a/com/textcontrol/reportingcloud/gson/MergeBodySerializer.html +++ b/com/textcontrol/reportingcloud/gson/MergeBodySerializer.html @@ -2,7 +2,7 @@ - + MergeBodySerializer @@ -48,8 +48,8 @@
            • Frames
              • @@ -243,8 +243,8 @@

              serialize

            • Frames
              • diff --git a/com/textcontrol/reportingcloud/gson/MergeBodySerializerTest.html b/com/textcontrol/reportingcloud/gson/MergeBodySerializerTest.html new file mode 100644 index 0000000..52bb45d --- /dev/null +++ b/com/textcontrol/reportingcloud/gson/MergeBodySerializerTest.html @@ -0,0 +1,274 @@ + + + + + +MergeBodySerializerTest + + + + + + + + +
              + + +
              Skip navigation links
              + + + + +
              +
              + + + +
              + +
              +
              +
                +
              • Summary: 
                • +
              • Nested | 
                • +
              • Field | 
                • +
              • Constr | 
                • +
              • Method
                • +
              + +
              + + +
              + + +
              +
              com.textcontrol.reportingcloud.gson
              +

              Class MergeBodySerializerTest

              +
              +
              +
                +
              • java.lang.Object
                • +
              • +
                  +
                • com.textcontrol.reportingcloud.gson.MergeBodySerializerTest
                  • +
                +
                • +
              +
              +
                +
              • +
                +
                +
                public class MergeBodySerializerTest
+extends java.lang.Object
                +
                MergeBodySerializer test class.
                +
                +
                Author:
                +
                Thorsten Kummerow
                +
                +
                • +
              +
              +
              +
                +
              • + + + +
                  +
                • + + +

                  Method Summary

                  + + + + + + + + + + +
                  All Methods Instance Methods Concrete Methods 
                  Modifier and TypeMethod and Description
                  voidserialize() 
                  +
                    +
                  • + + +

                    Methods inherited from class java.lang.Object

                    +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
                    • +
                  +
                  • +
                +
                • +
              +
              +
              +
                +
              • + +
                  +
                • + + +

                  Constructor Detail

                  + + + +
                    +
                  • +

                    MergeBodySerializerTest

                    +
                    public MergeBodySerializerTest()
                    +
                    • +
                  +
                  • +
                + +
                  +
                • + + +

                  Method Detail

                  + + + +
                    +
                  • +

                    serialize

                    +
                    public void serialize()
                    +
                    • +
                  +
                  • +
                +
                • +
              +
              +
              + + +
              + + +
              Skip navigation links
              + + + + +
              +
              + + + +
              + +
              +
              +
                +
              • Summary: 
                • +
              • Nested | 
                • +
              • Field | 
                • +
              • Constr | 
                • +
              • Method
                • +
              + +
              + + +
              + + + diff --git a/com/textcontrol/reportingcloud/gson/MergeSettingsSerializer.html b/com/textcontrol/reportingcloud/gson/MergeSettingsSerializer.html index 8959679..97f9f30 100644 --- a/com/textcontrol/reportingcloud/gson/MergeSettingsSerializer.html +++ b/com/textcontrol/reportingcloud/gson/MergeSettingsSerializer.html @@ -2,7 +2,7 @@ - + MergeSettingsSerializer @@ -48,8 +48,8 @@
            • Frames
              • @@ -243,8 +243,8 @@

              serialize

            • Frames
              • diff --git a/com/textcontrol/reportingcloud/gson/MergeSettingsSerializerTest.html b/com/textcontrol/reportingcloud/gson/MergeSettingsSerializerTest.html new file mode 100644 index 0000000..7f376a6 --- /dev/null +++ b/com/textcontrol/reportingcloud/gson/MergeSettingsSerializerTest.html @@ -0,0 +1,274 @@ + + + + + +MergeSettingsSerializerTest + + + + + + + + +
              + + +
              Skip navigation links
              + + + + +
              +
              + + + +
              + +
              +
              +
                +
              • Summary: 
                • +
              • Nested | 
                • +
              • Field | 
                • +
              • Constr | 
                • +
              • Method
                • +
              + +
              + + +
              + + +
              +
              com.textcontrol.reportingcloud.gson
              +

              Class MergeSettingsSerializerTest

              +
              +
              +
                +
              • java.lang.Object
                • +
              • +
                  +
                • com.textcontrol.reportingcloud.gson.MergeSettingsSerializerTest
                  • +
                +
                • +
              +
              +
                +
              • +
                +
                +
                public class MergeSettingsSerializerTest
+extends java.lang.Object
                +
                MergeSettingsSerializerTest test class.
                +
                +
                Author:
                +
                Thorsten Kummerow
                +
                +
                • +
              +
              +
              +
                +
              • + + + +
                  +
                • + + +

                  Method Summary

                  + + + + + + + + + + +
                  All Methods Instance Methods Concrete Methods 
                  Modifier and TypeMethod and Description
                  voidserialize() 
                  +
                    +
                  • + + +

                    Methods inherited from class java.lang.Object

                    +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
                    • +
                  +
                  • +
                +
                • +
              +
              +
              +
                +
              • + +
                  +
                • + + +

                  Constructor Detail

                  + + + +
                    +
                  • +

                    MergeSettingsSerializerTest

                    +
                    public MergeSettingsSerializerTest()
                    +
                    • +
                  +
                  • +
                + +
                  +
                • + + +

                  Method Detail

                  + + + +
                    +
                  • +

                    serialize

                    +
                    public void serialize()
                    +
                    • +
                  +
                  • +
                +
                • +
              +
              +
              + + +
              + + +
              Skip navigation links
              + + + + +
              +
              + + + +
              + +
              +
              +
                +
              • Summary: 
                • +
              • Nested | 
                • +
              • Field | 
                • +
              • Constr | 
                • +
              • Method
                • +
              + +
              + + +
              + + + diff --git a/com/textcontrol/reportingcloud/gson/TemplateDeserializer.html b/com/textcontrol/reportingcloud/gson/TemplateDeserializer.html index 09d90a3..0082870 100644 --- a/com/textcontrol/reportingcloud/gson/TemplateDeserializer.html +++ b/com/textcontrol/reportingcloud/gson/TemplateDeserializer.html @@ -2,7 +2,7 @@ - + TemplateDeserializer @@ -48,8 +48,8 @@
            • Frames
              • @@ -245,8 +245,8 @@

              deserialize

            • Frames
              • diff --git a/com/textcontrol/reportingcloud/gson/TemplateDeserializerTest.html b/com/textcontrol/reportingcloud/gson/TemplateDeserializerTest.html new file mode 100644 index 0000000..fc9ba65 --- /dev/null +++ b/com/textcontrol/reportingcloud/gson/TemplateDeserializerTest.html @@ -0,0 +1,274 @@ + + + + + +TemplateDeserializerTest + + + + + + + + +
              + + +
              Skip navigation links
              + + + + +
              +
              + + + +
              + +
              +
              +
                +
              • Summary: 
                • +
              • Nested | 
                • +
              • Field | 
                • +
              • Constr | 
                • +
              • Method
                • +
              + +
              + + +
              + + +
              +
              com.textcontrol.reportingcloud.gson
              +

              Class TemplateDeserializerTest

              +
              +
              +
                +
              • java.lang.Object
                • +
              • +
                  +
                • com.textcontrol.reportingcloud.gson.TemplateDeserializerTest
                  • +
                +
                • +
              +
              +
                +
              • +
                +
                +
                public class TemplateDeserializerTest
+extends java.lang.Object
                +
                TemplateDeserializer test class.
                +
                +
                Author:
                +
                Thorsten Kummerow
                +
                +
                • +
              +
              +
              +
                +
              • + + + +
                  +
                • + + +

                  Method Summary

                  + + + + + + + + + + +
                  All Methods Instance Methods Concrete Methods 
                  Modifier and TypeMethod and Description
                  voiddeserialize() 
                  +
                    +
                  • + + +

                    Methods inherited from class java.lang.Object

                    +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
                    • +
                  +
                  • +
                +
                • +
              +
              +
              +
                +
              • + +
                  +
                • + + +

                  Constructor Detail

                  + + + +
                    +
                  • +

                    TemplateDeserializerTest

                    +
                    public TemplateDeserializerTest()
                    +
                    • +
                  +
                  • +
                + +
                  +
                • + + +

                  Method Detail

                  + + + +
                    +
                  • +

                    deserialize

                    +
                    public void deserialize()
                    +
                    • +
                  +
                  • +
                +
                • +
              +
              +
              + + +
              + + +
              Skip navigation links
              + + + + +
              +
              + + + +
              + +
              +
              +
                +
              • Summary: 
                • +
              • Nested | 
                • +
              • Field | 
                • +
              • Constr | 
                • +
              • Method
                • +
              + +
              + + +
              + + + diff --git a/com/textcontrol/reportingcloud/gson/package-frame.html b/com/textcontrol/reportingcloud/gson/package-frame.html index c133a1f..215442b 100644 --- a/com/textcontrol/reportingcloud/gson/package-frame.html +++ b/com/textcontrol/reportingcloud/gson/package-frame.html @@ -2,7 +2,7 @@ - + com.textcontrol.reportingcloud.gson @@ -14,9 +14,13 @@

              Classes

            diff --git a/com/textcontrol/reportingcloud/gson/package-summary.html b/com/textcontrol/reportingcloud/gson/package-summary.html index 2653013..1d69e2b 100644 --- a/com/textcontrol/reportingcloud/gson/package-summary.html +++ b/com/textcontrol/reportingcloud/gson/package-summary.html @@ -2,7 +2,7 @@ - + com.textcontrol.reportingcloud.gson @@ -88,12 +88,24 @@

            Package com.textcontrol.reportingcloud.gs +AccountSettingsDeserializerTest + +
            AccountSettingsDeserializer test class.
            + + + MergeBodySerializer
            Needed by GSON to serialize MergeBody objects to JSON.
            + +MergeBodySerializerTest + +
            MergeBodySerializer test class.
            + + MergeSettingsSerializer @@ -102,11 +114,23 @@

            Package com.textcontrol.reportingcloud.gs +MergeSettingsSerializerTest + +
            MergeSettingsSerializerTest test class.
            + + + TemplateDeserializer
            Needed by GSON to create Template objects from JSON data.
            + +TemplateDeserializerTest + +
            TemplateDeserializer test class.
            + + diff --git a/com/textcontrol/reportingcloud/gson/package-tree.html b/com/textcontrol/reportingcloud/gson/package-tree.html index 7d5386c..4a188d8 100644 --- a/com/textcontrol/reportingcloud/gson/package-tree.html +++ b/com/textcontrol/reportingcloud/gson/package-tree.html @@ -2,7 +2,7 @@ - + com.textcontrol.reportingcloud.gson Class Hierarchy @@ -81,9 +81,13 @@

            Class Hierarchy

          • java.lang.Object
          diff --git a/com/textcontrol/reportingcloud/package-frame.html b/com/textcontrol/reportingcloud/package-frame.html index df32c0c..a6721a5 100644 --- a/com/textcontrol/reportingcloud/package-frame.html +++ b/com/textcontrol/reportingcloud/package-frame.html @@ -2,7 +2,7 @@ - + com.textcontrol.reportingcloud @@ -14,13 +14,19 @@

          Classes

          Enums

          diff --git a/constant-values.html b/constant-values.html index 1d4d8eb..27a8cd4 100644 --- a/constant-values.html +++ b/constant-values.html @@ -2,7 +2,7 @@ - + Constant Field Values diff --git a/deprecated-list.html b/deprecated-list.html index f0dea42..018b82c 100644 --- a/deprecated-list.html +++ b/deprecated-list.html @@ -2,7 +2,7 @@ - + Deprecated List diff --git a/help-doc.html b/help-doc.html index ec13dc9..925f94d 100644 --- a/help-doc.html +++ b/help-doc.html @@ -2,7 +2,7 @@ - + API Help diff --git a/index-files/index-1.html b/index-files/index-1.html index 87a6d92..381901a 100644 --- a/index-files/index-1.html +++ b/index-files/index-1.html @@ -2,7 +2,7 @@ - + A-Index @@ -85,6 +85,18 @@

          A

          AccountSettingsDeserializer() - Constructor for class com.textcontrol.reportingcloud.gson.AccountSettingsDeserializer
           
          +
          AccountSettingsDeserializerTest - Class in com.textcontrol.reportingcloud.gson
          +
          +
          AccountSettingsDeserializer test class.
          +
          +
          AccountSettingsDeserializerTest() - Constructor for class com.textcontrol.reportingcloud.gson.AccountSettingsDeserializerTest
          +
           
          +
          AccountSettingsTest - Class in com.textcontrol.reportingcloud
          +
          +
          The AccountSettings test class.
          +
          +
          AccountSettingsTest() - Constructor for class com.textcontrol.reportingcloud.AccountSettingsTest
          +
           
      A B C D G I L M N R S T U V 
diff --git a/index-files/index-10.html b/index-files/index-10.html index b86c948..5a8b1a7 100644 --- a/index-files/index-10.html +++ b/index-files/index-10.html @@ -2,7 +2,7 @@ - + R-Index diff --git a/index-files/index-11.html b/index-files/index-11.html index d529065..2ff8c32 100644 --- a/index-files/index-11.html +++ b/index-files/index-11.html @@ -2,7 +2,7 @@ - + S-Index @@ -75,12 +75,30 @@

S

serialize(MergeBody, Type, JsonSerializationContext) - Method in class com.textcontrol.reportingcloud.gson.MergeBodySerializer
 
+
serialize() - Method in class com.textcontrol.reportingcloud.gson.MergeBodySerializerTest
+
 
serialize(MergeSettings, Type, JsonSerializationContext) - Method in class com.textcontrol.reportingcloud.gson.MergeSettingsSerializer
 
+
serialize() - Method in class com.textcontrol.reportingcloud.gson.MergeSettingsSerializerTest
+
 
setAuthor(String) - Method in class com.textcontrol.reportingcloud.MergeSettings
Sets the document's author.
+
setCreationDate(String) - Method in class com.textcontrol.reportingcloud.MergeSettings
+
+
Sets the creation date.
+
+
setCreationDate(ZonedDateTime) - Method in class com.textcontrol.reportingcloud.MergeSettings
+
+
Sets the creation date.
+
+
setCreationDate_acceptsNull() - Method in class com.textcontrol.reportingcloud.MergeSettingsTest
+
 
+
setCreationDate_acceptsValidString() - Method in class com.textcontrol.reportingcloud.MergeSettingsTest
+
 
+
setCreationDate_throwsOnInvalidFormat() - Method in class com.textcontrol.reportingcloud.MergeSettingsTest
+
 
setCreatorApplication(String) - Method in class com.textcontrol.reportingcloud.MergeSettings
Sets the application which created the document.
@@ -93,10 +111,32 @@

S

Sets the document's title.
+
setLastModificationDate(String) - Method in class com.textcontrol.reportingcloud.MergeSettings
+
+
Sets the last modification date.
+
+
setLastModificationDate(ZonedDateTime) - Method in class com.textcontrol.reportingcloud.MergeSettings
+
+
Sets the last modification date.
+
+
setLastModificationDate_acceptsNull() - Method in class com.textcontrol.reportingcloud.MergeSettingsTest
+
 
+
setLastModificationDate_acceptsValidString() - Method in class com.textcontrol.reportingcloud.MergeSettingsTest
+
 
+
setLastModificationDate_throwsOnInvalidFormat() - Method in class com.textcontrol.reportingcloud.MergeSettingsTest
+
 
setMergeData(Iterable<Object>) - Method in class com.textcontrol.reportingcloud.MergeBody
Sets the merge data.
+
setMergeData(Object[]) - Method in class com.textcontrol.reportingcloud.MergeBody
+
+
Sets the merge data.
+
+
setMergeData_throwsInCaseOfEmptyArray() - Method in class com.textcontrol.reportingcloud.MergeBodyTest
+
 
+
setMergeData_throwsInCaseOfNull() - Method in class com.textcontrol.reportingcloud.MergeBodyTest
+
 
setMergeSettings(MergeSettings) - Method in class com.textcontrol.reportingcloud.MergeBody
Sets the merge settings to specify merge properties and document properties such diff --git a/index-files/index-12.html b/index-files/index-12.html index bd1202f..2414337 100644 --- a/index-files/index-12.html +++ b/index-files/index-12.html @@ -2,7 +2,7 @@ - + T-Index @@ -87,12 +87,24 @@

T

TemplateDataValidator() - Constructor for class com.textcontrol.reportingcloud.TemplateDataValidator
 
+
TemplateDataValidatorTest - Class in com.textcontrol.reportingcloud
+
+
The TemplateDataValidator test class.
+
+
TemplateDataValidatorTest() - Constructor for class com.textcontrol.reportingcloud.TemplateDataValidatorTest
+
 
TemplateDeserializer - Class in com.textcontrol.reportingcloud.gson
Needed by GSON to create Template objects from JSON data.
TemplateDeserializer() - Constructor for class com.textcontrol.reportingcloud.gson.TemplateDeserializer
 
+
TemplateDeserializerTest - Class in com.textcontrol.reportingcloud.gson
+
+
TemplateDeserializer test class.
+
+
TemplateDeserializerTest() - Constructor for class com.textcontrol.reportingcloud.gson.TemplateDeserializerTest
+
 
templateExists(String) - Method in class com.textcontrol.reportingcloud.ReportingCloud
Checks whether a template exists in the template storage.
@@ -105,6 +117,18 @@

T

TemplateNameValidator() - Constructor for class com.textcontrol.reportingcloud.TemplateNameValidator
 
+
TemplateNameValidatorTest - Class in com.textcontrol.reportingcloud
+
+
The TemplateNameValidator test class.
+
+
TemplateNameValidatorTest() - Constructor for class com.textcontrol.reportingcloud.TemplateNameValidatorTest
+
 
+
TemplateTest - Class in com.textcontrol.reportingcloud
+
+
The Template test class.
+
+
TemplateTest() - Constructor for class com.textcontrol.reportingcloud.TemplateTest
+
 
A B C D G I L M N R S T U V  diff --git a/index-files/index-13.html b/index-files/index-13.html index eca5d79..c1fa8fe 100644 --- a/index-files/index-13.html +++ b/index-files/index-13.html @@ -2,7 +2,7 @@ - + U-Index diff --git a/index-files/index-14.html b/index-files/index-14.html index c7ca266..4841c42 100644 --- a/index-files/index-14.html +++ b/index-files/index-14.html @@ -2,7 +2,7 @@ - + V-Index @@ -81,6 +81,18 @@

V

Checks if a template name contains something.
+
validate_throwsOnEmptyData() - Method in class com.textcontrol.reportingcloud.TemplateDataValidatorTest
+
 
+
validate_throwsOnEmptyData() - Method in class com.textcontrol.reportingcloud.TemplateNameValidatorTest
+
 
+
validate_throwsOnNull() - Method in class com.textcontrol.reportingcloud.TemplateDataValidatorTest
+
 
+
validate_throwsOnNull() - Method in class com.textcontrol.reportingcloud.TemplateNameValidatorTest
+
 
+
validate_validatesNonEmptyData() - Method in class com.textcontrol.reportingcloud.TemplateDataValidatorTest
+
 
+
validate_validatesNonEmptyData() - Method in class com.textcontrol.reportingcloud.TemplateNameValidatorTest
+
 
valueOf(String) - Static method in enum com.textcontrol.reportingcloud.ImageFormat
Returns the enum constant of this type with the specified name.
diff --git a/index-files/index-2.html b/index-files/index-2.html index 06bc10f..8b89feb 100644 --- a/index-files/index-2.html +++ b/index-files/index-2.html @@ -2,7 +2,7 @@ - + B-Index diff --git a/index-files/index-3.html b/index-files/index-3.html index acb0001..50447d1 100644 --- a/index-files/index-3.html +++ b/index-files/index-3.html @@ -2,7 +2,7 @@ - + C-Index diff --git a/index-files/index-4.html b/index-files/index-4.html index 91a7aa7..ead014e 100644 --- a/index-files/index-4.html +++ b/index-files/index-4.html @@ -2,7 +2,7 @@ - + D-Index @@ -81,8 +81,12 @@

D

 
deserialize(JsonElement, Type, JsonDeserializationContext) - Method in class com.textcontrol.reportingcloud.gson.AccountSettingsDeserializer
 
+
deserialize() - Method in class com.textcontrol.reportingcloud.gson.AccountSettingsDeserializerTest
+
 
deserialize(JsonElement, Type, JsonDeserializationContext) - Method in class com.textcontrol.reportingcloud.gson.TemplateDeserializer
 
+
deserialize() - Method in class com.textcontrol.reportingcloud.gson.TemplateDeserializerTest
+
 
downloadTemplate(String) - Method in class com.textcontrol.reportingcloud.ReportingCloud
Returns the selected template from the storage.
diff --git a/index-files/index-5.html b/index-files/index-5.html index 1357da9..f5f58e4 100644 --- a/index-files/index-5.html +++ b/index-files/index-5.html @@ -2,7 +2,7 @@ - + G-Index @@ -87,6 +87,10 @@

G

Gets the number of created documents in the current month.
+
getCreationDate() - Method in class com.textcontrol.reportingcloud.MergeSettings
+
+
Gets the creation date.
+
getCreatorApplication() - Method in class com.textcontrol.reportingcloud.MergeSettings
Gets the application which created the document.
@@ -99,6 +103,10 @@

G

Gets the document's title.
+
getLastModificationDate() - Method in class com.textcontrol.reportingcloud.MergeSettings
+
+
Gets the last modification date.
+
getMaxDocuments() - Method in class com.textcontrol.reportingcloud.AccountSettings
Gets the maximum number of documents that can be created per month.
diff --git a/index-files/index-6.html b/index-files/index-6.html index 103f6db..188655b 100644 --- a/index-files/index-6.html +++ b/index-files/index-6.html @@ -2,7 +2,7 @@ - + I-Index @@ -79,6 +79,10 @@

I

initialize() - Method in class com.textcontrol.reportingcloud.ReportingCloudTest
 
+
isConstructedCorrectly() - Method in class com.textcontrol.reportingcloud.AccountSettingsTest
+
 
+
isConstructedCorrectly() - Method in class com.textcontrol.reportingcloud.TemplateTest
+
 
item - Variable in class com.textcontrol.reportingcloud.ReportingCloudTest.MasterItem
 
item_description - Variable in class com.textcontrol.reportingcloud.ReportingCloudTest.NestedItem
diff --git a/index-files/index-7.html b/index-files/index-7.html index 2393ca2..9f513ae 100644 --- a/index-files/index-7.html +++ b/index-files/index-7.html @@ -2,7 +2,7 @@ - + L-Index diff --git a/index-files/index-8.html b/index-files/index-8.html index e652bb4..ad7922b 100644 --- a/index-files/index-8.html +++ b/index-files/index-8.html @@ -2,7 +2,7 @@ - + M-Index @@ -98,6 +98,18 @@

M

MergeBodySerializer() - Constructor for class com.textcontrol.reportingcloud.gson.MergeBodySerializer
 
+
MergeBodySerializerTest - Class in com.textcontrol.reportingcloud.gson
+
+
MergeBodySerializer test class.
+
+
MergeBodySerializerTest() - Constructor for class com.textcontrol.reportingcloud.gson.MergeBodySerializerTest
+
 
+
MergeBodyTest - Class in com.textcontrol.reportingcloud
+
+
The MergeBody test class.
+
+
MergeBodyTest() - Constructor for class com.textcontrol.reportingcloud.MergeBodyTest
+
 
mergeDocument(MergeBody) - Method in class com.textcontrol.reportingcloud.ReportingCloud
Merges and returns a template from the template storage or an uploaded template with JSON data.
@@ -131,6 +143,18 @@

M

MergeSettingsSerializer() - Constructor for class com.textcontrol.reportingcloud.gson.MergeSettingsSerializer
 
+
MergeSettingsSerializerTest - Class in com.textcontrol.reportingcloud.gson
+
+
MergeSettingsSerializerTest test class.
+
+
MergeSettingsSerializerTest() - Constructor for class com.textcontrol.reportingcloud.gson.MergeSettingsSerializerTest
+
 
+
MergeSettingsTest - Class in com.textcontrol.reportingcloud
+
+
The MergeSettings test class.
+
+
MergeSettingsTest() - Constructor for class com.textcontrol.reportingcloud.MergeSettingsTest
+
 
A B C D G I L M N R S T U V  diff --git a/index-files/index-9.html b/index-files/index-9.html index 74835c9..58575f8 100644 --- a/index-files/index-9.html +++ b/index-files/index-9.html @@ -2,7 +2,7 @@ - + N-Index diff --git a/index.html b/index.html index a63ec31..d8d2547 100644 --- a/index.html +++ b/index.html @@ -2,7 +2,7 @@ - + Generated Documentation (Untitled) - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
-
    -
  • Summary: 
    • -
  • Nested | 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
- -
- - -
- - -
-
com.textcontrol.reportingcloud
-

Class AccountSettingsTest

-
-
-
    -
  • java.lang.Object
    • -
  • -
      -
    • com.textcontrol.reportingcloud.AccountSettingsTest
      • -
    -
    • -
-
-
    -
  • -
    -
    -
    public class AccountSettingsTest
-extends java.lang.Object
    -
    The AccountSettings test class.
    -
    -
    Author:
    -
    Thorsten Kummerow
    -
    -
    • -
-
-
-
    -
  • - - - -
      -
    • - - -

      Method Summary

      - - - - - - - - - - -
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      voidisConstructedCorrectly() 
      -
        -
      • - - -

        Methods inherited from class java.lang.Object

        -clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
        • -
      -
      • -
    -
    • -
-
-
-
    -
  • - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        AccountSettingsTest

        -
        public AccountSettingsTest()
        -
        • -
      -
      • -
    - -
      -
    • - - -

      Method Detail

      - - - -
        -
      • -

        isConstructedCorrectly

        -
        public void isConstructedCorrectly()
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
-
    -
  • Summary: 
    • -
  • Nested | 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
- -
- - -
- - - diff --git a/com/textcontrol/reportingcloud/ImageFormat.html b/com/textcontrol/reportingcloud/ImageFormat.html index de90042..3928556 100644 --- a/com/textcontrol/reportingcloud/ImageFormat.html +++ b/com/textcontrol/reportingcloud/ImageFormat.html @@ -2,7 +2,7 @@ - + ImageFormat @@ -48,7 +48,7 @@
    @@ -335,7 +335,7 @@

    valueOf

    diff --git a/com/textcontrol/reportingcloud/MergeBody.html b/com/textcontrol/reportingcloud/MergeBody.html index 1595ac5..8ba04e7 100644 --- a/com/textcontrol/reportingcloud/MergeBody.html +++ b/com/textcontrol/reportingcloud/MergeBody.html @@ -2,7 +2,7 @@ - + MergeBody @@ -49,7 +49,7 @@
    • Frames
      • @@ -503,7 +503,7 @@

      setMergeData

      • Frames
        • diff --git a/com/textcontrol/reportingcloud/MergeBodyTest.html b/com/textcontrol/reportingcloud/MergeBodyTest.html deleted file mode 100644 index ecc059b..0000000 --- a/com/textcontrol/reportingcloud/MergeBodyTest.html +++ /dev/null @@ -1,287 +0,0 @@ - - - - - -MergeBodyTest - - - - - - - - -
        - - -
        Skip navigation links
        - - - - -
        -
        - - - -
        - -
        -
        -
          -
        • Summary: 
          • -
        • Nested | 
          • -
        • Field | 
          • -
        • Constr | 
          • -
        • Method
          • -
        - -
        - - -
        - - -
        -
        com.textcontrol.reportingcloud
        -

        Class MergeBodyTest

        -
        -
        -
          -
        • java.lang.Object
          • -
        • -
            -
          • com.textcontrol.reportingcloud.MergeBodyTest
            • -
          -
          • -
        -
        -
          -
        • -
          -
          -
          public class MergeBodyTest
-extends java.lang.Object
          -
          The MergeBody test class.
          -
          -
          Author:
          -
          Thorsten Kummerow
          -
          -
          • -
        -
        -
        - -
        -
        -
          -
        • - -
            -
          • - - -

            Constructor Detail

            - - - -
              -
            • -

              MergeBodyTest

              -
              public MergeBodyTest()
              -
              • -
            -
            • -
          - -
            -
          • - - -

            Method Detail

            - - - -
              -
            • -

              setMergeData_throwsInCaseOfNull

              -
              public void setMergeData_throwsInCaseOfNull()
              -
              • -
            - - - -
              -
            • -

              setMergeData_throwsInCaseOfEmptyArray

              -
              public void setMergeData_throwsInCaseOfEmptyArray()
              -
              • -
            -
            • -
          -
          • -
        -
        -
        - - -
        - - -
        Skip navigation links
        - - - - -
        -
        - - - -
        - -
        -
        -
          -
        • Summary: 
          • -
        • Nested | 
          • -
        • Field | 
          • -
        • Constr | 
          • -
        • Method
          • -
        - -
        - - -
        - - - diff --git a/com/textcontrol/reportingcloud/MergeSettings.html b/com/textcontrol/reportingcloud/MergeSettings.html index fdd6209..ebce8af 100644 --- a/com/textcontrol/reportingcloud/MergeSettings.html +++ b/com/textcontrol/reportingcloud/MergeSettings.html @@ -2,7 +2,7 @@ - + MergeSettings @@ -48,8 +48,8 @@
      • Frames
        • @@ -715,8 +715,8 @@

        setLastModificationDate

      • Frames
        • diff --git a/com/textcontrol/reportingcloud/MergeSettingsTest.html b/com/textcontrol/reportingcloud/MergeSettingsTest.html deleted file mode 100644 index 1e117d3..0000000 --- a/com/textcontrol/reportingcloud/MergeSettingsTest.html +++ /dev/null @@ -1,339 +0,0 @@ - - - - - -MergeSettingsTest - - - - - - - - -
        - - -
        Skip navigation links
        - - - - -
        -
        - - - -
        - -
        -
        -
          -
        • Summary: 
          • -
        • Nested | 
          • -
        • Field | 
          • -
        • Constr | 
          • -
        • Method
          • -
        - -
        - - -
        - - -
        -
        com.textcontrol.reportingcloud
        -

        Class MergeSettingsTest

        -
        -
        -
          -
        • java.lang.Object
          • -
        • -
            -
          • com.textcontrol.reportingcloud.MergeSettingsTest
            • -
          -
          • -
        -
        -
          -
        • -
          -
          -
          public class MergeSettingsTest
-extends java.lang.Object
          -
          The MergeSettings test class.
          -
          -
          Author:
          -
          Thorsten Kummerow
          -
          -
          • -
        -
        -
        - -
        -
        -
          -
        • - -
            -
          • - - -

            Constructor Detail

            - - - -
              -
            • -

              MergeSettingsTest

              -
              public MergeSettingsTest()
              -
              • -
            -
            • -
          - -
            -
          • - - -

            Method Detail

            - - - -
              -
            • -

              setCreationDate_throwsOnInvalidFormat

              -
              public void setCreationDate_throwsOnInvalidFormat()
              -
              • -
            - - - -
              -
            • -

              setCreationDate_acceptsValidString

              -
              public void setCreationDate_acceptsValidString()
              -
              • -
            - - - -
              -
            • -

              setCreationDate_acceptsNull

              -
              public void setCreationDate_acceptsNull()
              -
              • -
            - - - -
              -
            • -

              setLastModificationDate_throwsOnInvalidFormat

              -
              public void setLastModificationDate_throwsOnInvalidFormat()
              -
              • -
            - - - -
              -
            • -

              setLastModificationDate_acceptsValidString

              -
              public void setLastModificationDate_acceptsValidString()
              -
              • -
            - - - -
              -
            • -

              setLastModificationDate_acceptsNull

              -
              public void setLastModificationDate_acceptsNull()
              -
              • -
            -
            • -
          -
          • -
        -
        -
        - - -
        - - -
        Skip navigation links
        - - - - -
        -
        - - - -
        - -
        -
        -
          -
        • Summary: 
          • -
        • Nested | 
          • -
        • Field | 
          • -
        • Constr | 
          • -
        • Method
          • -
        - -
        - - -
        - - - diff --git a/com/textcontrol/reportingcloud/ReportingCloud.html b/com/textcontrol/reportingcloud/ReportingCloud.html index d3c40dd..caab5b4 100644 --- a/com/textcontrol/reportingcloud/ReportingCloud.html +++ b/com/textcontrol/reportingcloud/ReportingCloud.html @@ -2,7 +2,7 @@ - + ReportingCloud @@ -48,8 +48,8 @@
      • Frames
        • @@ -781,8 +781,8 @@

        mergeDocument

      • Frames
        • diff --git a/com/textcontrol/reportingcloud/ReportingCloudTest.MasterItem.html b/com/textcontrol/reportingcloud/ReportingCloudTest.MasterItem.html deleted file mode 100644 index 679d447..0000000 --- a/com/textcontrol/reportingcloud/ReportingCloudTest.MasterItem.html +++ /dev/null @@ -1,303 +0,0 @@ - - - - - -ReportingCloudTest.MasterItem - - - - - - - - -
        - - -
        Skip navigation links
        - - - - -
        -
        - - - -
        - -
        -
        - - -
        - - -
        - - -
        -
        com.textcontrol.reportingcloud
        -

        Class ReportingCloudTest.MasterItem

        -
        -
        -
          -
        • java.lang.Object
          • -
        • -
            -
          • com.textcontrol.reportingcloud.ReportingCloudTest.MasterItem
            • -
          -
          • -
        -
        -
          -
        • -
          -
          Enclosing class:
          -
          ReportingCloudTest
          -
          -
          -
          -
          public class ReportingCloudTest.MasterItem
-extends java.lang.Object
          -
          • -
        -
        -
        -
          -
        • - - - -
            -
          • - - -

            Constructor Summary

            - - - - - - - - -
            Constructors 
            Constructor and Description
            MasterItem(java.lang.String recipient_name, - java.lang.String billto_name) 
            -
            • -
          - -
            -
          • - - -

            Method Summary

            -
              -
            • - - -

              Methods inherited from class java.lang.Object

              -clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
              • -
            -
            • -
          -
          • -
        -
        -
        -
          -
        • - -
            -
          • - - -

            Field Detail

            - - - - - - - -
              -
            • -

              recipient_name

              -
              public java.lang.String recipient_name
              -
              • -
            - - - -
              -
            • -

              billto_name

              -
              public java.lang.String billto_name
              -
              • -
            -
            • -
          - -
            -
          • - - -

            Constructor Detail

            - - - -
              -
            • -

              MasterItem

              -
              public MasterItem(java.lang.String recipient_name,
-                  java.lang.String billto_name)
              -
              • -
            -
            • -
          -
          • -
        -
        -
        - - -
        - - -
        Skip navigation links
        - - - - -
        -
        - - - -
        - -
        -
        - - -
        - - -
        - - - diff --git a/com/textcontrol/reportingcloud/ReportingCloudTest.NestedItem.html b/com/textcontrol/reportingcloud/ReportingCloudTest.NestedItem.html deleted file mode 100644 index 3b97871..0000000 --- a/com/textcontrol/reportingcloud/ReportingCloudTest.NestedItem.html +++ /dev/null @@ -1,305 +0,0 @@ - - - - - -ReportingCloudTest.NestedItem - - - - - - - - -
        - - -
        Skip navigation links
        - - - - -
        -
        - - - -
        - -
        -
        - - -
        - - -
        - - -
        -
        com.textcontrol.reportingcloud
        -

        Class ReportingCloudTest.NestedItem

        -
        -
        -
          -
        • java.lang.Object
          • -
        • -
            -
          • com.textcontrol.reportingcloud.ReportingCloudTest.NestedItem
            • -
          -
          • -
        -
        -
          -
        • -
          -
          Enclosing class:
          -
          ReportingCloudTest
          -
          -
          -
          -
          public class ReportingCloudTest.NestedItem
-extends java.lang.Object
          -
          • -
        -
        -
        -
          -
        • - - - -
            -
          • - - -

            Constructor Summary

            - - - - - - - - -
            Constructors 
            Constructor and Description
            NestedItem(int item_no, - java.lang.String item_description, - double item_total) 
            -
            • -
          - -
            -
          • - - -

            Method Summary

            -
              -
            • - - -

              Methods inherited from class java.lang.Object

              -clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
              • -
            -
            • -
          -
          • -
        -
        -
        -
          -
        • - -
            -
          • - - -

            Field Detail

            - - - -
              -
            • -

              item_no

              -
              public int item_no
              -
              • -
            - - - -
              -
            • -

              item_description

              -
              public java.lang.String item_description
              -
              • -
            - - - -
              -
            • -

              item_total

              -
              public double item_total
              -
              • -
            -
            • -
          - -
            -
          • - - -

            Constructor Detail

            - - - -
              -
            • -

              NestedItem

              -
              public NestedItem(int item_no,
-                  java.lang.String item_description,
-                  double item_total)
              -
              • -
            -
            • -
          -
          • -
        -
        -
        - - -
        - - -
        Skip navigation links
        - - - - -
        -
        - - - -
        - -
        -
        - - -
        - - -
        - - - diff --git a/com/textcontrol/reportingcloud/ReportingCloudTest.html b/com/textcontrol/reportingcloud/ReportingCloudTest.html deleted file mode 100644 index 8d1bc39..0000000 --- a/com/textcontrol/reportingcloud/ReportingCloudTest.html +++ /dev/null @@ -1,523 +0,0 @@ - - - - - -ReportingCloudTest - - - - - - - - -
        - - -
        Skip navigation links
        - - - - -
        -
        - - - -
        - -
        -
        - - -
        - - -
        - - -
        -
        com.textcontrol.reportingcloud
        -

        Class ReportingCloudTest

        -
        -
        -
          -
        • java.lang.Object
          • -
        • -
            -
          • com.textcontrol.reportingcloud.ReportingCloudTest
            • -
          -
          • -
        -
        -
          -
        • -
          -
          -
          public class ReportingCloudTest
-extends java.lang.Object
          -
          The ReportingCloud test class.
          -
          -
          Author:
          -
          Thorsten Kummerow
          -
          -
          • -
        -
        -
        - -
        -
        -
          -
        • - -
            -
          • - - -

            Constructor Detail

            - - - -
              -
            • -

              ReportingCloudTest

              -
              public ReportingCloudTest()
-                   throws java.io.IOException
              -
              -
              Throws:
              -
              java.io.IOException
              -
              -
              • -
            -
            • -
          - -
            -
          • - - -

            Method Detail

            - - - -
              -
            • -

              initialize

              -
              public void initialize()
-                throws java.io.IOException
              -
              -
              Throws:
              -
              java.io.IOException
              -
              -
              • -
            - - - -
              -
            • -

              getTemplateCount

              -
              public void getTemplateCount()
-                      throws java.lang.Exception
              -
              -
              Throws:
              -
              java.lang.Exception
              -
              -
              • -
            - - - -
              -
            • -

              getTemplatePageCount

              -
              public void getTemplatePageCount()
-                          throws java.lang.Exception
              -
              -
              Throws:
              -
              java.lang.Exception
              -
              -
              • -
            - - - -
              -
            • -

              listTemplates

              -
              public void listTemplates()
-                   throws java.lang.Exception
              -
              -
              Throws:
              -
              java.lang.Exception
              -
              -
              • -
            - - - -
              -
            • -

              convertDocument

              -
              public void convertDocument()
-                     throws java.lang.Exception
              -
              -
              Throws:
              -
              java.lang.Exception
              -
              -
              • -
            - - - -
              -
            • -

              getAccountSettings

              -
              public void getAccountSettings()
-                        throws java.lang.Exception
              -
              -
              Throws:
              -
              java.lang.Exception
              -
              -
              • -
            - - - -
              -
            • -

              mergeDocument_usingIterable

              -
              public void mergeDocument_usingIterable()
-                                 throws java.lang.Exception
              -
              -
              Throws:
              -
              java.lang.Exception
              -
              -
              • -
            - - - -
              -
            • -

              mergeDocument_usingArray

              -
              public void mergeDocument_usingArray()
-                              throws java.lang.Exception
              -
              -
              Throws:
              -
              java.lang.Exception
              -
              -
              • -
            - - - -
              -
            • -

              uploadTemplate

              -
              public void uploadTemplate()
-                    throws java.lang.Exception
              -
              -
              Throws:
              -
              java.lang.Exception
              -
              -
              • -
            - - - -
              -
            • -

              templateExists

              -
              public void templateExists()
-                    throws java.lang.Exception
              -
              -
              Throws:
              -
              java.lang.Exception
              -
              -
              • -
            - - - -
              -
            • -

              downloadTemplate

              -
              public void downloadTemplate()
-                      throws java.lang.Exception
              -
              -
              Throws:
              -
              java.lang.Exception
              -
              -
              • -
            - - - -
              -
            • -

              getTemplateThumbnails

              -
              public void getTemplateThumbnails()
-                           throws java.lang.Exception
              -
              -
              Throws:
              -
              java.lang.Exception
              -
              -
              • -
            - - - -
              -
            • -

              deleteTemplate

              -
              public void deleteTemplate()
-                    throws java.lang.Exception
              -
              -
              Throws:
              -
              java.lang.Exception
              -
              -
              • -
            -
            • -
          -
          • -
        -
        -
        - - -
        - - -
        Skip navigation links
        - - - - -
        -
        - - - -
        - -
        -
        - - -
        - - -
        - - - diff --git a/com/textcontrol/reportingcloud/ReturnFormat.html b/com/textcontrol/reportingcloud/ReturnFormat.html index 3de37e3..a4eb1bb 100644 --- a/com/textcontrol/reportingcloud/ReturnFormat.html +++ b/com/textcontrol/reportingcloud/ReturnFormat.html @@ -2,7 +2,7 @@ - + ReturnFormat @@ -48,7 +48,7 @@
        @@ -380,7 +380,7 @@

        valueOf

        diff --git a/com/textcontrol/reportingcloud/Template.html b/com/textcontrol/reportingcloud/Template.html index f9faa93..cce95e5 100644 --- a/com/textcontrol/reportingcloud/Template.html +++ b/com/textcontrol/reportingcloud/Template.html @@ -2,7 +2,7 @@ - + Template diff --git a/com/textcontrol/reportingcloud/TemplateDataValidator.html b/com/textcontrol/reportingcloud/TemplateDataValidator.html index 63321e3..e65f2f4 100644 --- a/com/textcontrol/reportingcloud/TemplateDataValidator.html +++ b/com/textcontrol/reportingcloud/TemplateDataValidator.html @@ -2,7 +2,7 @@ - + TemplateDataValidator @@ -49,7 +49,7 @@
        • Frames
          • @@ -237,7 +237,7 @@

          validate

          • Frames
            • diff --git a/com/textcontrol/reportingcloud/TemplateDataValidatorTest.html b/com/textcontrol/reportingcloud/TemplateDataValidatorTest.html deleted file mode 100644 index 8274223..0000000 --- a/com/textcontrol/reportingcloud/TemplateDataValidatorTest.html +++ /dev/null @@ -1,310 +0,0 @@ - - - - - -TemplateDataValidatorTest - - - - - - - - -
            - - -
            Skip navigation links
            - - - - -
            -
            - - - -
            - -
            -
            -
              -
            • Summary: 
              • -
            • Nested | 
              • -
            • Field | 
              • -
            • Constr | 
              • -
            • Method
              • -
            - -
            - - -
            - - -
            -
            com.textcontrol.reportingcloud
            -

            Class TemplateDataValidatorTest

            -
            -
            -
              -
            • java.lang.Object
              • -
            • -
                -
              • com.textcontrol.reportingcloud.TemplateDataValidatorTest
                • -
              -
              • -
            -
            -
              -
            • -
              -
              -
              public class TemplateDataValidatorTest
-extends java.lang.Object
              -
              The TemplateDataValidator test class.
              -
              -
              Author:
              -
              Thorsten Kummerow
              -
              -
              • -
            -
            -
            - -
            -
            -
              -
            • - -
                -
              • - - -

                Constructor Detail

                - - - -
                  -
                • -

                  TemplateDataValidatorTest

                  -
                  public TemplateDataValidatorTest()
                  -
                  • -
                -
                • -
              - -
                -
              • - - -

                Method Detail

                - - - -
                  -
                • -

                  validate_throwsOnEmptyData

                  -
                  public void validate_throwsOnEmptyData()
-                                throws java.lang.Exception
                  -
                  -
                  Throws:
                  -
                  java.lang.Exception
                  -
                  -
                  • -
                - - - -
                  -
                • -

                  validate_throwsOnNull

                  -
                  public void validate_throwsOnNull()
-                           throws java.lang.Exception
                  -
                  -
                  Throws:
                  -
                  java.lang.Exception
                  -
                  -
                  • -
                - - - -
                  -
                • -

                  validate_validatesNonEmptyData

                  -
                  public void validate_validatesNonEmptyData()
                  -
                  • -
                -
                • -
              -
              • -
            -
            -
            - - -
            - - -
            Skip navigation links
            - - - - -
            -
            - - - -
            - -
            -
            -
              -
            • Summary: 
              • -
            • Nested | 
              • -
            • Field | 
              • -
            • Constr | 
              • -
            • Method
              • -
            - -
            - - -
            - - - diff --git a/com/textcontrol/reportingcloud/TemplateNameValidator.html b/com/textcontrol/reportingcloud/TemplateNameValidator.html index 2a51336..d982ecc 100644 --- a/com/textcontrol/reportingcloud/TemplateNameValidator.html +++ b/com/textcontrol/reportingcloud/TemplateNameValidator.html @@ -2,7 +2,7 @@ - + TemplateNameValidator @@ -48,8 +48,8 @@
          • Frames
            • @@ -239,8 +239,8 @@

            validate

          • Frames
            • diff --git a/com/textcontrol/reportingcloud/TemplateNameValidatorTest.html b/com/textcontrol/reportingcloud/TemplateNameValidatorTest.html deleted file mode 100644 index bc4a407..0000000 --- a/com/textcontrol/reportingcloud/TemplateNameValidatorTest.html +++ /dev/null @@ -1,310 +0,0 @@ - - - - - -TemplateNameValidatorTest - - - - - - - - -
            - - -
            Skip navigation links
            - - - - -
            -
            - - - -
            - -
            -
            -
              -
            • Summary: 
              • -
            • Nested | 
              • -
            • Field | 
              • -
            • Constr | 
              • -
            • Method
              • -
            - -
            - - -
            - - -
            -
            com.textcontrol.reportingcloud
            -

            Class TemplateNameValidatorTest

            -
            -
            -
              -
            • java.lang.Object
              • -
            • -
                -
              • com.textcontrol.reportingcloud.TemplateNameValidatorTest
                • -
              -
              • -
            -
            -
              -
            • -
              -
              -
              public class TemplateNameValidatorTest
-extends java.lang.Object
              -
              The TemplateNameValidator test class.
              -
              -
              Author:
              -
              Thorsten Kummerow
              -
              -
              • -
            -
            -
            - -
            -
            -
              -
            • - -
                -
              • - - -

                Constructor Detail

                - - - -
                  -
                • -

                  TemplateNameValidatorTest

                  -
                  public TemplateNameValidatorTest()
                  -
                  • -
                -
                • -
              - -
                -
              • - - -

                Method Detail

                - - - -
                  -
                • -

                  validate_throwsOnEmptyData

                  -
                  public void validate_throwsOnEmptyData()
-                                throws java.lang.Exception
                  -
                  -
                  Throws:
                  -
                  java.lang.Exception
                  -
                  -
                  • -
                - - - -
                  -
                • -

                  validate_throwsOnNull

                  -
                  public void validate_throwsOnNull()
-                           throws java.lang.Exception
                  -
                  -
                  Throws:
                  -
                  java.lang.Exception
                  -
                  -
                  • -
                - - - -
                  -
                • -

                  validate_validatesNonEmptyData

                  -
                  public void validate_validatesNonEmptyData()
                  -
                  • -
                -
                • -
              -
              • -
            -
            -
            - - -
            - - -
            Skip navigation links
            - - - - -
            -
            - - - -
            - -
            -
            -
              -
            • Summary: 
              • -
            • Nested | 
              • -
            • Field | 
              • -
            • Constr | 
              • -
            • Method
              • -
            - -
            - - -
            - - - diff --git a/com/textcontrol/reportingcloud/TemplateTest.html b/com/textcontrol/reportingcloud/TemplateTest.html deleted file mode 100644 index de301b1..0000000 --- a/com/textcontrol/reportingcloud/TemplateTest.html +++ /dev/null @@ -1,274 +0,0 @@ - - - - - -TemplateTest - - - - - - - - -
            - - -
            Skip navigation links
            - - - - -
            -
            - - - -
            - -
            -
            -
              -
            • Summary: 
              • -
            • Nested | 
              • -
            • Field | 
              • -
            • Constr | 
              • -
            • Method
              • -
            - -
            - - -
            - - -
            -
            com.textcontrol.reportingcloud
            -

            Class TemplateTest

            -
            -
            -
              -
            • java.lang.Object
              • -
            • -
                -
              • com.textcontrol.reportingcloud.TemplateTest
                • -
              -
              • -
            -
            -
              -
            • -
              -
              -
              public class TemplateTest
-extends java.lang.Object
              -
              The Template test class.
              -
              -
              Author:
              -
              Thorsten Kummerow
              -
              -
              • -
            -
            -
            -
              -
            • - -
                -
              • - - -

                Constructor Summary

                - - - - - - - - -
                Constructors 
                Constructor and Description
                TemplateTest() 
                -
                • -
              - -
                -
              • - - -

                Method Summary

                - - - - - - - - - - -
                All Methods Instance Methods Concrete Methods 
                Modifier and TypeMethod and Description
                voidisConstructedCorrectly() 
                -
                  -
                • - - -

                  Methods inherited from class java.lang.Object

                  -clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
                  • -
                -
                • -
              -
              • -
            -
            -
            -
              -
            • - -
                -
              • - - -

                Constructor Detail

                - - - -
                  -
                • -

                  TemplateTest

                  -
                  public TemplateTest()
                  -
                  • -
                -
                • -
              - -
                -
              • - - -

                Method Detail

                - - - -
                  -
                • -

                  isConstructedCorrectly

                  -
                  public void isConstructedCorrectly()
                  -
                  • -
                -
                • -
              -
              • -
            -
            -
            - - -
            - - -
            Skip navigation links
            - - - - -
            -
            - - - -
            - -
            -
            -
              -
            • Summary: 
              • -
            • Nested | 
              • -
            • Field | 
              • -
            • Constr | 
              • -
            • Method
              • -
            - -
            - - -
            - - - diff --git a/com/textcontrol/reportingcloud/gson/AccountSettingsDeserializer.html b/com/textcontrol/reportingcloud/gson/AccountSettingsDeserializer.html index 3e70d1b..a78779d 100644 --- a/com/textcontrol/reportingcloud/gson/AccountSettingsDeserializer.html +++ b/com/textcontrol/reportingcloud/gson/AccountSettingsDeserializer.html @@ -2,7 +2,7 @@ - + AccountSettingsDeserializer @@ -49,7 +49,7 @@
            • Frames
              • @@ -246,7 +246,7 @@

              deserialize

              • Frames
                • diff --git a/com/textcontrol/reportingcloud/gson/AccountSettingsDeserializerTest.html b/com/textcontrol/reportingcloud/gson/AccountSettingsDeserializerTest.html deleted file mode 100644 index 211f877..0000000 --- a/com/textcontrol/reportingcloud/gson/AccountSettingsDeserializerTest.html +++ /dev/null @@ -1,274 +0,0 @@ - - - - - -AccountSettingsDeserializerTest - - - - - - - - -
                - - -
                Skip navigation links
                - - - - -
                -
                - - - -
                - -
                -
                -
                  -
                • Summary: 
                  • -
                • Nested | 
                  • -
                • Field | 
                  • -
                • Constr | 
                  • -
                • Method
                  • -
                - -
                - - -
                - - -
                -
                com.textcontrol.reportingcloud.gson
                -

                Class AccountSettingsDeserializerTest

                -
                -
                -
                  -
                • java.lang.Object
                  • -
                • -
                    -
                  • com.textcontrol.reportingcloud.gson.AccountSettingsDeserializerTest
                    • -
                  -
                  • -
                -
                -
                  -
                • -
                  -
                  -
                  public class AccountSettingsDeserializerTest
-extends java.lang.Object
                  -
                  AccountSettingsDeserializer test class.
                  -
                  -
                  Author:
                  -
                  Thorsten Kummerow
                  -
                  -
                  • -
                -
                -
                -
                  -
                • - - - -
                    -
                  • - - -

                    Method Summary

                    - - - - - - - - - - -
                    All Methods Instance Methods Concrete Methods 
                    Modifier and TypeMethod and Description
                    voiddeserialize() 
                    -
                      -
                    • - - -

                      Methods inherited from class java.lang.Object

                      -clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
                      • -
                    -
                    • -
                  -
                  • -
                -
                -
                -
                  -
                • - -
                    -
                  • - - -

                    Constructor Detail

                    - - - -
                      -
                    • -

                      AccountSettingsDeserializerTest

                      -
                      public AccountSettingsDeserializerTest()
                      -
                      • -
                    -
                    • -
                  - -
                    -
                  • - - -

                    Method Detail

                    - - - -
                      -
                    • -

                      deserialize

                      -
                      public void deserialize()
                      -
                      • -
                    -
                    • -
                  -
                  • -
                -
                -
                - - -
                - - -
                Skip navigation links
                - - - - -
                -
                - - - -
                - -
                -
                -
                  -
                • Summary: 
                  • -
                • Nested | 
                  • -
                • Field | 
                  • -
                • Constr | 
                  • -
                • Method
                  • -
                - -
                - - -
                - - - diff --git a/com/textcontrol/reportingcloud/gson/MergeBodySerializer.html b/com/textcontrol/reportingcloud/gson/MergeBodySerializer.html index bd0544a..e99dbbb 100644 --- a/com/textcontrol/reportingcloud/gson/MergeBodySerializer.html +++ b/com/textcontrol/reportingcloud/gson/MergeBodySerializer.html @@ -2,7 +2,7 @@ - + MergeBodySerializer @@ -48,8 +48,8 @@
              • Frames
                • @@ -243,8 +243,8 @@

                serialize

              • Frames
                • diff --git a/com/textcontrol/reportingcloud/gson/MergeBodySerializerTest.html b/com/textcontrol/reportingcloud/gson/MergeBodySerializerTest.html deleted file mode 100644 index 52bb45d..0000000 --- a/com/textcontrol/reportingcloud/gson/MergeBodySerializerTest.html +++ /dev/null @@ -1,274 +0,0 @@ - - - - - -MergeBodySerializerTest - - - - - - - - -
                - - -
                Skip navigation links
                - - - - -
                -
                - - - -
                - -
                -
                -
                  -
                • Summary: 
                  • -
                • Nested | 
                  • -
                • Field | 
                  • -
                • Constr | 
                  • -
                • Method
                  • -
                - -
                - - -
                - - -
                -
                com.textcontrol.reportingcloud.gson
                -

                Class MergeBodySerializerTest

                -
                -
                -
                  -
                • java.lang.Object
                  • -
                • -
                    -
                  • com.textcontrol.reportingcloud.gson.MergeBodySerializerTest
                    • -
                  -
                  • -
                -
                -
                  -
                • -
                  -
                  -
                  public class MergeBodySerializerTest
-extends java.lang.Object
                  -
                  MergeBodySerializer test class.
                  -
                  -
                  Author:
                  -
                  Thorsten Kummerow
                  -
                  -
                  • -
                -
                -
                -
                  -
                • - - - -
                    -
                  • - - -

                    Method Summary

                    - - - - - - - - - - -
                    All Methods Instance Methods Concrete Methods 
                    Modifier and TypeMethod and Description
                    voidserialize() 
                    -
                      -
                    • - - -

                      Methods inherited from class java.lang.Object

                      -clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
                      • -
                    -
                    • -
                  -
                  • -
                -
                -
                -
                  -
                • - -
                    -
                  • - - -

                    Constructor Detail

                    - - - -
                      -
                    • -

                      MergeBodySerializerTest

                      -
                      public MergeBodySerializerTest()
                      -
                      • -
                    -
                    • -
                  - -
                    -
                  • - - -

                    Method Detail

                    - - - -
                      -
                    • -

                      serialize

                      -
                      public void serialize()
                      -
                      • -
                    -
                    • -
                  -
                  • -
                -
                -
                - - -
                - - -
                Skip navigation links
                - - - - -
                -
                - - - -
                - -
                -
                -
                  -
                • Summary: 
                  • -
                • Nested | 
                  • -
                • Field | 
                  • -
                • Constr | 
                  • -
                • Method
                  • -
                - -
                - - -
                - - - diff --git a/com/textcontrol/reportingcloud/gson/MergeSettingsSerializer.html b/com/textcontrol/reportingcloud/gson/MergeSettingsSerializer.html index 97f9f30..86309cf 100644 --- a/com/textcontrol/reportingcloud/gson/MergeSettingsSerializer.html +++ b/com/textcontrol/reportingcloud/gson/MergeSettingsSerializer.html @@ -2,7 +2,7 @@ - + MergeSettingsSerializer @@ -48,8 +48,8 @@
              • Frames
                • @@ -243,8 +243,8 @@

                serialize

              • Frames
                • diff --git a/com/textcontrol/reportingcloud/gson/MergeSettingsSerializerTest.html b/com/textcontrol/reportingcloud/gson/MergeSettingsSerializerTest.html deleted file mode 100644 index 7f376a6..0000000 --- a/com/textcontrol/reportingcloud/gson/MergeSettingsSerializerTest.html +++ /dev/null @@ -1,274 +0,0 @@ - - - - - -MergeSettingsSerializerTest - - - - - - - - -
                - - -
                Skip navigation links
                - - - - -
                -
                - - - -
                - -
                -
                -
                  -
                • Summary: 
                  • -
                • Nested | 
                  • -
                • Field | 
                  • -
                • Constr | 
                  • -
                • Method
                  • -
                - -
                - - -
                - - -
                -
                com.textcontrol.reportingcloud.gson
                -

                Class MergeSettingsSerializerTest

                -
                -
                -
                  -
                • java.lang.Object
                  • -
                • -
                    -
                  • com.textcontrol.reportingcloud.gson.MergeSettingsSerializerTest
                    • -
                  -
                  • -
                -
                -
                  -
                • -
                  -
                  -
                  public class MergeSettingsSerializerTest
-extends java.lang.Object
                  -
                  MergeSettingsSerializerTest test class.
                  -
                  -
                  Author:
                  -
                  Thorsten Kummerow
                  -
                  -
                  • -
                -
                -
                -
                  -
                • - - - -
                    -
                  • - - -

                    Method Summary

                    - - - - - - - - - - -
                    All Methods Instance Methods Concrete Methods 
                    Modifier and TypeMethod and Description
                    voidserialize() 
                    -
                      -
                    • - - -

                      Methods inherited from class java.lang.Object

                      -clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
                      • -
                    -
                    • -
                  -
                  • -
                -
                -
                -
                  -
                • - -
                    -
                  • - - -

                    Constructor Detail

                    - - - -
                      -
                    • -

                      MergeSettingsSerializerTest

                      -
                      public MergeSettingsSerializerTest()
                      -
                      • -
                    -
                    • -
                  - -
                    -
                  • - - -

                    Method Detail

                    - - - -
                      -
                    • -

                      serialize

                      -
                      public void serialize()
                      -
                      • -
                    -
                    • -
                  -
                  • -
                -
                -
                - - -
                - - -
                Skip navigation links
                - - - - -
                -
                - - - -
                - -
                -
                -
                  -
                • Summary: 
                  • -
                • Nested | 
                  • -
                • Field | 
                  • -
                • Constr | 
                  • -
                • Method
                  • -
                - -
                - - -
                - - - diff --git a/com/textcontrol/reportingcloud/gson/TemplateDeserializer.html b/com/textcontrol/reportingcloud/gson/TemplateDeserializer.html index 0082870..28af025 100644 --- a/com/textcontrol/reportingcloud/gson/TemplateDeserializer.html +++ b/com/textcontrol/reportingcloud/gson/TemplateDeserializer.html @@ -2,7 +2,7 @@ - + TemplateDeserializer @@ -48,8 +48,8 @@
              • Frames
                • @@ -245,8 +245,8 @@

                deserialize

              • Frames
                • diff --git a/com/textcontrol/reportingcloud/gson/TemplateDeserializerTest.html b/com/textcontrol/reportingcloud/gson/TemplateDeserializerTest.html deleted file mode 100644 index fc9ba65..0000000 --- a/com/textcontrol/reportingcloud/gson/TemplateDeserializerTest.html +++ /dev/null @@ -1,274 +0,0 @@ - - - - - -TemplateDeserializerTest - - - - - - - - -
                - - -
                Skip navigation links
                - - - - -
                -
                - - - -
                - -
                -
                -
                  -
                • Summary: 
                  • -
                • Nested | 
                  • -
                • Field | 
                  • -
                • Constr | 
                  • -
                • Method
                  • -
                - -
                - - -
                - - -
                -
                com.textcontrol.reportingcloud.gson
                -

                Class TemplateDeserializerTest

                -
                -
                -
                  -
                • java.lang.Object
                  • -
                • -
                    -
                  • com.textcontrol.reportingcloud.gson.TemplateDeserializerTest
                    • -
                  -
                  • -
                -
                -
                  -
                • -
                  -
                  -
                  public class TemplateDeserializerTest
-extends java.lang.Object
                  -
                  TemplateDeserializer test class.
                  -
                  -
                  Author:
                  -
                  Thorsten Kummerow
                  -
                  -
                  • -
                -
                -
                -
                  -
                • - - - -
                    -
                  • - - -

                    Method Summary

                    - - - - - - - - - - -
                    All Methods Instance Methods Concrete Methods 
                    Modifier and TypeMethod and Description
                    voiddeserialize() 
                    -
                      -
                    • - - -

                      Methods inherited from class java.lang.Object

                      -clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
                      • -
                    -
                    • -
                  -
                  • -
                -
                -
                -
                  -
                • - -
                    -
                  • - - -

                    Constructor Detail

                    - - - -
                      -
                    • -

                      TemplateDeserializerTest

                      -
                      public TemplateDeserializerTest()
                      -
                      • -
                    -
                    • -
                  - -
                    -
                  • - - -

                    Method Detail

                    - - - -
                      -
                    • -

                      deserialize

                      -
                      public void deserialize()
                      -
                      • -
                    -
                    • -
                  -
                  • -
                -
                -
                - - -
                - - -
                Skip navigation links
                - - - - -
                -
                - - - -
                - -
                -
                -
                  -
                • Summary: 
                  • -
                • Nested | 
                  • -
                • Field | 
                  • -
                • Constr | 
                  • -
                • Method
                  • -
                - -
                - - -
                - - - diff --git a/com/textcontrol/reportingcloud/gson/package-frame.html b/com/textcontrol/reportingcloud/gson/package-frame.html index 215442b..78e0c34 100644 --- a/com/textcontrol/reportingcloud/gson/package-frame.html +++ b/com/textcontrol/reportingcloud/gson/package-frame.html @@ -2,7 +2,7 @@ - + com.textcontrol.reportingcloud.gson @@ -14,13 +14,9 @@

                Classes

              diff --git a/com/textcontrol/reportingcloud/gson/package-summary.html b/com/textcontrol/reportingcloud/gson/package-summary.html index 1d69e2b..2955eb7 100644 --- a/com/textcontrol/reportingcloud/gson/package-summary.html +++ b/com/textcontrol/reportingcloud/gson/package-summary.html @@ -2,7 +2,7 @@ - + com.textcontrol.reportingcloud.gson @@ -88,24 +88,12 @@

              Package com.textcontrol.reportingcloud.gs -AccountSettingsDeserializerTest - -
              AccountSettingsDeserializer test class.
              - - - MergeBodySerializer
              Needed by GSON to serialize MergeBody objects to JSON.
              - -MergeBodySerializerTest - -
              MergeBodySerializer test class.
              - - MergeSettingsSerializer @@ -114,23 +102,11 @@

              Package com.textcontrol.reportingcloud.gs -MergeSettingsSerializerTest - -
              MergeSettingsSerializerTest test class.
              - - - TemplateDeserializer
              Needed by GSON to create Template objects from JSON data.
              - -TemplateDeserializerTest - -
              TemplateDeserializer test class.
              - - diff --git a/com/textcontrol/reportingcloud/gson/package-tree.html b/com/textcontrol/reportingcloud/gson/package-tree.html index 4a188d8..81ec7d9 100644 --- a/com/textcontrol/reportingcloud/gson/package-tree.html +++ b/com/textcontrol/reportingcloud/gson/package-tree.html @@ -2,7 +2,7 @@ - + com.textcontrol.reportingcloud.gson Class Hierarchy @@ -81,13 +81,9 @@

              Class Hierarchy

            • java.lang.Object
            diff --git a/com/textcontrol/reportingcloud/package-frame.html b/com/textcontrol/reportingcloud/package-frame.html index a6721a5..a8306c8 100644 --- a/com/textcontrol/reportingcloud/package-frame.html +++ b/com/textcontrol/reportingcloud/package-frame.html @@ -2,7 +2,7 @@ - + com.textcontrol.reportingcloud @@ -14,19 +14,12 @@

            Classes

            Enums

            diff --git a/constant-values.html b/constant-values.html index 27a8cd4..4fb1108 100644 --- a/constant-values.html +++ b/constant-values.html @@ -2,7 +2,7 @@ - + Constant Field Values diff --git a/deprecated-list.html b/deprecated-list.html index 018b82c..e160758 100644 --- a/deprecated-list.html +++ b/deprecated-list.html @@ -2,7 +2,7 @@ - + Deprecated List diff --git a/help-doc.html b/help-doc.html index 925f94d..398565d 100644 --- a/help-doc.html +++ b/help-doc.html @@ -2,7 +2,7 @@ - + API Help diff --git a/index-files/index-1.html b/index-files/index-1.html index 381901a..af88c6d 100644 --- a/index-files/index-1.html +++ b/index-files/index-1.html @@ -2,7 +2,7 @@ - + A-Index @@ -68,7 +68,7 @@
            -
            A B C D G I L M N R S T U V  +
            A C D G I L M R S T U V 

            A

            @@ -85,20 +85,8 @@

            A

            AccountSettingsDeserializer() - Constructor for class com.textcontrol.reportingcloud.gson.AccountSettingsDeserializer
             
            -
            AccountSettingsDeserializerTest - Class in com.textcontrol.reportingcloud.gson
            -
            -
            AccountSettingsDeserializer test class.
            -
            -
            AccountSettingsDeserializerTest() - Constructor for class com.textcontrol.reportingcloud.gson.AccountSettingsDeserializerTest
            -
             
            -
            AccountSettingsTest - Class in com.textcontrol.reportingcloud
            -
            -
            The AccountSettings test class.
            -
            -
            AccountSettingsTest() - Constructor for class com.textcontrol.reportingcloud.AccountSettingsTest
            -
             
            -A B C D G I L M N R S T U V 
            +A C D G I L M R S T U V 
            diff --git a/index-files/index-10.html b/index-files/index-10.html index 5a8b1a7..1807aac 100644 --- a/index-files/index-10.html +++ b/index-files/index-10.html @@ -2,8 +2,8 @@ - -R-Index + +T-Index @@ -12,7 +12,7 @@ @@ -12,7 +12,7 @@ @@ -12,7 +12,7 @@ - - - - - -
            - - -
            Skip navigation links
            - - - - -
            -
            - - - -
            - -
            - - -
            - -
            A B C D G I L M N R S T U V  - - -

            U

            -
            -
            uploadTemplate(String, byte[]) - Method in class com.textcontrol.reportingcloud.ReportingCloud
            -
            -
            Stores an uploaded template in the template storage (.doc, .docx, - .rtf and .tx).
            -
            -
            uploadTemplate() - Method in class com.textcontrol.reportingcloud.ReportingCloudTest
            -
             
            -
            -A B C D G I L M N R S T U V 
            - -
            - - -
            Skip navigation links
            - - - - -
            -
            - - - -
            - -
            - - -
            - - - diff --git a/index-files/index-14.html b/index-files/index-14.html deleted file mode 100644 index 4841c42..0000000 --- a/index-files/index-14.html +++ /dev/null @@ -1,163 +0,0 @@ - - - - - -V-Index - - - - - - - - -
            - - -
            Skip navigation links
            - - - - -
            -
            - - - -
            - -
            - - -
            - -
            A B C D G I L M N R S T U V  - - -

            V

            -
            -
            validate(byte[]) - Static method in class com.textcontrol.reportingcloud.TemplateDataValidator
            -
            -
            Checks if a template data buffer contains something.
            -
            -
            validate(String) - Static method in class com.textcontrol.reportingcloud.TemplateNameValidator
            -
            -
            Checks if a template name contains something.
            -
            -
            validate_throwsOnEmptyData() - Method in class com.textcontrol.reportingcloud.TemplateDataValidatorTest
            -
             
            -
            validate_throwsOnEmptyData() - Method in class com.textcontrol.reportingcloud.TemplateNameValidatorTest
            -
             
            -
            validate_throwsOnNull() - Method in class com.textcontrol.reportingcloud.TemplateDataValidatorTest
            -
             
            -
            validate_throwsOnNull() - Method in class com.textcontrol.reportingcloud.TemplateNameValidatorTest
            -
             
            -
            validate_validatesNonEmptyData() - Method in class com.textcontrol.reportingcloud.TemplateDataValidatorTest
            -
             
            -
            validate_validatesNonEmptyData() - Method in class com.textcontrol.reportingcloud.TemplateNameValidatorTest
            -
             
            -
            valueOf(String) - Static method in enum com.textcontrol.reportingcloud.ImageFormat
            -
            -
            Returns the enum constant of this type with the specified name.
            -
            -
            valueOf(String) - Static method in enum com.textcontrol.reportingcloud.ReturnFormat
            -
            -
            Returns the enum constant of this type with the specified name.
            -
            -
            values() - Static method in enum com.textcontrol.reportingcloud.ImageFormat
            -
            -
            Returns an array containing the constants of this enum type, in -the order they are declared.
            -
            -
            values() - Static method in enum com.textcontrol.reportingcloud.ReturnFormat
            -
            -
            Returns an array containing the constants of this enum type, in -the order they are declared.
            -
            -
            -A B C D G I L M N R S T U V 
            - -
            - - -
            Skip navigation links
            - - - - -
            -
            - - - -
            - -
            - - -
            - - - diff --git a/index-files/index-2.html b/index-files/index-2.html index 8b89feb..994c486 100644 --- a/index-files/index-2.html +++ b/index-files/index-2.html @@ -2,8 +2,8 @@ - -B-Index + +C-Index @@ -12,7 +12,7 @@ @@ -12,7 +12,7 @@ @@ -12,7 +12,7 @@ @@ -12,7 +12,7 @@ @@ -12,7 +12,7 @@ @@ -12,7 +12,7 @@ @@ -12,7 +12,7 @@ @@ -12,7 +12,7 @@ - - - - - -
            - - -
            Skip navigation links
            - - - - -
            -
            - - - -
            - -
            -
            -
              -
            • Summary: 
              • -
            • Nested | 
              • -
            • Field | 
              • -
            • Constr | 
              • -
            • Method
              • -
            - -
            - - -
            - - -
            -
            txtextcontrol.reportingcloud
            -

            Class AccountSettings

            -
            -
            -
              -
            • java.lang.Object
              • -
            • -
                -
              • txtextcontrol.reportingcloud.AccountSettings
                • -
              -
              • -
            -
            -
              -
            • -
              -
              -
              public class AccountSettings
-extends java.lang.Object
              -
              Represents ReportingCloud account settings.
              -
              -
              Author:
              -
              Thorsten Kummerow
              -
              -
              • -
            -
            -
            -
              -
            • - -
                -
              • - - -

                Constructor Summary

                - - - - - - - - -
                Constructors 
                Constructor and Description
                AccountSettings(java.lang.String serialNumber, - int createdDocuments, - int uploadedTemplates, - int maxDocuments, - int maxTemplates, - java.lang.String validUntil) 
                -
                • -
              - -
                -
              • - - -

                Method Summary

                - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                All Methods Instance Methods Concrete Methods 
                Modifier and TypeMethod and Description
                intgetCreatedDocuments() -
                Gets the number of created documents in the current month.
                -
                intgetMaxDocuments() -
                Gets the maximum number of documents that can be created per month.
                -
                intgetMaxTemplates() -
                Gets the maximum number of templates that can be uploaded to the template storage.
                -
                java.lang.StringgetSerialNumber() -
                Gets the serial number that is attached to the - account.
                -
                intgetUploadedTemplates() -
                Gets the number of uploaded templates to the template storage.
                -
                java.time.LocalDateTimegetValidUntil() -
                Gets the date until the current subscription is valid.
                -
                -
                  -
                • - - -

                  Methods inherited from class java.lang.Object

                  -clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
                  • -
                -
                • -
              -
              • -
            -
            -
            -
              -
            • - -
                -
              • - - -

                Constructor Detail

                - - - -
                  -
                • -

                  AccountSettings

                  -
                  public AccountSettings(java.lang.String serialNumber,
-                       int createdDocuments,
-                       int uploadedTemplates,
-                       int maxDocuments,
-                       int maxTemplates,
-                       java.lang.String validUntil)
                  -
                  • -
                -
                • -
              - -
                -
              • - - -

                Method Detail

                - - - -
                  -
                • -

                  getSerialNumber

                  -
                  public java.lang.String getSerialNumber()
                  -
                  Gets the serial number that is attached to the - account. Possible values are "FREE", "TRIAL" and a 13 character long serial number.
                  -
                  -
                  Returns:
                  -
                  The serial number.
                  -
                  -
                  • -
                - - - -
                  -
                • -

                  getCreatedDocuments

                  -
                  public int getCreatedDocuments()
                  -
                  Gets the number of created documents in the current month.
                  -
                  -
                  Returns:
                  -
                  The number of created documents.
                  -
                  -
                  • -
                - - - -
                  -
                • -

                  getUploadedTemplates

                  -
                  public int getUploadedTemplates()
                  -
                  Gets the number of uploaded templates to the template storage.
                  -
                  -
                  Returns:
                  -
                  The number of uploaded templates.
                  -
                  -
                  • -
                - - - -
                  -
                • -

                  getMaxDocuments

                  -
                  public int getMaxDocuments()
                  -
                  Gets the maximum number of documents that can be created per month.
                  -
                  -
                  Returns:
                  -
                  The maximum number of documents.
                  -
                  -
                  • -
                - - - -
                  -
                • -

                  getMaxTemplates

                  -
                  public int getMaxTemplates()
                  -
                  Gets the maximum number of templates that can be uploaded to the template storage.
                  -
                  -
                  Returns:
                  -
                  The maximum number of templates.
                  -
                  -
                  • -
                - - - -
                  -
                • -

                  getValidUntil

                  -
                  public java.time.LocalDateTime getValidUntil()
                  -
                  Gets the date until the current subscription is valid. Can be nil.
                  -
                  -
                  Returns:
                  -
                  The date until the current subscription is valid.
                  -
                  -
                  • -
                -
                • -
              -
              • -
            -
            -
            - - -
            - - -
            Skip navigation links
            - - - - -
            -
            - - - -
            - -
            -
            -
              -
            • Summary: 
              • -
            • Nested | 
              • -
            • Field | 
              • -
            • Constr | 
              • -
            • Method
              • -
            - -
            - - -
            - - - diff --git a/txtextcontrol/reportingcloud/ImageFormat.html b/txtextcontrol/reportingcloud/ImageFormat.html deleted file mode 100644 index a3be35e..0000000 --- a/txtextcontrol/reportingcloud/ImageFormat.html +++ /dev/null @@ -1,380 +0,0 @@ - - - - - -ImageFormat - - - - - - - - -
            - - -
            Skip navigation links
            - - - - -
            -
            - - - -
            - -
            -
            - - -
            - - -
            - - -
            -
            txtextcontrol.reportingcloud
            -

            Enum ImageFormat

            -
            -
            -
              -
            • java.lang.Object
              • -
            • -
                -
              • java.lang.Enum<ImageFormat>
                • -
              • -
                  -
                • txtextcontrol.reportingcloud.ImageFormat
                  • -
                -
                • -
              -
              • -
            -
            -
              -
            • -
              -
              All Implemented Interfaces:
              -
              java.io.Serializable, java.lang.Comparable<ImageFormat>
              -
              -
              -
              -
              public enum ImageFormat
-extends java.lang.Enum<ImageFormat>
              -
              This enum lists all possible image formats for the thumbnails
              -
              -
              Author:
              -
              Thorsten Kummerow
              -
              -
              • -
            -
            -
            -
              -
            • - -
                -
              • - - -

                Enum Constant Summary

                - - - - - - - - - - - - - - - - - -
                Enum Constants 
                Enum Constant and Description
                BMP -
                Windows Bitmap
                -
                GIF -
                Graphics Interchange Format
                -
                JPG -
                Joint Photographic Experts Group
                -
                PNG -
                Portable Network Graphics
                -
                -
                • -
              - -
                -
              • - - -

                Method Summary

                - - - - - - - - - - - - - - -
                All Methods Static Methods Concrete Methods 
                Modifier and TypeMethod and Description
                static ImageFormatvalueOf(java.lang.String name) -
                Returns the enum constant of this type with the specified name.
                -
                static ImageFormat[]values() -
                Returns an array containing the constants of this enum type, in -the order they are declared.
                -
                -
                  -
                • - - -

                  Methods inherited from class java.lang.Enum

                  -clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
                  • -
                -
                  -
                • - - -

                  Methods inherited from class java.lang.Object

                  -getClass, notify, notifyAll, wait, wait, wait
                  • -
                -
                • -
              -
              • -
            -
            -
            -
              -
            • - -
                -
              • - - -

                Enum Constant Detail

                - - - -
                  -
                • -

                  JPG

                  -
                  public static final ImageFormat JPG
                  -
                  Joint Photographic Experts Group
                  -
                  • -
                - - - -
                  -
                • -

                  PNG

                  -
                  public static final ImageFormat PNG
                  -
                  Portable Network Graphics
                  -
                  • -
                - - - -
                  -
                • -

                  BMP

                  -
                  public static final ImageFormat BMP
                  -
                  Windows Bitmap
                  -
                  • -
                - - - -
                  -
                • -

                  GIF

                  -
                  public static final ImageFormat GIF
                  -
                  Graphics Interchange Format
                  -
                  • -
                -
                • -
              - -
                -
              • - - -

                Method Detail

                - - - -
                  -
                • -

                  values

                  -
                  public static ImageFormat[] values()
                  -
                  Returns an array containing the constants of this enum type, in -the order they are declared. This method may be used to iterate -over the constants as follows: -
                  -for (ImageFormat c : ImageFormat.values())
-    System.out.println(c);
-
                  -
                  -
                  Returns:
                  -
                  an array containing the constants of this enum type, in the order they are declared
                  -
                  -
                  • -
                - - - -
                  -
                • -

                  valueOf

                  -
                  public static ImageFormat valueOf(java.lang.String name)
                  -
                  Returns the enum constant of this type with the specified name. -The string must match exactly an identifier used to declare an -enum constant in this type. (Extraneous whitespace characters are -not permitted.)
                  -
                  -
                  Parameters:
                  -
                  name - the name of the enum constant to be returned.
                  -
                  Returns:
                  -
                  the enum constant with the specified name
                  -
                  Throws:
                  -
                  java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
                  -
                  java.lang.NullPointerException - if the argument is null
                  -
                  -
                  • -
                -
                • -
              -
              • -
            -
            -
            - - -
            - - -
            Skip navigation links
            - - - - -
            -
            - - - -
            - -
            -
            - - -
            - - -
            - - - diff --git a/txtextcontrol/reportingcloud/MergeBody.html b/txtextcontrol/reportingcloud/MergeBody.html deleted file mode 100644 index 59ecd0b..0000000 --- a/txtextcontrol/reportingcloud/MergeBody.html +++ /dev/null @@ -1,448 +0,0 @@ - - - - - -MergeBody - - - - - - - - -
            - - -
            Skip navigation links
            - - - - -
            -
            - - - -
            - -
            -
            -
              -
            • Summary: 
              • -
            • Nested | 
              • -
            • Field | 
              • -
            • Constr | 
              • -
            • Method
              • -
            - -
            - - -
            - - -
            -
            txtextcontrol.reportingcloud
            -

            Class MergeBody

            -
            -
            -
              -
            • java.lang.Object
              • -
            • -
                -
              • txtextcontrol.reportingcloud.MergeBody
                • -
              -
              • -
            -
            -
              -
            • -
              -
              -
              public class MergeBody
-extends java.lang.Object
              -
              Used to pass data to the merge method.
              -
              -
              Author:
              -
              Thorsten Kummerow
              -
              -
              • -
            -
            -
            -
              -
            • - -
                -
              • - - -

                Constructor Summary

                - - - - - - - - - - - - - - -
                Constructors 
                Constructor and Description
                MergeBody(java.util.List<java.lang.Object> mergeData) 
                MergeBody(java.util.List<java.lang.Object> mergeData, - MergeSettings mergeSettings) 
                MergeBody(java.util.List<java.lang.Object> mergeData, - MergeSettings mergeSettings, - byte[] template) 
                -
                • -
              - -
                -
              • - - -

                Method Summary

                - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                All Methods Instance Methods Concrete Methods 
                Modifier and TypeMethod and Description
                java.util.List<java.lang.Object>getMergeData() -
                Gets the merge data.
                -
                MergeSettingsgetMergeSettings() -
                Gets the merge settings to specify merge properties and document properties such - as title and author.
                -
                byte[]getTemplate() -
                Gets the binary template document data.
                -
                voidsetMergeData(java.util.List<java.lang.Object> mergeData) -
                Sets the merge data.
                -
                voidsetMergeSettings(MergeSettings mergeSettings) -
                Sets the merge settings to specify merge properties and document properties such - as title and author.
                -
                voidsetTemplate(byte[] template) -
                Sets the binary template document data.
                -
                -
                  -
                • - - -

                  Methods inherited from class java.lang.Object

                  -clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
                  • -
                -
                • -
              -
              • -
            -
            -
            -
              -
            • - -
                -
              • - - -

                Constructor Detail

                - - - -
                  -
                • -

                  MergeBody

                  -
                  public MergeBody(java.util.List<java.lang.Object> mergeData)
-          throws java.security.InvalidParameterException
                  -
                  -
                  Parameters:
                  -
                  mergeData - The merge data. Can be a list of HashMap objects or a list of objects - which can be serialized to JSON by GSON.
                  -
                  Throws:
                  -
                  java.security.InvalidParameterException
                  -
                  -
                  • -
                - - - -
                  -
                • -

                  MergeBody

                  -
                  public MergeBody(java.util.List<java.lang.Object> mergeData,
-                 MergeSettings mergeSettings)
-          throws java.security.InvalidParameterException
                  -
                  -
                  Parameters:
                  -
                  mergeData - The merge data. Can be a list of HashMap objects or - a list of objects which can be serialized to JSON by GSON.
                  -
                  mergeSettings - Merge settings to specify merge properties and document properties - such as title and author.
                  -
                  Throws:
                  -
                  java.security.InvalidParameterException
                  -
                  -
                  • -
                - - - -
                  -
                • -

                  MergeBody

                  -
                  public MergeBody(java.util.List<java.lang.Object> mergeData,
-                 MergeSettings mergeSettings,
-                 byte[] template)
-          throws java.security.InvalidParameterException
                  -
                  -
                  Parameters:
                  -
                  mergeData - The merge data. Can be a list of HashMap objects or - a list of objects which can be serialized to JSON by GSON.
                  -
                  mergeSettings - Merge settings to specify merge properties and document properties - such as title and author.
                  -
                  template - The binary template document data. Supported formats are .rtf, - .doc, .docx and .tx.
                  -
                  Throws:
                  -
                  java.security.InvalidParameterException
                  -
                  -
                  • -
                -
                • -
              - -
                -
              • - - -

                Method Detail

                - - - -
                  -
                • -

                  getTemplate

                  -
                  public byte[] getTemplate()
                  -
                  Gets the binary template document data. Supported formats are .rtf, .doc, - .docx and .tx.
                  -
                  -
                  Returns:
                  -
                  The binary template document data.
                  -
                  -
                  • -
                - - - -
                  -
                • -

                  setTemplate

                  -
                  public void setTemplate(byte[] template)
                  -
                  Sets the binary template document data. Supported formats are .rtf, .doc, - .docx and .tx.
                  -
                  -
                  Parameters:
                  -
                  template - The binary template document data
                  -
                  -
                  • -
                - - - -
                  -
                • -

                  getMergeSettings

                  -
                  public MergeSettings getMergeSettings()
                  -
                  Gets the merge settings to specify merge properties and document properties such - as title and author.
                  -
                  -
                  Returns:
                  -
                  The merge settings.
                  -
                  -
                  • -
                - - - -
                  -
                • -

                  setMergeSettings

                  -
                  public void setMergeSettings(MergeSettings mergeSettings)
                  -
                  Sets the merge settings to specify merge properties and document properties such - as title and author.
                  -
                  -
                  Parameters:
                  -
                  mergeSettings - The merge settings.
                  -
                  -
                  • -
                - - - -
                  -
                • -

                  getMergeData

                  -
                  public java.util.List<java.lang.Object> getMergeData()
                  -
                  Gets the merge data.
                  -
                  -
                  Returns:
                  -
                  The merge data.
                  -
                  -
                  • -
                - - - -
                  -
                • -

                  setMergeData

                  -
                  public void setMergeData(java.util.List<java.lang.Object> mergeData)
                  -
                  Sets the merge data. Can be a list of HashMap objects or a list of objects - which can be serialized to JSON by GSON.
                  -
                  -
                  Parameters:
                  -
                  mergeData - The merge data.
                  -
                  -
                  • -
                -
                • -
              -
              • -
            -
            -
            - - -
            - - -
            Skip navigation links
            - - - - -
            -
            - - - -
            - -
            -
            -
              -
            • Summary: 
              • -
            • Nested | 
              • -
            • Field | 
              • -
            • Constr | 
              • -
            • Method
              • -
            - -
            - - -
            - - - diff --git a/txtextcontrol/reportingcloud/MergeSettings.html b/txtextcontrol/reportingcloud/MergeSettings.html deleted file mode 100644 index 41fe9ea..0000000 --- a/txtextcontrol/reportingcloud/MergeSettings.html +++ /dev/null @@ -1,632 +0,0 @@ - - - - - -MergeSettings - - - - - - - - -
            - - -
            Skip navigation links
            - - - - -
            -
            - - - -
            - -
            -
            -
              -
            • Summary: 
              • -
            • Nested | 
              • -
            • Field | 
              • -
            • Constr | 
              • -
            • Method
              • -
            - -
            - - -
            - - -
            -
            txtextcontrol.reportingcloud
            -

            Class MergeSettings

            -
            -
            -
              -
            • java.lang.Object
              • -
            • -
                -
              • txtextcontrol.reportingcloud.MergeSettings
                • -
              -
              • -
            -
            -
              -
            • -
              -
              -
              public class MergeSettings
-extends java.lang.Object
              -
              Holds the merge settings needed by the merge method.
              -
              -
              Author:
              -
              Thorsten Kummerow
              -
              -
              • -
            -
            -
            -
              -
            • - -
                -
              • - - -

                Constructor Summary

                - - - - - - - - -
                Constructors 
                Constructor and Description
                MergeSettings() 
                -
                • -
              - -
                -
              • - - -

                Method Summary

                - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                All Methods Instance Methods Concrete Methods 
                Modifier and TypeMethod and Description
                java.lang.StringgetAuthor() -
                Gets the document's author.
                -
                java.lang.StringgetCreatorApplication() -
                Gets the application which created the document.
                -
                java.lang.StringgetDocumentSubject() -
                Gets the document's subject.
                -
                java.lang.StringgetdocumentTitle() -
                Gets the document's title.
                -
                booleangetRemoveEmptyBlocks() -
                Gets whether the content of empty merge blocks should be removed from the template - or not.
                -
                booleangetRemoveEmptyFields() -
                Gets whether empty fields should be removed from the template or not.
                -
                booleangetRemoveEmptyImages() -
                Gets whether images which don't have merge data should be removed from - the template or not.
                -
                booleangetRemoveTrailingWhitespace() -
                Gets whether trailing whitespace should be removed before saving a document.
                -
                java.lang.StringgetUserPassword() -
                Gets the password needed to open the document.
                -
                voidsetAuthor(java.lang.String author) -
                Sets the document's author.
                -
                voidsetCreatorApplication(java.lang.String creatorApplication) -
                Sets the application which created the document.
                -
                voidsetDocumentSubject(java.lang.String documentSubject) -
                Sets the document's subject.
                -
                voidsetDocumentTitle(java.lang.String documentTitle) -
                Sets the document's title.
                -
                voidsetRemoveEmptyBlocks(boolean removeEmptyBlocks) -
                Sets whether the content of empty merge blocks should be removed from the template - or not.
                -
                voidsetRemoveEmptyFields(boolean removeEmptyFields) -
                Sets whether empty fields should be removed from the template or not.
                -
                voidsetRemoveEmptyImages(boolean removeEmptyImages) -
                Sets whether images which don't have merge data should be removed from - the template or not.
                -
                voidsetRemoveTrailingWhitespace(boolean removeTrailingWhitespace) -
                Sets whether trailing whitespace should be removed before saving a document.
                -
                voidsetUserPassword(java.lang.String userPassword) -
                Sets the password needed to open the document.
                -
                -
                  -
                • - - -

                  Methods inherited from class java.lang.Object

                  -clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
                  • -
                -
                • -
              -
              • -
            -
            -
            -
              -
            • - -
                -
              • - - -

                Constructor Detail

                - - - -
                  -
                • -

                  MergeSettings

                  -
                  public MergeSettings()
                  -
                  • -
                -
                • -
              - -
                -
              • - - -

                Method Detail

                - - - -
                  -
                • -

                  getRemoveEmptyFields

                  -
                  public boolean getRemoveEmptyFields()
                  -
                  Gets whether empty fields should be removed from the template or not.
                  -
                  -
                  Returns:
                  -
                  Empty fields should be removed.
                  -
                  -
                  • -
                - - - -
                  -
                • -

                  setRemoveEmptyFields

                  -
                  public void setRemoveEmptyFields(boolean removeEmptyFields)
                  -
                  Sets whether empty fields should be removed from the template or not.
                  -
                  -
                  Parameters:
                  -
                  removeEmptyFields - Empty fields should be removed or not.
                  -
                  -
                  • -
                - - - -
                  -
                • -

                  getRemoveEmptyBlocks

                  -
                  public boolean getRemoveEmptyBlocks()
                  -
                  Gets whether the content of empty merge blocks should be removed from the template - or not.
                  -
                  -
                  Returns:
                  -
                  The content of empty merge blocks should be removed.
                  -
                  -
                  • -
                - - - -
                  -
                • -

                  setRemoveEmptyBlocks

                  -
                  public void setRemoveEmptyBlocks(boolean removeEmptyBlocks)
                  -
                  Sets whether the content of empty merge blocks should be removed from the template - or not.
                  -
                  -
                  Parameters:
                  -
                  removeEmptyBlocks - The content of empty merge blocks should be removed - from the template or not.
                  -
                  -
                  • -
                - - - -
                  -
                • -

                  getRemoveEmptyImages

                  -
                  public boolean getRemoveEmptyImages()
                  -
                  Gets whether images which don't have merge data should be removed from - the template or not.
                  -
                  -
                  Returns:
                  -
                  The images which don't have merge data should be removed.
                  -
                  -
                  • -
                - - - -
                  -
                • -

                  setRemoveEmptyImages

                  -
                  public void setRemoveEmptyImages(boolean removeEmptyImages)
                  -
                  Sets whether images which don't have merge data should be removed from - the template or not.
                  -
                  -
                  Parameters:
                  -
                  removeEmptyImages - images which don't have merge data should be - removed from the template or not.
                  -
                  -
                  • -
                - - - -
                  -
                • -

                  getRemoveTrailingWhitespace

                  -
                  public boolean getRemoveTrailingWhitespace()
                  -
                  Gets whether trailing whitespace should be removed before saving a document.
                  -
                  -
                  Returns:
                  -
                  Trailing whitespace should be removed.
                  -
                  -
                  • -
                - - - -
                  -
                • -

                  setRemoveTrailingWhitespace

                  -
                  public void setRemoveTrailingWhitespace(boolean removeTrailingWhitespace)
                  -
                  Sets whether trailing whitespace should be removed before saving a document.
                  -
                  -
                  Parameters:
                  -
                  removeTrailingWhitespace - trailing whitespace should be removed before - saving a document.
                  -
                  -
                  • -
                - - - -
                  -
                • -

                  getAuthor

                  -
                  public java.lang.String getAuthor()
                  -
                  Gets the document's author.
                  -
                  -
                  Returns:
                  -
                  The document's author.
                  -
                  -
                  • -
                - - - -
                  -
                • -

                  setAuthor

                  -
                  public void setAuthor(java.lang.String author)
                  -
                  Sets the document's author.
                  -
                  -
                  Parameters:
                  -
                  author - The document's author.
                  -
                  -
                  • -
                - - - -
                  -
                • -

                  getCreatorApplication

                  -
                  public java.lang.String getCreatorApplication()
                  -
                  Gets the application which created the document.
                  -
                  -
                  Returns:
                  -
                  The application which created the document.
                  -
                  -
                  • -
                - - - -
                  -
                • -

                  setCreatorApplication

                  -
                  public void setCreatorApplication(java.lang.String creatorApplication)
                  -
                  Sets the application which created the document.
                  -
                  -
                  Parameters:
                  -
                  creatorApplication - The application which created the document.
                  -
                  -
                  • -
                - - - -
                  -
                • -

                  getDocumentSubject

                  -
                  public java.lang.String getDocumentSubject()
                  -
                  Gets the document's subject.
                  -
                  -
                  Returns:
                  -
                  The document's subject.
                  -
                  -
                  • -
                - - - -
                  -
                • -

                  setDocumentSubject

                  -
                  public void setDocumentSubject(java.lang.String documentSubject)
                  -
                  Sets the document's subject.
                  -
                  -
                  Parameters:
                  -
                  documentSubject - The document's subject.
                  -
                  -
                  • -
                - - - -
                  -
                • -

                  getdocumentTitle

                  -
                  public java.lang.String getdocumentTitle()
                  -
                  Gets the document's title.
                  -
                  -
                  Returns:
                  -
                  The document's title.
                  -
                  -
                  • -
                - - - -
                  -
                • -

                  setDocumentTitle

                  -
                  public void setDocumentTitle(java.lang.String documentTitle)
                  -
                  Sets the document's title.
                  -
                  -
                  Parameters:
                  -
                  documentTitle - The document's title.
                  -
                  -
                  • -
                - - - -
                  -
                • -

                  getUserPassword

                  -
                  public java.lang.String getUserPassword()
                  -
                  Gets the password needed to open the document.
                  -
                  -
                  Returns:
                  -
                  The password needed to open the document.
                  -
                  -
                  • -
                - - - -
                  -
                • -

                  setUserPassword

                  -
                  public void setUserPassword(java.lang.String userPassword)
                  -
                  Sets the password needed to open the document.
                  -
                  -
                  Parameters:
                  -
                  userPassword - The password needed to open the document.
                  -
                  -
                  • -
                -
                • -
              -
              • -
            -
            -
            - - -
            - - -
            Skip navigation links
            - - - - -
            -
            - - - -
            - -
            -
            -
              -
            • Summary: 
              • -
            • Nested | 
              • -
            • Field | 
              • -
            • Constr | 
              • -
            • Method
              • -
            - -
            - - -
            - - - diff --git a/txtextcontrol/reportingcloud/ReportingCloud.html b/txtextcontrol/reportingcloud/ReportingCloud.html deleted file mode 100644 index 23d32ac..0000000 --- a/txtextcontrol/reportingcloud/ReportingCloud.html +++ /dev/null @@ -1,826 +0,0 @@ - - - - - -ReportingCloud - - - - - - - - -
            - - -
            Skip navigation links
            - - - - -
            -
            - - - -
            - -
            -
            -
              -
            • Summary: 
              • -
            • Nested | 
              • -
            • Field | 
              • -
            • Constr | 
              • -
            • Method
              • -
            - -
            - - -
            - - -
            -
            txtextcontrol.reportingcloud
            -

            Class ReportingCloud

            -
            -
            -
              -
            • java.lang.Object
              • -
            • -
                -
              • txtextcontrol.reportingcloud.ReportingCloud
                • -
              -
              • -
            -
            -
              -
            • -
              -
              -
              public class ReportingCloud
-extends java.lang.Object
              -
              The ReportingCloud API wrapper class.
              -
              -
              Author:
              -
              Thorsten Kummerow
              -
              -
              • -
            -
            -
            -
              -
            • - -
                -
              • - - -

                Constructor Summary

                - - - - - - - - - - - -
                Constructors 
                Constructor and Description
                ReportingCloud(java.lang.String username, - java.lang.String password) -
                Creates a new ReportingCloud wrapper instance with the API base URL - set to "http://api.reporting.cloud".
                -
                ReportingCloud(java.lang.String username, - java.lang.String password, - java.lang.String baseUrl) -
                Creates a new ReportingCloud wrapper instance.
                -
                -
                • -
              - -
                -
              • - - -

                Method Summary

                - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                All Methods Instance Methods Concrete Methods 
                Modifier and TypeMethod and Description
                byte[]convertDocument(byte[] templateData, - ReturnFormat returnFormat) -
                Converts a document to another format.
                -
                voiddeleteTemplate(java.lang.String templateName) -
                Deletes a template from the template storage.
                -
                byte[]downloadTemplate(java.lang.String templateName) -
                Returns the selected template from the storage.
                -
                AccountSettingsgetAccountSettings() -
                Gets the current user's account settings.
                -
                intgetTemplateCount() -
                Returns the number of templates in the template storage.
                -
                intgetTemplatePageCount(java.lang.String templateName) -
                Returns the number of pages of a template in the template storage.
                -
                java.util.List<byte[]>getTemplateThumbnails(java.lang.String templateName, - int zoomFactor) -
                Returns a list of thumbnails of a specific template.
                -
                java.util.List<byte[]>getTemplateThumbnails(java.lang.String templateName, - int zoomFactor, - int fromPage) -
                Returns a list of thumbnails of a specific template.
                -
                java.util.List<byte[]>getTemplateThumbnails(java.lang.String templateName, - int zoomFactor, - int fromPage, - int toPage) -
                Returns a list of thumbnails of a specific template.
                -
                java.util.List<byte[]>getTemplateThumbnails(java.lang.String templateName, - int zoomFactor, - int fromPage, - int toPage, - ImageFormat imageFormat) -
                Returns a list of thumbnails of a specific template.
                -
                java.util.List<Template>listTemplates() -
                Lists all templates from the template storage.
                -
                java.util.List<byte[]>mergeDocument(MergeBody mergeBody) -
                Merges and returns a template from the template storage or an uploaded template with JSON data.
                -
                java.util.List<byte[]>mergeDocument(MergeBody mergeBody, - java.lang.String templateName) -
                Merges and returns a template from the template storage or an uploaded template with JSON data.
                -
                java.util.List<byte[]>mergeDocument(MergeBody mergeBody, - java.lang.String templateName, - ReturnFormat returnFormat) -
                Merges and returns a template from the template storage or an uploaded template with JSON data.
                -
                java.util.List<byte[]>mergeDocument(MergeBody mergeBody, - java.lang.String templateName, - ReturnFormat returnFormat, - boolean append) -
                Merges and returns a template from the template storage or an uploaded template with JSON data.
                -
                booleantemplateExists(java.lang.String templateName) -
                Checks whether a template exists in the template storage.
                -
                voiduploadTemplate(java.lang.String templateName, - byte[] templateData) -
                Stores an uploaded template in the template storage (.doc, .docx, - .rtf and .tx).
                -
                -
                  -
                • - - -

                  Methods inherited from class java.lang.Object

                  -clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
                  • -
                -
                • -
              -
              • -
            -
            -
            -
              -
            • - -
                -
              • - - -

                Constructor Detail

                - - - -
                  -
                • -

                  ReportingCloud

                  -
                  public ReportingCloud(java.lang.String username,
-                      java.lang.String password,
-                      java.lang.String baseUrl)
                  -
                  Creates a new ReportingCloud wrapper instance.
                  -
                  -
                  Parameters:
                  -
                  username - The username.
                  -
                  password - The password.
                  -
                  baseUrl - The API base URL.
                  -
                  -
                  • -
                - - - -
                  -
                • -

                  ReportingCloud

                  -
                  public ReportingCloud(java.lang.String username,
-                      java.lang.String password)
                  -
                  Creates a new ReportingCloud wrapper instance with the API base URL - set to "http://api.reporting.cloud".
                  -
                  -
                  Parameters:
                  -
                  username - The username.
                  -
                  password - The password.
                  -
                  -
                  • -
                -
                • -
              - -
                -
              • - - -

                Method Detail

                - - - -
                  -
                • -

                  getTemplateCount

                  -
                  public int getTemplateCount()
-                     throws java.lang.IllegalArgumentException,
-                            java.io.IOException
                  -
                  Returns the number of templates in the template storage.
                  -
                  -
                  Returns:
                  -
                  The number of templates in the template storage.
                  -
                  Throws:
                  -
                  java.io.IOException - If an I/O error occurs.
                  -
                  java.lang.IllegalArgumentException - If something went wrong concerning the HTTP request.
                  -
                  -
                  • -
                - - - -
                  -
                • -

                  getAccountSettings

                  -
                  public AccountSettings getAccountSettings()
-                                   throws java.lang.IllegalArgumentException,
-                                          java.io.IOException
                  -
                  Gets the current user's account settings.
                  -
                  -
                  Returns:
                  -
                  The account settings.
                  -
                  Throws:
                  -
                  java.io.IOException - If an I/O error occurs.
                  -
                  java.lang.IllegalArgumentException - If something went wrong concerning the HTTP request.
                  -
                  -
                  • -
                - - - -
                  -
                • -

                  listTemplates

                  -
                  public java.util.List<Template> listTemplates()
-                                       throws java.lang.IllegalArgumentException,
-                                              java.io.IOException
                  -
                  Lists all templates from the template storage.
                  -
                  -
                  Returns:
                  -
                  A list of Template objects.
                  -
                  Throws:
                  -
                  java.lang.IllegalArgumentException - If something went wrong concerning the HTTP request.
                  -
                  java.io.IOException - If an I/O error occurs.
                  -
                  -
                  • -
                - - - -
                  -
                • -

                  getTemplatePageCount

                  -
                  public int getTemplatePageCount(java.lang.String templateName)
-                         throws java.lang.IllegalArgumentException,
-                                java.io.IOException
                  -
                  Returns the number of pages of a template in the template storage.
                  -
                  -
                  Parameters:
                  -
                  templateName - The filename of the template in the template - storage to retrieve the number of pages for.
                  -
                  Returns:
                  -
                  The number of pages in the template.
                  -
                  Throws:
                  -
                  java.io.IOException - If an I/O error occurs.
                  -
                  java.lang.IllegalArgumentException - If something went wrong concerning the HTTP request.
                  -
                  -
                  • -
                - - - -
                  -
                • -

                  getTemplateThumbnails

                  -
                  public java.util.List<byte[]> getTemplateThumbnails(java.lang.String templateName,
-                                                    int zoomFactor)
-                                             throws java.lang.IllegalArgumentException,
-                                                    java.io.IOException
                  -
                  Returns a list of thumbnails of a specific template.
                  -
                  -
                  Parameters:
                  -
                  templateName - The filename of the template in the template storage.
                  -
                  zoomFactor - An Integer value between 1 and 400 to set the percentage - zoom factor of the created thumbnail images.
                  -
                  Returns:
                  -
                  An array of binary image data.
                  -
                  Throws:
                  -
                  java.lang.IllegalArgumentException - If something went wrong concerning the HTTP request.
                  -
                  java.io.IOException - If an I/O error occurs.
                  -
                  -
                  • -
                - - - -
                  -
                • -

                  getTemplateThumbnails

                  -
                  public java.util.List<byte[]> getTemplateThumbnails(java.lang.String templateName,
-                                                    int zoomFactor,
-                                                    int fromPage)
-                                             throws java.lang.IllegalArgumentException,
-                                                    java.io.IOException
                  -
                  Returns a list of thumbnails of a specific template.
                  -
                  -
                  Parameters:
                  -
                  templateName - The filename of the template in the template storage.
                  -
                  zoomFactor - An Integer value between 1 and 400 to set the percentage - zoom factor of the created thumbnail images.
                  -
                  fromPage - An Integer value that specifies the first page.
                  -
                  Returns:
                  -
                  An array of binary image data.
                  -
                  Throws:
                  -
                  java.lang.IllegalArgumentException - If something went wrong concerning the HTTP request.
                  -
                  java.io.IOException - If an I/O error occurs.
                  -
                  -
                  • -
                - - - -
                  -
                • -

                  getTemplateThumbnails

                  -
                  public java.util.List<byte[]> getTemplateThumbnails(java.lang.String templateName,
-                                                    int zoomFactor,
-                                                    int fromPage,
-                                                    int toPage)
-                                             throws java.lang.IllegalArgumentException,
-                                                    java.io.IOException
                  -
                  Returns a list of thumbnails of a specific template.
                  -
                  -
                  Parameters:
                  -
                  templateName - The filename of the template in the template storage.
                  -
                  zoomFactor - An Integer value between 1 and 400 to set the percentage - zoom factor of the created thumbnail images.
                  -
                  fromPage - An Integer value that specifies the first page.
                  -
                  toPage - An Integer value that specifies the last page.
                  -
                  Returns:
                  -
                  An array of binary image data.
                  -
                  Throws:
                  -
                  java.lang.IllegalArgumentException - If something went wrong concerning the HTTP request.
                  -
                  java.io.IOException - If an I/O error occurs.
                  -
                  -
                  • -
                - - - -
                  -
                • -

                  getTemplateThumbnails

                  -
                  public java.util.List<byte[]> getTemplateThumbnails(java.lang.String templateName,
-                                                    int zoomFactor,
-                                                    int fromPage,
-                                                    int toPage,
-                                                    ImageFormat imageFormat)
-                                             throws java.lang.IllegalArgumentException,
-                                                    java.io.IOException
                  -
                  Returns a list of thumbnails of a specific template.
                  -
                  -
                  Parameters:
                  -
                  templateName - The filename of the template in the template storage.
                  -
                  zoomFactor - An Integer value between 1 and 400 to set the percentage - zoom factor of the created thumbnail images.
                  -
                  fromPage - An Integer value that specifies the first page.
                  -
                  toPage - An Integer value that specifies the last page.
                  -
                  imageFormat - Defines the image format of the returned thumbnails.
                  -
                  Returns:
                  -
                  An array of binary image data.
                  -
                  Throws:
                  -
                  java.lang.IllegalArgumentException - If something went wrong concerning the HTTP request.
                  -
                  java.io.IOException - If an I/O error occurs.
                  -
                  -
                  • -
                - - - -
                  -
                • -

                  uploadTemplate

                  -
                  public void uploadTemplate(java.lang.String templateName,
-                           byte[] templateData)
-                    throws java.lang.IllegalArgumentException,
-                           java.io.IOException
                  -
                  Stores an uploaded template in the template storage (.doc, .docx, - .rtf and .tx).
                  -
                  -
                  Parameters:
                  -
                  templateName - The filename of the template in the template storage. Existing - files with the same filename will be overwritten.
                  -
                  templateData - Binary document data. The supported formats are .doc, - .docx, .rtf and .tx.
                  -
                  Throws:
                  -
                  java.lang.IllegalArgumentException - If something went wrong concerning the HTTP request.
                  -
                  java.io.IOException - If an I/O error occurs.
                  -
                  -
                  • -
                - - - -
                  -
                • -

                  templateExists

                  -
                  public boolean templateExists(java.lang.String templateName)
-                       throws java.lang.IllegalArgumentException,
-                              java.io.IOException
                  -
                  Checks whether a template exists in the template storage.
                  -
                  -
                  Parameters:
                  -
                  templateName - The filename of the template to be checked for - availability in the template storage.
                  -
                  Returns:
                  -
                  Returns if the template with the given name exists in the template - storage.
                  -
                  Throws:
                  -
                  java.lang.IllegalArgumentException - If something went wrong concerning the HTTP request.
                  -
                  java.io.IOException - If an I/O error occurs.
                  -
                  -
                  • -
                - - - -
                  -
                • -

                  downloadTemplate

                  -
                  public byte[] downloadTemplate(java.lang.String templateName)
-                        throws java.lang.IllegalArgumentException,
-                               java.io.IOException
                  -
                  Returns the selected template from the storage.
                  -
                  -
                  Parameters:
                  -
                  templateName - The filename of the template in the template storage.
                  -
                  Returns:
                  -
                  The template document data.
                  -
                  Throws:
                  -
                  java.io.IOException - If an I/O error occurs.
                  -
                  java.lang.IllegalArgumentException - If something went wrong concerning the HTTP request.
                  -
                  -
                  • -
                - - - -
                  -
                • -

                  deleteTemplate

                  -
                  public void deleteTemplate(java.lang.String templateName)
-                    throws java.lang.IllegalArgumentException,
-                           java.io.IOException
                  -
                  Deletes a template from the template storage.
                  -
                  -
                  Parameters:
                  -
                  templateName - The filename of the template to be deleted - from the template storage.
                  -
                  Throws:
                  -
                  java.lang.IllegalArgumentException - If something went wrong concerning the HTTP request.
                  -
                  java.io.IOException - If an I/O error occurs.
                  -
                  -
                  • -
                - - - -
                  -
                • -

                  convertDocument

                  -
                  public byte[] convertDocument(byte[] templateData,
-                              ReturnFormat returnFormat)
-                       throws java.lang.IllegalArgumentException,
-                              java.io.IOException
                  -
                  Converts a document to another format.
                  -
                  -
                  Parameters:
                  -
                  templateData - The source document encoded as a Base64 string. - The supported document formats are .rtf, .doc, - .docx, .html, .pdf and .tx.
                  -
                  returnFormat - The format of the created document.
                  -
                  Returns:
                  -
                  The created document encoded as a Base64 string.
                  -
                  Throws:
                  -
                  java.lang.IllegalArgumentException - If something went wrong concerning the HTTP request.
                  -
                  java.io.IOException - If an I/O error occurs.
                  -
                  -
                  • -
                - - - -
                  -
                • -

                  mergeDocument

                  -
                  public java.util.List<byte[]> mergeDocument(MergeBody mergeBody)
-                                     throws java.lang.IllegalArgumentException,
-                                            java.io.IOException
                  -
                  Merges and returns a template from the template storage or an uploaded template with JSON data.
                  -
                  -
                  Parameters:
                  -
                  mergeBody - The MergeBody object contains the data source - as a JSON data object and optionally, a template encoded as a Base64 string.
                  -
                  Returns:
                  -
                  The response body contains an array of the created documents.
                  -
                  Throws:
                  -
                  java.lang.IllegalArgumentException - If something went wrong concerning the HTTP request.
                  -
                  java.io.IOException - If an I/O error occurs.
                  -
                  -
                  • -
                - - - -
                  -
                • -

                  mergeDocument

                  -
                  public java.util.List<byte[]> mergeDocument(MergeBody mergeBody,
-                                            java.lang.String templateName)
-                                     throws java.lang.IllegalArgumentException,
-                                            java.io.IOException
                  -
                  Merges and returns a template from the template storage or an uploaded template with JSON data.
                  -
                  -
                  Parameters:
                  -
                  mergeBody - The MergeBody object contains the data source - as a JSON data object and optionally, a template encoded as a Base64 string.
                  -
                  templateName - The name of the template in the template storage. If no template - name is specified, the template must be uploaded in the MergeBody - object of this request.
                  -
                  Returns:
                  -
                  The response body contains an array of the created documents.
                  -
                  Throws:
                  -
                  java.lang.IllegalArgumentException - If something went wrong concerning the HTTP request.
                  -
                  java.io.IOException - If an I/O error occurs.
                  -
                  -
                  • -
                - - - -
                  -
                • -

                  mergeDocument

                  -
                  public java.util.List<byte[]> mergeDocument(MergeBody mergeBody,
-                                            java.lang.String templateName,
-                                            ReturnFormat returnFormat)
-                                     throws java.lang.IllegalArgumentException,
-                                            java.io.IOException
                  -
                  Merges and returns a template from the template storage or an uploaded template with JSON data.
                  -
                  -
                  Parameters:
                  -
                  mergeBody - The MergeBody object contains the data source - as a JSON data object and optionally, a template encoded as a Base64 string.
                  -
                  templateName - The name of the template in the template storage. If no template - name is specified, the template must be uploaded in the MergeBody - object of this request.
                  -
                  returnFormat - The format of the created document.
                  -
                  Returns:
                  -
                  The response body contains an array of the created documents.
                  -
                  Throws:
                  -
                  java.lang.IllegalArgumentException - If something went wrong concerning the HTTP request.
                  -
                  java.io.IOException - If an I/O error occurs.
                  -
                  -
                  • -
                - - - -
                  -
                • -

                  mergeDocument

                  -
                  public java.util.List<byte[]> mergeDocument(MergeBody mergeBody,
-                                            java.lang.String templateName,
-                                            ReturnFormat returnFormat,
-                                            boolean append)
-                                     throws java.lang.IllegalArgumentException,
-                                            java.io.IOException
                  -
                  Merges and returns a template from the template storage or an uploaded template with JSON data.
                  -
                  -
                  Parameters:
                  -
                  mergeBody - The MergeBody object contains the data source - as a JSON data object and optionally, a template encoded as a Base64 string.
                  -
                  templateName - The name of the template in the template storage. If no template - name is specified, the template must be uploaded in the MergeBody - object of this request.
                  -
                  returnFormat - The format of the created document.
                  -
                  append - Specifies whether the documents should be appended to one resulting - document when more than 1 data row is passed.
                  -
                  Returns:
                  -
                  The response body contains an array of the created documents.
                  -
                  Throws:
                  -
                  java.lang.IllegalArgumentException - If something went wrong concerning the HTTP request.
                  -
                  java.io.IOException - If an I/O error occurs.
                  -
                  -
                  • -
                -
                • -
              -
              • -
            -
            -
            - - -
            - - -
            Skip navigation links
            - - - - -
            -
            - - - -
            - -
            -
            -
              -
            • Summary: 
              • -
            • Nested | 
              • -
            • Field | 
              • -
            • Constr | 
              • -
            • Method
              • -
            - -
            - - -
            - - - diff --git a/txtextcontrol/reportingcloud/ReturnFormat.html b/txtextcontrol/reportingcloud/ReturnFormat.html deleted file mode 100644 index e71438f..0000000 --- a/txtextcontrol/reportingcloud/ReturnFormat.html +++ /dev/null @@ -1,425 +0,0 @@ - - - - - -ReturnFormat - - - - - - - - -
            - - -
            Skip navigation links
            - - - - -
            -
            - - - -
            - -
            -
            - - -
            - - -
            - - -
            -
            txtextcontrol.reportingcloud
            -

            Enum ReturnFormat

            -
            -
            -
              -
            • java.lang.Object
              • -
            • -
                -
              • java.lang.Enum<ReturnFormat>
                • -
              • -
                  -
                • txtextcontrol.reportingcloud.ReturnFormat
                  • -
                -
                • -
              -
              • -
            -
            -
              -
            • -
              -
              All Implemented Interfaces:
              -
              java.io.Serializable, java.lang.Comparable<ReturnFormat>
              -
              -
              -
              -
              public enum ReturnFormat
-extends java.lang.Enum<ReturnFormat>
              -
              This enum lists all possible return formats for the Merge method.
              -
              -
              Author:
              -
              Thorsten Kummerow
              -
              -
              • -
            -
            -
            -
              -
            • - -
                -
              • - - -

                Enum Constant Summary

                - - - - - - - - - - - - - - - - - - - - - - - - - - -
                Enum Constants 
                Enum Constant and Description
                DOC -
                Microsoft Word 97-2003
                -
                DOCX -
                Microsoft Office Open XML
                -
                HMTL -
                Hypertext Markup Language
                -
                PDF -
                Adobe PDF
                -
                PDFA -
                Adobe PDF/A
                -
                RTF -
                Rich Text Format
                -
                TX -
                TX Text Control Internal Format
                -
                -
                • -
              - -
                -
              • - - -

                Method Summary

                - - - - - - - - - - - - - - -
                All Methods Static Methods Concrete Methods 
                Modifier and TypeMethod and Description
                static ReturnFormatvalueOf(java.lang.String name) -
                Returns the enum constant of this type with the specified name.
                -
                static ReturnFormat[]values() -
                Returns an array containing the constants of this enum type, in -the order they are declared.
                -
                -
                  -
                • - - -

                  Methods inherited from class java.lang.Enum

                  -clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
                  • -
                -
                  -
                • - - -

                  Methods inherited from class java.lang.Object

                  -getClass, notify, notifyAll, wait, wait, wait
                  • -
                -
                • -
              -
              • -
            -
            -
            -
              -
            • - -
                -
              • - - -

                Enum Constant Detail

                - - - -
                  -
                • -

                  PDF

                  -
                  public static final ReturnFormat PDF
                  -
                  Adobe PDF
                  -
                  • -
                - - - -
                  -
                • -

                  PDFA

                  -
                  public static final ReturnFormat PDFA
                  -
                  Adobe PDF/A
                  -
                  • -
                - - - -
                  -
                • -

                  DOC

                  -
                  public static final ReturnFormat DOC
                  -
                  Microsoft Word 97-2003
                  -
                  • -
                - - - -
                  -
                • -

                  DOCX

                  -
                  public static final ReturnFormat DOCX
                  -
                  Microsoft Office Open XML
                  -
                  • -
                - - - -
                  -
                • -

                  RTF

                  -
                  public static final ReturnFormat RTF
                  -
                  Rich Text Format
                  -
                  • -
                - - - -
                  -
                • -

                  TX

                  -
                  public static final ReturnFormat TX
                  -
                  TX Text Control Internal Format
                  -
                  • -
                - - - -
                  -
                • -

                  HMTL

                  -
                  public static final ReturnFormat HMTL
                  -
                  Hypertext Markup Language
                  -
                  • -
                -
                • -
              - -
                -
              • - - -

                Method Detail

                - - - -
                  -
                • -

                  values

                  -
                  public static ReturnFormat[] values()
                  -
                  Returns an array containing the constants of this enum type, in -the order they are declared. This method may be used to iterate -over the constants as follows: -
                  -for (ReturnFormat c : ReturnFormat.values())
-    System.out.println(c);
-
                  -
                  -
                  Returns:
                  -
                  an array containing the constants of this enum type, in the order they are declared
                  -
                  -
                  • -
                - - - -
                  -
                • -

                  valueOf

                  -
                  public static ReturnFormat valueOf(java.lang.String name)
                  -
                  Returns the enum constant of this type with the specified name. -The string must match exactly an identifier used to declare an -enum constant in this type. (Extraneous whitespace characters are -not permitted.)
                  -
                  -
                  Parameters:
                  -
                  name - the name of the enum constant to be returned.
                  -
                  Returns:
                  -
                  the enum constant with the specified name
                  -
                  Throws:
                  -
                  java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
                  -
                  java.lang.NullPointerException - if the argument is null
                  -
                  -
                  • -
                -
                • -
              -
              • -
            -
            -
            - - -
            - - -
            Skip navigation links
            - - - - -
            -
            - - - -
            - -
            -
            - - -
            - - -
            - - - diff --git a/txtextcontrol/reportingcloud/Template.html b/txtextcontrol/reportingcloud/Template.html deleted file mode 100644 index 9ac4079..0000000 --- a/txtextcontrol/reportingcloud/Template.html +++ /dev/null @@ -1,335 +0,0 @@ - - - - - -Template - - - - - - - - -
            - - -
            Skip navigation links
            - - - - -
            -
            - - - -
            - -
            -
            -
              -
            • Summary: 
              • -
            • Nested | 
              • -
            • Field | 
              • -
            • Constr | 
              • -
            • Method
              • -
            - -
            - - -
            - - -
            -
            txtextcontrol.reportingcloud
            -

            Class Template

            -
            -
            -
              -
            • java.lang.Object
              • -
            • -
                -
              • txtextcontrol.reportingcloud.Template
                • -
              -
              • -
            -
            -
              -
            • -
              -
              -
              public class Template
-extends java.lang.Object
              -
              Holds information about a template in the template storage.
              -
              -
              Author:
              -
              Thorsten Kummerow
              -
              -
              • -
            -
            -
            -
              -
            • - -
                -
              • - - -

                Constructor Summary

                - - - - - - - - -
                Constructors 
                Constructor and Description
                Template(java.lang.String templateName, - java.lang.String modified, - int size) -
                Creates a new Template instance.
                -
                -
                • -
              - -
                -
              • - - -

                Method Summary

                - - - - - - - - - - - - - - - - - - -
                All Methods Instance Methods Concrete Methods 
                Modifier and TypeMethod and Description
                java.time.LocalDateTimegetModified() -
                Gets the date and time the template file was last modified
                -
                intgetSize() -
                Gets the size of the template file in bytes.
                -
                java.lang.StringgetTemplateName() -
                Gets the template file name.
                -
                -
                  -
                • - - -

                  Methods inherited from class java.lang.Object

                  -clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
                  • -
                -
                • -
              -
              • -
            -
            -
            -
              -
            • - -
                -
              • - - -

                Constructor Detail

                - - - -
                  -
                • -

                  Template

                  -
                  public Template(java.lang.String templateName,
-                java.lang.String modified,
-                int size)
                  -
                  Creates a new Template instance.
                  -
                  -
                  Parameters:
                  -
                  templateName - The template file name.
                  -
                  modified - The date and time the template file was last modified (ISO 8601 date and - time string).
                  -
                  size - The size of the template file in bytes.
                  -
                  -
                  • -
                -
                • -
              - -
                -
              • - - -

                Method Detail

                - - - -
                  -
                • -

                  getTemplateName

                  -
                  public java.lang.String getTemplateName()
                  -
                  Gets the template file name.
                  -
                  -
                  Returns:
                  -
                  The template file name.
                  -
                  -
                  • -
                - - - -
                  -
                • -

                  getModified

                  -
                  public java.time.LocalDateTime getModified()
                  -
                  Gets the date and time the template file was last modified
                  -
                  -
                  Returns:
                  -
                  The modification date.
                  -
                  -
                  • -
                - - - -
                  -
                • -

                  getSize

                  -
                  public int getSize()
                  -
                  Gets the size of the template file in bytes.
                  -
                  -
                  Returns:
                  -
                  The template size.
                  -
                  -
                  • -
                -
                • -
              -
              • -
            -
            -
            - - -
            - - -
            Skip navigation links
            - - - - -
            -
            - - - -
            - -
            -
            -
              -
            • Summary: 
              • -
            • Nested | 
              • -
            • Field | 
              • -
            • Constr | 
              • -
            • Method
              • -
            - -
            - - -
            - - - diff --git a/txtextcontrol/reportingcloud/TemplateDataValidator.html b/txtextcontrol/reportingcloud/TemplateDataValidator.html deleted file mode 100644 index af05888..0000000 --- a/txtextcontrol/reportingcloud/TemplateDataValidator.html +++ /dev/null @@ -1,281 +0,0 @@ - - - - - -TemplateDataValidator - - - - - - - - -
            - - -
            Skip navigation links
            - - - - -
            -
            - - - -
            - -
            -
            -
              -
            • Summary: 
              • -
            • Nested | 
              • -
            • Field | 
              • -
            • Constr | 
              • -
            • Method
              • -
            - -
            - - -
            - - -
            -
            txtextcontrol.reportingcloud
            -

            Class TemplateDataValidator

            -
            -
            -
              -
            • java.lang.Object
              • -
            • -
                -
              • txtextcontrol.reportingcloud.TemplateDataValidator
                • -
              -
              • -
            -
            -
              -
            • -
              -
              -
              public class TemplateDataValidator
-extends java.lang.Object
              -
              Internal method parameter validator class.
              -
              -
              Author:
              -
              Thorsten Kummerow
              -
              -
              • -
            -
            -
            -
              -
            • - - - -
                -
              • - - -

                Method Summary

                - - - - - - - - - - -
                All Methods Static Methods Concrete Methods 
                Modifier and TypeMethod and Description
                static voidvalidate(byte[] templateData) -
                Checks if a template data buffer contains something.
                -
                -
                  -
                • - - -

                  Methods inherited from class java.lang.Object

                  -clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
                  • -
                -
                • -
              -
              • -
            -
            -
            -
              -
            • - -
                -
              • - - -

                Constructor Detail

                - - - -
                  -
                • -

                  TemplateDataValidator

                  -
                  public TemplateDataValidator()
                  -
                  • -
                -
                • -
              - -
                -
              • - - -

                Method Detail

                - - - -
                  -
                • -

                  validate

                  -
                  public static void validate(byte[] templateData)
                  -
                  Checks if a template data buffer contains something. Throws an exception if not.
                  -
                  -
                  Parameters:
                  -
                  templateData - Template data.
                  -
                  -
                  • -
                -
                • -
              -
              • -
            -
            -
            - - -
            - - -
            Skip navigation links
            - - - - -
            -
            - - - -
            - -
            -
            -
              -
            • Summary: 
              • -
            • Nested | 
              • -
            • Field | 
              • -
            • Constr | 
              • -
            • Method
              • -
            - -
            - - -
            - - - diff --git a/txtextcontrol/reportingcloud/TemplateNameValidator.html b/txtextcontrol/reportingcloud/TemplateNameValidator.html deleted file mode 100644 index b57d12b..0000000 --- a/txtextcontrol/reportingcloud/TemplateNameValidator.html +++ /dev/null @@ -1,284 +0,0 @@ - - - - - -TemplateNameValidator - - - - - - - - -
            - - -
            Skip navigation links
            - - - - -
            -
            - - - -
            - -
            -
            -
              -
            • Summary: 
              • -
            • Nested | 
              • -
            • Field | 
              • -
            • Constr | 
              • -
            • Method
              • -
            - -
            - - -
            - - -
            -
            txtextcontrol.reportingcloud
            -

            Class TemplateNameValidator

            -
            -
            -
              -
            • java.lang.Object
              • -
            • -
                -
              • txtextcontrol.reportingcloud.TemplateNameValidator
                • -
              -
              • -
            -
            -
              -
            • -
              -
              -
              public class TemplateNameValidator
-extends java.lang.Object
              -
              Internal method parameter validator class.
              -
              -
              Author:
              -
              Thorsten Kummerow
              -
              -
              • -
            -
            -
            -
              -
            • - - - -
                -
              • - - -

                Method Summary

                - - - - - - - - - - -
                All Methods Static Methods Concrete Methods 
                Modifier and TypeMethod and Description
                static voidvalidate(java.lang.String templateName) -
                Checks if a template name contains something.
                -
                -
                  -
                • - - -

                  Methods inherited from class java.lang.Object

                  -clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
                  • -
                -
                • -
              -
              • -
            -
            -
            -
              -
            • - -
                -
              • - - -

                Constructor Detail

                - - - -
                  -
                • -

                  TemplateNameValidator

                  -
                  public TemplateNameValidator()
                  -
                  • -
                -
                • -
              - -
                -
              • - - -

                Method Detail

                - - - -
                  -
                • -

                  validate

                  -
                  public static void validate(java.lang.String templateName)
-                     throws java.security.InvalidParameterException
                  -
                  Checks if a template name contains something. Throws an exception if not.
                  -
                  -
                  Parameters:
                  -
                  templateName - The Template name.
                  -
                  Throws:
                  -
                  java.security.InvalidParameterException
                  -
                  -
                  • -
                -
                • -
              -
              • -
            -
            -
            - - -
            - - -
            Skip navigation links
            - - - - -
            -
            - - - -
            - -
            -
            -
              -
            • Summary: 
              • -
            • Nested | 
              • -
            • Field | 
              • -
            • Constr | 
              • -
            • Method
              • -
            - -
            - - -
            - - - diff --git a/txtextcontrol/reportingcloud/gson/AccountSettingsDeserializer.html b/txtextcontrol/reportingcloud/gson/AccountSettingsDeserializer.html deleted file mode 100644 index b2cda27..0000000 --- a/txtextcontrol/reportingcloud/gson/AccountSettingsDeserializer.html +++ /dev/null @@ -1,290 +0,0 @@ - - - - - -AccountSettingsDeserializer - - - - - - - - -
            - - -
            Skip navigation links
            - - - - -
            -
            - - - -
            - -
            -
            -
              -
            • Summary: 
              • -
            • Nested | 
              • -
            • Field | 
              • -
            • Constr | 
              • -
            • Method
              • -
            - -
            - - -
            - - -
            -
            txtextcontrol.reportingcloud.gson
            -

            Class AccountSettingsDeserializer

            -
            -
            -
              -
            • java.lang.Object
              • -
            • -
                -
              • txtextcontrol.reportingcloud.gson.AccountSettingsDeserializer
                • -
              -
              • -
            -
            -
              -
            • -
              -
              All Implemented Interfaces:
              -
              com.google.gson.JsonDeserializer<AccountSettings>
              -
              -
              -
              -
              public class AccountSettingsDeserializer
-extends java.lang.Object
-implements com.google.gson.JsonDeserializer<AccountSettings>
              -
              Needed by GSON to create AccountSettings objects from JSON data.
              -
              -
              Author:
              -
              Thorsten Kummerow
              -
              -
              • -
            -
            -
            -
              -
            • - - - -
                -
              • - - -

                Method Summary

                - - - - - - - - - - -
                All Methods Instance Methods Concrete Methods 
                Modifier and TypeMethod and Description
                AccountSettingsdeserialize(com.google.gson.JsonElement json, - java.lang.reflect.Type typeOfT, - com.google.gson.JsonDeserializationContext context) 
                -
                  -
                • - - -

                  Methods inherited from class java.lang.Object

                  -clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
                  • -
                -
                • -
              -
              • -
            -
            -
            -
              -
            • - -
                -
              • - - -

                Constructor Detail

                - - - -
                  -
                • -

                  AccountSettingsDeserializer

                  -
                  public AccountSettingsDeserializer()
                  -
                  • -
                -
                • -
              - -
                -
              • - - -

                Method Detail

                - - - -
                  -
                • -

                  deserialize

                  -
                  public AccountSettings deserialize(com.google.gson.JsonElement json,
-                                   java.lang.reflect.Type typeOfT,
-                                   com.google.gson.JsonDeserializationContext context)
-                            throws com.google.gson.JsonParseException
                  -
                  -
                  Specified by:
                  -
                  deserialize in interface com.google.gson.JsonDeserializer<AccountSettings>
                  -
                  Throws:
                  -
                  com.google.gson.JsonParseException
                  -
                  -
                  • -
                -
                • -
              -
              • -
            -
            -
            - - -
            - - -
            Skip navigation links
            - - - - -
            -
            - - - -
            - -
            -
            -
              -
            • Summary: 
              • -
            • Nested | 
              • -
            • Field | 
              • -
            • Constr | 
              • -
            • Method
              • -
            - -
            - - -
            - - - diff --git a/txtextcontrol/reportingcloud/gson/MergeBodySerializer.html b/txtextcontrol/reportingcloud/gson/MergeBodySerializer.html deleted file mode 100644 index d918ffc..0000000 --- a/txtextcontrol/reportingcloud/gson/MergeBodySerializer.html +++ /dev/null @@ -1,288 +0,0 @@ - - - - - -MergeBodySerializer - - - - - - - - -
            - - -
            Skip navigation links
            - - - - -
            -
            - - - -
            - -
            -
            -
              -
            • Summary: 
              • -
            • Nested | 
              • -
            • Field | 
              • -
            • Constr | 
              • -
            • Method
              • -
            - -
            - - -
            - - -
            -
            txtextcontrol.reportingcloud.gson
            -

            Class MergeBodySerializer

            -
            -
            -
              -
            • java.lang.Object
              • -
            • -
                -
              • txtextcontrol.reportingcloud.gson.MergeBodySerializer
                • -
              -
              • -
            -
            -
              -
            • -
              -
              All Implemented Interfaces:
              -
              com.google.gson.JsonSerializer<MergeBody>
              -
              -
              -
              -
              public class MergeBodySerializer
-extends java.lang.Object
-implements com.google.gson.JsonSerializer<MergeBody>
              -
              Needed by GSON to serialize MergeBody objects to - JSON.
              -
              -
              Author:
              -
              Thorsten Kummerow
              -
              -
              • -
            -
            -
            -
              -
            • - - - -
                -
              • - - -

                Method Summary

                - - - - - - - - - - -
                All Methods Instance Methods Concrete Methods 
                Modifier and TypeMethod and Description
                com.google.gson.JsonElementserialize(MergeBody src, - java.lang.reflect.Type typeOfSrc, - com.google.gson.JsonSerializationContext context) 
                -
                  -
                • - - -

                  Methods inherited from class java.lang.Object

                  -clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
                  • -
                -
                • -
              -
              • -
            -
            -
            -
              -
            • - -
                -
              • - - -

                Constructor Detail

                - - - -
                  -
                • -

                  MergeBodySerializer

                  -
                  public MergeBodySerializer()
                  -
                  • -
                -
                • -
              - -
                -
              • - - -

                Method Detail

                - - - -
                  -
                • -

                  serialize

                  -
                  public com.google.gson.JsonElement serialize(MergeBody src,
-                                             java.lang.reflect.Type typeOfSrc,
-                                             com.google.gson.JsonSerializationContext context)
                  -
                  -
                  Specified by:
                  -
                  serialize in interface com.google.gson.JsonSerializer<MergeBody>
                  -
                  -
                  • -
                -
                • -
              -
              • -
            -
            -
            - - -
            - - -
            Skip navigation links
            - - - - -
            -
            - - - -
            - -
            -
            -
              -
            • Summary: 
              • -
            • Nested | 
              • -
            • Field | 
              • -
            • Constr | 
              • -
            • Method
              • -
            - -
            - - -
            - - - diff --git a/txtextcontrol/reportingcloud/gson/MergeSettingsSerializer.html b/txtextcontrol/reportingcloud/gson/MergeSettingsSerializer.html deleted file mode 100644 index cd414f1..0000000 --- a/txtextcontrol/reportingcloud/gson/MergeSettingsSerializer.html +++ /dev/null @@ -1,288 +0,0 @@ - - - - - -MergeSettingsSerializer - - - - - - - - -
            - - -
            Skip navigation links
            - - - - -
            -
            - - - -
            - -
            -
            -
              -
            • Summary: 
              • -
            • Nested | 
              • -
            • Field | 
              • -
            • Constr | 
              • -
            • Method
              • -
            - -
            - - -
            - - -
            -
            txtextcontrol.reportingcloud.gson
            -

            Class MergeSettingsSerializer

            -
            -
            -
              -
            • java.lang.Object
              • -
            • -
                -
              • txtextcontrol.reportingcloud.gson.MergeSettingsSerializer
                • -
              -
              • -
            -
            -
              -
            • -
              -
              All Implemented Interfaces:
              -
              com.google.gson.JsonSerializer<MergeSettings>
              -
              -
              -
              -
              public class MergeSettingsSerializer
-extends java.lang.Object
-implements com.google.gson.JsonSerializer<MergeSettings>
              -
              Needed by GSON to serialize MergeSettings objects to - JSON.
              -
              -
              Author:
              -
              Thorsten Kummerow
              -
              -
              • -
            -
            -
            -
              -
            • - - - -
                -
              • - - -

                Method Summary

                - - - - - - - - - - -
                All Methods Instance Methods Concrete Methods 
                Modifier and TypeMethod and Description
                com.google.gson.JsonElementserialize(MergeSettings src, - java.lang.reflect.Type typeOfSrc, - com.google.gson.JsonSerializationContext context) 
                -
                  -
                • - - -

                  Methods inherited from class java.lang.Object

                  -clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
                  • -
                -
                • -
              -
              • -
            -
            -
            -
              -
            • - -
                -
              • - - -

                Constructor Detail

                - - - -
                  -
                • -

                  MergeSettingsSerializer

                  -
                  public MergeSettingsSerializer()
                  -
                  • -
                -
                • -
              - -
                -
              • - - -

                Method Detail

                - - - -
                  -
                • -

                  serialize

                  -
                  public com.google.gson.JsonElement serialize(MergeSettings src,
-                                             java.lang.reflect.Type typeOfSrc,
-                                             com.google.gson.JsonSerializationContext context)
                  -
                  -
                  Specified by:
                  -
                  serialize in interface com.google.gson.JsonSerializer<MergeSettings>
                  -
                  -
                  • -
                -
                • -
              -
              • -
            -
            -
            - - -
            - - -
            Skip navigation links
            - - - - -
            -
            - - - -
            - -
            -
            -
              -
            • Summary: 
              • -
            • Nested | 
              • -
            • Field | 
              • -
            • Constr | 
              • -
            • Method
              • -
            - -
            - - -
            - - - diff --git a/txtextcontrol/reportingcloud/gson/TemplateDeserializer.html b/txtextcontrol/reportingcloud/gson/TemplateDeserializer.html deleted file mode 100644 index 3cea3f6..0000000 --- a/txtextcontrol/reportingcloud/gson/TemplateDeserializer.html +++ /dev/null @@ -1,290 +0,0 @@ - - - - - -TemplateDeserializer - - - - - - - - -
            - - -
            Skip navigation links
            - - - - -
            -
            - - - -
            - -
            -
            -
              -
            • Summary: 
              • -
            • Nested | 
              • -
            • Field | 
              • -
            • Constr | 
              • -
            • Method
              • -
            - -
            - - -
            - - -
            -
            txtextcontrol.reportingcloud.gson
            -

            Class TemplateDeserializer

            -
            -
            -
              -
            • java.lang.Object
              • -
            • -
                -
              • txtextcontrol.reportingcloud.gson.TemplateDeserializer
                • -
              -
              • -
            -
            -
              -
            • -
              -
              All Implemented Interfaces:
              -
              com.google.gson.JsonDeserializer<Template>
              -
              -
              -
              -
              public class TemplateDeserializer
-extends java.lang.Object
-implements com.google.gson.JsonDeserializer<Template>
              -
              Needed by GSON to create Template objects from JSON data.
              -
              -
              Author:
              -
              Thorsten Kummerow
              -
              -
              • -
            -
            -
            -
              -
            • - - - -
                -
              • - - -

                Method Summary

                - - - - - - - - - - -
                All Methods Instance Methods Concrete Methods 
                Modifier and TypeMethod and Description
                Templatedeserialize(com.google.gson.JsonElement json, - java.lang.reflect.Type typeOfT, - com.google.gson.JsonDeserializationContext context) 
                -
                  -
                • - - -

                  Methods inherited from class java.lang.Object

                  -clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
                  • -
                -
                • -
              -
              • -
            -
            -
            -
              -
            • - -
                -
              • - - -

                Constructor Detail

                - - - -
                  -
                • -

                  TemplateDeserializer

                  -
                  public TemplateDeserializer()
                  -
                  • -
                -
                • -
              - -
                -
              • - - -

                Method Detail

                - - - -
                  -
                • -

                  deserialize

                  -
                  public Template deserialize(com.google.gson.JsonElement json,
-                            java.lang.reflect.Type typeOfT,
-                            com.google.gson.JsonDeserializationContext context)
-                     throws com.google.gson.JsonParseException
                  -
                  -
                  Specified by:
                  -
                  deserialize in interface com.google.gson.JsonDeserializer<Template>
                  -
                  Throws:
                  -
                  com.google.gson.JsonParseException
                  -
                  -
                  • -
                -
                • -
              -
              • -
            -
            -
            - - -
            - - -
            Skip navigation links
            - - - - -
            -
            - - - -
            - -
            -
            -
              -
            • Summary: 
              • -
            • Nested | 
              • -
            • Field | 
              • -
            • Constr | 
              • -
            • Method
              • -
            - -
            - - -
            - - - diff --git a/txtextcontrol/reportingcloud/gson/package-frame.html b/txtextcontrol/reportingcloud/gson/package-frame.html deleted file mode 100644 index 4b0af88..0000000 --- a/txtextcontrol/reportingcloud/gson/package-frame.html +++ /dev/null @@ -1,23 +0,0 @@ - - - - - -txtextcontrol.reportingcloud.gson - - - - - -

            txtextcontrol.reportingcloud.gson

            -
            -

            Classes

            - -
            - - diff --git a/txtextcontrol/reportingcloud/gson/package-summary.html b/txtextcontrol/reportingcloud/gson/package-summary.html deleted file mode 100644 index 4ffb418..0000000 --- a/txtextcontrol/reportingcloud/gson/package-summary.html +++ /dev/null @@ -1,162 +0,0 @@ - - - - - -txtextcontrol.reportingcloud.gson - - - - - - - - -
            - - -
            Skip navigation links
            - - - - -
            -
            - - - -
            - -
            - - -
            - -
            -

            Package txtextcontrol.reportingcloud.gson

            -
            -
            - -
            - -
            - - -
            Skip navigation links
            - - - - -
            -
            - - - -
            - -
            - - -
            - - - diff --git a/txtextcontrol/reportingcloud/gson/package-tree.html b/txtextcontrol/reportingcloud/gson/package-tree.html deleted file mode 100644 index 62ff95c..0000000 --- a/txtextcontrol/reportingcloud/gson/package-tree.html +++ /dev/null @@ -1,138 +0,0 @@ - - - - - -txtextcontrol.reportingcloud.gson Class Hierarchy - - - - - - - - -
            - - -
            Skip navigation links
            - - - - -
            -
            - - - -
            - -
            - - -
            - -
            -

            Hierarchy For Package txtextcontrol.reportingcloud.gson

            -Package Hierarchies: - -
            -
            -

            Class Hierarchy

            -
              -
            • java.lang.Object - -
              • -
            -
            - -
            - - -
            Skip navigation links
            - - - - -
            -
            - - - -
            - -
            - - -
            - - - diff --git a/txtextcontrol/reportingcloud/package-frame.html b/txtextcontrol/reportingcloud/package-frame.html deleted file mode 100644 index 3b48cac..0000000 --- a/txtextcontrol/reportingcloud/package-frame.html +++ /dev/null @@ -1,31 +0,0 @@ - - - - - -txtextcontrol.reportingcloud - - - - - -

            txtextcontrol.reportingcloud

            -
            -

            Classes

            - -

            Enums

            - -
            - - diff --git a/txtextcontrol/reportingcloud/package-summary.html b/txtextcontrol/reportingcloud/package-summary.html deleted file mode 100644 index aeeb9a8..0000000 --- a/txtextcontrol/reportingcloud/package-summary.html +++ /dev/null @@ -1,201 +0,0 @@ - - - - - -txtextcontrol.reportingcloud - - - - - - - - -
            - - -
            Skip navigation links
            - - - - -
            -
            - - - -
            - -
            - - -
            - -
            -

            Package txtextcontrol.reportingcloud

            -
            -
            -
              -
            • - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
              Class Summary 
              ClassDescription
              AccountSettings -
              Represents ReportingCloud account settings.
              -
              MergeBody -
              Used to pass data to the merge method.
              -
              MergeSettings -
              Holds the merge settings needed by the merge method.
              -
              ReportingCloud -
              The ReportingCloud API wrapper class.
              -
              Template -
              Holds information about a template in the template storage.
              -
              TemplateDataValidator -
              Internal method parameter validator class.
              -
              TemplateNameValidator -
              Internal method parameter validator class.
              -
              -
              • -
            • - - - - - - - - - - - - - - - - -
              Enum Summary 
              EnumDescription
              ImageFormat -
              This enum lists all possible image formats for the thumbnails
              -
              ReturnFormat -
              This enum lists all possible return formats for the Merge method.
              -
              -
              • -
            -
            - -
            - - -
            Skip navigation links
            - - - - -
            -
            - - - -
            - -
            - - -
            - - - diff --git a/txtextcontrol/reportingcloud/package-tree.html b/txtextcontrol/reportingcloud/package-tree.html deleted file mode 100644 index 84e8cff..0000000 --- a/txtextcontrol/reportingcloud/package-tree.html +++ /dev/null @@ -1,154 +0,0 @@ - - - - - -txtextcontrol.reportingcloud Class Hierarchy - - - - - - - - -
            - - -
            Skip navigation links
            - - - - -
            -
            - - - -
            - -
            - - -
            - -
            -

            Hierarchy For Package txtextcontrol.reportingcloud

            -Package Hierarchies: - -
            -
            -

            Class Hierarchy

            - -

            Enum Hierarchy

            -
              -
            • java.lang.Object -
                -
              • java.lang.Enum<E> (implements java.lang.Comparable<T>, java.io.Serializable) - -
                • -
              -
              • -
            -
            - -
            - - -
            Skip navigation links
            - - - - -
            -
            - - - -
            - -
            - - -
            - - - From 3eb76a44811c184d7b0ea764af93e3610c5edc9b Mon Sep 17 00:00:00 2001 From: Thorsten Kummerow Date: Wed, 15 Jun 2016 09:22:19 +0200 Subject: [PATCH 08/20] Updating documentation. --- allclasses-frame.html | 6 +- allclasses-noframe.html | 6 +- .../reportingcloud/AccountSettings.html | 16 +- .../reportingcloud/ImageFormat.html | 16 +- com/textcontrol/reportingcloud/MergeBody.html | 16 +- .../reportingcloud/MergeSettings.html | 16 +- .../reportingcloud/ReportingCloud.html | 16 +- .../reportingcloud/ReturnFormat.html | 16 +- com/textcontrol/reportingcloud/Template.html | 16 +- .../reportingcloud/TemplateDataValidator.html | 21 +- .../reportingcloud/TemplateNameValidator.html | 16 +- .../gson/AccountSettingsDeserializer.html | 16 +- .../gson/MergeBodySerializer.html | 16 +- .../gson/MergeSettingsSerializer.html | 16 +- .../gson/TemplateDeserializer.html | 16 +- .../reportingcloud/gson/package-frame.html | 6 +- .../reportingcloud/gson/package-summary.html | 21 +- .../reportingcloud/gson/package-tree.html | 12 +- .../reportingcloud/package-frame.html | 6 +- .../reportingcloud/package-summary.html | 21 +- .../reportingcloud/package-tree.html | 14 +- constant-values.html | 12 +- deprecated-list.html | 12 +- help-doc.html | 14 +- index-all.html | 564 ++++++++++++++++++ index-files/index-1.html | 137 ----- index-files/index-10.html | 155 ----- index-files/index-11.html | 130 ---- index-files/index-12.html | 151 ----- index-files/index-2.html | 133 ----- index-files/index-3.html | 137 ----- index-files/index-4.html | 249 -------- index-files/index-5.html | 129 ---- index-files/index-6.html | 129 ---- index-files/index-7.html | 177 ------ index-files/index-8.html | 142 ----- index-files/index-9.html | 200 ------- index.html | 4 +- overview-frame.html | 6 +- overview-summary.html | 23 +- overview-tree.html | 14 +- 41 files changed, 747 insertions(+), 2076 deletions(-) create mode 100644 index-all.html delete mode 100644 index-files/index-1.html delete mode 100644 index-files/index-10.html delete mode 100644 index-files/index-11.html delete mode 100644 index-files/index-12.html delete mode 100644 index-files/index-2.html delete mode 100644 index-files/index-3.html delete mode 100644 index-files/index-4.html delete mode 100644 index-files/index-5.html delete mode 100644 index-files/index-6.html delete mode 100644 index-files/index-7.html delete mode 100644 index-files/index-8.html delete mode 100644 index-files/index-9.html diff --git a/allclasses-frame.html b/allclasses-frame.html index 920095d..b16414a 100644 --- a/allclasses-frame.html +++ b/allclasses-frame.html @@ -2,9 +2,9 @@ - -All Classes - + +All Classes (txtextcontrol-reportingcloud-java 1.2 API) + diff --git a/allclasses-noframe.html b/allclasses-noframe.html index 964692c..92a50da 100644 --- a/allclasses-noframe.html +++ b/allclasses-noframe.html @@ -2,9 +2,9 @@ - -All Classes - + +All Classes (txtextcontrol-reportingcloud-java 1.2 API) + diff --git a/com/textcontrol/reportingcloud/AccountSettings.html b/com/textcontrol/reportingcloud/AccountSettings.html index fc07b0e..9e85add 100644 --- a/com/textcontrol/reportingcloud/AccountSettings.html +++ b/com/textcontrol/reportingcloud/AccountSettings.html @@ -2,9 +2,9 @@ - -AccountSettings - + +AccountSettings (txtextcontrol-reportingcloud-java 1.2 API) + @@ -12,7 +12,7 @@ @@ -12,7 +12,7 @@ @@ -12,7 +12,7 @@ @@ -12,7 +12,7 @@ @@ -12,7 +12,7 @@ @@ -12,7 +12,7 @@ @@ -12,7 +12,7 @@ @@ -12,7 +12,7 @@ @@ -12,7 +12,7 @@ @@ -12,7 +12,7 @@ @@ -12,7 +12,7 @@ @@ -12,7 +12,7 @@ @@ -12,7 +12,7 @@ diff --git a/com/textcontrol/reportingcloud/gson/package-summary.html b/com/textcontrol/reportingcloud/gson/package-summary.html index 2955eb7..f32ec1f 100644 --- a/com/textcontrol/reportingcloud/gson/package-summary.html +++ b/com/textcontrol/reportingcloud/gson/package-summary.html @@ -2,9 +2,9 @@ - -com.textcontrol.reportingcloud.gson - + +com.textcontrol.reportingcloud.gson (txtextcontrol-reportingcloud-java 1.2 API) + @@ -12,7 +12,7 @@ @@ -12,7 +12,7 @@ diff --git a/com/textcontrol/reportingcloud/package-summary.html b/com/textcontrol/reportingcloud/package-summary.html index 2c84863..9685511 100644 --- a/com/textcontrol/reportingcloud/package-summary.html +++ b/com/textcontrol/reportingcloud/package-summary.html @@ -2,9 +2,9 @@ - -com.textcontrol.reportingcloud - + +com.textcontrol.reportingcloud (txtextcontrol-reportingcloud-java 1.2 API) + @@ -12,7 +12,7 @@ @@ -12,7 +12,7 @@ @@ -12,7 +12,7 @@ @@ -12,7 +12,7 @@ @@ -12,7 +12,7 @@ + + + + + +
            + + +
            Skip navigation links
            + + + + +
            +
            +
              +
            • Prev
              • +
            • Next
              • +
            + + +
            + +
            + + +
            + +
            A C D G I L M R S T U V  + + +

            A

            +
            +
            AccountSettings - Class in com.textcontrol.reportingcloud
            +
            +
            Represents ReportingCloud account settings.
            +
            +
            AccountSettings(String, int, int, int, int, String) - Constructor for class com.textcontrol.reportingcloud.AccountSettings
            +
             
            +
            AccountSettingsDeserializer - Class in com.textcontrol.reportingcloud.gson
            +
            +
            Needed by GSON to create AccountSettings objects from JSON data.
            +
            +
            AccountSettingsDeserializer() - Constructor for class com.textcontrol.reportingcloud.gson.AccountSettingsDeserializer
            +
             
            +
            + + + +

            C

            +
            +
            com.textcontrol.reportingcloud - package com.textcontrol.reportingcloud
            +
            +
            Contains classes and enumerations of the Text Control ReportingCloud Java wrapper.
            +
            +
            com.textcontrol.reportingcloud.gson - package com.textcontrol.reportingcloud.gson
            +
            +
            Contains GSON serializer and deserializer implementations.
            +
            +
            convertDocument(byte[], ReturnFormat) - Method in class com.textcontrol.reportingcloud.ReportingCloud
            +
            +
            Converts a document to another format.
            +
            +
            + + + +

            D

            +
            +
            deleteTemplate(String) - Method in class com.textcontrol.reportingcloud.ReportingCloud
            +
            +
            Deletes a template from the template storage.
            +
            +
            deserialize(JsonElement, Type, JsonDeserializationContext) - Method in class com.textcontrol.reportingcloud.gson.AccountSettingsDeserializer
            +
             
            +
            deserialize(JsonElement, Type, JsonDeserializationContext) - Method in class com.textcontrol.reportingcloud.gson.TemplateDeserializer
            +
             
            +
            downloadTemplate(String) - Method in class com.textcontrol.reportingcloud.ReportingCloud
            +
            +
            Returns the selected template from the storage.
            +
            +
            + + + +

            G

            +
            +
            getAccountSettings() - Method in class com.textcontrol.reportingcloud.ReportingCloud
            +
            +
            Gets the current user's account settings.
            +
            +
            getAuthor() - Method in class com.textcontrol.reportingcloud.MergeSettings
            +
            +
            Gets the document's author.
            +
            +
            getCreatedDocuments() - Method in class com.textcontrol.reportingcloud.AccountSettings
            +
            +
            Gets the number of created documents in the current month.
            +
            +
            getCreationDate() - Method in class com.textcontrol.reportingcloud.MergeSettings
            +
            +
            Gets the creation date.
            +
            +
            getCreatorApplication() - Method in class com.textcontrol.reportingcloud.MergeSettings
            +
            +
            Gets the application which created the document.
            +
            +
            getDocumentSubject() - Method in class com.textcontrol.reportingcloud.MergeSettings
            +
            +
            Gets the document's subject.
            +
            +
            getdocumentTitle() - Method in class com.textcontrol.reportingcloud.MergeSettings
            +
            +
            Gets the document's title.
            +
            +
            getLastModificationDate() - Method in class com.textcontrol.reportingcloud.MergeSettings
            +
            +
            Gets the last modification date.
            +
            +
            getMaxDocuments() - Method in class com.textcontrol.reportingcloud.AccountSettings
            +
            +
            Gets the maximum number of documents that can be created per month.
            +
            +
            getMaxTemplates() - Method in class com.textcontrol.reportingcloud.AccountSettings
            +
            +
            Gets the maximum number of templates that can be uploaded to the template storage.
            +
            +
            getMergeData() - Method in class com.textcontrol.reportingcloud.MergeBody
            +
            +
            Gets the merge data.
            +
            +
            getMergeSettings() - Method in class com.textcontrol.reportingcloud.MergeBody
            +
            +
            Gets the merge settings to specify merge properties and document properties such + as title and author.
            +
            +
            getModified() - Method in class com.textcontrol.reportingcloud.Template
            +
            +
            Gets the date and time the template file was last modified
            +
            +
            getRemoveEmptyBlocks() - Method in class com.textcontrol.reportingcloud.MergeSettings
            +
            +
            Gets whether the content of empty merge blocks should be removed from the template + or not.
            +
            +
            getRemoveEmptyFields() - Method in class com.textcontrol.reportingcloud.MergeSettings
            +
            +
            Gets whether empty fields should be removed from the template or not.
            +
            +
            getRemoveEmptyImages() - Method in class com.textcontrol.reportingcloud.MergeSettings
            +
            +
            Gets whether images which don't have merge data should be removed from + the template or not.
            +
            +
            getRemoveTrailingWhitespace() - Method in class com.textcontrol.reportingcloud.MergeSettings
            +
            +
            Gets whether trailing whitespace should be removed before saving a document.
            +
            +
            getSerialNumber() - Method in class com.textcontrol.reportingcloud.AccountSettings
            +
            +
            Gets the serial number that is attached to the + account.
            +
            +
            getSize() - Method in class com.textcontrol.reportingcloud.Template
            +
            +
            Gets the size of the template file in bytes.
            +
            +
            getTemplate() - Method in class com.textcontrol.reportingcloud.MergeBody
            +
            +
            Gets the binary template document data.
            +
            +
            getTemplateCount() - Method in class com.textcontrol.reportingcloud.ReportingCloud
            +
            +
            Returns the number of templates in the template storage.
            +
            +
            getTemplateName() - Method in class com.textcontrol.reportingcloud.Template
            +
            +
            Gets the template file name.
            +
            +
            getTemplatePageCount(String) - Method in class com.textcontrol.reportingcloud.ReportingCloud
            +
            +
            Returns the number of pages of a template in the template storage.
            +
            +
            getTemplateThumbnails(String, int) - Method in class com.textcontrol.reportingcloud.ReportingCloud
            +
            +
            Returns a list of thumbnails of a specific template.
            +
            +
            getTemplateThumbnails(String, int, int) - Method in class com.textcontrol.reportingcloud.ReportingCloud
            +
            +
            Returns a list of thumbnails of a specific template.
            +
            +
            getTemplateThumbnails(String, int, int, int) - Method in class com.textcontrol.reportingcloud.ReportingCloud
            +
            +
            Returns a list of thumbnails of a specific template.
            +
            +
            getTemplateThumbnails(String, int, int, int, ImageFormat) - Method in class com.textcontrol.reportingcloud.ReportingCloud
            +
            +
            Returns a list of thumbnails of a specific template.
            +
            +
            getUploadedTemplates() - Method in class com.textcontrol.reportingcloud.AccountSettings
            +
            +
            Gets the number of uploaded templates to the template storage.
            +
            +
            getUserPassword() - Method in class com.textcontrol.reportingcloud.MergeSettings
            +
            +
            Gets the password needed to open the document.
            +
            +
            getValidUntil() - Method in class com.textcontrol.reportingcloud.AccountSettings
            +
            +
            Gets the date until the current subscription is valid.
            +
            +
            + + + +

            I

            +
            +
            ImageFormat - Enum in com.textcontrol.reportingcloud
            +
            +
            This enum lists all possible image formats for the thumbnails
            +
            +
            + + + +

            L

            +
            +
            listTemplates() - Method in class com.textcontrol.reportingcloud.ReportingCloud
            +
            +
            Lists all templates from the template storage.
            +
            +
            + + + +

            M

            +
            +
            MergeBody - Class in com.textcontrol.reportingcloud
            +
            +
            Used to pass data to the merge method.
            +
            +
            MergeBody(Iterable<Object>) - Constructor for class com.textcontrol.reportingcloud.MergeBody
            +
             
            +
            MergeBody(Object[]) - Constructor for class com.textcontrol.reportingcloud.MergeBody
            +
             
            +
            MergeBody(Iterable<Object>, MergeSettings) - Constructor for class com.textcontrol.reportingcloud.MergeBody
            +
             
            +
            MergeBody(Object[], MergeSettings) - Constructor for class com.textcontrol.reportingcloud.MergeBody
            +
             
            +
            MergeBody(Iterable<Object>, MergeSettings, byte[]) - Constructor for class com.textcontrol.reportingcloud.MergeBody
            +
             
            +
            MergeBody(Object[], MergeSettings, byte[]) - Constructor for class com.textcontrol.reportingcloud.MergeBody
            +
             
            +
            MergeBodySerializer - Class in com.textcontrol.reportingcloud.gson
            +
            +
            Needed by GSON to serialize MergeBody objects to + JSON.
            +
            +
            MergeBodySerializer() - Constructor for class com.textcontrol.reportingcloud.gson.MergeBodySerializer
            +
             
            +
            mergeDocument(MergeBody) - Method in class com.textcontrol.reportingcloud.ReportingCloud
            +
            +
            Merges and returns a template from the template storage or an uploaded template with JSON data.
            +
            +
            mergeDocument(MergeBody, String) - Method in class com.textcontrol.reportingcloud.ReportingCloud
            +
            +
            Merges and returns a template from the template storage or an uploaded template with JSON data.
            +
            +
            mergeDocument(MergeBody, String, ReturnFormat) - Method in class com.textcontrol.reportingcloud.ReportingCloud
            +
            +
            Merges and returns a template from the template storage or an uploaded template with JSON data.
            +
            +
            mergeDocument(MergeBody, String, ReturnFormat, boolean) - Method in class com.textcontrol.reportingcloud.ReportingCloud
            +
            +
            Merges and returns a template from the template storage or an uploaded template with JSON data.
            +
            +
            MergeSettings - Class in com.textcontrol.reportingcloud
            +
            +
            Holds the merge settings needed by the merge method.
            +
            +
            MergeSettings() - Constructor for class com.textcontrol.reportingcloud.MergeSettings
            +
             
            +
            MergeSettingsSerializer - Class in com.textcontrol.reportingcloud.gson
            +
            +
            Needed by GSON to serialize MergeSettings objects to + JSON.
            +
            +
            MergeSettingsSerializer() - Constructor for class com.textcontrol.reportingcloud.gson.MergeSettingsSerializer
            +
             
            +
            + + + +

            R

            +
            +
            ReportingCloud - Class in com.textcontrol.reportingcloud
            +
            +
            The ReportingCloud API wrapper class.
            +
            +
            ReportingCloud(String, String, String) - Constructor for class com.textcontrol.reportingcloud.ReportingCloud
            +
            +
            Creates a new ReportingCloud wrapper instance.
            +
            +
            ReportingCloud(String, String) - Constructor for class com.textcontrol.reportingcloud.ReportingCloud
            +
            +
            Creates a new ReportingCloud wrapper instance with the API base URL + set to "http://api.reporting.cloud".
            +
            +
            ReturnFormat - Enum in com.textcontrol.reportingcloud
            +
            +
            This enum lists all possible return formats for the Merge method.
            +
            +
            + + + +

            S

            +
            +
            serialize(MergeBody, Type, JsonSerializationContext) - Method in class com.textcontrol.reportingcloud.gson.MergeBodySerializer
            +
             
            +
            serialize(MergeSettings, Type, JsonSerializationContext) - Method in class com.textcontrol.reportingcloud.gson.MergeSettingsSerializer
            +
             
            +
            setAuthor(String) - Method in class com.textcontrol.reportingcloud.MergeSettings
            +
            +
            Sets the document's author.
            +
            +
            setCreationDate(String) - Method in class com.textcontrol.reportingcloud.MergeSettings
            +
            +
            Sets the creation date.
            +
            +
            setCreationDate(ZonedDateTime) - Method in class com.textcontrol.reportingcloud.MergeSettings
            +
            +
            Sets the creation date.
            +
            +
            setCreatorApplication(String) - Method in class com.textcontrol.reportingcloud.MergeSettings
            +
            +
            Sets the application which created the document.
            +
            +
            setDocumentSubject(String) - Method in class com.textcontrol.reportingcloud.MergeSettings
            +
            +
            Sets the document's subject.
            +
            +
            setDocumentTitle(String) - Method in class com.textcontrol.reportingcloud.MergeSettings
            +
            +
            Sets the document's title.
            +
            +
            setLastModificationDate(String) - Method in class com.textcontrol.reportingcloud.MergeSettings
            +
            +
            Sets the last modification date.
            +
            +
            setLastModificationDate(ZonedDateTime) - Method in class com.textcontrol.reportingcloud.MergeSettings
            +
            +
            Sets the last modification date.
            +
            +
            setMergeData(Iterable<Object>) - Method in class com.textcontrol.reportingcloud.MergeBody
            +
            +
            Sets the merge data.
            +
            +
            setMergeData(Object[]) - Method in class com.textcontrol.reportingcloud.MergeBody
            +
            +
            Sets the merge data.
            +
            +
            setMergeSettings(MergeSettings) - Method in class com.textcontrol.reportingcloud.MergeBody
            +
            +
            Sets the merge settings to specify merge properties and document properties such + as title and author.
            +
            +
            setRemoveEmptyBlocks(boolean) - Method in class com.textcontrol.reportingcloud.MergeSettings
            +
            +
            Sets whether the content of empty merge blocks should be removed from the template + or not.
            +
            +
            setRemoveEmptyFields(boolean) - Method in class com.textcontrol.reportingcloud.MergeSettings
            +
            +
            Sets whether empty fields should be removed from the template or not.
            +
            +
            setRemoveEmptyImages(boolean) - Method in class com.textcontrol.reportingcloud.MergeSettings
            +
            +
            Sets whether images which don't have merge data should be removed from + the template or not.
            +
            +
            setRemoveTrailingWhitespace(boolean) - Method in class com.textcontrol.reportingcloud.MergeSettings
            +
            +
            Sets whether trailing whitespace should be removed before saving a document.
            +
            +
            setTemplate(byte[]) - Method in class com.textcontrol.reportingcloud.MergeBody
            +
            +
            Sets the binary template document data.
            +
            +
            setUserPassword(String) - Method in class com.textcontrol.reportingcloud.MergeSettings
            +
            +
            Sets the password needed to open the document.
            +
            +
            + + + +

            T

            +
            +
            Template - Class in com.textcontrol.reportingcloud
            +
            +
            Holds information about a template in the template storage.
            +
            +
            Template(String, String, int) - Constructor for class com.textcontrol.reportingcloud.Template
            +
            +
            Creates a new Template instance.
            +
            +
            TemplateDataValidator - Class in com.textcontrol.reportingcloud
            +
            +
            Internal method parameter validator class.
            +
            +
            TemplateDataValidator() - Constructor for class com.textcontrol.reportingcloud.TemplateDataValidator
            +
             
            +
            TemplateDeserializer - Class in com.textcontrol.reportingcloud.gson
            +
            +
            Needed by GSON to create Template objects from JSON data.
            +
            +
            TemplateDeserializer() - Constructor for class com.textcontrol.reportingcloud.gson.TemplateDeserializer
            +
             
            +
            templateExists(String) - Method in class com.textcontrol.reportingcloud.ReportingCloud
            +
            +
            Checks whether a template exists in the template storage.
            +
            +
            TemplateNameValidator - Class in com.textcontrol.reportingcloud
            +
            +
            Internal method parameter validator class.
            +
            +
            TemplateNameValidator() - Constructor for class com.textcontrol.reportingcloud.TemplateNameValidator
            +
             
            +
            + + + +

            U

            +
            +
            uploadTemplate(String, byte[]) - Method in class com.textcontrol.reportingcloud.ReportingCloud
            +
            +
            Stores an uploaded template in the template storage (.doc, .docx, + .rtf and .tx).
            +
            +
            + + + +

            V

            +
            +
            validate(byte[]) - Static method in class com.textcontrol.reportingcloud.TemplateDataValidator
            +
            +
            Checks if a template data buffer contains something.
            +
            +
            validate(String) - Static method in class com.textcontrol.reportingcloud.TemplateNameValidator
            +
            +
            Checks if a template name contains something.
            +
            +
            valueOf(String) - Static method in enum com.textcontrol.reportingcloud.ImageFormat
            +
            +
            Returns the enum constant of this type with the specified name.
            +
            +
            valueOf(String) - Static method in enum com.textcontrol.reportingcloud.ReturnFormat
            +
            +
            Returns the enum constant of this type with the specified name.
            +
            +
            values() - Static method in enum com.textcontrol.reportingcloud.ImageFormat
            +
            +
            Returns an array containing the constants of this enum type, in +the order they are declared.
            +
            +
            values() - Static method in enum com.textcontrol.reportingcloud.ReturnFormat
            +
            +
            Returns an array containing the constants of this enum type, in +the order they are declared.
            +
            +
            +A C D G I L M R S T U V 
            + +
            + + +
            Skip navigation links
            + + + + +
            +
            +
              +
            • Prev
              • +
            • Next
              • +
            + + +
            + +
            + + +
            + + + diff --git a/index-files/index-1.html b/index-files/index-1.html deleted file mode 100644 index af88c6d..0000000 --- a/index-files/index-1.html +++ /dev/null @@ -1,137 +0,0 @@ - - - - - -A-Index - - - - - - - - -
            - - -
            Skip navigation links
            - - - - -
            -
            - - - -
            - -
            - - -
            - -
            A C D G I L M R S T U V  - - -

            A

            -
            -
            AccountSettings - Class in com.textcontrol.reportingcloud
            -
            -
            Represents ReportingCloud account settings.
            -
            -
            AccountSettings(String, int, int, int, int, String) - Constructor for class com.textcontrol.reportingcloud.AccountSettings
            -
             
            -
            AccountSettingsDeserializer - Class in com.textcontrol.reportingcloud.gson
            -
            -
            Needed by GSON to create AccountSettings objects from JSON data.
            -
            -
            AccountSettingsDeserializer() - Constructor for class com.textcontrol.reportingcloud.gson.AccountSettingsDeserializer
            -
             
            -
            -A C D G I L M R S T U V 
            - -
            - - -
            Skip navigation links
            - - - - -
            -
            - - - -
            - -
            - - -
            - - - diff --git a/index-files/index-10.html b/index-files/index-10.html deleted file mode 100644 index 1807aac..0000000 --- a/index-files/index-10.html +++ /dev/null @@ -1,155 +0,0 @@ - - - - - -T-Index - - - - - - - - -
            - - -
            Skip navigation links
            - - - - -
            -
            - - - -
            - -
            - - -
            - -
            A C D G I L M R S T U V  - - -

            T

            -
            -
            Template - Class in com.textcontrol.reportingcloud
            -
            -
            Holds information about a template in the template storage.
            -
            -
            Template(String, String, int) - Constructor for class com.textcontrol.reportingcloud.Template
            -
            -
            Creates a new Template instance.
            -
            -
            TemplateDataValidator - Class in com.textcontrol.reportingcloud
            -
            -
            Internal method parameter validator class.
            -
            -
            TemplateDataValidator() - Constructor for class com.textcontrol.reportingcloud.TemplateDataValidator
            -
             
            -
            TemplateDeserializer - Class in com.textcontrol.reportingcloud.gson
            -
            -
            Needed by GSON to create Template objects from JSON data.
            -
            -
            TemplateDeserializer() - Constructor for class com.textcontrol.reportingcloud.gson.TemplateDeserializer
            -
             
            -
            templateExists(String) - Method in class com.textcontrol.reportingcloud.ReportingCloud
            -
            -
            Checks whether a template exists in the template storage.
            -
            -
            TemplateNameValidator - Class in com.textcontrol.reportingcloud
            -
            -
            Internal method parameter validator class.
            -
            -
            TemplateNameValidator() - Constructor for class com.textcontrol.reportingcloud.TemplateNameValidator
            -
             
            -
            -A C D G I L M R S T U V 
            - -
            - - -
            Skip navigation links
            - - - - -
            -
            - - - -
            - -
            - - -
            - - - diff --git a/index-files/index-11.html b/index-files/index-11.html deleted file mode 100644 index 73598f0..0000000 --- a/index-files/index-11.html +++ /dev/null @@ -1,130 +0,0 @@ - - - - - -U-Index - - - - - - - - -
            - - -
            Skip navigation links
            - - - - -
            -
            - - - -
            - -
            - - -
            - -
            A C D G I L M R S T U V  - - -

            U

            -
            -
            uploadTemplate(String, byte[]) - Method in class com.textcontrol.reportingcloud.ReportingCloud
            -
            -
            Stores an uploaded template in the template storage (.doc, .docx, - .rtf and .tx).
            -
            -
            -A C D G I L M R S T U V 
            - -
            - - -
            Skip navigation links
            - - - - -
            -
            - - - -
            - -
            - - -
            - - - diff --git a/index-files/index-12.html b/index-files/index-12.html deleted file mode 100644 index e74c7c3..0000000 --- a/index-files/index-12.html +++ /dev/null @@ -1,151 +0,0 @@ - - - - - -V-Index - - - - - - - - -
            - - -
            Skip navigation links
            - - - - -
            -
            - - - -
            - -
            - - -
            - -
            A C D G I L M R S T U V  - - -

            V

            -
            -
            validate(byte[]) - Static method in class com.textcontrol.reportingcloud.TemplateDataValidator
            -
            -
            Checks if a template data buffer contains something.
            -
            -
            validate(String) - Static method in class com.textcontrol.reportingcloud.TemplateNameValidator
            -
            -
            Checks if a template name contains something.
            -
            -
            valueOf(String) - Static method in enum com.textcontrol.reportingcloud.ImageFormat
            -
            -
            Returns the enum constant of this type with the specified name.
            -
            -
            valueOf(String) - Static method in enum com.textcontrol.reportingcloud.ReturnFormat
            -
            -
            Returns the enum constant of this type with the specified name.
            -
            -
            values() - Static method in enum com.textcontrol.reportingcloud.ImageFormat
            -
            -
            Returns an array containing the constants of this enum type, in -the order they are declared.
            -
            -
            values() - Static method in enum com.textcontrol.reportingcloud.ReturnFormat
            -
            -
            Returns an array containing the constants of this enum type, in -the order they are declared.
            -
            -
            -A C D G I L M R S T U V 
            - -
            - - -
            Skip navigation links
            - - - - -
            -
            - - - -
            - -
            - - -
            - - - diff --git a/index-files/index-2.html b/index-files/index-2.html deleted file mode 100644 index 994c486..0000000 --- a/index-files/index-2.html +++ /dev/null @@ -1,133 +0,0 @@ - - - - - -C-Index - - - - - - - - -
            - - -
            Skip navigation links
            - - - - -
            -
            - - - -
            - -
            - - -
            - -
            A C D G I L M R S T U V  - - -

            C

            -
            -
            com.textcontrol.reportingcloud - package com.textcontrol.reportingcloud
            -
             
            -
            com.textcontrol.reportingcloud.gson - package com.textcontrol.reportingcloud.gson
            -
             
            -
            convertDocument(byte[], ReturnFormat) - Method in class com.textcontrol.reportingcloud.ReportingCloud
            -
            -
            Converts a document to another format.
            -
            -
            -A C D G I L M R S T U V 
            - -
            - - -
            Skip navigation links
            - - - - -
            -
            - - - -
            - -
            - - -
            - - - diff --git a/index-files/index-3.html b/index-files/index-3.html deleted file mode 100644 index 9a40c6c..0000000 --- a/index-files/index-3.html +++ /dev/null @@ -1,137 +0,0 @@ - - - - - -D-Index - - - - - - - - -
            - - -
            Skip navigation links
            - - - - -
            -
            - - - -
            - -
            - - -
            - -
            A C D G I L M R S T U V  - - -

            D

            -
            -
            deleteTemplate(String) - Method in class com.textcontrol.reportingcloud.ReportingCloud
            -
            -
            Deletes a template from the template storage.
            -
            -
            deserialize(JsonElement, Type, JsonDeserializationContext) - Method in class com.textcontrol.reportingcloud.gson.AccountSettingsDeserializer
            -
             
            -
            deserialize(JsonElement, Type, JsonDeserializationContext) - Method in class com.textcontrol.reportingcloud.gson.TemplateDeserializer
            -
             
            -
            downloadTemplate(String) - Method in class com.textcontrol.reportingcloud.ReportingCloud
            -
            -
            Returns the selected template from the storage.
            -
            -
            -A C D G I L M R S T U V 
            - -
            - - -
            Skip navigation links
            - - - - -
            -
            - - - -
            - -
            - - -
            - - - diff --git a/index-files/index-4.html b/index-files/index-4.html deleted file mode 100644 index 0ff0e23..0000000 --- a/index-files/index-4.html +++ /dev/null @@ -1,249 +0,0 @@ - - - - - -G-Index - - - - - - - - -
            - - -
            Skip navigation links
            - - - - -
            -
            - - - -
            - -
            - - -
            - -
            A C D G I L M R S T U V  - - -

            G

            -
            -
            getAccountSettings() - Method in class com.textcontrol.reportingcloud.ReportingCloud
            -
            -
            Gets the current user's account settings.
            -
            -
            getAuthor() - Method in class com.textcontrol.reportingcloud.MergeSettings
            -
            -
            Gets the document's author.
            -
            -
            getCreatedDocuments() - Method in class com.textcontrol.reportingcloud.AccountSettings
            -
            -
            Gets the number of created documents in the current month.
            -
            -
            getCreationDate() - Method in class com.textcontrol.reportingcloud.MergeSettings
            -
            -
            Gets the creation date.
            -
            -
            getCreatorApplication() - Method in class com.textcontrol.reportingcloud.MergeSettings
            -
            -
            Gets the application which created the document.
            -
            -
            getDocumentSubject() - Method in class com.textcontrol.reportingcloud.MergeSettings
            -
            -
            Gets the document's subject.
            -
            -
            getdocumentTitle() - Method in class com.textcontrol.reportingcloud.MergeSettings
            -
            -
            Gets the document's title.
            -
            -
            getLastModificationDate() - Method in class com.textcontrol.reportingcloud.MergeSettings
            -
            -
            Gets the last modification date.
            -
            -
            getMaxDocuments() - Method in class com.textcontrol.reportingcloud.AccountSettings
            -
            -
            Gets the maximum number of documents that can be created per month.
            -
            -
            getMaxTemplates() - Method in class com.textcontrol.reportingcloud.AccountSettings
            -
            -
            Gets the maximum number of templates that can be uploaded to the template storage.
            -
            -
            getMergeData() - Method in class com.textcontrol.reportingcloud.MergeBody
            -
            -
            Gets the merge data.
            -
            -
            getMergeSettings() - Method in class com.textcontrol.reportingcloud.MergeBody
            -
            -
            Gets the merge settings to specify merge properties and document properties such - as title and author.
            -
            -
            getModified() - Method in class com.textcontrol.reportingcloud.Template
            -
            -
            Gets the date and time the template file was last modified
            -
            -
            getRemoveEmptyBlocks() - Method in class com.textcontrol.reportingcloud.MergeSettings
            -
            -
            Gets whether the content of empty merge blocks should be removed from the template - or not.
            -
            -
            getRemoveEmptyFields() - Method in class com.textcontrol.reportingcloud.MergeSettings
            -
            -
            Gets whether empty fields should be removed from the template or not.
            -
            -
            getRemoveEmptyImages() - Method in class com.textcontrol.reportingcloud.MergeSettings
            -
            -
            Gets whether images which don't have merge data should be removed from - the template or not.
            -
            -
            getRemoveTrailingWhitespace() - Method in class com.textcontrol.reportingcloud.MergeSettings
            -
            -
            Gets whether trailing whitespace should be removed before saving a document.
            -
            -
            getSerialNumber() - Method in class com.textcontrol.reportingcloud.AccountSettings
            -
            -
            Gets the serial number that is attached to the - account.
            -
            -
            getSize() - Method in class com.textcontrol.reportingcloud.Template
            -
            -
            Gets the size of the template file in bytes.
            -
            -
            getTemplate() - Method in class com.textcontrol.reportingcloud.MergeBody
            -
            -
            Gets the binary template document data.
            -
            -
            getTemplateCount() - Method in class com.textcontrol.reportingcloud.ReportingCloud
            -
            -
            Returns the number of templates in the template storage.
            -
            -
            getTemplateName() - Method in class com.textcontrol.reportingcloud.Template
            -
            -
            Gets the template file name.
            -
            -
            getTemplatePageCount(String) - Method in class com.textcontrol.reportingcloud.ReportingCloud
            -
            -
            Returns the number of pages of a template in the template storage.
            -
            -
            getTemplateThumbnails(String, int) - Method in class com.textcontrol.reportingcloud.ReportingCloud
            -
            -
            Returns a list of thumbnails of a specific template.
            -
            -
            getTemplateThumbnails(String, int, int) - Method in class com.textcontrol.reportingcloud.ReportingCloud
            -
            -
            Returns a list of thumbnails of a specific template.
            -
            -
            getTemplateThumbnails(String, int, int, int) - Method in class com.textcontrol.reportingcloud.ReportingCloud
            -
            -
            Returns a list of thumbnails of a specific template.
            -
            -
            getTemplateThumbnails(String, int, int, int, ImageFormat) - Method in class com.textcontrol.reportingcloud.ReportingCloud
            -
            -
            Returns a list of thumbnails of a specific template.
            -
            -
            getUploadedTemplates() - Method in class com.textcontrol.reportingcloud.AccountSettings
            -
            -
            Gets the number of uploaded templates to the template storage.
            -
            -
            getUserPassword() - Method in class com.textcontrol.reportingcloud.MergeSettings
            -
            -
            Gets the password needed to open the document.
            -
            -
            getValidUntil() - Method in class com.textcontrol.reportingcloud.AccountSettings
            -
            -
            Gets the date until the current subscription is valid.
            -
            -
            -A C D G I L M R S T U V 
            - -
            - - -
            Skip navigation links
            - - - - -
            -
            - - - -
            - -
            - - -
            - - - diff --git a/index-files/index-5.html b/index-files/index-5.html deleted file mode 100644 index 707f136..0000000 --- a/index-files/index-5.html +++ /dev/null @@ -1,129 +0,0 @@ - - - - - -I-Index - - - - - - - - -
            - - -
            Skip navigation links
            - - - - -
            -
            - - - -
            - -
            - - -
            - -
            A C D G I L M R S T U V  - - -

            I

            -
            -
            ImageFormat - Enum in com.textcontrol.reportingcloud
            -
            -
            This enum lists all possible image formats for the thumbnails
            -
            -
            -A C D G I L M R S T U V 
            - -
            - - -
            Skip navigation links
            - - - - -
            -
            - - - -
            - -
            - - -
            - - - diff --git a/index-files/index-6.html b/index-files/index-6.html deleted file mode 100644 index ff9963a..0000000 --- a/index-files/index-6.html +++ /dev/null @@ -1,129 +0,0 @@ - - - - - -L-Index - - - - - - - - -
            - - -
            Skip navigation links
            - - - - -
            -
            - - - -
            - -
            - - -
            - -
            A C D G I L M R S T U V  - - -

            L

            -
            -
            listTemplates() - Method in class com.textcontrol.reportingcloud.ReportingCloud
            -
            -
            Lists all templates from the template storage.
            -
            -
            -A C D G I L M R S T U V 
            - -
            - - -
            Skip navigation links
            - - - - -
            -
            - - - -
            - -
            - - -
            - - - diff --git a/index-files/index-7.html b/index-files/index-7.html deleted file mode 100644 index 0e15fe0..0000000 --- a/index-files/index-7.html +++ /dev/null @@ -1,177 +0,0 @@ - - - - - -M-Index - - - - - - - - -
            - - -
            Skip navigation links
            - - - - -
            -
            - - - -
            - -
            - - -
            - -
            A C D G I L M R S T U V  - - -

            M

            -
            -
            MergeBody - Class in com.textcontrol.reportingcloud
            -
            -
            Used to pass data to the merge method.
            -
            -
            MergeBody(Iterable<Object>) - Constructor for class com.textcontrol.reportingcloud.MergeBody
            -
             
            -
            MergeBody(Object[]) - Constructor for class com.textcontrol.reportingcloud.MergeBody
            -
             
            -
            MergeBody(Iterable<Object>, MergeSettings) - Constructor for class com.textcontrol.reportingcloud.MergeBody
            -
             
            -
            MergeBody(Object[], MergeSettings) - Constructor for class com.textcontrol.reportingcloud.MergeBody
            -
             
            -
            MergeBody(Iterable<Object>, MergeSettings, byte[]) - Constructor for class com.textcontrol.reportingcloud.MergeBody
            -
             
            -
            MergeBody(Object[], MergeSettings, byte[]) - Constructor for class com.textcontrol.reportingcloud.MergeBody
            -
             
            -
            MergeBodySerializer - Class in com.textcontrol.reportingcloud.gson
            -
            -
            Needed by GSON to serialize MergeBody objects to - JSON.
            -
            -
            MergeBodySerializer() - Constructor for class com.textcontrol.reportingcloud.gson.MergeBodySerializer
            -
             
            -
            mergeDocument(MergeBody) - Method in class com.textcontrol.reportingcloud.ReportingCloud
            -
            -
            Merges and returns a template from the template storage or an uploaded template with JSON data.
            -
            -
            mergeDocument(MergeBody, String) - Method in class com.textcontrol.reportingcloud.ReportingCloud
            -
            -
            Merges and returns a template from the template storage or an uploaded template with JSON data.
            -
            -
            mergeDocument(MergeBody, String, ReturnFormat) - Method in class com.textcontrol.reportingcloud.ReportingCloud
            -
            -
            Merges and returns a template from the template storage or an uploaded template with JSON data.
            -
            -
            mergeDocument(MergeBody, String, ReturnFormat, boolean) - Method in class com.textcontrol.reportingcloud.ReportingCloud
            -
            -
            Merges and returns a template from the template storage or an uploaded template with JSON data.
            -
            -
            MergeSettings - Class in com.textcontrol.reportingcloud
            -
            -
            Holds the merge settings needed by the merge method.
            -
            -
            MergeSettings() - Constructor for class com.textcontrol.reportingcloud.MergeSettings
            -
             
            -
            MergeSettingsSerializer - Class in com.textcontrol.reportingcloud.gson
            -
            -
            Needed by GSON to serialize MergeSettings objects to - JSON.
            -
            -
            MergeSettingsSerializer() - Constructor for class com.textcontrol.reportingcloud.gson.MergeSettingsSerializer
            -
             
            -
            -A C D G I L M R S T U V 
            - -
            - - -
            Skip navigation links
            - - - - -
            -
            - - - -
            - -
            - - -
            - - - diff --git a/index-files/index-8.html b/index-files/index-8.html deleted file mode 100644 index 7876eda..0000000 --- a/index-files/index-8.html +++ /dev/null @@ -1,142 +0,0 @@ - - - - - -R-Index - - - - - - - - -
            - - -
            Skip navigation links
            - - - - -
            -
            - - - -
            - -
            - - -
            - -
            A C D G I L M R S T U V  - - -

            R

            -
            -
            ReportingCloud - Class in com.textcontrol.reportingcloud
            -
            -
            The ReportingCloud API wrapper class.
            -
            -
            ReportingCloud(String, String, String) - Constructor for class com.textcontrol.reportingcloud.ReportingCloud
            -
            -
            Creates a new ReportingCloud wrapper instance.
            -
            -
            ReportingCloud(String, String) - Constructor for class com.textcontrol.reportingcloud.ReportingCloud
            -
            -
            Creates a new ReportingCloud wrapper instance with the API base URL - set to "http://api.reporting.cloud".
            -
            -
            ReturnFormat - Enum in com.textcontrol.reportingcloud
            -
            -
            This enum lists all possible return formats for the Merge method.
            -
            -
            -A C D G I L M R S T U V 
            - -
            - - -
            Skip navigation links
            - - - - -
            -
            - - - -
            - -
            - - -
            - - - diff --git a/index-files/index-9.html b/index-files/index-9.html deleted file mode 100644 index 96376a4..0000000 --- a/index-files/index-9.html +++ /dev/null @@ -1,200 +0,0 @@ - - - - - -S-Index - - - - - - - - -
            - - -
            Skip navigation links
            - - - - -
            -
            - - - -
            - -
            - - -
            - -
            A C D G I L M R S T U V  - - -

            S

            -
            -
            serialize(MergeBody, Type, JsonSerializationContext) - Method in class com.textcontrol.reportingcloud.gson.MergeBodySerializer
            -
             
            -
            serialize(MergeSettings, Type, JsonSerializationContext) - Method in class com.textcontrol.reportingcloud.gson.MergeSettingsSerializer
            -
             
            -
            setAuthor(String) - Method in class com.textcontrol.reportingcloud.MergeSettings
            -
            -
            Sets the document's author.
            -
            -
            setCreationDate(String) - Method in class com.textcontrol.reportingcloud.MergeSettings
            -
            -
            Sets the creation date.
            -
            -
            setCreationDate(ZonedDateTime) - Method in class com.textcontrol.reportingcloud.MergeSettings
            -
            -
            Sets the creation date.
            -
            -
            setCreatorApplication(String) - Method in class com.textcontrol.reportingcloud.MergeSettings
            -
            -
            Sets the application which created the document.
            -
            -
            setDocumentSubject(String) - Method in class com.textcontrol.reportingcloud.MergeSettings
            -
            -
            Sets the document's subject.
            -
            -
            setDocumentTitle(String) - Method in class com.textcontrol.reportingcloud.MergeSettings
            -
            -
            Sets the document's title.
            -
            -
            setLastModificationDate(String) - Method in class com.textcontrol.reportingcloud.MergeSettings
            -
            -
            Sets the last modification date.
            -
            -
            setLastModificationDate(ZonedDateTime) - Method in class com.textcontrol.reportingcloud.MergeSettings
            -
            -
            Sets the last modification date.
            -
            -
            setMergeData(Iterable<Object>) - Method in class com.textcontrol.reportingcloud.MergeBody
            -
            -
            Sets the merge data.
            -
            -
            setMergeData(Object[]) - Method in class com.textcontrol.reportingcloud.MergeBody
            -
            -
            Sets the merge data.
            -
            -
            setMergeSettings(MergeSettings) - Method in class com.textcontrol.reportingcloud.MergeBody
            -
            -
            Sets the merge settings to specify merge properties and document properties such - as title and author.
            -
            -
            setRemoveEmptyBlocks(boolean) - Method in class com.textcontrol.reportingcloud.MergeSettings
            -
            -
            Sets whether the content of empty merge blocks should be removed from the template - or not.
            -
            -
            setRemoveEmptyFields(boolean) - Method in class com.textcontrol.reportingcloud.MergeSettings
            -
            -
            Sets whether empty fields should be removed from the template or not.
            -
            -
            setRemoveEmptyImages(boolean) - Method in class com.textcontrol.reportingcloud.MergeSettings
            -
            -
            Sets whether images which don't have merge data should be removed from - the template or not.
            -
            -
            setRemoveTrailingWhitespace(boolean) - Method in class com.textcontrol.reportingcloud.MergeSettings
            -
            -
            Sets whether trailing whitespace should be removed before saving a document.
            -
            -
            setTemplate(byte[]) - Method in class com.textcontrol.reportingcloud.MergeBody
            -
            -
            Sets the binary template document data.
            -
            -
            setUserPassword(String) - Method in class com.textcontrol.reportingcloud.MergeSettings
            -
            -
            Sets the password needed to open the document.
            -
            -
            -A C D G I L M R S T U V 
            - -
            - - -
            Skip navigation links
            - - - - -
            -
            - - - -
            - -
            - - -
            - - - diff --git a/index.html b/index.html index c960b62..a53335d 100644 --- a/index.html +++ b/index.html @@ -2,8 +2,8 @@ - -Generated Documentation (Untitled) + +txtextcontrol-reportingcloud-java 1.2 API diff --git a/overview-summary.html b/overview-summary.html index 41589f0..f66c616 100644 --- a/overview-summary.html +++ b/overview-summary.html @@ -2,9 +2,9 @@ - -Overview - + +Overview (txtextcontrol-reportingcloud-java 1.2 API) + @@ -12,7 +12,7 @@ @@ -12,7 +12,7 @@ - - - - - -
            - - -
            Skip navigation links
            - - - - -
            -
            - - - -
            - -
            -
            -
              -
            • Summary: 
              • -
            • Nested | 
              • -
            • Field | 
              • -
            • Constr | 
              • -
            • Method
              • -
            - -
            - - -
            - - -
            -
            com.textcontrol.reportingcloud
            -

            Class TemplateDataValidator

            -
            -
            -
              -
            • java.lang.Object
              • -
            • -
                -
              • com.textcontrol.reportingcloud.TemplateDataValidator
                • -
              -
              • -
            -
            -
              -
            • -
              -
              -
              public class TemplateDataValidator
-extends java.lang.Object
              -
              Internal method parameter validator class.
              -
              • -
            -
            -
            -
              -
            • - - - -
                -
              • - - -

                Method Summary

                - - - - - - - - - - -
                All Methods Static Methods Concrete Methods 
                Modifier and TypeMethod and Description
                static voidvalidate(byte[] templateData) -
                Checks if a template data buffer contains something.
                -
                -
                  -
                • - - -

                  Methods inherited from class java.lang.Object

                  -clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
                  • -
                -
                • -
              -
              • -
            -
            -
            -
              -
            • - -
                -
              • - - -

                Constructor Detail

                - - - -
                  -
                • -

                  TemplateDataValidator

                  -
                  public TemplateDataValidator()
                  -
                  • -
                -
                • -
              - -
                -
              • - - -

                Method Detail

                - - - -
                  -
                • -

                  validate

                  -
                  public static void validate(byte[] templateData)
-                     throws java.security.InvalidParameterException
                  -
                  Checks if a template data buffer contains something. Throws an exception if not.
                  -
                  -
                  Parameters:
                  -
                  templateData - Template data.
                  -
                  Throws:
                  -
                  java.security.InvalidParameterException
                  -
                  -
                  • -
                -
                • -
              -
              • -
            -
            -
            - - -
            - - -
            Skip navigation links
            - - - - -
            -
            - - - -
            - -
            -
            -
              -
            • Summary: 
              • -
            • Nested | 
              • -
            • Field | 
              • -
            • Constr | 
              • -
            • Method
              • -
            - -
            - - -
            - - - diff --git a/com/textcontrol/reportingcloud/TemplateNameValidator.html b/com/textcontrol/reportingcloud/TemplateNameValidator.html deleted file mode 100644 index 80c1f82..0000000 --- a/com/textcontrol/reportingcloud/TemplateNameValidator.html +++ /dev/null @@ -1,280 +0,0 @@ - - - - - -TemplateNameValidator (txtextcontrol-reportingcloud-java 1.2 API) - - - - - - - - -
            - - -
            Skip navigation links
            - - - - -
            -
            - - - -
            - -
            -
            -
              -
            • Summary: 
              • -
            • Nested | 
              • -
            • Field | 
              • -
            • Constr | 
              • -
            • Method
              • -
            - -
            - - -
            - - -
            -
            com.textcontrol.reportingcloud
            -

            Class TemplateNameValidator

            -
            -
            -
              -
            • java.lang.Object
              • -
            • -
                -
              • com.textcontrol.reportingcloud.TemplateNameValidator
                • -
              -
              • -
            -
            -
              -
            • -
              -
              -
              public class TemplateNameValidator
-extends java.lang.Object
              -
              Internal method parameter validator class.
              -
              • -
            -
            -
            -
              -
            • - - - -
                -
              • - - -

                Method Summary

                - - - - - - - - - - -
                All Methods Static Methods Concrete Methods 
                Modifier and TypeMethod and Description
                static voidvalidate(java.lang.String templateName) -
                Checks if a template name contains something.
                -
                -
                  -
                • - - -

                  Methods inherited from class java.lang.Object

                  -clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
                  • -
                -
                • -
              -
              • -
            -
            -
            -
              -
            • - -
                -
              • - - -

                Constructor Detail

                - - - -
                  -
                • -

                  TemplateNameValidator

                  -
                  public TemplateNameValidator()
                  -
                  • -
                -
                • -
              - -
                -
              • - - -

                Method Detail

                - - - -
                  -
                • -

                  validate

                  -
                  public static void validate(java.lang.String templateName)
-                     throws java.security.InvalidParameterException
                  -
                  Checks if a template name contains something. Throws an exception if not.
                  -
                  -
                  Parameters:
                  -
                  templateName - The Template name.
                  -
                  Throws:
                  -
                  java.security.InvalidParameterException
                  -
                  -
                  • -
                -
                • -
              -
              • -
            -
            -
            - - -
            - - -
            Skip navigation links
            - - - - -
            -
            - - - -
            - -
            -
            -
              -
            • Summary: 
              • -
            • Nested | 
              • -
            • Field | 
              • -
            • Constr | 
              • -
            • Method
              • -
            - -
            - - -
            - - - diff --git a/com/textcontrol/reportingcloud/gson/AccountSettingsDeserializer.html b/com/textcontrol/reportingcloud/gson/AccountSettingsDeserializer.html index aac0650..bd1767a 100644 --- a/com/textcontrol/reportingcloud/gson/AccountSettingsDeserializer.html +++ b/com/textcontrol/reportingcloud/gson/AccountSettingsDeserializer.html @@ -2,7 +2,7 @@ - + AccountSettingsDeserializer (txtextcontrol-reportingcloud-java 1.2 API) diff --git a/com/textcontrol/reportingcloud/gson/MergeBodySerializer.html b/com/textcontrol/reportingcloud/gson/MergeBodySerializer.html index 513ddad..56f59fe 100644 --- a/com/textcontrol/reportingcloud/gson/MergeBodySerializer.html +++ b/com/textcontrol/reportingcloud/gson/MergeBodySerializer.html @@ -2,7 +2,7 @@ - + MergeBodySerializer (txtextcontrol-reportingcloud-java 1.2 API) diff --git a/com/textcontrol/reportingcloud/gson/MergeSettingsSerializer.html b/com/textcontrol/reportingcloud/gson/MergeSettingsSerializer.html index 11bc26f..ed30320 100644 --- a/com/textcontrol/reportingcloud/gson/MergeSettingsSerializer.html +++ b/com/textcontrol/reportingcloud/gson/MergeSettingsSerializer.html @@ -2,7 +2,7 @@ - + MergeSettingsSerializer (txtextcontrol-reportingcloud-java 1.2 API) diff --git a/com/textcontrol/reportingcloud/gson/TemplateDeserializer.html b/com/textcontrol/reportingcloud/gson/TemplateDeserializer.html index e31f7d0..abfdf0a 100644 --- a/com/textcontrol/reportingcloud/gson/TemplateDeserializer.html +++ b/com/textcontrol/reportingcloud/gson/TemplateDeserializer.html @@ -2,7 +2,7 @@ - + TemplateDeserializer (txtextcontrol-reportingcloud-java 1.2 API) diff --git a/com/textcontrol/reportingcloud/gson/package-frame.html b/com/textcontrol/reportingcloud/gson/package-frame.html index f7c93ce..bbaf6d0 100644 --- a/com/textcontrol/reportingcloud/gson/package-frame.html +++ b/com/textcontrol/reportingcloud/gson/package-frame.html @@ -2,7 +2,7 @@ - + com.textcontrol.reportingcloud.gson (txtextcontrol-reportingcloud-java 1.2 API) diff --git a/com/textcontrol/reportingcloud/gson/package-summary.html b/com/textcontrol/reportingcloud/gson/package-summary.html index f32ec1f..830fe3b 100644 --- a/com/textcontrol/reportingcloud/gson/package-summary.html +++ b/com/textcontrol/reportingcloud/gson/package-summary.html @@ -2,7 +2,7 @@ - + com.textcontrol.reportingcloud.gson (txtextcontrol-reportingcloud-java 1.2 API) diff --git a/com/textcontrol/reportingcloud/gson/package-tree.html b/com/textcontrol/reportingcloud/gson/package-tree.html index 55fa585..4ecc563 100644 --- a/com/textcontrol/reportingcloud/gson/package-tree.html +++ b/com/textcontrol/reportingcloud/gson/package-tree.html @@ -2,7 +2,7 @@ - + com.textcontrol.reportingcloud.gson Class Hierarchy (txtextcontrol-reportingcloud-java 1.2 API) diff --git a/com/textcontrol/reportingcloud/package-frame.html b/com/textcontrol/reportingcloud/package-frame.html index 68a2090..9bcdad0 100644 --- a/com/textcontrol/reportingcloud/package-frame.html +++ b/com/textcontrol/reportingcloud/package-frame.html @@ -2,7 +2,7 @@ - + com.textcontrol.reportingcloud (txtextcontrol-reportingcloud-java 1.2 API) @@ -18,8 +18,6 @@

            Classes

          • MergeSettings
          • ReportingCloud
          • Template
            • -
          • TemplateDataValidator
            • -
          • TemplateNameValidator

          Enums

            diff --git a/com/textcontrol/reportingcloud/package-summary.html b/com/textcontrol/reportingcloud/package-summary.html index 9685511..407be63 100644 --- a/com/textcontrol/reportingcloud/package-summary.html +++ b/com/textcontrol/reportingcloud/package-summary.html @@ -2,7 +2,7 @@ - + com.textcontrol.reportingcloud (txtextcontrol-reportingcloud-java 1.2 API) @@ -115,18 +115,6 @@

            Package com.textcontrol.reportingcloudHolds information about a template in the template storage.

          - -TemplateDataValidator - -
          Internal method parameter validator class.
          - - - -TemplateNameValidator - -
          Internal method parameter validator class.
          - - diff --git a/com/textcontrol/reportingcloud/package-tree.html b/com/textcontrol/reportingcloud/package-tree.html index 18703bd..008be41 100644 --- a/com/textcontrol/reportingcloud/package-tree.html +++ b/com/textcontrol/reportingcloud/package-tree.html @@ -2,7 +2,7 @@ - + com.textcontrol.reportingcloud Class Hierarchy (txtextcontrol-reportingcloud-java 1.2 API) @@ -85,8 +85,6 @@

          Class Hierarchy

        • com.textcontrol.reportingcloud.MergeSettings
        • com.textcontrol.reportingcloud.ReportingCloud
        • com.textcontrol.reportingcloud.Template
          • -
        • com.textcontrol.reportingcloud.TemplateDataValidator
          • -
        • com.textcontrol.reportingcloud.TemplateNameValidator
      diff --git a/constant-values.html b/constant-values.html index f85a2d4..b141b5e 100644 --- a/constant-values.html +++ b/constant-values.html @@ -2,7 +2,7 @@ - + Constant Field Values (txtextcontrol-reportingcloud-java 1.2 API) diff --git a/deprecated-list.html b/deprecated-list.html index 404b9a9..39c9864 100644 --- a/deprecated-list.html +++ b/deprecated-list.html @@ -2,7 +2,7 @@ - + Deprecated List (txtextcontrol-reportingcloud-java 1.2 API) diff --git a/help-doc.html b/help-doc.html index 4d7276b..c228223 100644 --- a/help-doc.html +++ b/help-doc.html @@ -2,7 +2,7 @@ - + API Help (txtextcontrol-reportingcloud-java 1.2 API) diff --git a/index-all.html b/index-all.html index fdfeeb0..457edc5 100644 --- a/index-all.html +++ b/index-all.html @@ -2,7 +2,7 @@ - + Index (txtextcontrol-reportingcloud-java 1.2 API) @@ -447,12 +447,6 @@

      T

      Creates a new Template instance.
      -
      TemplateDataValidator - Class in com.textcontrol.reportingcloud
      -
      -
      Internal method parameter validator class.
      -
      -
      TemplateDataValidator() - Constructor for class com.textcontrol.reportingcloud.TemplateDataValidator
      -
       
      TemplateDeserializer - Class in com.textcontrol.reportingcloud.gson
      Needed by GSON to create Template objects from JSON data.
      @@ -463,12 +457,6 @@

      T

      Checks whether a template exists in the template storage.
      -
      TemplateNameValidator - Class in com.textcontrol.reportingcloud
      -
      -
      Internal method parameter validator class.
      -
      -
      TemplateNameValidator() - Constructor for class com.textcontrol.reportingcloud.TemplateNameValidator
      -
       
      @@ -486,14 +474,6 @@

      U

      V

      -
      validate(byte[]) - Static method in class com.textcontrol.reportingcloud.TemplateDataValidator
      -
      -
      Checks if a template data buffer contains something.
      -
      -
      validate(String) - Static method in class com.textcontrol.reportingcloud.TemplateNameValidator
      -
      -
      Checks if a template name contains something.
      -
      valueOf(String) - Static method in enum com.textcontrol.reportingcloud.ImageFormat
      Returns the enum constant of this type with the specified name.
      diff --git a/index.html b/index.html index a53335d..aefc0c6 100644 --- a/index.html +++ b/index.html @@ -2,7 +2,7 @@ - + txtextcontrol-reportingcloud-java 1.2 API diff --git a/allclasses-noframe.html b/allclasses-noframe.html index 04ce86d..6d2a18d 100644 --- a/allclasses-noframe.html +++ b/allclasses-noframe.html @@ -2,8 +2,8 @@ - -All Classes (txtextcontrol-reportingcloud-java 1.2 API) + +All Classes (reportingcloud 1.0 API) diff --git a/com/textcontrol/reportingcloud/AccountSettings.html b/com/textcontrol/reportingcloud/AccountSettings.html index 14a4011..23249ca 100644 --- a/com/textcontrol/reportingcloud/AccountSettings.html +++ b/com/textcontrol/reportingcloud/AccountSettings.html @@ -2,8 +2,8 @@ - -AccountSettings (txtextcontrol-reportingcloud-java 1.2 API) + +AccountSettings (reportingcloud 1.0 API) @@ -12,7 +12,7 @@ @@ -12,7 +12,7 @@ @@ -12,7 +12,7 @@ @@ -12,7 +12,7 @@ @@ -12,7 +12,7 @@ @@ -12,7 +12,7 @@ @@ -12,7 +12,7 @@ @@ -12,7 +12,7 @@ @@ -12,7 +12,7 @@ @@ -12,7 +12,7 @@ @@ -12,7 +12,7 @@ diff --git a/com/textcontrol/reportingcloud/gson/package-summary.html b/com/textcontrol/reportingcloud/gson/package-summary.html index 830fe3b..a7a7be7 100644 --- a/com/textcontrol/reportingcloud/gson/package-summary.html +++ b/com/textcontrol/reportingcloud/gson/package-summary.html @@ -2,8 +2,8 @@ - -com.textcontrol.reportingcloud.gson (txtextcontrol-reportingcloud-java 1.2 API) + +com.textcontrol.reportingcloud.gson (reportingcloud 1.0 API) @@ -12,7 +12,7 @@ @@ -12,7 +12,7 @@ diff --git a/com/textcontrol/reportingcloud/package-summary.html b/com/textcontrol/reportingcloud/package-summary.html index 407be63..dbfc825 100644 --- a/com/textcontrol/reportingcloud/package-summary.html +++ b/com/textcontrol/reportingcloud/package-summary.html @@ -2,8 +2,8 @@ - -com.textcontrol.reportingcloud (txtextcontrol-reportingcloud-java 1.2 API) + +com.textcontrol.reportingcloud (reportingcloud 1.0 API) @@ -12,7 +12,7 @@ @@ -12,7 +12,7 @@ @@ -12,7 +12,7 @@ @@ -12,7 +12,7 @@ @@ -12,7 +12,7 @@ @@ -12,7 +12,7 @@ diff --git a/overview-summary.html b/overview-summary.html index 929d1c2..9eb166a 100644 --- a/overview-summary.html +++ b/overview-summary.html @@ -2,8 +2,8 @@ - -Overview (txtextcontrol-reportingcloud-java 1.2 API) + +Overview (reportingcloud 1.0 API) @@ -12,7 +12,7 @@ @@ -12,7 +12,7 @@ diff --git a/allclasses-noframe.html b/allclasses-noframe.html index 6d2a18d..37e724e 100644 --- a/allclasses-noframe.html +++ b/allclasses-noframe.html @@ -2,9 +2,9 @@ - + All Classes (reportingcloud 1.0 API) - + diff --git a/com/textcontrol/reportingcloud/AccountSettings.html b/com/textcontrol/reportingcloud/AccountSettings.html index 23249ca..6425ecb 100644 --- a/com/textcontrol/reportingcloud/AccountSettings.html +++ b/com/textcontrol/reportingcloud/AccountSettings.html @@ -2,9 +2,9 @@ - + AccountSettings (reportingcloud 1.0 API) - + diff --git a/com/textcontrol/reportingcloud/ImageFormat.html b/com/textcontrol/reportingcloud/ImageFormat.html index 89b708f..1bd4b41 100644 --- a/com/textcontrol/reportingcloud/ImageFormat.html +++ b/com/textcontrol/reportingcloud/ImageFormat.html @@ -2,9 +2,9 @@ - + ImageFormat (reportingcloud 1.0 API) - + diff --git a/com/textcontrol/reportingcloud/MergeBody.html b/com/textcontrol/reportingcloud/MergeBody.html index 1d5122a..51994a0 100644 --- a/com/textcontrol/reportingcloud/MergeBody.html +++ b/com/textcontrol/reportingcloud/MergeBody.html @@ -2,9 +2,9 @@ - + MergeBody (reportingcloud 1.0 API) - + diff --git a/com/textcontrol/reportingcloud/MergeSettings.html b/com/textcontrol/reportingcloud/MergeSettings.html index a238c03..41584d6 100644 --- a/com/textcontrol/reportingcloud/MergeSettings.html +++ b/com/textcontrol/reportingcloud/MergeSettings.html @@ -2,9 +2,9 @@ - + MergeSettings (reportingcloud 1.0 API) - + diff --git a/com/textcontrol/reportingcloud/ReportingCloud.html b/com/textcontrol/reportingcloud/ReportingCloud.html index 253a5a5..8ef637d 100644 --- a/com/textcontrol/reportingcloud/ReportingCloud.html +++ b/com/textcontrol/reportingcloud/ReportingCloud.html @@ -2,9 +2,9 @@ - + ReportingCloud (reportingcloud 1.0 API) - + @@ -132,7 +132,7 @@

      Constructor Summary

      ReportingCloud(java.lang.String username, java.lang.String password)
      Creates a new ReportingCloud wrapper instance with the API base URL - set to "http://api.reporting.cloud".
      + set to "https://api.reporting.cloud".
      @@ -327,7 +327,7 @@

      ReportingCloud

      public ReportingCloud(java.lang.String username,
                       java.lang.String password)
      Creates a new ReportingCloud wrapper instance with the API base URL - set to "http://api.reporting.cloud".
      + set to "https://api.reporting.cloud".
    Parameters:
    username - The username.
    diff --git a/com/textcontrol/reportingcloud/ReturnFormat.html b/com/textcontrol/reportingcloud/ReturnFormat.html index af94b05..ac0ca21 100644 --- a/com/textcontrol/reportingcloud/ReturnFormat.html +++ b/com/textcontrol/reportingcloud/ReturnFormat.html @@ -2,9 +2,9 @@ - + ReturnFormat (reportingcloud 1.0 API) - + diff --git a/com/textcontrol/reportingcloud/Template.html b/com/textcontrol/reportingcloud/Template.html index 68dfece..174155a 100644 --- a/com/textcontrol/reportingcloud/Template.html +++ b/com/textcontrol/reportingcloud/Template.html @@ -2,9 +2,9 @@ - + Template (reportingcloud 1.0 API) - + diff --git a/com/textcontrol/reportingcloud/gson/AccountSettingsDeserializer.html b/com/textcontrol/reportingcloud/gson/AccountSettingsDeserializer.html index 1fe7b84..0e93696 100644 --- a/com/textcontrol/reportingcloud/gson/AccountSettingsDeserializer.html +++ b/com/textcontrol/reportingcloud/gson/AccountSettingsDeserializer.html @@ -2,9 +2,9 @@ - + AccountSettingsDeserializer (reportingcloud 1.0 API) - + diff --git a/com/textcontrol/reportingcloud/gson/MergeBodySerializer.html b/com/textcontrol/reportingcloud/gson/MergeBodySerializer.html index 43a14f3..553a086 100644 --- a/com/textcontrol/reportingcloud/gson/MergeBodySerializer.html +++ b/com/textcontrol/reportingcloud/gson/MergeBodySerializer.html @@ -2,9 +2,9 @@ - + MergeBodySerializer (reportingcloud 1.0 API) - + diff --git a/com/textcontrol/reportingcloud/gson/MergeSettingsSerializer.html b/com/textcontrol/reportingcloud/gson/MergeSettingsSerializer.html index 0081084..c3160c1 100644 --- a/com/textcontrol/reportingcloud/gson/MergeSettingsSerializer.html +++ b/com/textcontrol/reportingcloud/gson/MergeSettingsSerializer.html @@ -2,9 +2,9 @@ - + MergeSettingsSerializer (reportingcloud 1.0 API) - + diff --git a/com/textcontrol/reportingcloud/gson/TemplateDeserializer.html b/com/textcontrol/reportingcloud/gson/TemplateDeserializer.html index a983287..e454959 100644 --- a/com/textcontrol/reportingcloud/gson/TemplateDeserializer.html +++ b/com/textcontrol/reportingcloud/gson/TemplateDeserializer.html @@ -2,9 +2,9 @@ - + TemplateDeserializer (reportingcloud 1.0 API) - + diff --git a/com/textcontrol/reportingcloud/gson/package-frame.html b/com/textcontrol/reportingcloud/gson/package-frame.html index 547f034..b3afbf0 100644 --- a/com/textcontrol/reportingcloud/gson/package-frame.html +++ b/com/textcontrol/reportingcloud/gson/package-frame.html @@ -2,9 +2,9 @@ - + com.textcontrol.reportingcloud.gson (reportingcloud 1.0 API) - + diff --git a/com/textcontrol/reportingcloud/gson/package-summary.html b/com/textcontrol/reportingcloud/gson/package-summary.html index a7a7be7..f8b1b7b 100644 --- a/com/textcontrol/reportingcloud/gson/package-summary.html +++ b/com/textcontrol/reportingcloud/gson/package-summary.html @@ -2,9 +2,9 @@ - + com.textcontrol.reportingcloud.gson (reportingcloud 1.0 API) - + diff --git a/com/textcontrol/reportingcloud/gson/package-tree.html b/com/textcontrol/reportingcloud/gson/package-tree.html index c19026a..2cc00af 100644 --- a/com/textcontrol/reportingcloud/gson/package-tree.html +++ b/com/textcontrol/reportingcloud/gson/package-tree.html @@ -2,9 +2,9 @@ - + com.textcontrol.reportingcloud.gson Class Hierarchy (reportingcloud 1.0 API) - + diff --git a/com/textcontrol/reportingcloud/package-frame.html b/com/textcontrol/reportingcloud/package-frame.html index 9518bb4..1c9d9ad 100644 --- a/com/textcontrol/reportingcloud/package-frame.html +++ b/com/textcontrol/reportingcloud/package-frame.html @@ -2,9 +2,9 @@ - + com.textcontrol.reportingcloud (reportingcloud 1.0 API) - + diff --git a/com/textcontrol/reportingcloud/package-summary.html b/com/textcontrol/reportingcloud/package-summary.html index dbfc825..cfc3a82 100644 --- a/com/textcontrol/reportingcloud/package-summary.html +++ b/com/textcontrol/reportingcloud/package-summary.html @@ -2,9 +2,9 @@ - + com.textcontrol.reportingcloud (reportingcloud 1.0 API) - + diff --git a/com/textcontrol/reportingcloud/package-tree.html b/com/textcontrol/reportingcloud/package-tree.html index 1887b61..33d8533 100644 --- a/com/textcontrol/reportingcloud/package-tree.html +++ b/com/textcontrol/reportingcloud/package-tree.html @@ -2,9 +2,9 @@ - + com.textcontrol.reportingcloud Class Hierarchy (reportingcloud 1.0 API) - + diff --git a/constant-values.html b/constant-values.html index 5525eac..fe81cfe 100644 --- a/constant-values.html +++ b/constant-values.html @@ -2,9 +2,9 @@ - + Constant Field Values (reportingcloud 1.0 API) - + diff --git a/deprecated-list.html b/deprecated-list.html index e4db56d..b2c4760 100644 --- a/deprecated-list.html +++ b/deprecated-list.html @@ -2,9 +2,9 @@ - + Deprecated List (reportingcloud 1.0 API) - + diff --git a/help-doc.html b/help-doc.html index faef526..606c6a9 100644 --- a/help-doc.html +++ b/help-doc.html @@ -2,9 +2,9 @@ - + API Help (reportingcloud 1.0 API) - + diff --git a/index-all.html b/index-all.html index 6c582aa..900bf8c 100644 --- a/index-all.html +++ b/index-all.html @@ -2,9 +2,9 @@ - + Index (reportingcloud 1.0 API) - + @@ -346,7 +346,7 @@

    R

    ReportingCloud(String, String) - Constructor for class com.textcontrol.reportingcloud.ReportingCloud
    Creates a new ReportingCloud wrapper instance with the API base URL - set to "http://api.reporting.cloud".
    + set to "https://api.reporting.cloud".
ReturnFormat - Enum in com.textcontrol.reportingcloud
diff --git a/index.html b/index.html index 19af718..64813bb 100644 --- a/index.html +++ b/index.html @@ -2,7 +2,7 @@ - + reportingcloud 1.0 API diff --git a/overview-summary.html b/overview-summary.html index 9eb166a..1a68a4e 100644 --- a/overview-summary.html +++ b/overview-summary.html @@ -2,9 +2,9 @@ - + Overview (reportingcloud 1.0 API) - + diff --git a/overview-tree.html b/overview-tree.html index f337df3..ac0ff25 100644 --- a/overview-tree.html +++ b/overview-tree.html @@ -2,9 +2,9 @@ - + Class Hierarchy (reportingcloud 1.0 API) - + From af24fb58287fa0ff634272f3428c654cab459924 Mon Sep 17 00:00:00 2001 From: Thorsten Date: Fri, 31 Mar 2017 09:50:56 +0200 Subject: [PATCH 12/20] Endpoint /templates/info --- allclasses-frame.html | 64 +- allclasses-noframe.html | 64 +- .../reportingcloud/AccountSettings.html | 778 ++++---- .../reportingcloud/ImageFormat.html | 752 ++++---- .../reportingcloud/MergeBlock.html | 321 ++++ com/textcontrol/reportingcloud/MergeBody.html | 1086 +++++------ .../reportingcloud/MergeField.html | 409 ++++ .../reportingcloud/MergeSettings.html | 1512 +++++++-------- .../reportingcloud/ReportingCloud.html | 1671 +++++++++-------- .../reportingcloud/ReturnFormat.html | 842 ++++----- com/textcontrol/reportingcloud/Template.html | 662 +++---- .../reportingcloud/TemplateInfo.html | 327 ++++ .../gson/AccountSettingsDeserializer.html | 572 +++--- .../gson/MergeBlockDeserializer.html | 286 +++ .../gson/MergeBodySerializer.html | 568 +++--- .../gson/MergeFieldDeserializer.html | 286 +++ .../gson/MergeSettingsSerializer.html | 568 +++--- .../gson/TemplateDeserializer.html | 572 +++--- .../gson/TemplateInfoDeserializer.html | 286 +++ .../reportingcloud/gson/package-frame.html | 49 +- .../reportingcloud/gson/package-summary.html | 360 ++-- .../reportingcloud/gson/package-tree.html | 279 +-- .../reportingcloud/package-frame.html | 61 +- .../reportingcloud/package-summary.html | 414 ++-- .../reportingcloud/package-tree.html | 307 +-- constant-values.html | 244 +-- deprecated-list.html | 244 +-- help-doc.html | 446 ++--- index-all.html | 1186 ++++++------ index.html | 149 +- overview-frame.html | 44 +- overview-summary.html | 288 +-- overview-tree.html | 320 ++-- package-list | 4 +- script.js | 60 +- stylesheet.css | 1148 +++++------ 36 files changed, 9668 insertions(+), 7561 deletions(-) create mode 100644 com/textcontrol/reportingcloud/MergeBlock.html create mode 100644 com/textcontrol/reportingcloud/MergeField.html create mode 100644 com/textcontrol/reportingcloud/TemplateInfo.html create mode 100644 com/textcontrol/reportingcloud/gson/MergeBlockDeserializer.html create mode 100644 com/textcontrol/reportingcloud/gson/MergeFieldDeserializer.html create mode 100644 com/textcontrol/reportingcloud/gson/TemplateInfoDeserializer.html diff --git a/allclasses-frame.html b/allclasses-frame.html index 344ec76..9ddf33d 100644 --- a/allclasses-frame.html +++ b/allclasses-frame.html @@ -1,29 +1,35 @@ - - - - - -All Classes (reportingcloud 1.0 API) - - - - - -

All Classes

-
- -
- - + + + + + +All Classes (reportingcloud 1.1 API) + + + + + +

All Classes

+
+ +
+ + diff --git a/allclasses-noframe.html b/allclasses-noframe.html index 37e724e..1306101 100644 --- a/allclasses-noframe.html +++ b/allclasses-noframe.html @@ -1,29 +1,35 @@ - - - - - -All Classes (reportingcloud 1.0 API) - - - - - -

All Classes

-
- -
- - + + + + + +All Classes (reportingcloud 1.1 API) + + + + + +

All Classes

+
+ +
+ + diff --git a/com/textcontrol/reportingcloud/AccountSettings.html b/com/textcontrol/reportingcloud/AccountSettings.html index 6425ecb..48e6ff9 100644 --- a/com/textcontrol/reportingcloud/AccountSettings.html +++ b/com/textcontrol/reportingcloud/AccountSettings.html @@ -1,389 +1,389 @@ - - - - - -AccountSettings (reportingcloud 1.0 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
-
    -
  • Summary: 
    • -
  • Nested | 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
- -
- - -
- - -
-
com.textcontrol.reportingcloud
-

Class AccountSettings

-
-
-
    -
  • java.lang.Object
    • -
  • -
      -
    • com.textcontrol.reportingcloud.AccountSettings
      • -
    -
    • -
-
-
    -
  • -
    -
    -
    public class AccountSettings
-extends java.lang.Object
    -
    Represents ReportingCloud account settings.
    -
    • -
-
-
-
    -
  • - -
      -
    • - - -

      Constructor Summary

      - - - - - - - - -
      Constructors 
      Constructor and Description
      AccountSettings(java.lang.String serialNumber, - int createdDocuments, - int uploadedTemplates, - int maxDocuments, - int maxTemplates, - java.lang.String validUntil) 
      -
      • -
    - -
      -
    • - - -

      Method Summary

      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      intgetCreatedDocuments() -
      Gets the number of created documents in the current month.
      -
      intgetMaxDocuments() -
      Gets the maximum number of documents that can be created per month.
      -
      intgetMaxTemplates() -
      Gets the maximum number of templates that can be uploaded to the template storage.
      -
      java.lang.StringgetSerialNumber() -
      Gets the serial number that is attached to the - account.
      -
      intgetUploadedTemplates() -
      Gets the number of uploaded templates to the template storage.
      -
      java.time.ZonedDateTimegetValidUntil() -
      Gets the date until the current subscription is valid.
      -
      -
        -
      • - - -

        Methods inherited from class java.lang.Object

        -clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
        • -
      -
      • -
    -
    • -
-
-
-
    -
  • - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        AccountSettings

        -
        public AccountSettings(java.lang.String serialNumber,
-                       int createdDocuments,
-                       int uploadedTemplates,
-                       int maxDocuments,
-                       int maxTemplates,
-                       java.lang.String validUntil)
        -
        • -
      -
      • -
    - -
      -
    • - - -

      Method Detail

      - - - -
        -
      • -

        getSerialNumber

        -
        public java.lang.String getSerialNumber()
        -
        Gets the serial number that is attached to the - account. Possible values are "FREE", "TRIAL" and a 13 character long serial number.
        -
        -
        Returns:
        -
        The serial number.
        -
        -
        • -
      - - - -
        -
      • -

        getCreatedDocuments

        -
        public int getCreatedDocuments()
        -
        Gets the number of created documents in the current month.
        -
        -
        Returns:
        -
        The number of created documents.
        -
        -
        • -
      - - - -
        -
      • -

        getUploadedTemplates

        -
        public int getUploadedTemplates()
        -
        Gets the number of uploaded templates to the template storage.
        -
        -
        Returns:
        -
        The number of uploaded templates.
        -
        -
        • -
      - - - -
        -
      • -

        getMaxDocuments

        -
        public int getMaxDocuments()
        -
        Gets the maximum number of documents that can be created per month.
        -
        -
        Returns:
        -
        The maximum number of documents.
        -
        -
        • -
      - - - -
        -
      • -

        getMaxTemplates

        -
        public int getMaxTemplates()
        -
        Gets the maximum number of templates that can be uploaded to the template storage.
        -
        -
        Returns:
        -
        The maximum number of templates.
        -
        -
        • -
      - - - -
        -
      • -

        getValidUntil

        -
        public java.time.ZonedDateTime getValidUntil()
        -
        Gets the date until the current subscription is valid. Can be nil.
        -
        -
        Returns:
        -
        The date until the current subscription is valid.
        -
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
-
    -
  • Summary: 
    • -
  • Nested | 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
- -
- - -
- - - + + + + + +AccountSettings (reportingcloud 1.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
com.textcontrol.reportingcloud
+

Class AccountSettings

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • com.textcontrol.reportingcloud.AccountSettings
      • +
    +
    • +
+
+
    +
  • +
    +
    +
    public class AccountSettings
+extends java.lang.Object
    +
    Represents ReportingCloud account settings.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      AccountSettings(java.lang.String serialNumber, + int createdDocuments, + int uploadedTemplates, + int maxDocuments, + int maxTemplates, + java.lang.String validUntil) 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      intgetCreatedDocuments() +
      Gets the number of created documents in the current month.
      +
      intgetMaxDocuments() +
      Gets the maximum number of documents that can be created per month.
      +
      intgetMaxTemplates() +
      Gets the maximum number of templates that can be uploaded to the template storage.
      +
      java.lang.StringgetSerialNumber() +
      Gets the serial number that is attached to the + account.
      +
      intgetUploadedTemplates() +
      Gets the number of uploaded templates to the template storage.
      +
      java.time.ZonedDateTimegetValidUntil() +
      Gets the date until the current subscription is valid.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        AccountSettings

        +
        public AccountSettings(java.lang.String serialNumber,
+                       int createdDocuments,
+                       int uploadedTemplates,
+                       int maxDocuments,
+                       int maxTemplates,
+                       java.lang.String validUntil)
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getSerialNumber

        +
        public java.lang.String getSerialNumber()
        +
        Gets the serial number that is attached to the + account. Possible values are "FREE", "TRIAL" and a 13 character long serial number.
        +
        +
        Returns:
        +
        The serial number.
        +
        +
        • +
      + + + +
        +
      • +

        getCreatedDocuments

        +
        public int getCreatedDocuments()
        +
        Gets the number of created documents in the current month.
        +
        +
        Returns:
        +
        The number of created documents.
        +
        +
        • +
      + + + +
        +
      • +

        getUploadedTemplates

        +
        public int getUploadedTemplates()
        +
        Gets the number of uploaded templates to the template storage.
        +
        +
        Returns:
        +
        The number of uploaded templates.
        +
        +
        • +
      + + + +
        +
      • +

        getMaxDocuments

        +
        public int getMaxDocuments()
        +
        Gets the maximum number of documents that can be created per month.
        +
        +
        Returns:
        +
        The maximum number of documents.
        +
        +
        • +
      + + + +
        +
      • +

        getMaxTemplates

        +
        public int getMaxTemplates()
        +
        Gets the maximum number of templates that can be uploaded to the template storage.
        +
        +
        Returns:
        +
        The maximum number of templates.
        +
        +
        • +
      + + + +
        +
      • +

        getValidUntil

        +
        public java.time.ZonedDateTime getValidUntil()
        +
        Gets the date until the current subscription is valid. Can be nil.
        +
        +
        Returns:
        +
        The date until the current subscription is valid.
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/com/textcontrol/reportingcloud/ImageFormat.html b/com/textcontrol/reportingcloud/ImageFormat.html index 1bd4b41..78ad7cc 100644 --- a/com/textcontrol/reportingcloud/ImageFormat.html +++ b/com/textcontrol/reportingcloud/ImageFormat.html @@ -1,376 +1,376 @@ - - - - - -ImageFormat (reportingcloud 1.0 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- - -
-
com.textcontrol.reportingcloud
-

Enum ImageFormat

-
-
-
    -
  • java.lang.Object
    • -
  • -
      -
    • java.lang.Enum<ImageFormat>
      • -
    • -
        -
      • com.textcontrol.reportingcloud.ImageFormat
        • -
      -
      • -
    -
    • -
-
-
    -
  • -
    -
    All Implemented Interfaces:
    -
    java.io.Serializable, java.lang.Comparable<ImageFormat>
    -
    -
    -
    -
    public enum ImageFormat
-extends java.lang.Enum<ImageFormat>
    -
    This enum lists all possible image formats for the thumbnails
    -
    • -
-
-
-
    -
  • - -
      -
    • - - -

      Enum Constant Summary

      - - - - - - - - - - - - - - - - - -
      Enum Constants 
      Enum Constant and Description
      BMP -
      Windows Bitmap
      -
      GIF -
      Graphics Interchange Format
      -
      JPG -
      Joint Photographic Experts Group
      -
      PNG -
      Portable Network Graphics
      -
      -
      • -
    - -
      -
    • - - -

      Method Summary

      - - - - - - - - - - - - - - -
      All Methods Static Methods Concrete Methods 
      Modifier and TypeMethod and Description
      static ImageFormatvalueOf(java.lang.String name) -
      Returns the enum constant of this type with the specified name.
      -
      static ImageFormat[]values() -
      Returns an array containing the constants of this enum type, in -the order they are declared.
      -
      -
        -
      • - - -

        Methods inherited from class java.lang.Enum

        -clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
        • -
      -
        -
      • - - -

        Methods inherited from class java.lang.Object

        -getClass, notify, notifyAll, wait, wait, wait
        • -
      -
      • -
    -
    • -
-
-
-
    -
  • - -
      -
    • - - -

      Enum Constant Detail

      - - - -
        -
      • -

        JPG

        -
        public static final ImageFormat JPG
        -
        Joint Photographic Experts Group
        -
        • -
      - - - -
        -
      • -

        PNG

        -
        public static final ImageFormat PNG
        -
        Portable Network Graphics
        -
        • -
      - - - -
        -
      • -

        BMP

        -
        public static final ImageFormat BMP
        -
        Windows Bitmap
        -
        • -
      - - - -
        -
      • -

        GIF

        -
        public static final ImageFormat GIF
        -
        Graphics Interchange Format
        -
        • -
      -
      • -
    - -
      -
    • - - -

      Method Detail

      - - - -
        -
      • -

        values

        -
        public static ImageFormat[] values()
        -
        Returns an array containing the constants of this enum type, in -the order they are declared. This method may be used to iterate -over the constants as follows: -
        -for (ImageFormat c : ImageFormat.values())
-    System.out.println(c);
-
        -
        -
        Returns:
        -
        an array containing the constants of this enum type, in the order they are declared
        -
        -
        • -
      - - - -
        -
      • -

        valueOf

        -
        public static ImageFormat valueOf(java.lang.String name)
        -
        Returns the enum constant of this type with the specified name. -The string must match exactly an identifier used to declare an -enum constant in this type. (Extraneous whitespace characters are -not permitted.)
        -
        -
        Parameters:
        -
        name - the name of the enum constant to be returned.
        -
        Returns:
        -
        the enum constant with the specified name
        -
        Throws:
        -
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        -
        java.lang.NullPointerException - if the argument is null
        -
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- - - + + + + + +ImageFormat (reportingcloud 1.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
com.textcontrol.reportingcloud
+

Enum ImageFormat

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • java.lang.Enum<ImageFormat>
      • +
    • +
        +
      • com.textcontrol.reportingcloud.ImageFormat
        • +
      +
      • +
    +
    • +
+
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.io.Serializable, java.lang.Comparable<ImageFormat>
    +
    +
    +
    +
    public enum ImageFormat
+extends java.lang.Enum<ImageFormat>
    +
    This enum lists all possible image formats for the thumbnails
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Enum Constant Summary

      + + + + + + + + + + + + + + + + + +
      Enum Constants 
      Enum Constant and Description
      BMP +
      Windows Bitmap
      +
      GIF +
      Graphics Interchange Format
      +
      JPG +
      Joint Photographic Experts Group
      +
      PNG +
      Portable Network Graphics
      +
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + +
      All Methods Static Methods Concrete Methods 
      Modifier and TypeMethod and Description
      static ImageFormatvalueOf(java.lang.String name) +
      Returns the enum constant of this type with the specified name.
      +
      static ImageFormat[]values() +
      Returns an array containing the constants of this enum type, in +the order they are declared.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Enum

        +clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +getClass, notify, notifyAll, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Enum Constant Detail

      + + + +
        +
      • +

        JPG

        +
        public static final ImageFormat JPG
        +
        Joint Photographic Experts Group
        +
        • +
      + + + +
        +
      • +

        PNG

        +
        public static final ImageFormat PNG
        +
        Portable Network Graphics
        +
        • +
      + + + +
        +
      • +

        BMP

        +
        public static final ImageFormat BMP
        +
        Windows Bitmap
        +
        • +
      + + + +
        +
      • +

        GIF

        +
        public static final ImageFormat GIF
        +
        Graphics Interchange Format
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        values

        +
        public static ImageFormat[] values()
        +
        Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +
        +for (ImageFormat c : ImageFormat.values())
+    System.out.println(c);
+
        +
        +
        Returns:
        +
        an array containing the constants of this enum type, in the order they are declared
        +
        +
        • +
      + + + +
        +
      • +

        valueOf

        +
        public static ImageFormat valueOf(java.lang.String name)
        +
        Returns the enum constant of this type with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.)
        +
        +
        Parameters:
        +
        name - the name of the enum constant to be returned.
        +
        Returns:
        +
        the enum constant with the specified name
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        +
        java.lang.NullPointerException - if the argument is null
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/com/textcontrol/reportingcloud/MergeBlock.html b/com/textcontrol/reportingcloud/MergeBlock.html new file mode 100644 index 0000000..1549c95 --- /dev/null +++ b/com/textcontrol/reportingcloud/MergeBlock.html @@ -0,0 +1,321 @@ + + + + + +MergeBlock (reportingcloud 1.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
com.textcontrol.reportingcloud
+

Class MergeBlock

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • com.textcontrol.reportingcloud.MergeBlock
      • +
    +
    • +
+
+
    +
  • +
    +
    +
    public class MergeBlock
+extends java.lang.Object
    +
    Represents a merge block in a document template.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      MergeBlock(java.lang.String name, + java.util.List<MergeBlock> mergeBlocks, + java.util.List<MergeField> mergeFields) 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      java.util.List<MergeBlock>getMergeBlocks() +
      Returns the merge blocks inside the merge block.
      +
      java.util.List<MergeField>getMergeFields() +
      Returns the merge fields inside the merge block.
      +
      java.lang.StringgetName() +
      Returns the merge block's name.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        MergeBlock

        +
        public MergeBlock(java.lang.String name,
+                  java.util.List<MergeBlock> mergeBlocks,
+                  java.util.List<MergeField> mergeFields)
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getName

        +
        public java.lang.String getName()
        +
        Returns the merge block's name.
        +
        +
        Returns:
        +
        The merge block's name.
        +
        +
        • +
      + + + +
        +
      • +

        getMergeBlocks

        +
        public java.util.List<MergeBlock> getMergeBlocks()
        +
        Returns the merge blocks inside the merge block.
        +
        +
        Returns:
        +
        The merge blocks inside the merge block.
        +
        +
        • +
      + + + +
        +
      • +

        getMergeFields

        +
        public java.util.List<MergeField> getMergeFields()
        +
        Returns the merge fields inside the merge block.
        +
        +
        Returns:
        +
        The merge fields inside the merge block.
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/com/textcontrol/reportingcloud/MergeBody.html b/com/textcontrol/reportingcloud/MergeBody.html index 51994a0..7c9438b 100644 --- a/com/textcontrol/reportingcloud/MergeBody.html +++ b/com/textcontrol/reportingcloud/MergeBody.html @@ -1,543 +1,543 @@ - - - - - -MergeBody (reportingcloud 1.0 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
-
    -
  • Summary: 
    • -
  • Nested | 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
- -
- - -
- - -
-
com.textcontrol.reportingcloud
-

Class MergeBody

-
-
-
    -
  • java.lang.Object
    • -
  • -
      -
    • com.textcontrol.reportingcloud.MergeBody
      • -
    -
    • -
-
-
    -
  • -
    -
    -
    public class MergeBody
-extends java.lang.Object
    -
    Used to pass data to the merge method.
    -
    • -
-
-
-
    -
  • - -
      -
    • - - -

      Constructor Summary

      - - - - - - - - - - - - - - - - - - - - - - - -
      Constructors 
      Constructor and Description
      MergeBody(java.lang.Iterable<java.lang.Object> mergeData) 
      MergeBody(java.lang.Iterable<java.lang.Object> mergeData, - MergeSettings mergeSettings) 
      MergeBody(java.lang.Iterable<java.lang.Object> mergeData, - MergeSettings mergeSettings, - byte[] template) 
      MergeBody(java.lang.Object[] mergeData) 
      MergeBody(java.lang.Object[] mergeData, - MergeSettings mergeSettings) 
      MergeBody(java.lang.Object[] mergeData, - MergeSettings mergeSettings, - byte[] template) 
      -
      • -
    - -
      -
    • - - -

      Method Summary

      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      java.lang.Iterable<java.lang.Object>getMergeData() -
      Gets the merge data.
      -
      MergeSettingsgetMergeSettings() -
      Gets the merge settings to specify merge properties and document properties such - as title and author.
      -
      byte[]getTemplate() -
      Gets the binary template document data.
      -
      voidsetMergeData(java.lang.Iterable<java.lang.Object> mergeData) -
      Sets the merge data.
      -
      voidsetMergeData(java.lang.Object[] mergeData) -
      Sets the merge data.
      -
      voidsetMergeSettings(MergeSettings mergeSettings) -
      Sets the merge settings to specify merge properties and document properties such - as title and author.
      -
      voidsetTemplate(byte[] template) -
      Sets the binary template document data.
      -
      -
        -
      • - - -

        Methods inherited from class java.lang.Object

        -clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
        • -
      -
      • -
    -
    • -
-
-
-
    -
  • - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        MergeBody

        -
        public MergeBody(java.lang.Iterable<java.lang.Object> mergeData)
-          throws java.security.InvalidParameterException
        -
        -
        Parameters:
        -
        mergeData - The merge data. Can be an iterable type of HashMap objects - or an iterable type of objects which can be serialized to JSON by GSON.
        -
        Throws:
        -
        java.security.InvalidParameterException
        -
        -
        • -
      - - - -
        -
      • -

        MergeBody

        -
        public MergeBody(java.lang.Object[] mergeData)
-          throws java.security.InvalidParameterException
        -
        -
        Parameters:
        -
        mergeData - The merge data. Can be an array of HashMap objects - or an array of objects which can be serialized to JSON by GSON.
        -
        Throws:
        -
        java.security.InvalidParameterException
        -
        -
        • -
      - - - -
        -
      • -

        MergeBody

        -
        public MergeBody(java.lang.Iterable<java.lang.Object> mergeData,
-                 MergeSettings mergeSettings)
-          throws java.security.InvalidParameterException
        -
        -
        Parameters:
        -
        mergeData - The merge data. Can be an iterable type of HashMap objects - or an iterable type of objects which can be serialized to JSON by GSON.
        -
        mergeSettings - Merge settings to specify merge properties and document properties - such as title and author.
        -
        Throws:
        -
        java.security.InvalidParameterException
        -
        -
        • -
      - - - -
        -
      • -

        MergeBody

        -
        public MergeBody(java.lang.Object[] mergeData,
-                 MergeSettings mergeSettings)
-          throws java.security.InvalidParameterException
        -
        -
        Parameters:
        -
        mergeData - The merge data. Can be an array of HashMap objects - or an array of objects which can be serialized to JSON by GSON.
        -
        mergeSettings - Merge settings to specify merge properties and document properties - such as title and author.
        -
        Throws:
        -
        java.security.InvalidParameterException
        -
        -
        • -
      - - - -
        -
      • -

        MergeBody

        -
        public MergeBody(java.lang.Iterable<java.lang.Object> mergeData,
-                 MergeSettings mergeSettings,
-                 byte[] template)
-          throws java.security.InvalidParameterException
        -
        -
        Parameters:
        -
        mergeData - The merge data. Can be an iterable type of HashMap objects - or an iterable type of objects which can be serialized to JSON by GSON.
        -
        mergeSettings - Merge settings to specify merge properties and document properties - such as title and author.
        -
        template - The binary template document data. Supported formats are .rtf, - .doc, .docx and .tx.
        -
        Throws:
        -
        java.security.InvalidParameterException
        -
        -
        • -
      - - - -
        -
      • -

        MergeBody

        -
        public MergeBody(java.lang.Object[] mergeData,
-                 MergeSettings mergeSettings,
-                 byte[] template)
-          throws java.security.InvalidParameterException
        -
        -
        Parameters:
        -
        mergeData - The merge data. Can be an array of HashMap objects - or an array of objects which can be serialized to JSON by GSON.
        -
        mergeSettings - Merge settings to specify merge properties and document properties - such as title and author.
        -
        template - The binary template document data. Supported formats are .rtf, - .doc, .docx and .tx.
        -
        Throws:
        -
        java.security.InvalidParameterException
        -
        -
        • -
      -
      • -
    - -
      -
    • - - -

      Method Detail

      - - - -
        -
      • -

        getTemplate

        -
        public byte[] getTemplate()
        -
        Gets the binary template document data. Supported formats are .rtf, .doc, - .docx and .tx.
        -
        -
        Returns:
        -
        The binary template document data.
        -
        -
        • -
      - - - -
        -
      • -

        setTemplate

        -
        public void setTemplate(byte[] template)
        -
        Sets the binary template document data. Supported formats are .rtf, .doc, - .docx and .tx.
        -
        -
        Parameters:
        -
        template - The binary template document data
        -
        -
        • -
      - - - -
        -
      • -

        getMergeSettings

        -
        public MergeSettings getMergeSettings()
        -
        Gets the merge settings to specify merge properties and document properties such - as title and author.
        -
        -
        Returns:
        -
        The merge settings.
        -
        -
        • -
      - - - -
        -
      • -

        setMergeSettings

        -
        public void setMergeSettings(MergeSettings mergeSettings)
        -
        Sets the merge settings to specify merge properties and document properties such - as title and author.
        -
        -
        Parameters:
        -
        mergeSettings - The merge settings.
        -
        -
        • -
      - - - -
        -
      • -

        getMergeData

        -
        public java.lang.Iterable<java.lang.Object> getMergeData()
        -
        Gets the merge data.
        -
        -
        Returns:
        -
        The merge data.
        -
        -
        • -
      - - - -
        -
      • -

        setMergeData

        -
        public void setMergeData(java.lang.Iterable<java.lang.Object> mergeData)
-                  throws java.security.InvalidParameterException
        -
        Sets the merge data. Can be an iterable type of HashMap objects or an - iterable type of objects which can be serialized to JSON by GSON.
        -
        -
        Parameters:
        -
        mergeData - The merge data.
        -
        Throws:
        -
        java.security.InvalidParameterException
        -
        -
        • -
      - - - -
        -
      • -

        setMergeData

        -
        public void setMergeData(java.lang.Object[] mergeData)
-                  throws java.security.InvalidParameterException
        -
        Sets the merge data. Can be an array of HashMap objects or an array of objects - which can be serialized to JSON by GSON.
        -
        -
        Parameters:
        -
        mergeData - The merge data.
        -
        Throws:
        -
        java.security.InvalidParameterException
        -
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
-
    -
  • Summary: 
    • -
  • Nested | 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
- -
- - -
- - - + + + + + +MergeBody (reportingcloud 1.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
com.textcontrol.reportingcloud
+

Class MergeBody

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • com.textcontrol.reportingcloud.MergeBody
      • +
    +
    • +
+
+
    +
  • +
    +
    +
    public class MergeBody
+extends java.lang.Object
    +
    Used to pass data to the merge method.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + + + + + + + + + + + + + + +
      Constructors 
      Constructor and Description
      MergeBody(java.lang.Iterable<java.lang.Object> mergeData) 
      MergeBody(java.lang.Iterable<java.lang.Object> mergeData, + MergeSettings mergeSettings) 
      MergeBody(java.lang.Iterable<java.lang.Object> mergeData, + MergeSettings mergeSettings, + byte[] template) 
      MergeBody(java.lang.Object[] mergeData) 
      MergeBody(java.lang.Object[] mergeData, + MergeSettings mergeSettings) 
      MergeBody(java.lang.Object[] mergeData, + MergeSettings mergeSettings, + byte[] template) 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      java.lang.Iterable<java.lang.Object>getMergeData() +
      Gets the merge data.
      +
      MergeSettingsgetMergeSettings() +
      Gets the merge settings to specify merge properties and document properties such + as title and author.
      +
      byte[]getTemplate() +
      Gets the binary template document data.
      +
      voidsetMergeData(java.lang.Iterable<java.lang.Object> mergeData) +
      Sets the merge data.
      +
      voidsetMergeData(java.lang.Object[] mergeData) +
      Sets the merge data.
      +
      voidsetMergeSettings(MergeSettings mergeSettings) +
      Sets the merge settings to specify merge properties and document properties such + as title and author.
      +
      voidsetTemplate(byte[] template) +
      Sets the binary template document data.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        MergeBody

        +
        public MergeBody(java.lang.Iterable<java.lang.Object> mergeData)
+          throws java.security.InvalidParameterException
        +
        +
        Parameters:
        +
        mergeData - The merge data. Can be an iterable type of HashMap objects + or an iterable type of objects which can be serialized to JSON by GSON.
        +
        Throws:
        +
        java.security.InvalidParameterException
        +
        +
        • +
      + + + +
        +
      • +

        MergeBody

        +
        public MergeBody(java.lang.Object[] mergeData)
+          throws java.security.InvalidParameterException
        +
        +
        Parameters:
        +
        mergeData - The merge data. Can be an array of HashMap objects + or an array of objects which can be serialized to JSON by GSON.
        +
        Throws:
        +
        java.security.InvalidParameterException
        +
        +
        • +
      + + + +
        +
      • +

        MergeBody

        +
        public MergeBody(java.lang.Iterable<java.lang.Object> mergeData,
+                 MergeSettings mergeSettings)
+          throws java.security.InvalidParameterException
        +
        +
        Parameters:
        +
        mergeData - The merge data. Can be an iterable type of HashMap objects + or an iterable type of objects which can be serialized to JSON by GSON.
        +
        mergeSettings - Merge settings to specify merge properties and document properties + such as title and author.
        +
        Throws:
        +
        java.security.InvalidParameterException
        +
        +
        • +
      + + + +
        +
      • +

        MergeBody

        +
        public MergeBody(java.lang.Object[] mergeData,
+                 MergeSettings mergeSettings)
+          throws java.security.InvalidParameterException
        +
        +
        Parameters:
        +
        mergeData - The merge data. Can be an array of HashMap objects + or an array of objects which can be serialized to JSON by GSON.
        +
        mergeSettings - Merge settings to specify merge properties and document properties + such as title and author.
        +
        Throws:
        +
        java.security.InvalidParameterException
        +
        +
        • +
      + + + +
        +
      • +

        MergeBody

        +
        public MergeBody(java.lang.Iterable<java.lang.Object> mergeData,
+                 MergeSettings mergeSettings,
+                 byte[] template)
+          throws java.security.InvalidParameterException
        +
        +
        Parameters:
        +
        mergeData - The merge data. Can be an iterable type of HashMap objects + or an iterable type of objects which can be serialized to JSON by GSON.
        +
        mergeSettings - Merge settings to specify merge properties and document properties + such as title and author.
        +
        template - The binary template document data. Supported formats are .rtf, + .doc, .docx and .tx.
        +
        Throws:
        +
        java.security.InvalidParameterException
        +
        +
        • +
      + + + +
        +
      • +

        MergeBody

        +
        public MergeBody(java.lang.Object[] mergeData,
+                 MergeSettings mergeSettings,
+                 byte[] template)
+          throws java.security.InvalidParameterException
        +
        +
        Parameters:
        +
        mergeData - The merge data. Can be an array of HashMap objects + or an array of objects which can be serialized to JSON by GSON.
        +
        mergeSettings - Merge settings to specify merge properties and document properties + such as title and author.
        +
        template - The binary template document data. Supported formats are .rtf, + .doc, .docx and .tx.
        +
        Throws:
        +
        java.security.InvalidParameterException
        +
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getTemplate

        +
        public byte[] getTemplate()
        +
        Gets the binary template document data. Supported formats are .rtf, .doc, + .docx and .tx.
        +
        +
        Returns:
        +
        The binary template document data.
        +
        +
        • +
      + + + +
        +
      • +

        setTemplate

        +
        public void setTemplate(byte[] template)
        +
        Sets the binary template document data. Supported formats are .rtf, .doc, + .docx and .tx.
        +
        +
        Parameters:
        +
        template - The binary template document data
        +
        +
        • +
      + + + +
        +
      • +

        getMergeSettings

        +
        public MergeSettings getMergeSettings()
        +
        Gets the merge settings to specify merge properties and document properties such + as title and author.
        +
        +
        Returns:
        +
        The merge settings.
        +
        +
        • +
      + + + +
        +
      • +

        setMergeSettings

        +
        public void setMergeSettings(MergeSettings mergeSettings)
        +
        Sets the merge settings to specify merge properties and document properties such + as title and author.
        +
        +
        Parameters:
        +
        mergeSettings - The merge settings.
        +
        +
        • +
      + + + +
        +
      • +

        getMergeData

        +
        public java.lang.Iterable<java.lang.Object> getMergeData()
        +
        Gets the merge data.
        +
        +
        Returns:
        +
        The merge data.
        +
        +
        • +
      + + + +
        +
      • +

        setMergeData

        +
        public void setMergeData(java.lang.Iterable<java.lang.Object> mergeData)
+                  throws java.security.InvalidParameterException
        +
        Sets the merge data. Can be an iterable type of HashMap objects or an + iterable type of objects which can be serialized to JSON by GSON.
        +
        +
        Parameters:
        +
        mergeData - The merge data.
        +
        Throws:
        +
        java.security.InvalidParameterException
        +
        +
        • +
      + + + +
        +
      • +

        setMergeData

        +
        public void setMergeData(java.lang.Object[] mergeData)
+                  throws java.security.InvalidParameterException
        +
        Sets the merge data. Can be an array of HashMap objects or an array of objects + which can be serialized to JSON by GSON.
        +
        +
        Parameters:
        +
        mergeData - The merge data.
        +
        Throws:
        +
        java.security.InvalidParameterException
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/com/textcontrol/reportingcloud/MergeField.html b/com/textcontrol/reportingcloud/MergeField.html new file mode 100644 index 0000000..04671e7 --- /dev/null +++ b/com/textcontrol/reportingcloud/MergeField.html @@ -0,0 +1,409 @@ + + + + + +MergeField (reportingcloud 1.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
com.textcontrol.reportingcloud
+

Class MergeField

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • com.textcontrol.reportingcloud.MergeField
      • +
    +
    • +
+
+
    +
  • +
    +
    +
    public class MergeField
+extends java.lang.Object
    +
    Represents a merge field in a document template.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      MergeField(java.lang.String dateTimeFormat, + java.lang.String name, + java.lang.String numericFormat, + boolean preserveFormatting, + java.lang.String text, + java.lang.String textAfter, + java.lang.String textBefore) 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      java.lang.StringgetDateTimeFormat() +
      Returns the format which is applied to date / time values.
      +
      java.lang.StringgetName() +
      Returns the name of the field.
      +
      java.lang.StringgetNumericFormat() +
      Returns the format which is applied to numeric values.
      +
      booleangetPreserveFormatting() +
      Returns whether formatting is preserved.
      +
      java.lang.StringgetText() +
      Returns the field text.
      +
      java.lang.StringgetTextAfter() +
      Returns the text after the field.
      +
      java.lang.StringgetTextBefore() +
      Returns the text before the field.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        MergeField

        +
        public MergeField(java.lang.String dateTimeFormat,
+                  java.lang.String name,
+                  java.lang.String numericFormat,
+                  boolean preserveFormatting,
+                  java.lang.String text,
+                  java.lang.String textAfter,
+                  java.lang.String textBefore)
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getDateTimeFormat

        +
        public java.lang.String getDateTimeFormat()
        +
        Returns the format which is applied to date / time values.
        +
        +
        Returns:
        +
        The format which is applied to date / time values.
        +
        +
        • +
      + + + +
        +
      • +

        getName

        +
        public java.lang.String getName()
        +
        Returns the name of the field.
        +
        +
        Returns:
        +
        The name of the field.
        +
        +
        • +
      + + + +
        +
      • +

        getNumericFormat

        +
        public java.lang.String getNumericFormat()
        +
        Returns the format which is applied to numeric values.
        +
        +
        Returns:
        +
        The format which is applied to numeric values.
        +
        +
        • +
      + + + +
        +
      • +

        getPreserveFormatting

        +
        public boolean getPreserveFormatting()
        +
        Returns whether formatting is preserved.
        +
        +
        Returns:
        +
        Returns whether formatting is preserved.
        +
        +
        • +
      + + + +
        +
      • +

        getText

        +
        public java.lang.String getText()
        +
        Returns the field text.
        +
        +
        Returns:
        +
        The field text.
        +
        +
        • +
      + + + +
        +
      • +

        getTextAfter

        +
        public java.lang.String getTextAfter()
        +
        Returns the text after the field.
        +
        +
        Returns:
        +
        The text after the field.
        +
        +
        • +
      + + + +
        +
      • +

        getTextBefore

        +
        public java.lang.String getTextBefore()
        +
        Returns the text before the field.
        +
        +
        Returns:
        +
        The text before the field.
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/com/textcontrol/reportingcloud/MergeSettings.html b/com/textcontrol/reportingcloud/MergeSettings.html index 41584d6..8d2bbbb 100644 --- a/com/textcontrol/reportingcloud/MergeSettings.html +++ b/com/textcontrol/reportingcloud/MergeSettings.html @@ -1,756 +1,756 @@ - - - - - -MergeSettings (reportingcloud 1.0 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
-
    -
  • Summary: 
    • -
  • Nested | 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
- -
- - -
- - -
-
com.textcontrol.reportingcloud
-

Class MergeSettings

-
-
-
    -
  • java.lang.Object
    • -
  • -
      -
    • com.textcontrol.reportingcloud.MergeSettings
      • -
    -
    • -
-
-
    -
  • -
    -
    -
    public class MergeSettings
-extends java.lang.Object
    -
    Holds the merge settings needed by the merge method.
    -
    • -
-
-
-
    -
  • - -
      -
    • - - -

      Constructor Summary

      - - - - - - - - -
      Constructors 
      Constructor and Description
      MergeSettings() 
      -
      • -
    - -
      -
    • - - -

      Method Summary

      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      java.lang.StringgetAuthor() -
      Gets the document's author.
      -
      java.time.ZonedDateTimegetCreationDate() -
      Gets the creation date.
      -
      java.lang.StringgetCreatorApplication() -
      Gets the application which created the document.
      -
      java.lang.StringgetDocumentSubject() -
      Gets the document's subject.
      -
      java.lang.StringgetdocumentTitle() -
      Gets the document's title.
      -
      java.time.ZonedDateTimegetLastModificationDate() -
      Gets the last modification date.
      -
      booleangetRemoveEmptyBlocks() -
      Gets whether the content of empty merge blocks should be removed from the template - or not.
      -
      booleangetRemoveEmptyFields() -
      Gets whether empty fields should be removed from the template or not.
      -
      booleangetRemoveEmptyImages() -
      Gets whether images which don't have merge data should be removed from - the template or not.
      -
      booleangetRemoveTrailingWhitespace() -
      Gets whether trailing whitespace should be removed before saving a document.
      -
      java.lang.StringgetUserPassword() -
      Gets the password needed to open the document.
      -
      voidsetAuthor(java.lang.String author) -
      Sets the document's author.
      -
      voidsetCreationDate(java.lang.String creationDate) -
      Sets the creation date.
      -
      voidsetCreationDate(java.time.ZonedDateTime creationDate) -
      Sets the creation date.
      -
      voidsetCreatorApplication(java.lang.String creatorApplication) -
      Sets the application which created the document.
      -
      voidsetDocumentSubject(java.lang.String documentSubject) -
      Sets the document's subject.
      -
      voidsetDocumentTitle(java.lang.String documentTitle) -
      Sets the document's title.
      -
      voidsetLastModificationDate(java.lang.String lastModificationDate) -
      Sets the last modification date.
      -
      voidsetLastModificationDate(java.time.ZonedDateTime lastModificationDate) -
      Sets the last modification date.
      -
      voidsetRemoveEmptyBlocks(boolean removeEmptyBlocks) -
      Sets whether the content of empty merge blocks should be removed from the template - or not.
      -
      voidsetRemoveEmptyFields(boolean removeEmptyFields) -
      Sets whether empty fields should be removed from the template or not.
      -
      voidsetRemoveEmptyImages(boolean removeEmptyImages) -
      Sets whether images which don't have merge data should be removed from - the template or not.
      -
      voidsetRemoveTrailingWhitespace(boolean removeTrailingWhitespace) -
      Sets whether trailing whitespace should be removed before saving a document.
      -
      voidsetUserPassword(java.lang.String userPassword) -
      Sets the password needed to open the document.
      -
      -
        -
      • - - -

        Methods inherited from class java.lang.Object

        -clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
        • -
      -
      • -
    -
    • -
-
-
-
    -
  • - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        MergeSettings

        -
        public MergeSettings()
        -
        • -
      -
      • -
    - -
      -
    • - - -

      Method Detail

      - - - -
        -
      • -

        getRemoveEmptyFields

        -
        public boolean getRemoveEmptyFields()
        -
        Gets whether empty fields should be removed from the template or not.
        -
        -
        Returns:
        -
        Empty fields should be removed.
        -
        -
        • -
      - - - -
        -
      • -

        setRemoveEmptyFields

        -
        public void setRemoveEmptyFields(boolean removeEmptyFields)
        -
        Sets whether empty fields should be removed from the template or not.
        -
        -
        Parameters:
        -
        removeEmptyFields - Empty fields should be removed or not.
        -
        -
        • -
      - - - -
        -
      • -

        getRemoveEmptyBlocks

        -
        public boolean getRemoveEmptyBlocks()
        -
        Gets whether the content of empty merge blocks should be removed from the template - or not.
        -
        -
        Returns:
        -
        The content of empty merge blocks should be removed.
        -
        -
        • -
      - - - -
        -
      • -

        setRemoveEmptyBlocks

        -
        public void setRemoveEmptyBlocks(boolean removeEmptyBlocks)
        -
        Sets whether the content of empty merge blocks should be removed from the template - or not.
        -
        -
        Parameters:
        -
        removeEmptyBlocks - The content of empty merge blocks should be removed - from the template or not.
        -
        -
        • -
      - - - -
        -
      • -

        getRemoveEmptyImages

        -
        public boolean getRemoveEmptyImages()
        -
        Gets whether images which don't have merge data should be removed from - the template or not.
        -
        -
        Returns:
        -
        The images which don't have merge data should be removed.
        -
        -
        • -
      - - - -
        -
      • -

        setRemoveEmptyImages

        -
        public void setRemoveEmptyImages(boolean removeEmptyImages)
        -
        Sets whether images which don't have merge data should be removed from - the template or not.
        -
        -
        Parameters:
        -
        removeEmptyImages - images which don't have merge data should be - removed from the template or not.
        -
        -
        • -
      - - - -
        -
      • -

        getRemoveTrailingWhitespace

        -
        public boolean getRemoveTrailingWhitespace()
        -
        Gets whether trailing whitespace should be removed before saving a document.
        -
        -
        Returns:
        -
        Trailing whitespace should be removed.
        -
        -
        • -
      - - - -
        -
      • -

        setRemoveTrailingWhitespace

        -
        public void setRemoveTrailingWhitespace(boolean removeTrailingWhitespace)
        -
        Sets whether trailing whitespace should be removed before saving a document.
        -
        -
        Parameters:
        -
        removeTrailingWhitespace - trailing whitespace should be removed before - saving a document.
        -
        -
        • -
      - - - -
        -
      • -

        getAuthor

        -
        public java.lang.String getAuthor()
        -
        Gets the document's author.
        -
        -
        Returns:
        -
        The document's author.
        -
        -
        • -
      - - - -
        -
      • -

        setAuthor

        -
        public void setAuthor(java.lang.String author)
        -
        Sets the document's author.
        -
        -
        Parameters:
        -
        author - The document's author.
        -
        -
        • -
      - - - -
        -
      • -

        getCreatorApplication

        -
        public java.lang.String getCreatorApplication()
        -
        Gets the application which created the document.
        -
        -
        Returns:
        -
        The application which created the document.
        -
        -
        • -
      - - - -
        -
      • -

        setCreatorApplication

        -
        public void setCreatorApplication(java.lang.String creatorApplication)
        -
        Sets the application which created the document.
        -
        -
        Parameters:
        -
        creatorApplication - The application which created the document.
        -
        -
        • -
      - - - -
        -
      • -

        getDocumentSubject

        -
        public java.lang.String getDocumentSubject()
        -
        Gets the document's subject.
        -
        -
        Returns:
        -
        The document's subject.
        -
        -
        • -
      - - - -
        -
      • -

        setDocumentSubject

        -
        public void setDocumentSubject(java.lang.String documentSubject)
        -
        Sets the document's subject.
        -
        -
        Parameters:
        -
        documentSubject - The document's subject.
        -
        -
        • -
      - - - -
        -
      • -

        getdocumentTitle

        -
        public java.lang.String getdocumentTitle()
        -
        Gets the document's title.
        -
        -
        Returns:
        -
        The document's title.
        -
        -
        • -
      - - - -
        -
      • -

        setDocumentTitle

        -
        public void setDocumentTitle(java.lang.String documentTitle)
        -
        Sets the document's title.
        -
        -
        Parameters:
        -
        documentTitle - The document's title.
        -
        -
        • -
      - - - -
        -
      • -

        getUserPassword

        -
        public java.lang.String getUserPassword()
        -
        Gets the password needed to open the document.
        -
        -
        Returns:
        -
        The password needed to open the document.
        -
        -
        • -
      - - - -
        -
      • -

        setUserPassword

        -
        public void setUserPassword(java.lang.String userPassword)
        -
        Sets the password needed to open the document.
        -
        -
        Parameters:
        -
        userPassword - The password needed to open the document.
        -
        -
        • -
      - - - -
        -
      • -

        getCreationDate

        -
        public java.time.ZonedDateTime getCreationDate()
        -
        Gets the creation date.
        -
        -
        Returns:
        -
        The creation date.
        -
        -
        • -
      - - - -
        -
      • -

        setCreationDate

        -
        public void setCreationDate(java.lang.String creationDate)
-                     throws java.time.format.DateTimeParseException
        -
        Sets the creation date.
        -
        -
        Parameters:
        -
        creationDate - The creation date (ISO-8601 extended offset date-time format). - Can be null.
        -
        Throws:
        -
        java.time.format.DateTimeParseException
        -
        -
        • -
      - - - -
        -
      • -

        setCreationDate

        -
        public void setCreationDate(java.time.ZonedDateTime creationDate)
        -
        Sets the creation date.
        -
        -
        Parameters:
        -
        creationDate - The creation date. Can be null.
        -
        -
        • -
      - - - -
        -
      • -

        getLastModificationDate

        -
        public java.time.ZonedDateTime getLastModificationDate()
        -
        Gets the last modification date.
        -
        -
        Returns:
        -
        The last modification date.
        -
        -
        • -
      - - - -
        -
      • -

        setLastModificationDate

        -
        public void setLastModificationDate(java.lang.String lastModificationDate)
-                             throws java.time.format.DateTimeParseException
        -
        Sets the last modification date.
        -
        -
        Parameters:
        -
        lastModificationDate - The last modification date (ISO-8601 extended offset date-time format). - Can be null.
        -
        Throws:
        -
        java.time.format.DateTimeParseException
        -
        -
        • -
      - - - -
        -
      • -

        setLastModificationDate

        -
        public void setLastModificationDate(java.time.ZonedDateTime lastModificationDate)
        -
        Sets the last modification date.
        -
        -
        Parameters:
        -
        lastModificationDate - The last modification date. Can be null.
        -
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
-
    -
  • Summary: 
    • -
  • Nested | 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
- -
- - -
- - - + + + + + +MergeSettings (reportingcloud 1.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
com.textcontrol.reportingcloud
+

Class MergeSettings

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • com.textcontrol.reportingcloud.MergeSettings
      • +
    +
    • +
+
+
    +
  • +
    +
    +
    public class MergeSettings
+extends java.lang.Object
    +
    Holds the merge settings needed by the merge method.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      MergeSettings() 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      java.lang.StringgetAuthor() +
      Gets the document's author.
      +
      java.time.ZonedDateTimegetCreationDate() +
      Gets the creation date.
      +
      java.lang.StringgetCreatorApplication() +
      Gets the application which created the document.
      +
      java.lang.StringgetDocumentSubject() +
      Gets the document's subject.
      +
      java.lang.StringgetdocumentTitle() +
      Gets the document's title.
      +
      java.time.ZonedDateTimegetLastModificationDate() +
      Gets the last modification date.
      +
      booleangetRemoveEmptyBlocks() +
      Gets whether the content of empty merge blocks should be removed from the template + or not.
      +
      booleangetRemoveEmptyFields() +
      Gets whether empty fields should be removed from the template or not.
      +
      booleangetRemoveEmptyImages() +
      Gets whether images which don't have merge data should be removed from + the template or not.
      +
      booleangetRemoveTrailingWhitespace() +
      Gets whether trailing whitespace should be removed before saving a document.
      +
      java.lang.StringgetUserPassword() +
      Gets the password needed to open the document.
      +
      voidsetAuthor(java.lang.String author) +
      Sets the document's author.
      +
      voidsetCreationDate(java.lang.String creationDate) +
      Sets the creation date.
      +
      voidsetCreationDate(java.time.ZonedDateTime creationDate) +
      Sets the creation date.
      +
      voidsetCreatorApplication(java.lang.String creatorApplication) +
      Sets the application which created the document.
      +
      voidsetDocumentSubject(java.lang.String documentSubject) +
      Sets the document's subject.
      +
      voidsetDocumentTitle(java.lang.String documentTitle) +
      Sets the document's title.
      +
      voidsetLastModificationDate(java.lang.String lastModificationDate) +
      Sets the last modification date.
      +
      voidsetLastModificationDate(java.time.ZonedDateTime lastModificationDate) +
      Sets the last modification date.
      +
      voidsetRemoveEmptyBlocks(boolean removeEmptyBlocks) +
      Sets whether the content of empty merge blocks should be removed from the template + or not.
      +
      voidsetRemoveEmptyFields(boolean removeEmptyFields) +
      Sets whether empty fields should be removed from the template or not.
      +
      voidsetRemoveEmptyImages(boolean removeEmptyImages) +
      Sets whether images which don't have merge data should be removed from + the template or not.
      +
      voidsetRemoveTrailingWhitespace(boolean removeTrailingWhitespace) +
      Sets whether trailing whitespace should be removed before saving a document.
      +
      voidsetUserPassword(java.lang.String userPassword) +
      Sets the password needed to open the document.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        MergeSettings

        +
        public MergeSettings()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getRemoveEmptyFields

        +
        public boolean getRemoveEmptyFields()
        +
        Gets whether empty fields should be removed from the template or not.
        +
        +
        Returns:
        +
        Empty fields should be removed.
        +
        +
        • +
      + + + +
        +
      • +

        setRemoveEmptyFields

        +
        public void setRemoveEmptyFields(boolean removeEmptyFields)
        +
        Sets whether empty fields should be removed from the template or not.
        +
        +
        Parameters:
        +
        removeEmptyFields - Empty fields should be removed or not.
        +
        +
        • +
      + + + +
        +
      • +

        getRemoveEmptyBlocks

        +
        public boolean getRemoveEmptyBlocks()
        +
        Gets whether the content of empty merge blocks should be removed from the template + or not.
        +
        +
        Returns:
        +
        The content of empty merge blocks should be removed.
        +
        +
        • +
      + + + +
        +
      • +

        setRemoveEmptyBlocks

        +
        public void setRemoveEmptyBlocks(boolean removeEmptyBlocks)
        +
        Sets whether the content of empty merge blocks should be removed from the template + or not.
        +
        +
        Parameters:
        +
        removeEmptyBlocks - The content of empty merge blocks should be removed + from the template or not.
        +
        +
        • +
      + + + +
        +
      • +

        getRemoveEmptyImages

        +
        public boolean getRemoveEmptyImages()
        +
        Gets whether images which don't have merge data should be removed from + the template or not.
        +
        +
        Returns:
        +
        The images which don't have merge data should be removed.
        +
        +
        • +
      + + + +
        +
      • +

        setRemoveEmptyImages

        +
        public void setRemoveEmptyImages(boolean removeEmptyImages)
        +
        Sets whether images which don't have merge data should be removed from + the template or not.
        +
        +
        Parameters:
        +
        removeEmptyImages - Images which don't have merge data should be + removed from the template or not.
        +
        +
        • +
      + + + +
        +
      • +

        getRemoveTrailingWhitespace

        +
        public boolean getRemoveTrailingWhitespace()
        +
        Gets whether trailing whitespace should be removed before saving a document.
        +
        +
        Returns:
        +
        Trailing whitespace should be removed.
        +
        +
        • +
      + + + +
        +
      • +

        setRemoveTrailingWhitespace

        +
        public void setRemoveTrailingWhitespace(boolean removeTrailingWhitespace)
        +
        Sets whether trailing whitespace should be removed before saving a document.
        +
        +
        Parameters:
        +
        removeTrailingWhitespace - Trailing whitespace should be removed before + saving a document.
        +
        +
        • +
      + + + +
        +
      • +

        getAuthor

        +
        public java.lang.String getAuthor()
        +
        Gets the document's author.
        +
        +
        Returns:
        +
        The document's author.
        +
        +
        • +
      + + + +
        +
      • +

        setAuthor

        +
        public void setAuthor(java.lang.String author)
        +
        Sets the document's author.
        +
        +
        Parameters:
        +
        author - The document's author.
        +
        +
        • +
      + + + +
        +
      • +

        getCreatorApplication

        +
        public java.lang.String getCreatorApplication()
        +
        Gets the application which created the document.
        +
        +
        Returns:
        +
        The application which created the document.
        +
        +
        • +
      + + + +
        +
      • +

        setCreatorApplication

        +
        public void setCreatorApplication(java.lang.String creatorApplication)
        +
        Sets the application which created the document.
        +
        +
        Parameters:
        +
        creatorApplication - The application which created the document.
        +
        +
        • +
      + + + +
        +
      • +

        getDocumentSubject

        +
        public java.lang.String getDocumentSubject()
        +
        Gets the document's subject.
        +
        +
        Returns:
        +
        The document's subject.
        +
        +
        • +
      + + + +
        +
      • +

        setDocumentSubject

        +
        public void setDocumentSubject(java.lang.String documentSubject)
        +
        Sets the document's subject.
        +
        +
        Parameters:
        +
        documentSubject - The document's subject.
        +
        +
        • +
      + + + +
        +
      • +

        getdocumentTitle

        +
        public java.lang.String getdocumentTitle()
        +
        Gets the document's title.
        +
        +
        Returns:
        +
        The document's title.
        +
        +
        • +
      + + + +
        +
      • +

        setDocumentTitle

        +
        public void setDocumentTitle(java.lang.String documentTitle)
        +
        Sets the document's title.
        +
        +
        Parameters:
        +
        documentTitle - The document's title.
        +
        +
        • +
      + + + +
        +
      • +

        getUserPassword

        +
        public java.lang.String getUserPassword()
        +
        Gets the password needed to open the document.
        +
        +
        Returns:
        +
        The password needed to open the document.
        +
        +
        • +
      + + + +
        +
      • +

        setUserPassword

        +
        public void setUserPassword(java.lang.String userPassword)
        +
        Sets the password needed to open the document.
        +
        +
        Parameters:
        +
        userPassword - The password needed to open the document.
        +
        +
        • +
      + + + +
        +
      • +

        getCreationDate

        +
        public java.time.ZonedDateTime getCreationDate()
        +
        Gets the creation date.
        +
        +
        Returns:
        +
        The creation date.
        +
        +
        • +
      + + + +
        +
      • +

        setCreationDate

        +
        public void setCreationDate(java.lang.String creationDate)
+                     throws java.time.format.DateTimeParseException
        +
        Sets the creation date.
        +
        +
        Parameters:
        +
        creationDate - The creation date (ISO-8601 extended offset date-time format). + Can be null.
        +
        Throws:
        +
        java.time.format.DateTimeParseException
        +
        +
        • +
      + + + +
        +
      • +

        setCreationDate

        +
        public void setCreationDate(java.time.ZonedDateTime creationDate)
        +
        Sets the creation date.
        +
        +
        Parameters:
        +
        creationDate - The creation date. Can be null.
        +
        +
        • +
      + + + +
        +
      • +

        getLastModificationDate

        +
        public java.time.ZonedDateTime getLastModificationDate()
        +
        Gets the last modification date.
        +
        +
        Returns:
        +
        The last modification date.
        +
        +
        • +
      + + + +
        +
      • +

        setLastModificationDate

        +
        public void setLastModificationDate(java.lang.String lastModificationDate)
+                             throws java.time.format.DateTimeParseException
        +
        Sets the last modification date.
        +
        +
        Parameters:
        +
        lastModificationDate - The last modification date (ISO-8601 extended offset date-time format). + Can be null.
        +
        Throws:
        +
        java.time.format.DateTimeParseException
        +
        +
        • +
      + + + +
        +
      • +

        setLastModificationDate

        +
        public void setLastModificationDate(java.time.ZonedDateTime lastModificationDate)
        +
        Sets the last modification date.
        +
        +
        Parameters:
        +
        lastModificationDate - The last modification date. Can be null.
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/com/textcontrol/reportingcloud/ReportingCloud.html b/com/textcontrol/reportingcloud/ReportingCloud.html index 8ef637d..68017fe 100644 --- a/com/textcontrol/reportingcloud/ReportingCloud.html +++ b/com/textcontrol/reportingcloud/ReportingCloud.html @@ -1,822 +1,849 @@ - - - - - -ReportingCloud (reportingcloud 1.0 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
-
    -
  • Summary: 
    • -
  • Nested | 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
- -
- - -
- - -
-
com.textcontrol.reportingcloud
-

Class ReportingCloud

-
-
-
    -
  • java.lang.Object
    • -
  • -
      -
    • com.textcontrol.reportingcloud.ReportingCloud
      • -
    -
    • -
-
-
    -
  • -
    -
    -
    public class ReportingCloud
-extends java.lang.Object
    -
    The ReportingCloud API wrapper class.
    -
    • -
-
-
-
    -
  • - -
      -
    • - - -

      Constructor Summary

      - - - - - - - - - - - -
      Constructors 
      Constructor and Description
      ReportingCloud(java.lang.String username, - java.lang.String password) -
      Creates a new ReportingCloud wrapper instance with the API base URL - set to "https://api.reporting.cloud".
      -
      ReportingCloud(java.lang.String username, - java.lang.String password, - java.lang.String baseUrl) -
      Creates a new ReportingCloud wrapper instance.
      -
      -
      • -
    - -
      -
    • - - -

      Method Summary

      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      byte[]convertDocument(byte[] templateData, - ReturnFormat returnFormat) -
      Converts a document to another format.
      -
      voiddeleteTemplate(java.lang.String templateName) -
      Deletes a template from the template storage.
      -
      byte[]downloadTemplate(java.lang.String templateName) -
      Returns the selected template from the storage.
      -
      AccountSettingsgetAccountSettings() -
      Gets the current user's account settings.
      -
      intgetTemplateCount() -
      Returns the number of templates in the template storage.
      -
      intgetTemplatePageCount(java.lang.String templateName) -
      Returns the number of pages of a template in the template storage.
      -
      java.util.List<byte[]>getTemplateThumbnails(java.lang.String templateName, - int zoomFactor) -
      Returns a list of thumbnails of a specific template.
      -
      java.util.List<byte[]>getTemplateThumbnails(java.lang.String templateName, - int zoomFactor, - int fromPage) -
      Returns a list of thumbnails of a specific template.
      -
      java.util.List<byte[]>getTemplateThumbnails(java.lang.String templateName, - int zoomFactor, - int fromPage, - int toPage) -
      Returns a list of thumbnails of a specific template.
      -
      java.util.List<byte[]>getTemplateThumbnails(java.lang.String templateName, - int zoomFactor, - int fromPage, - int toPage, - ImageFormat imageFormat) -
      Returns a list of thumbnails of a specific template.
      -
      java.util.List<Template>listTemplates() -
      Lists all templates from the template storage.
      -
      java.util.List<byte[]>mergeDocument(MergeBody mergeBody) -
      Merges and returns a template from the template storage or an uploaded template with JSON data.
      -
      java.util.List<byte[]>mergeDocument(MergeBody mergeBody, - java.lang.String templateName) -
      Merges and returns a template from the template storage or an uploaded template with JSON data.
      -
      java.util.List<byte[]>mergeDocument(MergeBody mergeBody, - java.lang.String templateName, - ReturnFormat returnFormat) -
      Merges and returns a template from the template storage or an uploaded template with JSON data.
      -
      java.util.List<byte[]>mergeDocument(MergeBody mergeBody, - java.lang.String templateName, - ReturnFormat returnFormat, - boolean append) -
      Merges and returns a template from the template storage or an uploaded template with JSON data.
      -
      booleantemplateExists(java.lang.String templateName) -
      Checks whether a template exists in the template storage.
      -
      voiduploadTemplate(java.lang.String templateName, - byte[] templateData) -
      Stores an uploaded template in the template storage (.doc, .docx, - .rtf and .tx).
      -
      -
        -
      • - - -

        Methods inherited from class java.lang.Object

        -clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
        • -
      -
      • -
    -
    • -
-
-
-
    -
  • - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        ReportingCloud

        -
        public ReportingCloud(java.lang.String username,
-                      java.lang.String password,
-                      java.lang.String baseUrl)
        -
        Creates a new ReportingCloud wrapper instance.
        -
        -
        Parameters:
        -
        username - The username.
        -
        password - The password.
        -
        baseUrl - The API base URL.
        -
        -
        • -
      - - - -
        -
      • -

        ReportingCloud

        -
        public ReportingCloud(java.lang.String username,
-                      java.lang.String password)
        -
        Creates a new ReportingCloud wrapper instance with the API base URL - set to "https://api.reporting.cloud".
        -
        -
        Parameters:
        -
        username - The username.
        -
        password - The password.
        -
        -
        • -
      -
      • -
    - -
      -
    • - - -

      Method Detail

      - - - -
        -
      • -

        getTemplateCount

        -
        public int getTemplateCount()
-                     throws java.lang.IllegalArgumentException,
-                            java.io.IOException
        -
        Returns the number of templates in the template storage.
        -
        -
        Returns:
        -
        The number of templates in the template storage.
        -
        Throws:
        -
        java.io.IOException - If an I/O error occurs.
        -
        java.lang.IllegalArgumentException - If something went wrong concerning the HTTP request.
        -
        -
        • -
      - - - -
        -
      • -

        getAccountSettings

        -
        public AccountSettings getAccountSettings()
-                                   throws java.lang.IllegalArgumentException,
-                                          java.io.IOException
        -
        Gets the current user's account settings.
        -
        -
        Returns:
        -
        The account settings.
        -
        Throws:
        -
        java.io.IOException - If an I/O error occurs.
        -
        java.lang.IllegalArgumentException - If something went wrong concerning the HTTP request.
        -
        -
        • -
      - - - -
        -
      • -

        listTemplates

        -
        public java.util.List<Template> listTemplates()
-                                       throws java.lang.IllegalArgumentException,
-                                              java.io.IOException
        -
        Lists all templates from the template storage.
        -
        -
        Returns:
        -
        A list of Template objects.
        -
        Throws:
        -
        java.lang.IllegalArgumentException - If something went wrong concerning the HTTP request.
        -
        java.io.IOException - If an I/O error occurs.
        -
        -
        • -
      - - - -
        -
      • -

        getTemplatePageCount

        -
        public int getTemplatePageCount(java.lang.String templateName)
-                         throws java.lang.IllegalArgumentException,
-                                java.io.IOException
        -
        Returns the number of pages of a template in the template storage.
        -
        -
        Parameters:
        -
        templateName - The filename of the template in the template - storage to retrieve the number of pages for.
        -
        Returns:
        -
        The number of pages in the template.
        -
        Throws:
        -
        java.io.IOException - If an I/O error occurs.
        -
        java.lang.IllegalArgumentException - If something went wrong concerning the HTTP request.
        -
        -
        • -
      - - - -
        -
      • -

        getTemplateThumbnails

        -
        public java.util.List<byte[]> getTemplateThumbnails(java.lang.String templateName,
-                                                    int zoomFactor)
-                                             throws java.lang.IllegalArgumentException,
-                                                    java.io.IOException
        -
        Returns a list of thumbnails of a specific template.
        -
        -
        Parameters:
        -
        templateName - The filename of the template in the template storage.
        -
        zoomFactor - An Integer value between 1 and 400 to set the percentage - zoom factor of the created thumbnail images.
        -
        Returns:
        -
        An array of binary image data.
        -
        Throws:
        -
        java.lang.IllegalArgumentException - If something went wrong concerning the HTTP request.
        -
        java.io.IOException - If an I/O error occurs.
        -
        -
        • -
      - - - -
        -
      • -

        getTemplateThumbnails

        -
        public java.util.List<byte[]> getTemplateThumbnails(java.lang.String templateName,
-                                                    int zoomFactor,
-                                                    int fromPage)
-                                             throws java.lang.IllegalArgumentException,
-                                                    java.io.IOException
        -
        Returns a list of thumbnails of a specific template.
        -
        -
        Parameters:
        -
        templateName - The filename of the template in the template storage.
        -
        zoomFactor - An Integer value between 1 and 400 to set the percentage - zoom factor of the created thumbnail images.
        -
        fromPage - An Integer value that specifies the first page.
        -
        Returns:
        -
        An array of binary image data.
        -
        Throws:
        -
        java.lang.IllegalArgumentException - If something went wrong concerning the HTTP request.
        -
        java.io.IOException - If an I/O error occurs.
        -
        -
        • -
      - - - -
        -
      • -

        getTemplateThumbnails

        -
        public java.util.List<byte[]> getTemplateThumbnails(java.lang.String templateName,
-                                                    int zoomFactor,
-                                                    int fromPage,
-                                                    int toPage)
-                                             throws java.lang.IllegalArgumentException,
-                                                    java.io.IOException
        -
        Returns a list of thumbnails of a specific template.
        -
        -
        Parameters:
        -
        templateName - The filename of the template in the template storage.
        -
        zoomFactor - An Integer value between 1 and 400 to set the percentage - zoom factor of the created thumbnail images.
        -
        fromPage - An Integer value that specifies the first page.
        -
        toPage - An Integer value that specifies the last page.
        -
        Returns:
        -
        An array of binary image data.
        -
        Throws:
        -
        java.lang.IllegalArgumentException - If something went wrong concerning the HTTP request.
        -
        java.io.IOException - If an I/O error occurs.
        -
        -
        • -
      - - - -
        -
      • -

        getTemplateThumbnails

        -
        public java.util.List<byte[]> getTemplateThumbnails(java.lang.String templateName,
-                                                    int zoomFactor,
-                                                    int fromPage,
-                                                    int toPage,
-                                                    ImageFormat imageFormat)
-                                             throws java.lang.IllegalArgumentException,
-                                                    java.io.IOException
        -
        Returns a list of thumbnails of a specific template.
        -
        -
        Parameters:
        -
        templateName - The filename of the template in the template storage.
        -
        zoomFactor - An Integer value between 1 and 400 to set the percentage - zoom factor of the created thumbnail images.
        -
        fromPage - An Integer value that specifies the first page.
        -
        toPage - An Integer value that specifies the last page.
        -
        imageFormat - Defines the image format of the returned thumbnails.
        -
        Returns:
        -
        An array of binary image data.
        -
        Throws:
        -
        java.lang.IllegalArgumentException - If something went wrong concerning the HTTP request.
        -
        java.io.IOException - If an I/O error occurs.
        -
        -
        • -
      - - - -
        -
      • -

        uploadTemplate

        -
        public void uploadTemplate(java.lang.String templateName,
-                           byte[] templateData)
-                    throws java.lang.IllegalArgumentException,
-                           java.io.IOException
        -
        Stores an uploaded template in the template storage (.doc, .docx, - .rtf and .tx).
        -
        -
        Parameters:
        -
        templateName - The filename of the template in the template storage. Existing - files with the same filename will be overwritten.
        -
        templateData - Binary document data. The supported formats are .doc, - .docx, .rtf and .tx.
        -
        Throws:
        -
        java.lang.IllegalArgumentException - If something went wrong concerning the HTTP request.
        -
        java.io.IOException - If an I/O error occurs.
        -
        -
        • -
      - - - -
        -
      • -

        templateExists

        -
        public boolean templateExists(java.lang.String templateName)
-                       throws java.lang.IllegalArgumentException,
-                              java.io.IOException
        -
        Checks whether a template exists in the template storage.
        -
        -
        Parameters:
        -
        templateName - The filename of the template to be checked for - availability in the template storage.
        -
        Returns:
        -
        Returns if the template with the given name exists in the template - storage.
        -
        Throws:
        -
        java.lang.IllegalArgumentException - If something went wrong concerning the HTTP request.
        -
        java.io.IOException - If an I/O error occurs.
        -
        -
        • -
      - - - -
        -
      • -

        downloadTemplate

        -
        public byte[] downloadTemplate(java.lang.String templateName)
-                        throws java.lang.IllegalArgumentException,
-                               java.io.IOException
        -
        Returns the selected template from the storage.
        -
        -
        Parameters:
        -
        templateName - The filename of the template in the template storage.
        -
        Returns:
        -
        The template document data.
        -
        Throws:
        -
        java.io.IOException - If an I/O error occurs.
        -
        java.lang.IllegalArgumentException - If something went wrong concerning the HTTP request.
        -
        -
        • -
      - - - -
        -
      • -

        deleteTemplate

        -
        public void deleteTemplate(java.lang.String templateName)
-                    throws java.lang.IllegalArgumentException,
-                           java.io.IOException
        -
        Deletes a template from the template storage.
        -
        -
        Parameters:
        -
        templateName - The filename of the template to be deleted - from the template storage.
        -
        Throws:
        -
        java.lang.IllegalArgumentException - If something went wrong concerning the HTTP request.
        -
        java.io.IOException - If an I/O error occurs.
        -
        -
        • -
      - - - -
        -
      • -

        convertDocument

        -
        public byte[] convertDocument(byte[] templateData,
-                              ReturnFormat returnFormat)
-                       throws java.lang.IllegalArgumentException,
-                              java.io.IOException
        -
        Converts a document to another format.
        -
        -
        Parameters:
        -
        templateData - The source document encoded as a Base64 string. - The supported document formats are .rtf, .doc, - .docx, .html, .pdf and .tx.
        -
        returnFormat - The format of the created document.
        -
        Returns:
        -
        The created document encoded as a Base64 string.
        -
        Throws:
        -
        java.lang.IllegalArgumentException - If something went wrong concerning the HTTP request.
        -
        java.io.IOException - If an I/O error occurs.
        -
        -
        • -
      - - - -
        -
      • -

        mergeDocument

        -
        public java.util.List<byte[]> mergeDocument(MergeBody mergeBody)
-                                     throws java.lang.IllegalArgumentException,
-                                            java.io.IOException
        -
        Merges and returns a template from the template storage or an uploaded template with JSON data.
        -
        -
        Parameters:
        -
        mergeBody - The MergeBody object contains the data source - as a JSON data object and optionally, a template encoded as a Base64 string.
        -
        Returns:
        -
        The response body contains an array of the created documents.
        -
        Throws:
        -
        java.lang.IllegalArgumentException - If something went wrong concerning the HTTP request.
        -
        java.io.IOException - If an I/O error occurs.
        -
        -
        • -
      - - - -
        -
      • -

        mergeDocument

        -
        public java.util.List<byte[]> mergeDocument(MergeBody mergeBody,
-                                            java.lang.String templateName)
-                                     throws java.lang.IllegalArgumentException,
-                                            java.io.IOException
        -
        Merges and returns a template from the template storage or an uploaded template with JSON data.
        -
        -
        Parameters:
        -
        mergeBody - The MergeBody object contains the data source - as a JSON data object and optionally, a template encoded as a Base64 string.
        -
        templateName - The name of the template in the template storage. If no template - name is specified, the template must be uploaded in the MergeBody - object of this request.
        -
        Returns:
        -
        The response body contains an array of the created documents.
        -
        Throws:
        -
        java.lang.IllegalArgumentException - If something went wrong concerning the HTTP request.
        -
        java.io.IOException - If an I/O error occurs.
        -
        -
        • -
      - - - -
        -
      • -

        mergeDocument

        -
        public java.util.List<byte[]> mergeDocument(MergeBody mergeBody,
-                                            java.lang.String templateName,
-                                            ReturnFormat returnFormat)
-                                     throws java.lang.IllegalArgumentException,
-                                            java.io.IOException
        -
        Merges and returns a template from the template storage or an uploaded template with JSON data.
        -
        -
        Parameters:
        -
        mergeBody - The MergeBody object contains the data source - as a JSON data object and optionally, a template encoded as a Base64 string.
        -
        templateName - The name of the template in the template storage. If no template - name is specified, the template must be uploaded in the MergeBody - object of this request.
        -
        returnFormat - The format of the created document.
        -
        Returns:
        -
        The response body contains an array of the created documents.
        -
        Throws:
        -
        java.lang.IllegalArgumentException - If something went wrong concerning the HTTP request.
        -
        java.io.IOException - If an I/O error occurs.
        -
        -
        • -
      - - - -
        -
      • -

        mergeDocument

        -
        public java.util.List<byte[]> mergeDocument(MergeBody mergeBody,
-                                            java.lang.String templateName,
-                                            ReturnFormat returnFormat,
-                                            boolean append)
-                                     throws java.lang.IllegalArgumentException,
-                                            java.io.IOException
        -
        Merges and returns a template from the template storage or an uploaded template with JSON data.
        -
        -
        Parameters:
        -
        mergeBody - The MergeBody object contains the data source - as a JSON data object and optionally, a template encoded as a Base64 string.
        -
        templateName - The name of the template in the template storage. If no template - name is specified, the template must be uploaded in the MergeBody - object of this request.
        -
        returnFormat - The format of the created document.
        -
        append - Specifies whether the documents should be appended to one resulting - document when more than 1 data row is passed.
        -
        Returns:
        -
        The response body contains an array of the created documents.
        -
        Throws:
        -
        java.lang.IllegalArgumentException - If something went wrong concerning the HTTP request.
        -
        java.io.IOException - If an I/O error occurs.
        -
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
-
    -
  • Summary: 
    • -
  • Nested | 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
- -
- - -
- - - + + + + + +ReportingCloud (reportingcloud 1.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
com.textcontrol.reportingcloud
+

Class ReportingCloud

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • com.textcontrol.reportingcloud.ReportingCloud
      • +
    +
    • +
+
+
    +
  • +
    +
    +
    public class ReportingCloud
+extends java.lang.Object
    +
    The ReportingCloud API wrapper class.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + + +
      Constructors 
      Constructor and Description
      ReportingCloud(java.lang.String username, + java.lang.String password) +
      Creates a new ReportingCloud wrapper instance with the API base URL + set to "https://api.reporting.cloud".
      +
      ReportingCloud(java.lang.String username, + java.lang.String password, + java.lang.String baseUrl) +
      Creates a new ReportingCloud wrapper instance.
      +
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      byte[]convertDocument(byte[] templateData, + ReturnFormat returnFormat) +
      Converts a document to another format.
      +
      voiddeleteTemplate(java.lang.String templateName) +
      Deletes a template from the template storage.
      +
      byte[]downloadTemplate(java.lang.String templateName) +
      Returns the selected template from the storage.
      +
      AccountSettingsgetAccountSettings() +
      Gets the current user's account settings.
      +
      intgetTemplateCount() +
      Returns the number of templates in the template storage.
      +
      TemplateInfogetTemplateInfo(java.lang.String templateName) +
      Returns information about a template including merge fields and merge blocks.
      +
      intgetTemplatePageCount(java.lang.String templateName) +
      Returns the number of pages of a template in the template storage.
      +
      java.util.List<byte[]>getTemplateThumbnails(java.lang.String templateName, + int zoomFactor) +
      Returns a list of thumbnails of a specific template.
      +
      java.util.List<byte[]>getTemplateThumbnails(java.lang.String templateName, + int zoomFactor, + int fromPage) +
      Returns a list of thumbnails of a specific template.
      +
      java.util.List<byte[]>getTemplateThumbnails(java.lang.String templateName, + int zoomFactor, + int fromPage, + int toPage) +
      Returns a list of thumbnails of a specific template.
      +
      java.util.List<byte[]>getTemplateThumbnails(java.lang.String templateName, + int zoomFactor, + int fromPage, + int toPage, + ImageFormat imageFormat) +
      Returns a list of thumbnails of a specific template.
      +
      java.util.List<Template>listTemplates() +
      Lists all templates from the template storage.
      +
      java.util.List<byte[]>mergeDocument(MergeBody mergeBody) +
      Merges and returns a template from the template storage or an uploaded template with JSON data.
      +
      java.util.List<byte[]>mergeDocument(MergeBody mergeBody, + java.lang.String templateName) +
      Merges and returns a template from the template storage or an uploaded template with JSON data.
      +
      java.util.List<byte[]>mergeDocument(MergeBody mergeBody, + java.lang.String templateName, + ReturnFormat returnFormat) +
      Merges and returns a template from the template storage or an uploaded template with JSON data.
      +
      java.util.List<byte[]>mergeDocument(MergeBody mergeBody, + java.lang.String templateName, + ReturnFormat returnFormat, + boolean append) +
      Merges and returns a template from the template storage or an uploaded template with JSON data.
      +
      booleantemplateExists(java.lang.String templateName) +
      Checks whether a template exists in the template storage.
      +
      voiduploadTemplate(java.lang.String templateName, + byte[] templateData) +
      Stores an uploaded template in the template storage (.doc, .docx, + .rtf and .tx).
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        ReportingCloud

        +
        public ReportingCloud(java.lang.String username,
+                      java.lang.String password,
+                      java.lang.String baseUrl)
        +
        Creates a new ReportingCloud wrapper instance.
        +
        +
        Parameters:
        +
        username - The username.
        +
        password - The password.
        +
        baseUrl - The API base URL.
        +
        +
        • +
      + + + +
        +
      • +

        ReportingCloud

        +
        public ReportingCloud(java.lang.String username,
+                      java.lang.String password)
        +
        Creates a new ReportingCloud wrapper instance with the API base URL + set to "https://api.reporting.cloud".
        +
        +
        Parameters:
        +
        username - The username.
        +
        password - The password.
        +
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getTemplateCount

        +
        public int getTemplateCount()
+                     throws java.lang.IllegalArgumentException,
+                            java.io.IOException
        +
        Returns the number of templates in the template storage.
        +
        +
        Returns:
        +
        The number of templates in the template storage.
        +
        Throws:
        +
        java.io.IOException - If an I/O error occurs.
        +
        java.lang.IllegalArgumentException - If something went wrong concerning the HTTP request.
        +
        +
        • +
      + + + +
        +
      • +

        getAccountSettings

        +
        public AccountSettings getAccountSettings()
+                                   throws java.lang.IllegalArgumentException,
+                                          java.io.IOException
        +
        Gets the current user's account settings.
        +
        +
        Returns:
        +
        The account settings.
        +
        Throws:
        +
        java.io.IOException - If an I/O error occurs.
        +
        java.lang.IllegalArgumentException - If something went wrong concerning the HTTP request.
        +
        +
        • +
      + + + +
        +
      • +

        listTemplates

        +
        public java.util.List<Template> listTemplates()
+                                       throws java.lang.IllegalArgumentException,
+                                              java.io.IOException
        +
        Lists all templates from the template storage.
        +
        +
        Returns:
        +
        A list of Template objects.
        +
        Throws:
        +
        java.lang.IllegalArgumentException - If something went wrong concerning the HTTP request.
        +
        java.io.IOException - If an I/O error occurs.
        +
        +
        • +
      + + + +
        +
      • +

        getTemplatePageCount

        +
        public int getTemplatePageCount(java.lang.String templateName)
+                         throws java.lang.IllegalArgumentException,
+                                java.io.IOException
        +
        Returns the number of pages of a template in the template storage.
        +
        +
        Parameters:
        +
        templateName - The filename of the template in the template + storage to retrieve the number of pages for.
        +
        Returns:
        +
        The number of pages in the template.
        +
        Throws:
        +
        java.io.IOException - If an I/O error occurs.
        +
        java.lang.IllegalArgumentException - If something went wrong concerning the HTTP request.
        +
        +
        • +
      + + + +
        +
      • +

        getTemplateThumbnails

        +
        public java.util.List<byte[]> getTemplateThumbnails(java.lang.String templateName,
+                                                    int zoomFactor)
+                                             throws java.lang.IllegalArgumentException,
+                                                    java.io.IOException
        +
        Returns a list of thumbnails of a specific template.
        +
        +
        Parameters:
        +
        templateName - The filename of the template in the template storage.
        +
        zoomFactor - An Integer value between 1 and 400 to set the percentage + zoom factor of the created thumbnail images.
        +
        Returns:
        +
        An array of binary image data.
        +
        Throws:
        +
        java.lang.IllegalArgumentException - If something went wrong concerning the HTTP request.
        +
        java.io.IOException - If an I/O error occurs.
        +
        +
        • +
      + + + +
        +
      • +

        getTemplateThumbnails

        +
        public java.util.List<byte[]> getTemplateThumbnails(java.lang.String templateName,
+                                                    int zoomFactor,
+                                                    int fromPage)
+                                             throws java.lang.IllegalArgumentException,
+                                                    java.io.IOException
        +
        Returns a list of thumbnails of a specific template.
        +
        +
        Parameters:
        +
        templateName - The filename of the template in the template storage.
        +
        zoomFactor - An Integer value between 1 and 400 to set the percentage + zoom factor of the created thumbnail images.
        +
        fromPage - An Integer value that specifies the first page.
        +
        Returns:
        +
        An array of binary image data.
        +
        Throws:
        +
        java.lang.IllegalArgumentException - If something went wrong concerning the HTTP request.
        +
        java.io.IOException - If an I/O error occurs.
        +
        +
        • +
      + + + +
        +
      • +

        getTemplateThumbnails

        +
        public java.util.List<byte[]> getTemplateThumbnails(java.lang.String templateName,
+                                                    int zoomFactor,
+                                                    int fromPage,
+                                                    int toPage)
+                                             throws java.lang.IllegalArgumentException,
+                                                    java.io.IOException
        +
        Returns a list of thumbnails of a specific template.
        +
        +
        Parameters:
        +
        templateName - The filename of the template in the template storage.
        +
        zoomFactor - An Integer value between 1 and 400 to set the percentage + zoom factor of the created thumbnail images.
        +
        fromPage - An Integer value that specifies the first page.
        +
        toPage - An Integer value that specifies the last page.
        +
        Returns:
        +
        An array of binary image data.
        +
        Throws:
        +
        java.lang.IllegalArgumentException - If something went wrong concerning the HTTP request.
        +
        java.io.IOException - If an I/O error occurs.
        +
        +
        • +
      + + + +
        +
      • +

        getTemplateThumbnails

        +
        public java.util.List<byte[]> getTemplateThumbnails(java.lang.String templateName,
+                                                    int zoomFactor,
+                                                    int fromPage,
+                                                    int toPage,
+                                                    ImageFormat imageFormat)
+                                             throws java.lang.IllegalArgumentException,
+                                                    java.io.IOException
        +
        Returns a list of thumbnails of a specific template.
        +
        +
        Parameters:
        +
        templateName - The filename of the template in the template storage.
        +
        zoomFactor - An Integer value between 1 and 400 to set the percentage + zoom factor of the created thumbnail images.
        +
        fromPage - An Integer value that specifies the first page.
        +
        toPage - An Integer value that specifies the last page.
        +
        imageFormat - Defines the image format of the returned thumbnails.
        +
        Returns:
        +
        An array of binary image data.
        +
        Throws:
        +
        java.lang.IllegalArgumentException - If something went wrong concerning the HTTP request.
        +
        java.io.IOException - If an I/O error occurs.
        +
        +
        • +
      + + + +
        +
      • +

        uploadTemplate

        +
        public void uploadTemplate(java.lang.String templateName,
+                           byte[] templateData)
+                    throws java.lang.IllegalArgumentException,
+                           java.io.IOException
        +
        Stores an uploaded template in the template storage (.doc, .docx, + .rtf and .tx).
        +
        +
        Parameters:
        +
        templateName - The filename of the template in the template storage. Existing + files with the same filename will be overwritten.
        +
        templateData - Binary document data. The supported formats are .doc, + .docx, .rtf and .tx.
        +
        Throws:
        +
        java.lang.IllegalArgumentException - If something went wrong concerning the HTTP request.
        +
        java.io.IOException - If an I/O error occurs.
        +
        +
        • +
      + + + +
        +
      • +

        templateExists

        +
        public boolean templateExists(java.lang.String templateName)
+                       throws java.lang.IllegalArgumentException,
+                              java.io.IOException
        +
        Checks whether a template exists in the template storage.
        +
        +
        Parameters:
        +
        templateName - The filename of the template to be checked for + availability in the template storage.
        +
        Returns:
        +
        Returns if the template with the given name exists in the template + storage.
        +
        Throws:
        +
        java.lang.IllegalArgumentException - If something went wrong concerning the HTTP request.
        +
        java.io.IOException - If an I/O error occurs.
        +
        +
        • +
      + + + +
        +
      • +

        downloadTemplate

        +
        public byte[] downloadTemplate(java.lang.String templateName)
+                        throws java.lang.IllegalArgumentException,
+                               java.io.IOException
        +
        Returns the selected template from the storage.
        +
        +
        Parameters:
        +
        templateName - The filename of the template in the template storage.
        +
        Returns:
        +
        The template document data.
        +
        Throws:
        +
        java.io.IOException - If an I/O error occurs.
        +
        java.lang.IllegalArgumentException - If something went wrong concerning the HTTP request.
        +
        +
        • +
      + + + +
        +
      • +

        deleteTemplate

        +
        public void deleteTemplate(java.lang.String templateName)
+                    throws java.lang.IllegalArgumentException,
+                           java.io.IOException
        +
        Deletes a template from the template storage.
        +
        +
        Parameters:
        +
        templateName - The filename of the template to be deleted + from the template storage.
        +
        Throws:
        +
        java.lang.IllegalArgumentException - If something went wrong concerning the HTTP request.
        +
        java.io.IOException - If an I/O error occurs.
        +
        +
        • +
      + + + +
        +
      • +

        convertDocument

        +
        public byte[] convertDocument(byte[] templateData,
+                              ReturnFormat returnFormat)
+                       throws java.lang.IllegalArgumentException,
+                              java.io.IOException
        +
        Converts a document to another format.
        +
        +
        Parameters:
        +
        templateData - The source document encoded as a Base64 string. + The supported document formats are .rtf, .doc, + .docx, .html, .pdf and .tx.
        +
        returnFormat - The format of the created document.
        +
        Returns:
        +
        The created document encoded as a Base64 string.
        +
        Throws:
        +
        java.lang.IllegalArgumentException - If something went wrong concerning the HTTP request.
        +
        java.io.IOException - If an I/O error occurs.
        +
        +
        • +
      + + + +
        +
      • +

        mergeDocument

        +
        public java.util.List<byte[]> mergeDocument(MergeBody mergeBody)
+                                     throws java.lang.IllegalArgumentException,
+                                            java.io.IOException
        +
        Merges and returns a template from the template storage or an uploaded template with JSON data.
        +
        +
        Parameters:
        +
        mergeBody - The MergeBody object contains the data source + as a JSON data object and optionally, a template encoded as a Base64 string.
        +
        Returns:
        +
        The response body contains an array of the created documents.
        +
        Throws:
        +
        java.lang.IllegalArgumentException - If something went wrong concerning the HTTP request.
        +
        java.io.IOException - If an I/O error occurs.
        +
        +
        • +
      + + + +
        +
      • +

        mergeDocument

        +
        public java.util.List<byte[]> mergeDocument(MergeBody mergeBody,
+                                            java.lang.String templateName)
+                                     throws java.lang.IllegalArgumentException,
+                                            java.io.IOException
        +
        Merges and returns a template from the template storage or an uploaded template with JSON data.
        +
        +
        Parameters:
        +
        mergeBody - The MergeBody object contains the data source + as a JSON data object and optionally, a template encoded as a Base64 string.
        +
        templateName - The name of the template in the template storage. If no template + name is specified, the template must be uploaded in the MergeBody + object of this request.
        +
        Returns:
        +
        The response body contains an array of the created documents.
        +
        Throws:
        +
        java.lang.IllegalArgumentException - If something went wrong concerning the HTTP request.
        +
        java.io.IOException - If an I/O error occurs.
        +
        +
        • +
      + + + +
        +
      • +

        mergeDocument

        +
        public java.util.List<byte[]> mergeDocument(MergeBody mergeBody,
+                                            java.lang.String templateName,
+                                            ReturnFormat returnFormat)
+                                     throws java.lang.IllegalArgumentException,
+                                            java.io.IOException
        +
        Merges and returns a template from the template storage or an uploaded template with JSON data.
        +
        +
        Parameters:
        +
        mergeBody - The MergeBody object contains the data source + as a JSON data object and optionally, a template encoded as a Base64 string.
        +
        templateName - The name of the template in the template storage. If no template + name is specified, the template must be uploaded in the MergeBody + object of this request.
        +
        returnFormat - The format of the created document.
        +
        Returns:
        +
        The response body contains an array of the created documents.
        +
        Throws:
        +
        java.lang.IllegalArgumentException - If something went wrong concerning the HTTP request.
        +
        java.io.IOException - If an I/O error occurs.
        +
        +
        • +
      + + + +
        +
      • +

        mergeDocument

        +
        public java.util.List<byte[]> mergeDocument(MergeBody mergeBody,
+                                            java.lang.String templateName,
+                                            ReturnFormat returnFormat,
+                                            boolean append)
+                                     throws java.lang.IllegalArgumentException,
+                                            java.io.IOException
        +
        Merges and returns a template from the template storage or an uploaded template with JSON data.
        +
        +
        Parameters:
        +
        mergeBody - The MergeBody object contains the data source + as a JSON data object and optionally, a template encoded as a Base64 string.
        +
        templateName - The name of the template in the template storage. If no template + name is specified, the template must be uploaded in the MergeBody + object of this request.
        +
        returnFormat - The format of the created document.
        +
        append - Specifies whether the documents should be appended to one resulting + document when more than 1 data row is passed.
        +
        Returns:
        +
        The response body contains an array of the created documents.
        +
        Throws:
        +
        java.lang.IllegalArgumentException - If something went wrong concerning the HTTP request.
        +
        java.io.IOException - If an I/O error occurs.
        +
        +
        • +
      + + + +
        +
      • +

        getTemplateInfo

        +
        public TemplateInfo getTemplateInfo(java.lang.String templateName)
+                             throws java.lang.IllegalArgumentException,
+                                    java.io.IOException
        +
        Returns information about a template including merge fields and merge blocks.
        +
        +
        Parameters:
        +
        templateName - The filename of the template in the template storage to retrieve the information for.
        +
        Returns:
        +
        The template information.
        +
        Throws:
        +
        java.lang.IllegalArgumentException - If something went wrong concerning the HTTP request.
        +
        java.io.IOException - If an I/O error occurs.
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/com/textcontrol/reportingcloud/ReturnFormat.html b/com/textcontrol/reportingcloud/ReturnFormat.html index ac0ca21..2c2feec 100644 --- a/com/textcontrol/reportingcloud/ReturnFormat.html +++ b/com/textcontrol/reportingcloud/ReturnFormat.html @@ -1,421 +1,421 @@ - - - - - -ReturnFormat (reportingcloud 1.0 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- - -
-
com.textcontrol.reportingcloud
-

Enum ReturnFormat

-
-
-
    -
  • java.lang.Object
    • -
  • -
      -
    • java.lang.Enum<ReturnFormat>
      • -
    • -
        -
      • com.textcontrol.reportingcloud.ReturnFormat
        • -
      -
      • -
    -
    • -
-
-
    -
  • -
    -
    All Implemented Interfaces:
    -
    java.io.Serializable, java.lang.Comparable<ReturnFormat>
    -
    -
    -
    -
    public enum ReturnFormat
-extends java.lang.Enum<ReturnFormat>
    -
    This enum lists all possible return formats for the Merge method.
    -
    • -
-
-
-
    -
  • - -
      -
    • - - -

      Enum Constant Summary

      - - - - - - - - - - - - - - - - - - - - - - - - - - -
      Enum Constants 
      Enum Constant and Description
      DOC -
      Microsoft Word 97-2003
      -
      DOCX -
      Microsoft Office Open XML
      -
      HMTL -
      Hypertext Markup Language
      -
      PDF -
      Adobe PDF
      -
      PDFA -
      Adobe PDF/A
      -
      RTF -
      Rich Text Format
      -
      TX -
      TX Text Control Internal Format
      -
      -
      • -
    - -
      -
    • - - -

      Method Summary

      - - - - - - - - - - - - - - -
      All Methods Static Methods Concrete Methods 
      Modifier and TypeMethod and Description
      static ReturnFormatvalueOf(java.lang.String name) -
      Returns the enum constant of this type with the specified name.
      -
      static ReturnFormat[]values() -
      Returns an array containing the constants of this enum type, in -the order they are declared.
      -
      -
        -
      • - - -

        Methods inherited from class java.lang.Enum

        -clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
        • -
      -
        -
      • - - -

        Methods inherited from class java.lang.Object

        -getClass, notify, notifyAll, wait, wait, wait
        • -
      -
      • -
    -
    • -
-
-
-
    -
  • - -
      -
    • - - -

      Enum Constant Detail

      - - - -
        -
      • -

        PDF

        -
        public static final ReturnFormat PDF
        -
        Adobe PDF
        -
        • -
      - - - -
        -
      • -

        PDFA

        -
        public static final ReturnFormat PDFA
        -
        Adobe PDF/A
        -
        • -
      - - - -
        -
      • -

        DOC

        -
        public static final ReturnFormat DOC
        -
        Microsoft Word 97-2003
        -
        • -
      - - - -
        -
      • -

        DOCX

        -
        public static final ReturnFormat DOCX
        -
        Microsoft Office Open XML
        -
        • -
      - - - -
        -
      • -

        RTF

        -
        public static final ReturnFormat RTF
        -
        Rich Text Format
        -
        • -
      - - - -
        -
      • -

        TX

        -
        public static final ReturnFormat TX
        -
        TX Text Control Internal Format
        -
        • -
      - - - -
        -
      • -

        HMTL

        -
        public static final ReturnFormat HMTL
        -
        Hypertext Markup Language
        -
        • -
      -
      • -
    - -
      -
    • - - -

      Method Detail

      - - - -
        -
      • -

        values

        -
        public static ReturnFormat[] values()
        -
        Returns an array containing the constants of this enum type, in -the order they are declared. This method may be used to iterate -over the constants as follows: -
        -for (ReturnFormat c : ReturnFormat.values())
-    System.out.println(c);
-
        -
        -
        Returns:
        -
        an array containing the constants of this enum type, in the order they are declared
        -
        -
        • -
      - - - -
        -
      • -

        valueOf

        -
        public static ReturnFormat valueOf(java.lang.String name)
        -
        Returns the enum constant of this type with the specified name. -The string must match exactly an identifier used to declare an -enum constant in this type. (Extraneous whitespace characters are -not permitted.)
        -
        -
        Parameters:
        -
        name - the name of the enum constant to be returned.
        -
        Returns:
        -
        the enum constant with the specified name
        -
        Throws:
        -
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        -
        java.lang.NullPointerException - if the argument is null
        -
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- - - + + + + + +ReturnFormat (reportingcloud 1.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
com.textcontrol.reportingcloud
+

Enum ReturnFormat

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • java.lang.Enum<ReturnFormat>
      • +
    • +
        +
      • com.textcontrol.reportingcloud.ReturnFormat
        • +
      +
      • +
    +
    • +
+
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.io.Serializable, java.lang.Comparable<ReturnFormat>
    +
    +
    +
    +
    public enum ReturnFormat
+extends java.lang.Enum<ReturnFormat>
    +
    This enum lists all possible return formats for the Merge method.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Enum Constant Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Enum Constants 
      Enum Constant and Description
      DOC +
      Microsoft Word 97-2003
      +
      DOCX +
      Microsoft Office Open XML
      +
      HMTL +
      Hypertext Markup Language
      +
      PDF +
      Adobe PDF
      +
      PDFA +
      Adobe PDF/A
      +
      RTF +
      Rich Text Format
      +
      TX +
      TX Text Control Internal Format
      +
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + +
      All Methods Static Methods Concrete Methods 
      Modifier and TypeMethod and Description
      static ReturnFormatvalueOf(java.lang.String name) +
      Returns the enum constant of this type with the specified name.
      +
      static ReturnFormat[]values() +
      Returns an array containing the constants of this enum type, in +the order they are declared.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Enum

        +clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +getClass, notify, notifyAll, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Enum Constant Detail

      + + + +
        +
      • +

        PDF

        +
        public static final ReturnFormat PDF
        +
        Adobe PDF
        +
        • +
      + + + +
        +
      • +

        PDFA

        +
        public static final ReturnFormat PDFA
        +
        Adobe PDF/A
        +
        • +
      + + + +
        +
      • +

        DOC

        +
        public static final ReturnFormat DOC
        +
        Microsoft Word 97-2003
        +
        • +
      + + + +
        +
      • +

        DOCX

        +
        public static final ReturnFormat DOCX
        +
        Microsoft Office Open XML
        +
        • +
      + + + +
        +
      • +

        RTF

        +
        public static final ReturnFormat RTF
        +
        Rich Text Format
        +
        • +
      + + + +
        +
      • +

        TX

        +
        public static final ReturnFormat TX
        +
        TX Text Control Internal Format
        +
        • +
      + + + +
        +
      • +

        HMTL

        +
        public static final ReturnFormat HMTL
        +
        Hypertext Markup Language
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        values

        +
        public static ReturnFormat[] values()
        +
        Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +
        +for (ReturnFormat c : ReturnFormat.values())
+    System.out.println(c);
+
        +
        +
        Returns:
        +
        an array containing the constants of this enum type, in the order they are declared
        +
        +
        • +
      + + + +
        +
      • +

        valueOf

        +
        public static ReturnFormat valueOf(java.lang.String name)
        +
        Returns the enum constant of this type with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.)
        +
        +
        Parameters:
        +
        name - the name of the enum constant to be returned.
        +
        Returns:
        +
        the enum constant with the specified name
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        +
        java.lang.NullPointerException - if the argument is null
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/com/textcontrol/reportingcloud/Template.html b/com/textcontrol/reportingcloud/Template.html index 174155a..9012ffe 100644 --- a/com/textcontrol/reportingcloud/Template.html +++ b/com/textcontrol/reportingcloud/Template.html @@ -1,331 +1,331 @@ - - - - - -Template (reportingcloud 1.0 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
-
    -
  • Summary: 
    • -
  • Nested | 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
- -
- - -
- - -
-
com.textcontrol.reportingcloud
-

Class Template

-
-
-
    -
  • java.lang.Object
    • -
  • -
      -
    • com.textcontrol.reportingcloud.Template
      • -
    -
    • -
-
-
    -
  • -
    -
    -
    public class Template
-extends java.lang.Object
    -
    Holds information about a template in the template storage.
    -
    • -
-
-
-
    -
  • - -
      -
    • - - -

      Constructor Summary

      - - - - - - - - -
      Constructors 
      Constructor and Description
      Template(java.lang.String templateName, - java.lang.String modified, - int size) -
      Creates a new Template instance.
      -
      -
      • -
    - -
      -
    • - - -

      Method Summary

      - - - - - - - - - - - - - - - - - - -
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      java.time.ZonedDateTimegetModified() -
      Gets the date and time the template file was last modified
      -
      intgetSize() -
      Gets the size of the template file in bytes.
      -
      java.lang.StringgetTemplateName() -
      Gets the template file name.
      -
      -
        -
      • - - -

        Methods inherited from class java.lang.Object

        -clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
        • -
      -
      • -
    -
    • -
-
-
-
    -
  • - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        Template

        -
        public Template(java.lang.String templateName,
-                java.lang.String modified,
-                int size)
        -
        Creates a new Template instance.
        -
        -
        Parameters:
        -
        templateName - The template file name.
        -
        modified - The date and time the template file was last modified (ISO 8601 date and - time string).
        -
        size - The size of the template file in bytes.
        -
        -
        • -
      -
      • -
    - -
      -
    • - - -

      Method Detail

      - - - -
        -
      • -

        getTemplateName

        -
        public java.lang.String getTemplateName()
        -
        Gets the template file name.
        -
        -
        Returns:
        -
        The template file name.
        -
        -
        • -
      - - - -
        -
      • -

        getModified

        -
        public java.time.ZonedDateTime getModified()
        -
        Gets the date and time the template file was last modified
        -
        -
        Returns:
        -
        The modification date.
        -
        -
        • -
      - - - -
        -
      • -

        getSize

        -
        public int getSize()
        -
        Gets the size of the template file in bytes.
        -
        -
        Returns:
        -
        The template size.
        -
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
-
    -
  • Summary: 
    • -
  • Nested | 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
- -
- - -
- - - + + + + + +Template (reportingcloud 1.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
com.textcontrol.reportingcloud
+

Class Template

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • com.textcontrol.reportingcloud.Template
      • +
    +
    • +
+
+
    +
  • +
    +
    +
    public class Template
+extends java.lang.Object
    +
    Holds information about a template in the template storage.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      Template(java.lang.String templateName, + java.lang.String modified, + int size) +
      Creates a new Template instance.
      +
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      java.time.ZonedDateTimegetModified() +
      Gets the date and time the template file was last modified
      +
      intgetSize() +
      Gets the size of the template file in bytes.
      +
      java.lang.StringgetTemplateName() +
      Gets the template file name.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        Template

        +
        public Template(java.lang.String templateName,
+                java.lang.String modified,
+                int size)
        +
        Creates a new Template instance.
        +
        +
        Parameters:
        +
        templateName - The template file name.
        +
        modified - The date and time the template file was last modified (ISO 8601 date and + time string).
        +
        size - The size of the template file in bytes.
        +
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getTemplateName

        +
        public java.lang.String getTemplateName()
        +
        Gets the template file name.
        +
        +
        Returns:
        +
        The template file name.
        +
        +
        • +
      + + + +
        +
      • +

        getModified

        +
        public java.time.ZonedDateTime getModified()
        +
        Gets the date and time the template file was last modified
        +
        +
        Returns:
        +
        The modification date.
        +
        +
        • +
      + + + +
        +
      • +

        getSize

        +
        public int getSize()
        +
        Gets the size of the template file in bytes.
        +
        +
        Returns:
        +
        The template size.
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/com/textcontrol/reportingcloud/TemplateInfo.html b/com/textcontrol/reportingcloud/TemplateInfo.html new file mode 100644 index 0000000..456641b --- /dev/null +++ b/com/textcontrol/reportingcloud/TemplateInfo.html @@ -0,0 +1,327 @@ + + + + + +TemplateInfo (reportingcloud 1.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
com.textcontrol.reportingcloud
+

Class TemplateInfo

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • com.textcontrol.reportingcloud.TemplateInfo
      • +
    +
    • +
+
+
    +
  • +
    +
    +
    public class TemplateInfo
+extends java.lang.Object
    +
    Holds information about the merge blocks and merge fields in a template.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      TemplateInfo(java.lang.String templateName, + java.util.List<MergeBlock> mergeBlocks, + java.util.List<MergeField> mergeFields) 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      java.util.List<MergeBlock>getMergeBlocks() +
      Gets all top level merge blocks in the template.
      +
      java.util.List<MergeField>getMergeFields() +
      Gets all top level merge fields in the template.
      +
      java.lang.StringgetTemplateName() +
      Gets the template file name.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        TemplateInfo

        +
        public TemplateInfo(java.lang.String templateName,
+                    java.util.List<MergeBlock> mergeBlocks,
+                    java.util.List<MergeField> mergeFields)
        +
        +
        Parameters:
        +
        templateName - The template file name.
        +
        mergeBlocks - The top level merge blocks in the template.
        +
        mergeFields - The top level merge fields in the template.
        +
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getTemplateName

        +
        public java.lang.String getTemplateName()
        +
        Gets the template file name.
        +
        +
        Returns:
        +
        The template file name.
        +
        +
        • +
      + + + +
        +
      • +

        getMergeBlocks

        +
        public java.util.List<MergeBlock> getMergeBlocks()
        +
        Gets all top level merge blocks in the template.
        +
        +
        Returns:
        +
        All top level merge blocks in the template.
        +
        +
        • +
      + + + +
        +
      • +

        getMergeFields

        +
        public java.util.List<MergeField> getMergeFields()
        +
        Gets all top level merge fields in the template.
        +
        +
        Returns:
        +
        All top level merge fields in the template.
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/com/textcontrol/reportingcloud/gson/AccountSettingsDeserializer.html b/com/textcontrol/reportingcloud/gson/AccountSettingsDeserializer.html index 0e93696..1173fc8 100644 --- a/com/textcontrol/reportingcloud/gson/AccountSettingsDeserializer.html +++ b/com/textcontrol/reportingcloud/gson/AccountSettingsDeserializer.html @@ -1,286 +1,286 @@ - - - - - -AccountSettingsDeserializer (reportingcloud 1.0 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
-
    -
  • Summary: 
    • -
  • Nested | 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
- -
- - -
- - -
-
com.textcontrol.reportingcloud.gson
-

Class AccountSettingsDeserializer

-
-
-
    -
  • java.lang.Object
    • -
  • -
      -
    • com.textcontrol.reportingcloud.gson.AccountSettingsDeserializer
      • -
    -
    • -
-
-
    -
  • -
    -
    All Implemented Interfaces:
    -
    com.google.gson.JsonDeserializer<AccountSettings>
    -
    -
    -
    -
    public class AccountSettingsDeserializer
-extends java.lang.Object
-implements com.google.gson.JsonDeserializer<AccountSettings>
    -
    Needed by GSON to create AccountSettings objects from JSON data.
    -
    • -
-
-
-
    -
  • - - - -
      -
    • - - -

      Method Summary

      - - - - - - - - - - -
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      AccountSettingsdeserialize(com.google.gson.JsonElement json, - java.lang.reflect.Type typeOfT, - com.google.gson.JsonDeserializationContext context) 
      -
        -
      • - - -

        Methods inherited from class java.lang.Object

        -clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
        • -
      -
      • -
    -
    • -
-
-
-
    -
  • - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        AccountSettingsDeserializer

        -
        public AccountSettingsDeserializer()
        -
        • -
      -
      • -
    - -
      -
    • - - -

      Method Detail

      - - - -
        -
      • -

        deserialize

        -
        public AccountSettings deserialize(com.google.gson.JsonElement json,
-                                   java.lang.reflect.Type typeOfT,
-                                   com.google.gson.JsonDeserializationContext context)
-                            throws com.google.gson.JsonParseException
        -
        -
        Specified by:
        -
        deserialize in interface com.google.gson.JsonDeserializer<AccountSettings>
        -
        Throws:
        -
        com.google.gson.JsonParseException
        -
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
-
    -
  • Summary: 
    • -
  • Nested | 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
- -
- - -
- - - + + + + + +AccountSettingsDeserializer (reportingcloud 1.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
com.textcontrol.reportingcloud.gson
+

Class AccountSettingsDeserializer

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • com.textcontrol.reportingcloud.gson.AccountSettingsDeserializer
      • +
    +
    • +
+
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    com.google.gson.JsonDeserializer<AccountSettings>
    +
    +
    +
    +
    public class AccountSettingsDeserializer
+extends java.lang.Object
+implements com.google.gson.JsonDeserializer<AccountSettings>
    +
    Needed by GSON to create AccountSettings objects from JSON data.
    +
    • +
+
+
+
    +
  • + + + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      AccountSettingsdeserialize(com.google.gson.JsonElement json, + java.lang.reflect.Type typeOfT, + com.google.gson.JsonDeserializationContext context) 
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        AccountSettingsDeserializer

        +
        public AccountSettingsDeserializer()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        deserialize

        +
        public AccountSettings deserialize(com.google.gson.JsonElement json,
+                                   java.lang.reflect.Type typeOfT,
+                                   com.google.gson.JsonDeserializationContext context)
+                            throws com.google.gson.JsonParseException
        +
        +
        Specified by:
        +
        deserialize in interface com.google.gson.JsonDeserializer<AccountSettings>
        +
        Throws:
        +
        com.google.gson.JsonParseException
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/com/textcontrol/reportingcloud/gson/MergeBlockDeserializer.html b/com/textcontrol/reportingcloud/gson/MergeBlockDeserializer.html new file mode 100644 index 0000000..731f73c --- /dev/null +++ b/com/textcontrol/reportingcloud/gson/MergeBlockDeserializer.html @@ -0,0 +1,286 @@ + + + + + +MergeBlockDeserializer (reportingcloud 1.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
com.textcontrol.reportingcloud.gson
+

Class MergeBlockDeserializer

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • com.textcontrol.reportingcloud.gson.MergeBlockDeserializer
      • +
    +
    • +
+
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    com.google.gson.JsonDeserializer<MergeBlock>
    +
    +
    +
    +
    public class MergeBlockDeserializer
+extends java.lang.Object
+implements com.google.gson.JsonDeserializer<MergeBlock>
    +
    Needed by GSON to create MergeBlock objects from JSON data.
    +
    • +
+
+
+
    +
  • + + + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      MergeBlockdeserialize(com.google.gson.JsonElement json, + java.lang.reflect.Type typeOfT, + com.google.gson.JsonDeserializationContext context) 
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        MergeBlockDeserializer

        +
        public MergeBlockDeserializer()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        deserialize

        +
        public MergeBlock deserialize(com.google.gson.JsonElement json,
+                              java.lang.reflect.Type typeOfT,
+                              com.google.gson.JsonDeserializationContext context)
+                       throws com.google.gson.JsonParseException
        +
        +
        Specified by:
        +
        deserialize in interface com.google.gson.JsonDeserializer<MergeBlock>
        +
        Throws:
        +
        com.google.gson.JsonParseException
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/com/textcontrol/reportingcloud/gson/MergeBodySerializer.html b/com/textcontrol/reportingcloud/gson/MergeBodySerializer.html index 553a086..c796bb5 100644 --- a/com/textcontrol/reportingcloud/gson/MergeBodySerializer.html +++ b/com/textcontrol/reportingcloud/gson/MergeBodySerializer.html @@ -1,284 +1,284 @@ - - - - - -MergeBodySerializer (reportingcloud 1.0 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
-
    -
  • Summary: 
    • -
  • Nested | 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
- -
- - -
- - -
-
com.textcontrol.reportingcloud.gson
-

Class MergeBodySerializer

-
-
-
    -
  • java.lang.Object
    • -
  • -
      -
    • com.textcontrol.reportingcloud.gson.MergeBodySerializer
      • -
    -
    • -
-
-
    -
  • -
    -
    All Implemented Interfaces:
    -
    com.google.gson.JsonSerializer<MergeBody>
    -
    -
    -
    -
    public class MergeBodySerializer
-extends java.lang.Object
-implements com.google.gson.JsonSerializer<MergeBody>
    -
    Needed by GSON to serialize MergeBody objects to - JSON.
    -
    • -
-
-
-
    -
  • - - - -
      -
    • - - -

      Method Summary

      - - - - - - - - - - -
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      com.google.gson.JsonElementserialize(MergeBody src, - java.lang.reflect.Type typeOfSrc, - com.google.gson.JsonSerializationContext context) 
      -
        -
      • - - -

        Methods inherited from class java.lang.Object

        -clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
        • -
      -
      • -
    -
    • -
-
-
-
    -
  • - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        MergeBodySerializer

        -
        public MergeBodySerializer()
        -
        • -
      -
      • -
    - -
      -
    • - - -

      Method Detail

      - - - -
        -
      • -

        serialize

        -
        public com.google.gson.JsonElement serialize(MergeBody src,
-                                             java.lang.reflect.Type typeOfSrc,
-                                             com.google.gson.JsonSerializationContext context)
        -
        -
        Specified by:
        -
        serialize in interface com.google.gson.JsonSerializer<MergeBody>
        -
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
-
    -
  • Summary: 
    • -
  • Nested | 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
- -
- - -
- - - + + + + + +MergeBodySerializer (reportingcloud 1.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
com.textcontrol.reportingcloud.gson
+

Class MergeBodySerializer

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • com.textcontrol.reportingcloud.gson.MergeBodySerializer
      • +
    +
    • +
+
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    com.google.gson.JsonSerializer<MergeBody>
    +
    +
    +
    +
    public class MergeBodySerializer
+extends java.lang.Object
+implements com.google.gson.JsonSerializer<MergeBody>
    +
    Needed by GSON to serialize MergeBody objects to + JSON.
    +
    • +
+
+
+
    +
  • + + + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      com.google.gson.JsonElementserialize(MergeBody src, + java.lang.reflect.Type typeOfSrc, + com.google.gson.JsonSerializationContext context) 
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        MergeBodySerializer

        +
        public MergeBodySerializer()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        serialize

        +
        public com.google.gson.JsonElement serialize(MergeBody src,
+                                             java.lang.reflect.Type typeOfSrc,
+                                             com.google.gson.JsonSerializationContext context)
        +
        +
        Specified by:
        +
        serialize in interface com.google.gson.JsonSerializer<MergeBody>
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/com/textcontrol/reportingcloud/gson/MergeFieldDeserializer.html b/com/textcontrol/reportingcloud/gson/MergeFieldDeserializer.html new file mode 100644 index 0000000..c9b1310 --- /dev/null +++ b/com/textcontrol/reportingcloud/gson/MergeFieldDeserializer.html @@ -0,0 +1,286 @@ + + + + + +MergeFieldDeserializer (reportingcloud 1.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
com.textcontrol.reportingcloud.gson
+

Class MergeFieldDeserializer

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • com.textcontrol.reportingcloud.gson.MergeFieldDeserializer
      • +
    +
    • +
+
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    com.google.gson.JsonDeserializer<MergeField>
    +
    +
    +
    +
    public class MergeFieldDeserializer
+extends java.lang.Object
+implements com.google.gson.JsonDeserializer<MergeField>
    +
    Needed by GSON to create MergeField objects from JSON data.
    +
    • +
+
+
+
    +
  • + + + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      MergeFielddeserialize(com.google.gson.JsonElement json, + java.lang.reflect.Type typeOfT, + com.google.gson.JsonDeserializationContext context) 
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        MergeFieldDeserializer

        +
        public MergeFieldDeserializer()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        deserialize

        +
        public MergeField deserialize(com.google.gson.JsonElement json,
+                              java.lang.reflect.Type typeOfT,
+                              com.google.gson.JsonDeserializationContext context)
+                       throws com.google.gson.JsonParseException
        +
        +
        Specified by:
        +
        deserialize in interface com.google.gson.JsonDeserializer<MergeField>
        +
        Throws:
        +
        com.google.gson.JsonParseException
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/com/textcontrol/reportingcloud/gson/MergeSettingsSerializer.html b/com/textcontrol/reportingcloud/gson/MergeSettingsSerializer.html index c3160c1..7909757 100644 --- a/com/textcontrol/reportingcloud/gson/MergeSettingsSerializer.html +++ b/com/textcontrol/reportingcloud/gson/MergeSettingsSerializer.html @@ -1,284 +1,284 @@ - - - - - -MergeSettingsSerializer (reportingcloud 1.0 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
-
    -
  • Summary: 
    • -
  • Nested | 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
- -
- - -
- - -
-
com.textcontrol.reportingcloud.gson
-

Class MergeSettingsSerializer

-
-
-
    -
  • java.lang.Object
    • -
  • -
      -
    • com.textcontrol.reportingcloud.gson.MergeSettingsSerializer
      • -
    -
    • -
-
-
    -
  • -
    -
    All Implemented Interfaces:
    -
    com.google.gson.JsonSerializer<MergeSettings>
    -
    -
    -
    -
    public class MergeSettingsSerializer
-extends java.lang.Object
-implements com.google.gson.JsonSerializer<MergeSettings>
    -
    Needed by GSON to serialize MergeSettings objects to - JSON.
    -
    • -
-
-
-
    -
  • - - - -
      -
    • - - -

      Method Summary

      - - - - - - - - - - -
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      com.google.gson.JsonElementserialize(MergeSettings src, - java.lang.reflect.Type typeOfSrc, - com.google.gson.JsonSerializationContext context) 
      -
        -
      • - - -

        Methods inherited from class java.lang.Object

        -clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
        • -
      -
      • -
    -
    • -
-
-
-
    -
  • - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        MergeSettingsSerializer

        -
        public MergeSettingsSerializer()
        -
        • -
      -
      • -
    - -
      -
    • - - -

      Method Detail

      - - - -
        -
      • -

        serialize

        -
        public com.google.gson.JsonElement serialize(MergeSettings src,
-                                             java.lang.reflect.Type typeOfSrc,
-                                             com.google.gson.JsonSerializationContext context)
        -
        -
        Specified by:
        -
        serialize in interface com.google.gson.JsonSerializer<MergeSettings>
        -
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
-
    -
  • Summary: 
    • -
  • Nested | 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
- -
- - -
- - - + + + + + +MergeSettingsSerializer (reportingcloud 1.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
com.textcontrol.reportingcloud.gson
+

Class MergeSettingsSerializer

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • com.textcontrol.reportingcloud.gson.MergeSettingsSerializer
      • +
    +
    • +
+
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    com.google.gson.JsonSerializer<MergeSettings>
    +
    +
    +
    +
    public class MergeSettingsSerializer
+extends java.lang.Object
+implements com.google.gson.JsonSerializer<MergeSettings>
    +
    Needed by GSON to serialize MergeSettings objects to + JSON.
    +
    • +
+
+
+
    +
  • + + + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      com.google.gson.JsonElementserialize(MergeSettings src, + java.lang.reflect.Type typeOfSrc, + com.google.gson.JsonSerializationContext context) 
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        MergeSettingsSerializer

        +
        public MergeSettingsSerializer()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        serialize

        +
        public com.google.gson.JsonElement serialize(MergeSettings src,
+                                             java.lang.reflect.Type typeOfSrc,
+                                             com.google.gson.JsonSerializationContext context)
        +
        +
        Specified by:
        +
        serialize in interface com.google.gson.JsonSerializer<MergeSettings>
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/com/textcontrol/reportingcloud/gson/TemplateDeserializer.html b/com/textcontrol/reportingcloud/gson/TemplateDeserializer.html index e454959..c59ecb6 100644 --- a/com/textcontrol/reportingcloud/gson/TemplateDeserializer.html +++ b/com/textcontrol/reportingcloud/gson/TemplateDeserializer.html @@ -1,286 +1,286 @@ - - - - - -TemplateDeserializer (reportingcloud 1.0 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
-
    -
  • Summary: 
    • -
  • Nested | 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
- -
- - -
- - -
-
com.textcontrol.reportingcloud.gson
-

Class TemplateDeserializer

-
-
-
    -
  • java.lang.Object
    • -
  • -
      -
    • com.textcontrol.reportingcloud.gson.TemplateDeserializer
      • -
    -
    • -
-
-
    -
  • -
    -
    All Implemented Interfaces:
    -
    com.google.gson.JsonDeserializer<Template>
    -
    -
    -
    -
    public class TemplateDeserializer
-extends java.lang.Object
-implements com.google.gson.JsonDeserializer<Template>
    -
    Needed by GSON to create Template objects from JSON data.
    -
    • -
-
-
-
    -
  • - - - -
      -
    • - - -

      Method Summary

      - - - - - - - - - - -
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      Templatedeserialize(com.google.gson.JsonElement json, - java.lang.reflect.Type typeOfT, - com.google.gson.JsonDeserializationContext context) 
      -
        -
      • - - -

        Methods inherited from class java.lang.Object

        -clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
        • -
      -
      • -
    -
    • -
-
-
-
    -
  • - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        TemplateDeserializer

        -
        public TemplateDeserializer()
        -
        • -
      -
      • -
    - -
      -
    • - - -

      Method Detail

      - - - -
        -
      • -

        deserialize

        -
        public Template deserialize(com.google.gson.JsonElement json,
-                            java.lang.reflect.Type typeOfT,
-                            com.google.gson.JsonDeserializationContext context)
-                     throws com.google.gson.JsonParseException
        -
        -
        Specified by:
        -
        deserialize in interface com.google.gson.JsonDeserializer<Template>
        -
        Throws:
        -
        com.google.gson.JsonParseException
        -
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
-
    -
  • Summary: 
    • -
  • Nested | 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
- -
- - -
- - - + + + + + +TemplateDeserializer (reportingcloud 1.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
com.textcontrol.reportingcloud.gson
+

Class TemplateDeserializer

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • com.textcontrol.reportingcloud.gson.TemplateDeserializer
      • +
    +
    • +
+
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    com.google.gson.JsonDeserializer<Template>
    +
    +
    +
    +
    public class TemplateDeserializer
+extends java.lang.Object
+implements com.google.gson.JsonDeserializer<Template>
    +
    Needed by GSON to create Template objects from JSON data.
    +
    • +
+
+
+
    +
  • + + + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      Templatedeserialize(com.google.gson.JsonElement json, + java.lang.reflect.Type typeOfT, + com.google.gson.JsonDeserializationContext context) 
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        TemplateDeserializer

        +
        public TemplateDeserializer()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        deserialize

        +
        public Template deserialize(com.google.gson.JsonElement json,
+                            java.lang.reflect.Type typeOfT,
+                            com.google.gson.JsonDeserializationContext context)
+                     throws com.google.gson.JsonParseException
        +
        +
        Specified by:
        +
        deserialize in interface com.google.gson.JsonDeserializer<Template>
        +
        Throws:
        +
        com.google.gson.JsonParseException
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/com/textcontrol/reportingcloud/gson/TemplateInfoDeserializer.html b/com/textcontrol/reportingcloud/gson/TemplateInfoDeserializer.html new file mode 100644 index 0000000..f1a27b9 --- /dev/null +++ b/com/textcontrol/reportingcloud/gson/TemplateInfoDeserializer.html @@ -0,0 +1,286 @@ + + + + + +TemplateInfoDeserializer (reportingcloud 1.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
com.textcontrol.reportingcloud.gson
+

Class TemplateInfoDeserializer

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • com.textcontrol.reportingcloud.gson.TemplateInfoDeserializer
      • +
    +
    • +
+
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    com.google.gson.JsonDeserializer<TemplateInfo>
    +
    +
    +
    +
    public class TemplateInfoDeserializer
+extends java.lang.Object
+implements com.google.gson.JsonDeserializer<TemplateInfo>
    +
    Needed by GSON to create TemplateInfo objects from JSON data.
    +
    • +
+
+
+
    +
  • + + + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      TemplateInfodeserialize(com.google.gson.JsonElement json, + java.lang.reflect.Type typeOfT, + com.google.gson.JsonDeserializationContext context) 
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        TemplateInfoDeserializer

        +
        public TemplateInfoDeserializer()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        deserialize

        +
        public TemplateInfo deserialize(com.google.gson.JsonElement json,
+                                java.lang.reflect.Type typeOfT,
+                                com.google.gson.JsonDeserializationContext context)
+                         throws com.google.gson.JsonParseException
        +
        +
        Specified by:
        +
        deserialize in interface com.google.gson.JsonDeserializer<TemplateInfo>
        +
        Throws:
        +
        com.google.gson.JsonParseException
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/com/textcontrol/reportingcloud/gson/package-frame.html b/com/textcontrol/reportingcloud/gson/package-frame.html index b3afbf0..4efef2b 100644 --- a/com/textcontrol/reportingcloud/gson/package-frame.html +++ b/com/textcontrol/reportingcloud/gson/package-frame.html @@ -1,23 +1,26 @@ - - - - - -com.textcontrol.reportingcloud.gson (reportingcloud 1.0 API) - - - - - -

com.textcontrol.reportingcloud.gson

-
-

Classes

- -
- - + + + + + +com.textcontrol.reportingcloud.gson (reportingcloud 1.1 API) + + + + + +

com.textcontrol.reportingcloud.gson

+
+

Classes

+ +
+ + diff --git a/com/textcontrol/reportingcloud/gson/package-summary.html b/com/textcontrol/reportingcloud/gson/package-summary.html index f8b1b7b..33acd6c 100644 --- a/com/textcontrol/reportingcloud/gson/package-summary.html +++ b/com/textcontrol/reportingcloud/gson/package-summary.html @@ -1,171 +1,189 @@ - - - - - -com.textcontrol.reportingcloud.gson (reportingcloud 1.0 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Package com.textcontrol.reportingcloud.gson

-
-
Contains GSON serializer and deserializer implementations.
-
-

See: Description

-
-
- - - - -

Package com.textcontrol.reportingcloud.gson Description

-
Contains GSON serializer and deserializer implementations.
-
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- - - + + + + + +com.textcontrol.reportingcloud.gson (reportingcloud 1.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Package com.textcontrol.reportingcloud.gson

+
+
Contains GSON serializer and deserializer implementations.
+
+

See: Description

+
+
+ + + + +

Package com.textcontrol.reportingcloud.gson Description

+
Contains GSON serializer and deserializer implementations.
+
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/com/textcontrol/reportingcloud/gson/package-tree.html b/com/textcontrol/reportingcloud/gson/package-tree.html index 2cc00af..8b82b8f 100644 --- a/com/textcontrol/reportingcloud/gson/package-tree.html +++ b/com/textcontrol/reportingcloud/gson/package-tree.html @@ -1,138 +1,141 @@ - - - - - -com.textcontrol.reportingcloud.gson Class Hierarchy (reportingcloud 1.0 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Hierarchy For Package com.textcontrol.reportingcloud.gson

-Package Hierarchies: - -
-
-

Class Hierarchy

-
    -
  • java.lang.Object - -
    • -
-
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- - - + + + + + +com.textcontrol.reportingcloud.gson Class Hierarchy (reportingcloud 1.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Hierarchy For Package com.textcontrol.reportingcloud.gson

+Package Hierarchies: + +
+
+

Class Hierarchy

+
    +
  • java.lang.Object + +
    • +
+
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/com/textcontrol/reportingcloud/package-frame.html b/com/textcontrol/reportingcloud/package-frame.html index 1c9d9ad..d137ab8 100644 --- a/com/textcontrol/reportingcloud/package-frame.html +++ b/com/textcontrol/reportingcloud/package-frame.html @@ -1,29 +1,32 @@ - - - - - -com.textcontrol.reportingcloud (reportingcloud 1.0 API) - - - - - -

com.textcontrol.reportingcloud

-
-

Classes

- -

Enums

- -
- - + + + + + +com.textcontrol.reportingcloud (reportingcloud 1.1 API) + + + + + +

com.textcontrol.reportingcloud

+
+

Classes

+ +

Enums

+ +
+ + diff --git a/com/textcontrol/reportingcloud/package-summary.html b/com/textcontrol/reportingcloud/package-summary.html index cfc3a82..b3f43f9 100644 --- a/com/textcontrol/reportingcloud/package-summary.html +++ b/com/textcontrol/reportingcloud/package-summary.html @@ -1,198 +1,216 @@ - - - - - -com.textcontrol.reportingcloud (reportingcloud 1.0 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Package com.textcontrol.reportingcloud

-
-
Contains classes and enumerations of the Text Control ReportingCloud Java wrapper.
-
-

See: Description

-
-
-
    -
  • - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Class Summary 
    ClassDescription
    AccountSettings -
    Represents ReportingCloud account settings.
    -
    MergeBody -
    Used to pass data to the merge method.
    -
    MergeSettings -
    Holds the merge settings needed by the merge method.
    -
    ReportingCloud -
    The ReportingCloud API wrapper class.
    -
    Template -
    Holds information about a template in the template storage.
    -
    -
    • -
  • - - - - - - - - - - - - - - - - -
    Enum Summary 
    EnumDescription
    ImageFormat -
    This enum lists all possible image formats for the thumbnails
    -
    ReturnFormat -
    This enum lists all possible return formats for the Merge method.
    -
    -
    • -
- - - -

Package com.textcontrol.reportingcloud Description

-
Contains classes and enumerations of the Text Control ReportingCloud Java wrapper.
-
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- - - + + + + + +com.textcontrol.reportingcloud (reportingcloud 1.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Package com.textcontrol.reportingcloud

+
+
Contains classes and enumerations of the Text Control ReportingCloud Java wrapper.
+
+

See: Description

+
+
+
    +
  • + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Class Summary 
    ClassDescription
    AccountSettings +
    Represents ReportingCloud account settings.
    +
    MergeBlock +
    Represents a merge block in a document template.
    +
    MergeBody +
    Used to pass data to the merge method.
    +
    MergeField +
    Represents a merge field in a document template.
    +
    MergeSettings +
    Holds the merge settings needed by the merge method.
    +
    ReportingCloud +
    The ReportingCloud API wrapper class.
    +
    Template +
    Holds information about a template in the template storage.
    +
    TemplateInfo +
    Holds information about the merge blocks and merge fields in a template.
    +
    +
    • +
  • + + + + + + + + + + + + + + + + +
    Enum Summary 
    EnumDescription
    ImageFormat +
    This enum lists all possible image formats for the thumbnails
    +
    ReturnFormat +
    This enum lists all possible return formats for the Merge method.
    +
    +
    • +
+ + + +

Package com.textcontrol.reportingcloud Description

+
Contains classes and enumerations of the Text Control ReportingCloud Java wrapper.
+
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/com/textcontrol/reportingcloud/package-tree.html b/com/textcontrol/reportingcloud/package-tree.html index 33d8533..9df63e0 100644 --- a/com/textcontrol/reportingcloud/package-tree.html +++ b/com/textcontrol/reportingcloud/package-tree.html @@ -1,152 +1,155 @@ - - - - - -com.textcontrol.reportingcloud Class Hierarchy (reportingcloud 1.0 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Hierarchy For Package com.textcontrol.reportingcloud

-Package Hierarchies: - -
-
-

Class Hierarchy

- -

Enum Hierarchy

-
    -
  • java.lang.Object -
      -
    • java.lang.Enum<E> (implements java.lang.Comparable<T>, java.io.Serializable) - -
      • -
    -
    • -
-
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- - - + + + + + +com.textcontrol.reportingcloud Class Hierarchy (reportingcloud 1.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Hierarchy For Package com.textcontrol.reportingcloud

+Package Hierarchies: + +
+
+

Class Hierarchy

+ +

Enum Hierarchy

+
    +
  • java.lang.Object +
      +
    • java.lang.Enum<E> (implements java.lang.Comparable<T>, java.io.Serializable) + +
      • +
    +
    • +
+
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/constant-values.html b/constant-values.html index fe81cfe..6517a2c 100644 --- a/constant-values.html +++ b/constant-values.html @@ -1,122 +1,122 @@ - - - - - -Constant Field Values (reportingcloud 1.0 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
-
    -
  • Prev
    • -
  • Next
    • -
- - -
- -
- - -
- -
-

Constant Field Values

-

Contents

-
- -
- - -
Skip navigation links
- - - - -
-
-
    -
  • Prev
    • -
  • Next
    • -
- - -
- -
- - -
- - - + + + + + +Constant Field Values (reportingcloud 1.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+
    +
  • Prev
    • +
  • Next
    • +
+ + +
+ +
+ + +
+ +
+

Constant Field Values

+

Contents

+
+ +
+ + +
Skip navigation links
+ + + + +
+
+
    +
  • Prev
    • +
  • Next
    • +
+ + +
+ +
+ + +
+ + + diff --git a/deprecated-list.html b/deprecated-list.html index b2c4760..96377a8 100644 --- a/deprecated-list.html +++ b/deprecated-list.html @@ -1,122 +1,122 @@ - - - - - -Deprecated List (reportingcloud 1.0 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
-
    -
  • Prev
    • -
  • Next
    • -
- - -
- -
- - -
- -
-

Deprecated API

-

Contents

-
- -
- - -
Skip navigation links
- - - - -
-
-
    -
  • Prev
    • -
  • Next
    • -
- - -
- -
- - -
- - - + + + + + +Deprecated List (reportingcloud 1.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+
    +
  • Prev
    • +
  • Next
    • +
+ + +
+ +
+ + +
+ +
+

Deprecated API

+

Contents

+
+ +
+ + +
Skip navigation links
+ + + + +
+
+
    +
  • Prev
    • +
  • Next
    • +
+ + +
+ +
+ + +
+ + + diff --git a/help-doc.html b/help-doc.html index 606c6a9..9677996 100644 --- a/help-doc.html +++ b/help-doc.html @@ -1,223 +1,223 @@ - - - - - -API Help (reportingcloud 1.0 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
-
    -
  • Prev
    • -
  • Next
    • -
- - -
- -
- - -
- -
-

How This API Document Is Organized

-
This API (Application Programming Interface) document has pages corresponding to the items in the navigation bar, described as follows.
-
-
-
    -
  • -

    Overview

    -

    The Overview page is the front page of this API document and provides a list of all packages with a summary for each. This page can also contain an overall description of the set of packages.

    -
    • -
  • -

    Package

    -

    Each package has a page that contains a list of its classes and interfaces, with a summary for each. This page can contain six categories:

    -
      -
    • Interfaces (italic)
      • -
    • Classes
      • -
    • Enums
      • -
    • Exceptions
      • -
    • Errors
      • -
    • Annotation Types
      • -
    -
    • -
  • -

    Class/Interface

    -

    Each class, interface, nested class and nested interface has its own separate page. Each of these pages has three sections consisting of a class/interface description, summary tables, and detailed member descriptions:

    -
      -
    • Class inheritance diagram
      • -
    • Direct Subclasses
      • -
    • All Known Subinterfaces
      • -
    • All Known Implementing Classes
      • -
    • Class/interface declaration
      • -
    • Class/interface description
      • -
    -
      -
    • Nested Class Summary
      • -
    • Field Summary
      • -
    • Constructor Summary
      • -
    • Method Summary
      • -
    -
      -
    • Field Detail
      • -
    • Constructor Detail
      • -
    • Method Detail
      • -
    -

    Each summary entry contains the first sentence from the detailed description for that item. The summary entries are alphabetical, while the detailed descriptions are in the order they appear in the source code. This preserves the logical groupings established by the programmer.

    -
    • -
  • -

    Annotation Type

    -

    Each annotation type has its own separate page with the following sections:

    -
      -
    • Annotation Type declaration
      • -
    • Annotation Type description
      • -
    • Required Element Summary
      • -
    • Optional Element Summary
      • -
    • Element Detail
      • -
    -
    • -
  • -

    Enum

    -

    Each enum has its own separate page with the following sections:

    -
      -
    • Enum declaration
      • -
    • Enum description
      • -
    • Enum Constant Summary
      • -
    • Enum Constant Detail
      • -
    -
    • -
  • -

    Tree (Class Hierarchy)

    -

    There is a Class Hierarchy page for all packages, plus a hierarchy for each package. Each hierarchy page contains a list of classes and a list of interfaces. The classes are organized by inheritance structure starting with java.lang.Object. The interfaces do not inherit from java.lang.Object.

    -
      -
    • When viewing the Overview page, clicking on "Tree" displays the hierarchy for all packages.
      • -
    • When viewing a particular package, class or interface page, clicking "Tree" displays the hierarchy for only that package.
      • -
    -
    • -
  • -

    Deprecated API

    -

    The Deprecated API page lists all of the API that have been deprecated. A deprecated API is not recommended for use, generally due to improvements, and a replacement API is usually given. Deprecated APIs may be removed in future implementations.

    -
    • -
  • -

    Index

    -

    The Index contains an alphabetic list of all classes, interfaces, constructors, methods, and fields.

    -
    • -
  • -

    Prev/Next

    -

    These links take you to the next or previous class, interface, package, or related page.

    -
    • -
  • -

    Frames/No Frames

    -

    These links show and hide the HTML frames. All pages are available with or without frames.

    -
    • -
  • -

    All Classes

    -

    The All Classes link shows all classes and interfaces except non-static nested types.

    -
    • -
  • -

    Serialized Form

    -

    Each serializable or externalizable class has a description of its serialization fields and methods. This information is of interest to re-implementors, not to developers using the API. While there is no link in the navigation bar, you can get to this information by going to any serialized class and clicking "Serialized Form" in the "See also" section of the class description.

    -
    • -
  • -

    Constant Field Values

    -

    The Constant Field Values page lists the static final fields and their values.

    -
    • -
-This help file applies to API documentation generated using the standard doclet.
- -
- - -
Skip navigation links
- - - - -
-
-
    -
  • Prev
    • -
  • Next
    • -
- - -
- -
- - -
- - - + + + + + +API Help (reportingcloud 1.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+
    +
  • Prev
    • +
  • Next
    • +
+ + +
+ +
+ + +
+ +
+

How This API Document Is Organized

+
This API (Application Programming Interface) document has pages corresponding to the items in the navigation bar, described as follows.
+
+
+
    +
  • +

    Overview

    +

    The Overview page is the front page of this API document and provides a list of all packages with a summary for each. This page can also contain an overall description of the set of packages.

    +
    • +
  • +

    Package

    +

    Each package has a page that contains a list of its classes and interfaces, with a summary for each. This page can contain six categories:

    +
      +
    • Interfaces (italic)
      • +
    • Classes
      • +
    • Enums
      • +
    • Exceptions
      • +
    • Errors
      • +
    • Annotation Types
      • +
    +
    • +
  • +

    Class/Interface

    +

    Each class, interface, nested class and nested interface has its own separate page. Each of these pages has three sections consisting of a class/interface description, summary tables, and detailed member descriptions:

    +
      +
    • Class inheritance diagram
      • +
    • Direct Subclasses
      • +
    • All Known Subinterfaces
      • +
    • All Known Implementing Classes
      • +
    • Class/interface declaration
      • +
    • Class/interface description
      • +
    +
      +
    • Nested Class Summary
      • +
    • Field Summary
      • +
    • Constructor Summary
      • +
    • Method Summary
      • +
    +
      +
    • Field Detail
      • +
    • Constructor Detail
      • +
    • Method Detail
      • +
    +

    Each summary entry contains the first sentence from the detailed description for that item. The summary entries are alphabetical, while the detailed descriptions are in the order they appear in the source code. This preserves the logical groupings established by the programmer.

    +
    • +
  • +

    Annotation Type

    +

    Each annotation type has its own separate page with the following sections:

    +
      +
    • Annotation Type declaration
      • +
    • Annotation Type description
      • +
    • Required Element Summary
      • +
    • Optional Element Summary
      • +
    • Element Detail
      • +
    +
    • +
  • +

    Enum

    +

    Each enum has its own separate page with the following sections:

    +
      +
    • Enum declaration
      • +
    • Enum description
      • +
    • Enum Constant Summary
      • +
    • Enum Constant Detail
      • +
    +
    • +
  • +

    Tree (Class Hierarchy)

    +

    There is a Class Hierarchy page for all packages, plus a hierarchy for each package. Each hierarchy page contains a list of classes and a list of interfaces. The classes are organized by inheritance structure starting with java.lang.Object. The interfaces do not inherit from java.lang.Object.

    +
      +
    • When viewing the Overview page, clicking on "Tree" displays the hierarchy for all packages.
      • +
    • When viewing a particular package, class or interface page, clicking "Tree" displays the hierarchy for only that package.
      • +
    +
    • +
  • +

    Deprecated API

    +

    The Deprecated API page lists all of the API that have been deprecated. A deprecated API is not recommended for use, generally due to improvements, and a replacement API is usually given. Deprecated APIs may be removed in future implementations.

    +
    • +
  • +

    Index

    +

    The Index contains an alphabetic list of all classes, interfaces, constructors, methods, and fields.

    +
    • +
  • +

    Prev/Next

    +

    These links take you to the next or previous class, interface, package, or related page.

    +
    • +
  • +

    Frames/No Frames

    +

    These links show and hide the HTML frames. All pages are available with or without frames.

    +
    • +
  • +

    All Classes

    +

    The All Classes link shows all classes and interfaces except non-static nested types.

    +
    • +
  • +

    Serialized Form

    +

    Each serializable or externalizable class has a description of its serialization fields and methods. This information is of interest to re-implementors, not to developers using the API. While there is no link in the navigation bar, you can get to this information by going to any serialized class and clicking "Serialized Form" in the "See also" section of the class description.

    +
    • +
  • +

    Constant Field Values

    +

    The Constant Field Values page lists the static final fields and their values.

    +
    • +
+This help file applies to API documentation generated using the standard doclet.
+ +
+ + +
Skip navigation links
+ + + + +
+
+
    +
  • Prev
    • +
  • Next
    • +
+ + +
+ +
+ + +
+ + + diff --git a/index-all.html b/index-all.html index 900bf8c..ee688a5 100644 --- a/index-all.html +++ b/index-all.html @@ -1,544 +1,642 @@ - - - - - -Index (reportingcloud 1.0 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
-
    -
  • Prev
    • -
  • Next
    • -
- - -
- -
- - -
- -
A C D G I L M R S T U V  - - -

A

-
-
AccountSettings - Class in com.textcontrol.reportingcloud
-
-
Represents ReportingCloud account settings.
-
-
AccountSettings(String, int, int, int, int, String) - Constructor for class com.textcontrol.reportingcloud.AccountSettings
-
 
-
AccountSettingsDeserializer - Class in com.textcontrol.reportingcloud.gson
-
-
Needed by GSON to create AccountSettings objects from JSON data.
-
-
AccountSettingsDeserializer() - Constructor for class com.textcontrol.reportingcloud.gson.AccountSettingsDeserializer
-
 
-
- - - -

C

-
-
com.textcontrol.reportingcloud - package com.textcontrol.reportingcloud
-
-
Contains classes and enumerations of the Text Control ReportingCloud Java wrapper.
-
-
com.textcontrol.reportingcloud.gson - package com.textcontrol.reportingcloud.gson
-
-
Contains GSON serializer and deserializer implementations.
-
-
convertDocument(byte[], ReturnFormat) - Method in class com.textcontrol.reportingcloud.ReportingCloud
-
-
Converts a document to another format.
-
-
- - - -

D

-
-
deleteTemplate(String) - Method in class com.textcontrol.reportingcloud.ReportingCloud
-
-
Deletes a template from the template storage.
-
-
deserialize(JsonElement, Type, JsonDeserializationContext) - Method in class com.textcontrol.reportingcloud.gson.AccountSettingsDeserializer
-
 
-
deserialize(JsonElement, Type, JsonDeserializationContext) - Method in class com.textcontrol.reportingcloud.gson.TemplateDeserializer
-
 
-
downloadTemplate(String) - Method in class com.textcontrol.reportingcloud.ReportingCloud
-
-
Returns the selected template from the storage.
-
-
- - - -

G

-
-
getAccountSettings() - Method in class com.textcontrol.reportingcloud.ReportingCloud
-
-
Gets the current user's account settings.
-
-
getAuthor() - Method in class com.textcontrol.reportingcloud.MergeSettings
-
-
Gets the document's author.
-
-
getCreatedDocuments() - Method in class com.textcontrol.reportingcloud.AccountSettings
-
-
Gets the number of created documents in the current month.
-
-
getCreationDate() - Method in class com.textcontrol.reportingcloud.MergeSettings
-
-
Gets the creation date.
-
-
getCreatorApplication() - Method in class com.textcontrol.reportingcloud.MergeSettings
-
-
Gets the application which created the document.
-
-
getDocumentSubject() - Method in class com.textcontrol.reportingcloud.MergeSettings
-
-
Gets the document's subject.
-
-
getdocumentTitle() - Method in class com.textcontrol.reportingcloud.MergeSettings
-
-
Gets the document's title.
-
-
getLastModificationDate() - Method in class com.textcontrol.reportingcloud.MergeSettings
-
-
Gets the last modification date.
-
-
getMaxDocuments() - Method in class com.textcontrol.reportingcloud.AccountSettings
-
-
Gets the maximum number of documents that can be created per month.
-
-
getMaxTemplates() - Method in class com.textcontrol.reportingcloud.AccountSettings
-
-
Gets the maximum number of templates that can be uploaded to the template storage.
-
-
getMergeData() - Method in class com.textcontrol.reportingcloud.MergeBody
-
-
Gets the merge data.
-
-
getMergeSettings() - Method in class com.textcontrol.reportingcloud.MergeBody
-
-
Gets the merge settings to specify merge properties and document properties such - as title and author.
-
-
getModified() - Method in class com.textcontrol.reportingcloud.Template
-
-
Gets the date and time the template file was last modified
-
-
getRemoveEmptyBlocks() - Method in class com.textcontrol.reportingcloud.MergeSettings
-
-
Gets whether the content of empty merge blocks should be removed from the template - or not.
-
-
getRemoveEmptyFields() - Method in class com.textcontrol.reportingcloud.MergeSettings
-
-
Gets whether empty fields should be removed from the template or not.
-
-
getRemoveEmptyImages() - Method in class com.textcontrol.reportingcloud.MergeSettings
-
-
Gets whether images which don't have merge data should be removed from - the template or not.
-
-
getRemoveTrailingWhitespace() - Method in class com.textcontrol.reportingcloud.MergeSettings
-
-
Gets whether trailing whitespace should be removed before saving a document.
-
-
getSerialNumber() - Method in class com.textcontrol.reportingcloud.AccountSettings
-
-
Gets the serial number that is attached to the - account.
-
-
getSize() - Method in class com.textcontrol.reportingcloud.Template
-
-
Gets the size of the template file in bytes.
-
-
getTemplate() - Method in class com.textcontrol.reportingcloud.MergeBody
-
-
Gets the binary template document data.
-
-
getTemplateCount() - Method in class com.textcontrol.reportingcloud.ReportingCloud
-
-
Returns the number of templates in the template storage.
-
-
getTemplateName() - Method in class com.textcontrol.reportingcloud.Template
-
-
Gets the template file name.
-
-
getTemplatePageCount(String) - Method in class com.textcontrol.reportingcloud.ReportingCloud
-
-
Returns the number of pages of a template in the template storage.
-
-
getTemplateThumbnails(String, int) - Method in class com.textcontrol.reportingcloud.ReportingCloud
-
-
Returns a list of thumbnails of a specific template.
-
-
getTemplateThumbnails(String, int, int) - Method in class com.textcontrol.reportingcloud.ReportingCloud
-
-
Returns a list of thumbnails of a specific template.
-
-
getTemplateThumbnails(String, int, int, int) - Method in class com.textcontrol.reportingcloud.ReportingCloud
-
-
Returns a list of thumbnails of a specific template.
-
-
getTemplateThumbnails(String, int, int, int, ImageFormat) - Method in class com.textcontrol.reportingcloud.ReportingCloud
-
-
Returns a list of thumbnails of a specific template.
-
-
getUploadedTemplates() - Method in class com.textcontrol.reportingcloud.AccountSettings
-
-
Gets the number of uploaded templates to the template storage.
-
-
getUserPassword() - Method in class com.textcontrol.reportingcloud.MergeSettings
-
-
Gets the password needed to open the document.
-
-
getValidUntil() - Method in class com.textcontrol.reportingcloud.AccountSettings
-
-
Gets the date until the current subscription is valid.
-
-
- - - -

I

-
-
ImageFormat - Enum in com.textcontrol.reportingcloud
-
-
This enum lists all possible image formats for the thumbnails
-
-
- - - -

L

-
-
listTemplates() - Method in class com.textcontrol.reportingcloud.ReportingCloud
-
-
Lists all templates from the template storage.
-
-
- - - -

M

-
-
MergeBody - Class in com.textcontrol.reportingcloud
-
-
Used to pass data to the merge method.
-
-
MergeBody(Iterable<Object>) - Constructor for class com.textcontrol.reportingcloud.MergeBody
-
 
-
MergeBody(Object[]) - Constructor for class com.textcontrol.reportingcloud.MergeBody
-
 
-
MergeBody(Iterable<Object>, MergeSettings) - Constructor for class com.textcontrol.reportingcloud.MergeBody
-
 
-
MergeBody(Object[], MergeSettings) - Constructor for class com.textcontrol.reportingcloud.MergeBody
-
 
-
MergeBody(Iterable<Object>, MergeSettings, byte[]) - Constructor for class com.textcontrol.reportingcloud.MergeBody
-
 
-
MergeBody(Object[], MergeSettings, byte[]) - Constructor for class com.textcontrol.reportingcloud.MergeBody
-
 
-
MergeBodySerializer - Class in com.textcontrol.reportingcloud.gson
-
-
Needed by GSON to serialize MergeBody objects to - JSON.
-
-
MergeBodySerializer() - Constructor for class com.textcontrol.reportingcloud.gson.MergeBodySerializer
-
 
-
mergeDocument(MergeBody) - Method in class com.textcontrol.reportingcloud.ReportingCloud
-
-
Merges and returns a template from the template storage or an uploaded template with JSON data.
-
-
mergeDocument(MergeBody, String) - Method in class com.textcontrol.reportingcloud.ReportingCloud
-
-
Merges and returns a template from the template storage or an uploaded template with JSON data.
-
-
mergeDocument(MergeBody, String, ReturnFormat) - Method in class com.textcontrol.reportingcloud.ReportingCloud
-
-
Merges and returns a template from the template storage or an uploaded template with JSON data.
-
-
mergeDocument(MergeBody, String, ReturnFormat, boolean) - Method in class com.textcontrol.reportingcloud.ReportingCloud
-
-
Merges and returns a template from the template storage or an uploaded template with JSON data.
-
-
MergeSettings - Class in com.textcontrol.reportingcloud
-
-
Holds the merge settings needed by the merge method.
-
-
MergeSettings() - Constructor for class com.textcontrol.reportingcloud.MergeSettings
-
 
-
MergeSettingsSerializer - Class in com.textcontrol.reportingcloud.gson
-
-
Needed by GSON to serialize MergeSettings objects to - JSON.
-
-
MergeSettingsSerializer() - Constructor for class com.textcontrol.reportingcloud.gson.MergeSettingsSerializer
-
 
-
- - - -

R

-
-
ReportingCloud - Class in com.textcontrol.reportingcloud
-
-
The ReportingCloud API wrapper class.
-
-
ReportingCloud(String, String, String) - Constructor for class com.textcontrol.reportingcloud.ReportingCloud
-
-
Creates a new ReportingCloud wrapper instance.
-
-
ReportingCloud(String, String) - Constructor for class com.textcontrol.reportingcloud.ReportingCloud
-
-
Creates a new ReportingCloud wrapper instance with the API base URL - set to "https://api.reporting.cloud".
-
-
ReturnFormat - Enum in com.textcontrol.reportingcloud
-
-
This enum lists all possible return formats for the Merge method.
-
-
- - - -

S

-
-
serialize(MergeBody, Type, JsonSerializationContext) - Method in class com.textcontrol.reportingcloud.gson.MergeBodySerializer
-
 
-
serialize(MergeSettings, Type, JsonSerializationContext) - Method in class com.textcontrol.reportingcloud.gson.MergeSettingsSerializer
-
 
-
setAuthor(String) - Method in class com.textcontrol.reportingcloud.MergeSettings
-
-
Sets the document's author.
-
-
setCreationDate(String) - Method in class com.textcontrol.reportingcloud.MergeSettings
-
-
Sets the creation date.
-
-
setCreationDate(ZonedDateTime) - Method in class com.textcontrol.reportingcloud.MergeSettings
-
-
Sets the creation date.
-
-
setCreatorApplication(String) - Method in class com.textcontrol.reportingcloud.MergeSettings
-
-
Sets the application which created the document.
-
-
setDocumentSubject(String) - Method in class com.textcontrol.reportingcloud.MergeSettings
-
-
Sets the document's subject.
-
-
setDocumentTitle(String) - Method in class com.textcontrol.reportingcloud.MergeSettings
-
-
Sets the document's title.
-
-
setLastModificationDate(String) - Method in class com.textcontrol.reportingcloud.MergeSettings
-
-
Sets the last modification date.
-
-
setLastModificationDate(ZonedDateTime) - Method in class com.textcontrol.reportingcloud.MergeSettings
-
-
Sets the last modification date.
-
-
setMergeData(Iterable<Object>) - Method in class com.textcontrol.reportingcloud.MergeBody
-
-
Sets the merge data.
-
-
setMergeData(Object[]) - Method in class com.textcontrol.reportingcloud.MergeBody
-
-
Sets the merge data.
-
-
setMergeSettings(MergeSettings) - Method in class com.textcontrol.reportingcloud.MergeBody
-
-
Sets the merge settings to specify merge properties and document properties such - as title and author.
-
-
setRemoveEmptyBlocks(boolean) - Method in class com.textcontrol.reportingcloud.MergeSettings
-
-
Sets whether the content of empty merge blocks should be removed from the template - or not.
-
-
setRemoveEmptyFields(boolean) - Method in class com.textcontrol.reportingcloud.MergeSettings
-
-
Sets whether empty fields should be removed from the template or not.
-
-
setRemoveEmptyImages(boolean) - Method in class com.textcontrol.reportingcloud.MergeSettings
-
-
Sets whether images which don't have merge data should be removed from - the template or not.
-
-
setRemoveTrailingWhitespace(boolean) - Method in class com.textcontrol.reportingcloud.MergeSettings
-
-
Sets whether trailing whitespace should be removed before saving a document.
-
-
setTemplate(byte[]) - Method in class com.textcontrol.reportingcloud.MergeBody
-
-
Sets the binary template document data.
-
-
setUserPassword(String) - Method in class com.textcontrol.reportingcloud.MergeSettings
-
-
Sets the password needed to open the document.
-
-
- - - -

T

-
-
Template - Class in com.textcontrol.reportingcloud
-
-
Holds information about a template in the template storage.
-
-
Template(String, String, int) - Constructor for class com.textcontrol.reportingcloud.Template
-
-
Creates a new Template instance.
-
-
TemplateDeserializer - Class in com.textcontrol.reportingcloud.gson
-
-
Needed by GSON to create Template objects from JSON data.
-
-
TemplateDeserializer() - Constructor for class com.textcontrol.reportingcloud.gson.TemplateDeserializer
-
 
-
templateExists(String) - Method in class com.textcontrol.reportingcloud.ReportingCloud
-
-
Checks whether a template exists in the template storage.
-
-
- - - -

U

-
-
uploadTemplate(String, byte[]) - Method in class com.textcontrol.reportingcloud.ReportingCloud
-
-
Stores an uploaded template in the template storage (.doc, .docx, - .rtf and .tx).
-
-
- - - -

V

-
-
valueOf(String) - Static method in enum com.textcontrol.reportingcloud.ImageFormat
-
-
Returns the enum constant of this type with the specified name.
-
-
valueOf(String) - Static method in enum com.textcontrol.reportingcloud.ReturnFormat
-
-
Returns the enum constant of this type with the specified name.
-
-
values() - Static method in enum com.textcontrol.reportingcloud.ImageFormat
-
-
Returns an array containing the constants of this enum type, in -the order they are declared.
-
-
values() - Static method in enum com.textcontrol.reportingcloud.ReturnFormat
-
-
Returns an array containing the constants of this enum type, in -the order they are declared.
-
-
-A C D G I L M R S T U V 
- -
- - -
Skip navigation links
- - - - -
-
-
    -
  • Prev
    • -
  • Next
    • -
- - -
- -
- - -
- - - + + + + + +Index (reportingcloud 1.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+
    +
  • Prev
    • +
  • Next
    • +
+ + +
+ +
+ + +
+ +
A C D G I L M R S T U V  + + +

A

+
+
AccountSettings - Class in com.textcontrol.reportingcloud
+
+
Represents ReportingCloud account settings.
+
+
AccountSettings(String, int, int, int, int, String) - Constructor for class com.textcontrol.reportingcloud.AccountSettings
+
 
+
AccountSettingsDeserializer - Class in com.textcontrol.reportingcloud.gson
+
+
Needed by GSON to create AccountSettings objects from JSON data.
+
+
AccountSettingsDeserializer() - Constructor for class com.textcontrol.reportingcloud.gson.AccountSettingsDeserializer
+
 
+
+ + + +

C

+
+
com.textcontrol.reportingcloud - package com.textcontrol.reportingcloud
+
+
Contains classes and enumerations of the Text Control ReportingCloud Java wrapper.
+
+
com.textcontrol.reportingcloud.gson - package com.textcontrol.reportingcloud.gson
+
+
Contains GSON serializer and deserializer implementations.
+
+
convertDocument(byte[], ReturnFormat) - Method in class com.textcontrol.reportingcloud.ReportingCloud
+
+
Converts a document to another format.
+
+
+ + + +

D

+
+
deleteTemplate(String) - Method in class com.textcontrol.reportingcloud.ReportingCloud
+
+
Deletes a template from the template storage.
+
+
deserialize(JsonElement, Type, JsonDeserializationContext) - Method in class com.textcontrol.reportingcloud.gson.AccountSettingsDeserializer
+
 
+
deserialize(JsonElement, Type, JsonDeserializationContext) - Method in class com.textcontrol.reportingcloud.gson.MergeBlockDeserializer
+
 
+
deserialize(JsonElement, Type, JsonDeserializationContext) - Method in class com.textcontrol.reportingcloud.gson.MergeFieldDeserializer
+
 
+
deserialize(JsonElement, Type, JsonDeserializationContext) - Method in class com.textcontrol.reportingcloud.gson.TemplateDeserializer
+
 
+
deserialize(JsonElement, Type, JsonDeserializationContext) - Method in class com.textcontrol.reportingcloud.gson.TemplateInfoDeserializer
+
 
+
downloadTemplate(String) - Method in class com.textcontrol.reportingcloud.ReportingCloud
+
+
Returns the selected template from the storage.
+
+
+ + + +

G

+
+
getAccountSettings() - Method in class com.textcontrol.reportingcloud.ReportingCloud
+
+
Gets the current user's account settings.
+
+
getAuthor() - Method in class com.textcontrol.reportingcloud.MergeSettings
+
+
Gets the document's author.
+
+
getCreatedDocuments() - Method in class com.textcontrol.reportingcloud.AccountSettings
+
+
Gets the number of created documents in the current month.
+
+
getCreationDate() - Method in class com.textcontrol.reportingcloud.MergeSettings
+
+
Gets the creation date.
+
+
getCreatorApplication() - Method in class com.textcontrol.reportingcloud.MergeSettings
+
+
Gets the application which created the document.
+
+
getDateTimeFormat() - Method in class com.textcontrol.reportingcloud.MergeField
+
+
Returns the format which is applied to date / time values.
+
+
getDocumentSubject() - Method in class com.textcontrol.reportingcloud.MergeSettings
+
+
Gets the document's subject.
+
+
getdocumentTitle() - Method in class com.textcontrol.reportingcloud.MergeSettings
+
+
Gets the document's title.
+
+
getLastModificationDate() - Method in class com.textcontrol.reportingcloud.MergeSettings
+
+
Gets the last modification date.
+
+
getMaxDocuments() - Method in class com.textcontrol.reportingcloud.AccountSettings
+
+
Gets the maximum number of documents that can be created per month.
+
+
getMaxTemplates() - Method in class com.textcontrol.reportingcloud.AccountSettings
+
+
Gets the maximum number of templates that can be uploaded to the template storage.
+
+
getMergeBlocks() - Method in class com.textcontrol.reportingcloud.MergeBlock
+
+
Returns the merge blocks inside the merge block.
+
+
getMergeBlocks() - Method in class com.textcontrol.reportingcloud.TemplateInfo
+
+
Gets all top level merge blocks in the template.
+
+
getMergeData() - Method in class com.textcontrol.reportingcloud.MergeBody
+
+
Gets the merge data.
+
+
getMergeFields() - Method in class com.textcontrol.reportingcloud.MergeBlock
+
+
Returns the merge fields inside the merge block.
+
+
getMergeFields() - Method in class com.textcontrol.reportingcloud.TemplateInfo
+
+
Gets all top level merge fields in the template.
+
+
getMergeSettings() - Method in class com.textcontrol.reportingcloud.MergeBody
+
+
Gets the merge settings to specify merge properties and document properties such + as title and author.
+
+
getModified() - Method in class com.textcontrol.reportingcloud.Template
+
+
Gets the date and time the template file was last modified
+
+
getName() - Method in class com.textcontrol.reportingcloud.MergeBlock
+
+
Returns the merge block's name.
+
+
getName() - Method in class com.textcontrol.reportingcloud.MergeField
+
+
Returns the name of the field.
+
+
getNumericFormat() - Method in class com.textcontrol.reportingcloud.MergeField
+
+
Returns the format which is applied to numeric values.
+
+
getPreserveFormatting() - Method in class com.textcontrol.reportingcloud.MergeField
+
+
Returns whether formatting is preserved.
+
+
getRemoveEmptyBlocks() - Method in class com.textcontrol.reportingcloud.MergeSettings
+
+
Gets whether the content of empty merge blocks should be removed from the template + or not.
+
+
getRemoveEmptyFields() - Method in class com.textcontrol.reportingcloud.MergeSettings
+
+
Gets whether empty fields should be removed from the template or not.
+
+
getRemoveEmptyImages() - Method in class com.textcontrol.reportingcloud.MergeSettings
+
+
Gets whether images which don't have merge data should be removed from + the template or not.
+
+
getRemoveTrailingWhitespace() - Method in class com.textcontrol.reportingcloud.MergeSettings
+
+
Gets whether trailing whitespace should be removed before saving a document.
+
+
getSerialNumber() - Method in class com.textcontrol.reportingcloud.AccountSettings
+
+
Gets the serial number that is attached to the + account.
+
+
getSize() - Method in class com.textcontrol.reportingcloud.Template
+
+
Gets the size of the template file in bytes.
+
+
getTemplate() - Method in class com.textcontrol.reportingcloud.MergeBody
+
+
Gets the binary template document data.
+
+
getTemplateCount() - Method in class com.textcontrol.reportingcloud.ReportingCloud
+
+
Returns the number of templates in the template storage.
+
+
getTemplateInfo(String) - Method in class com.textcontrol.reportingcloud.ReportingCloud
+
+
Returns information about a template including merge fields and merge blocks.
+
+
getTemplateName() - Method in class com.textcontrol.reportingcloud.Template
+
+
Gets the template file name.
+
+
getTemplateName() - Method in class com.textcontrol.reportingcloud.TemplateInfo
+
+
Gets the template file name.
+
+
getTemplatePageCount(String) - Method in class com.textcontrol.reportingcloud.ReportingCloud
+
+
Returns the number of pages of a template in the template storage.
+
+
getTemplateThumbnails(String, int) - Method in class com.textcontrol.reportingcloud.ReportingCloud
+
+
Returns a list of thumbnails of a specific template.
+
+
getTemplateThumbnails(String, int, int) - Method in class com.textcontrol.reportingcloud.ReportingCloud
+
+
Returns a list of thumbnails of a specific template.
+
+
getTemplateThumbnails(String, int, int, int) - Method in class com.textcontrol.reportingcloud.ReportingCloud
+
+
Returns a list of thumbnails of a specific template.
+
+
getTemplateThumbnails(String, int, int, int, ImageFormat) - Method in class com.textcontrol.reportingcloud.ReportingCloud
+
+
Returns a list of thumbnails of a specific template.
+
+
getText() - Method in class com.textcontrol.reportingcloud.MergeField
+
+
Returns the field text.
+
+
getTextAfter() - Method in class com.textcontrol.reportingcloud.MergeField
+
+
Returns the text after the field.
+
+
getTextBefore() - Method in class com.textcontrol.reportingcloud.MergeField
+
+
Returns the text before the field.
+
+
getUploadedTemplates() - Method in class com.textcontrol.reportingcloud.AccountSettings
+
+
Gets the number of uploaded templates to the template storage.
+
+
getUserPassword() - Method in class com.textcontrol.reportingcloud.MergeSettings
+
+
Gets the password needed to open the document.
+
+
getValidUntil() - Method in class com.textcontrol.reportingcloud.AccountSettings
+
+
Gets the date until the current subscription is valid.
+
+
+ + + +

I

+
+
ImageFormat - Enum in com.textcontrol.reportingcloud
+
+
This enum lists all possible image formats for the thumbnails
+
+
+ + + +

L

+
+
listTemplates() - Method in class com.textcontrol.reportingcloud.ReportingCloud
+
+
Lists all templates from the template storage.
+
+
+ + + +

M

+
+
MergeBlock - Class in com.textcontrol.reportingcloud
+
+
Represents a merge block in a document template.
+
+
MergeBlock(String, List<MergeBlock>, List<MergeField>) - Constructor for class com.textcontrol.reportingcloud.MergeBlock
+
 
+
MergeBlockDeserializer - Class in com.textcontrol.reportingcloud.gson
+
+
Needed by GSON to create MergeBlock objects from JSON data.
+
+
MergeBlockDeserializer() - Constructor for class com.textcontrol.reportingcloud.gson.MergeBlockDeserializer
+
 
+
MergeBody - Class in com.textcontrol.reportingcloud
+
+
Used to pass data to the merge method.
+
+
MergeBody(Iterable<Object>) - Constructor for class com.textcontrol.reportingcloud.MergeBody
+
 
+
MergeBody(Object[]) - Constructor for class com.textcontrol.reportingcloud.MergeBody
+
 
+
MergeBody(Iterable<Object>, MergeSettings) - Constructor for class com.textcontrol.reportingcloud.MergeBody
+
 
+
MergeBody(Object[], MergeSettings) - Constructor for class com.textcontrol.reportingcloud.MergeBody
+
 
+
MergeBody(Iterable<Object>, MergeSettings, byte[]) - Constructor for class com.textcontrol.reportingcloud.MergeBody
+
 
+
MergeBody(Object[], MergeSettings, byte[]) - Constructor for class com.textcontrol.reportingcloud.MergeBody
+
 
+
MergeBodySerializer - Class in com.textcontrol.reportingcloud.gson
+
+
Needed by GSON to serialize MergeBody objects to + JSON.
+
+
MergeBodySerializer() - Constructor for class com.textcontrol.reportingcloud.gson.MergeBodySerializer
+
 
+
mergeDocument(MergeBody) - Method in class com.textcontrol.reportingcloud.ReportingCloud
+
+
Merges and returns a template from the template storage or an uploaded template with JSON data.
+
+
mergeDocument(MergeBody, String) - Method in class com.textcontrol.reportingcloud.ReportingCloud
+
+
Merges and returns a template from the template storage or an uploaded template with JSON data.
+
+
mergeDocument(MergeBody, String, ReturnFormat) - Method in class com.textcontrol.reportingcloud.ReportingCloud
+
+
Merges and returns a template from the template storage or an uploaded template with JSON data.
+
+
mergeDocument(MergeBody, String, ReturnFormat, boolean) - Method in class com.textcontrol.reportingcloud.ReportingCloud
+
+
Merges and returns a template from the template storage or an uploaded template with JSON data.
+
+
MergeField - Class in com.textcontrol.reportingcloud
+
+
Represents a merge field in a document template.
+
+
MergeField(String, String, String, boolean, String, String, String) - Constructor for class com.textcontrol.reportingcloud.MergeField
+
 
+
MergeFieldDeserializer - Class in com.textcontrol.reportingcloud.gson
+
+
Needed by GSON to create MergeField objects from JSON data.
+
+
MergeFieldDeserializer() - Constructor for class com.textcontrol.reportingcloud.gson.MergeFieldDeserializer
+
 
+
MergeSettings - Class in com.textcontrol.reportingcloud
+
+
Holds the merge settings needed by the merge method.
+
+
MergeSettings() - Constructor for class com.textcontrol.reportingcloud.MergeSettings
+
 
+
MergeSettingsSerializer - Class in com.textcontrol.reportingcloud.gson
+
+
Needed by GSON to serialize MergeSettings objects to + JSON.
+
+
MergeSettingsSerializer() - Constructor for class com.textcontrol.reportingcloud.gson.MergeSettingsSerializer
+
 
+
+ + + +

R

+
+
ReportingCloud - Class in com.textcontrol.reportingcloud
+
+
The ReportingCloud API wrapper class.
+
+
ReportingCloud(String, String, String) - Constructor for class com.textcontrol.reportingcloud.ReportingCloud
+
+
Creates a new ReportingCloud wrapper instance.
+
+
ReportingCloud(String, String) - Constructor for class com.textcontrol.reportingcloud.ReportingCloud
+
+
Creates a new ReportingCloud wrapper instance with the API base URL + set to "https://api.reporting.cloud".
+
+
ReturnFormat - Enum in com.textcontrol.reportingcloud
+
+
This enum lists all possible return formats for the Merge method.
+
+
+ + + +

S

+
+
serialize(MergeBody, Type, JsonSerializationContext) - Method in class com.textcontrol.reportingcloud.gson.MergeBodySerializer
+
 
+
serialize(MergeSettings, Type, JsonSerializationContext) - Method in class com.textcontrol.reportingcloud.gson.MergeSettingsSerializer
+
 
+
setAuthor(String) - Method in class com.textcontrol.reportingcloud.MergeSettings
+
+
Sets the document's author.
+
+
setCreationDate(String) - Method in class com.textcontrol.reportingcloud.MergeSettings
+
+
Sets the creation date.
+
+
setCreationDate(ZonedDateTime) - Method in class com.textcontrol.reportingcloud.MergeSettings
+
+
Sets the creation date.
+
+
setCreatorApplication(String) - Method in class com.textcontrol.reportingcloud.MergeSettings
+
+
Sets the application which created the document.
+
+
setDocumentSubject(String) - Method in class com.textcontrol.reportingcloud.MergeSettings
+
+
Sets the document's subject.
+
+
setDocumentTitle(String) - Method in class com.textcontrol.reportingcloud.MergeSettings
+
+
Sets the document's title.
+
+
setLastModificationDate(String) - Method in class com.textcontrol.reportingcloud.MergeSettings
+
+
Sets the last modification date.
+
+
setLastModificationDate(ZonedDateTime) - Method in class com.textcontrol.reportingcloud.MergeSettings
+
+
Sets the last modification date.
+
+
setMergeData(Iterable<Object>) - Method in class com.textcontrol.reportingcloud.MergeBody
+
+
Sets the merge data.
+
+
setMergeData(Object[]) - Method in class com.textcontrol.reportingcloud.MergeBody
+
+
Sets the merge data.
+
+
setMergeSettings(MergeSettings) - Method in class com.textcontrol.reportingcloud.MergeBody
+
+
Sets the merge settings to specify merge properties and document properties such + as title and author.
+
+
setRemoveEmptyBlocks(boolean) - Method in class com.textcontrol.reportingcloud.MergeSettings
+
+
Sets whether the content of empty merge blocks should be removed from the template + or not.
+
+
setRemoveEmptyFields(boolean) - Method in class com.textcontrol.reportingcloud.MergeSettings
+
+
Sets whether empty fields should be removed from the template or not.
+
+
setRemoveEmptyImages(boolean) - Method in class com.textcontrol.reportingcloud.MergeSettings
+
+
Sets whether images which don't have merge data should be removed from + the template or not.
+
+
setRemoveTrailingWhitespace(boolean) - Method in class com.textcontrol.reportingcloud.MergeSettings
+
+
Sets whether trailing whitespace should be removed before saving a document.
+
+
setTemplate(byte[]) - Method in class com.textcontrol.reportingcloud.MergeBody
+
+
Sets the binary template document data.
+
+
setUserPassword(String) - Method in class com.textcontrol.reportingcloud.MergeSettings
+
+
Sets the password needed to open the document.
+
+
+ + + +

T

+
+
Template - Class in com.textcontrol.reportingcloud
+
+
Holds information about a template in the template storage.
+
+
Template(String, String, int) - Constructor for class com.textcontrol.reportingcloud.Template
+
+
Creates a new Template instance.
+
+
TemplateDeserializer - Class in com.textcontrol.reportingcloud.gson
+
+
Needed by GSON to create Template objects from JSON data.
+
+
TemplateDeserializer() - Constructor for class com.textcontrol.reportingcloud.gson.TemplateDeserializer
+
 
+
templateExists(String) - Method in class com.textcontrol.reportingcloud.ReportingCloud
+
+
Checks whether a template exists in the template storage.
+
+
TemplateInfo - Class in com.textcontrol.reportingcloud
+
+
Holds information about the merge blocks and merge fields in a template.
+
+
TemplateInfo(String, List<MergeBlock>, List<MergeField>) - Constructor for class com.textcontrol.reportingcloud.TemplateInfo
+
 
+
TemplateInfoDeserializer - Class in com.textcontrol.reportingcloud.gson
+
+
Needed by GSON to create TemplateInfo objects from JSON data.
+
+
TemplateInfoDeserializer() - Constructor for class com.textcontrol.reportingcloud.gson.TemplateInfoDeserializer
+
 
+
+ + + +

U

+
+
uploadTemplate(String, byte[]) - Method in class com.textcontrol.reportingcloud.ReportingCloud
+
+
Stores an uploaded template in the template storage (.doc, .docx, + .rtf and .tx).
+
+
+ + + +

V

+
+
valueOf(String) - Static method in enum com.textcontrol.reportingcloud.ImageFormat
+
+
Returns the enum constant of this type with the specified name.
+
+
valueOf(String) - Static method in enum com.textcontrol.reportingcloud.ReturnFormat
+
+
Returns the enum constant of this type with the specified name.
+
+
values() - Static method in enum com.textcontrol.reportingcloud.ImageFormat
+
+
Returns an array containing the constants of this enum type, in +the order they are declared.
+
+
values() - Static method in enum com.textcontrol.reportingcloud.ReturnFormat
+
+
Returns an array containing the constants of this enum type, in +the order they are declared.
+
+
+A C D G I L M R S T U V 
+ +
+ + +
Skip navigation links
+ + + + +
+
+
    +
  • Prev
    • +
  • Next
    • +
+ + +
+ +
+ + +
+ + + diff --git a/index.html b/index.html index 64813bb..2a8fbc9 100644 --- a/index.html +++ b/index.html @@ -1,74 +1,75 @@ - - - - - -reportingcloud 1.0 API - - - - - - - - - -<noscript> -<div>JavaScript is disabled on your browser.</div> -</noscript> -<h2>Frame Alert</h2> -<p>This document is designed to be viewed using the frames feature. If you see this message, you are using a non-frame-capable web client. Link to <a href="overview-summary.html">Non-frame version</a>.</p> - - - + + + + + +reportingcloud 1.1 API + + + + + + + + + +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<h2>Frame Alert</h2> +<p>This document is designed to be viewed using the frames feature. If you see this message, you are using a non-frame-capable web client. Link to <a href="overview-summary.html">Non-frame version</a>.</p> + + + diff --git a/overview-frame.html b/overview-frame.html index 685b1cb..0dba6b2 100644 --- a/overview-frame.html +++ b/overview-frame.html @@ -1,22 +1,22 @@ - - - - - -Overview List (reportingcloud 1.0 API) - - - - - -
All Classes
-
-

Packages

- -
-

 

- - + + + + + +Overview List (reportingcloud 1.1 API) + + + + + +
All Classes
+
+

Packages

+ +
+

 

+ + diff --git a/overview-summary.html b/overview-summary.html index 1a68a4e..3076d0a 100644 --- a/overview-summary.html +++ b/overview-summary.html @@ -1,144 +1,144 @@ - - - - - -Overview (reportingcloud 1.0 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
-
    -
  • Prev
    • -
  • Next
    • -
- - -
- -
- - -
- -
-

reportingcloud 1.0 API

-
-
- - - - - - - - - - - - - - - - -
Packages 
PackageDescription
com.textcontrol.reportingcloud -
Contains classes and enumerations of the Text Control ReportingCloud Java wrapper.
-
com.textcontrol.reportingcloud.gson -
Contains GSON serializer and deserializer implementations.
-
-
- -
- - -
Skip navigation links
- - - - -
-
-
    -
  • Prev
    • -
  • Next
    • -
- - -
- -
- - -
- - - + + + + + +Overview (reportingcloud 1.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+
    +
  • Prev
    • +
  • Next
    • +
+ + +
+ +
+ + +
+ +
+

reportingcloud 1.1 API

+
+
+ + + + + + + + + + + + + + + + +
Packages 
PackageDescription
com.textcontrol.reportingcloud +
Contains classes and enumerations of the Text Control ReportingCloud Java wrapper.
+
com.textcontrol.reportingcloud.gson +
Contains GSON serializer and deserializer implementations.
+
+
+ +
+ + +
Skip navigation links
+ + + + +
+
+
    +
  • Prev
    • +
  • Next
    • +
+ + +
+ +
+ + +
+ + + diff --git a/overview-tree.html b/overview-tree.html index ac0ff25..c55f6d4 100644 --- a/overview-tree.html +++ b/overview-tree.html @@ -1,157 +1,163 @@ - - - - - -Class Hierarchy (reportingcloud 1.0 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
-
    -
  • Prev
    • -
  • Next
    • -
- - -
- -
- - -
- -
-

Hierarchy For All Packages

-Package Hierarchies: - -
-
-

Class Hierarchy

- -

Enum Hierarchy

-
    -
  • java.lang.Object -
      -
    • java.lang.Enum<E> (implements java.lang.Comparable<T>, java.io.Serializable) - -
      • -
    -
    • -
-
- -
- - -
Skip navigation links
- - - - -
-
-
    -
  • Prev
    • -
  • Next
    • -
- - -
- -
- - -
- - - + + + + + +Class Hierarchy (reportingcloud 1.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+
    +
  • Prev
    • +
  • Next
    • +
+ + +
+ +
+ + +
+ +
+

Hierarchy For All Packages

+Package Hierarchies: + +
+
+

Class Hierarchy

+ +

Enum Hierarchy

+
    +
  • java.lang.Object +
      +
    • java.lang.Enum<E> (implements java.lang.Comparable<T>, java.io.Serializable) + +
      • +
    +
    • +
+
+ +
+ + +
Skip navigation links
+ + + + +
+
+
    +
  • Prev
    • +
  • Next
    • +
+ + +
+ +
+ + +
+ + + diff --git a/package-list b/package-list index 503f112..38c9860 100644 --- a/package-list +++ b/package-list @@ -1,2 +1,2 @@ -com.textcontrol.reportingcloud -com.textcontrol.reportingcloud.gson +com.textcontrol.reportingcloud +com.textcontrol.reportingcloud.gson diff --git a/script.js b/script.js index b346356..c3a1cae 100644 --- a/script.js +++ b/script.js @@ -1,30 +1,30 @@ -function show(type) -{ - count = 0; - for (var key in methods) { - var row = document.getElementById(key); - if ((methods[key] & type) != 0) { - row.style.display = ''; - row.className = (count++ % 2) ? rowColor : altColor; - } - else - row.style.display = 'none'; - } - updateTabs(type); -} - -function updateTabs(type) -{ - for (var value in tabs) { - var sNode = document.getElementById(tabs[value][0]); - var spanNode = sNode.firstChild; - if (value == type) { - sNode.className = activeTableTab; - spanNode.innerHTML = tabs[value][1]; - } - else { - sNode.className = tableTab; - spanNode.innerHTML = "" + tabs[value][1] + ""; - } - } -} +function show(type) +{ + count = 0; + for (var key in methods) { + var row = document.getElementById(key); + if ((methods[key] & type) != 0) { + row.style.display = ''; + row.className = (count++ % 2) ? rowColor : altColor; + } + else + row.style.display = 'none'; + } + updateTabs(type); +} + +function updateTabs(type) +{ + for (var value in tabs) { + var sNode = document.getElementById(tabs[value][0]); + var spanNode = sNode.firstChild; + if (value == type) { + sNode.className = activeTableTab; + spanNode.innerHTML = tabs[value][1]; + } + else { + sNode.className = tableTab; + spanNode.innerHTML = "" + tabs[value][1] + ""; + } + } +} diff --git a/stylesheet.css b/stylesheet.css index 98055b2..b8dad08 100644 --- a/stylesheet.css +++ b/stylesheet.css @@ -1,574 +1,574 @@ -/* Javadoc style sheet */ -/* -Overall document style -*/ - -@import url('resources/fonts/dejavu.css'); - -body { - background-color:#ffffff; - color:#353833; - font-family:'DejaVu Sans', Arial, Helvetica, sans-serif; - font-size:14px; - margin:0; -} -a:link, a:visited { - text-decoration:none; - color:#4A6782; -} -a:hover, a:focus { - text-decoration:none; - color:#bb7a2a; -} -a:active { - text-decoration:none; - color:#4A6782; -} -a[name] { - color:#353833; -} -a[name]:hover { - text-decoration:none; - color:#353833; -} -pre { - font-family:'DejaVu Sans Mono', monospace; - font-size:14px; -} -h1 { - font-size:20px; -} -h2 { - font-size:18px; -} -h3 { - font-size:16px; - font-style:italic; -} -h4 { - font-size:13px; -} -h5 { - font-size:12px; -} -h6 { - font-size:11px; -} -ul { - list-style-type:disc; -} -code, tt { - font-family:'DejaVu Sans Mono', monospace; - font-size:14px; - padding-top:4px; - margin-top:8px; - line-height:1.4em; -} -dt code { - font-family:'DejaVu Sans Mono', monospace; - font-size:14px; - padding-top:4px; -} -table tr td dt code { - font-family:'DejaVu Sans Mono', monospace; - font-size:14px; - vertical-align:top; - padding-top:4px; -} -sup { - font-size:8px; -} -/* -Document title and Copyright styles -*/ -.clear { - clear:both; - height:0px; - overflow:hidden; -} -.aboutLanguage { - float:right; - padding:0px 21px; - font-size:11px; - z-index:200; - margin-top:-9px; -} -.legalCopy { - margin-left:.5em; -} -.bar a, .bar a:link, .bar a:visited, .bar a:active { - color:#FFFFFF; - text-decoration:none; -} -.bar a:hover, .bar a:focus { - color:#bb7a2a; -} -.tab { - background-color:#0066FF; - color:#ffffff; - padding:8px; - width:5em; - font-weight:bold; -} -/* -Navigation bar styles -*/ -.bar { - background-color:#4D7A97; - color:#FFFFFF; - padding:.8em .5em .4em .8em; - height:auto;/*height:1.8em;*/ - font-size:11px; - margin:0; -} -.topNav { - background-color:#4D7A97; - color:#FFFFFF; - float:left; - padding:0; - width:100%; - clear:right; - height:2.8em; - padding-top:10px; - overflow:hidden; - font-size:12px; -} -.bottomNav { - margin-top:10px; - background-color:#4D7A97; - color:#FFFFFF; - float:left; - padding:0; - width:100%; - clear:right; - height:2.8em; - padding-top:10px; - overflow:hidden; - font-size:12px; -} -.subNav { - background-color:#dee3e9; - float:left; - width:100%; - overflow:hidden; - font-size:12px; -} -.subNav div { - clear:left; - float:left; - padding:0 0 5px 6px; - text-transform:uppercase; -} -ul.navList, ul.subNavList { - float:left; - margin:0 25px 0 0; - padding:0; -} -ul.navList li{ - list-style:none; - float:left; - padding: 5px 6px; - text-transform:uppercase; -} -ul.subNavList li{ - list-style:none; - float:left; -} -.topNav a:link, .topNav a:active, .topNav a:visited, .bottomNav a:link, .bottomNav a:active, .bottomNav a:visited { - color:#FFFFFF; - text-decoration:none; - text-transform:uppercase; -} -.topNav a:hover, .bottomNav a:hover { - text-decoration:none; - color:#bb7a2a; - text-transform:uppercase; -} -.navBarCell1Rev { - background-color:#F8981D; - color:#253441; - margin: auto 5px; -} -.skipNav { - position:absolute; - top:auto; - left:-9999px; - overflow:hidden; -} -/* -Page header and footer styles -*/ -.header, .footer { - clear:both; - margin:0 20px; - padding:5px 0 0 0; -} -.indexHeader { - margin:10px; - position:relative; -} -.indexHeader span{ - margin-right:15px; -} -.indexHeader h1 { - font-size:13px; -} -.title { - color:#2c4557; - margin:10px 0; -} -.subTitle { - margin:5px 0 0 0; -} -.header ul { - margin:0 0 15px 0; - padding:0; -} -.footer ul { - margin:20px 0 5px 0; -} -.header ul li, .footer ul li { - list-style:none; - font-size:13px; -} -/* -Heading styles -*/ -div.details ul.blockList ul.blockList ul.blockList li.blockList h4, div.details ul.blockList ul.blockList ul.blockListLast li.blockList h4 { - background-color:#dee3e9; - border:1px solid #d0d9e0; - margin:0 0 6px -8px; - padding:7px 5px; -} -ul.blockList ul.blockList ul.blockList li.blockList h3 { - background-color:#dee3e9; - border:1px solid #d0d9e0; - margin:0 0 6px -8px; - padding:7px 5px; -} -ul.blockList ul.blockList li.blockList h3 { - padding:0; - margin:15px 0; -} -ul.blockList li.blockList h2 { - padding:0px 0 20px 0; -} -/* -Page layout container styles -*/ -.contentContainer, .sourceContainer, .classUseContainer, .serializedFormContainer, .constantValuesContainer { - clear:both; - padding:10px 20px; - position:relative; -} -.indexContainer { - margin:10px; - position:relative; - font-size:12px; -} -.indexContainer h2 { - font-size:13px; - padding:0 0 3px 0; -} -.indexContainer ul { - margin:0; - padding:0; -} -.indexContainer ul li { - list-style:none; - padding-top:2px; -} -.contentContainer .description dl dt, .contentContainer .details dl dt, .serializedFormContainer dl dt { - font-size:12px; - font-weight:bold; - margin:10px 0 0 0; - color:#4E4E4E; -} -.contentContainer .description dl dd, .contentContainer .details dl dd, .serializedFormContainer dl dd { - margin:5px 0 10px 0px; - font-size:14px; - font-family:'DejaVu Sans Mono',monospace; -} -.serializedFormContainer dl.nameValue dt { - margin-left:1px; - font-size:1.1em; - display:inline; - font-weight:bold; -} -.serializedFormContainer dl.nameValue dd { - margin:0 0 0 1px; - font-size:1.1em; - display:inline; -} -/* -List styles -*/ -ul.horizontal li { - display:inline; - font-size:0.9em; -} -ul.inheritance { - margin:0; - padding:0; -} -ul.inheritance li { - display:inline; - list-style:none; -} -ul.inheritance li ul.inheritance { - margin-left:15px; - padding-left:15px; - padding-top:1px; -} -ul.blockList, ul.blockListLast { - margin:10px 0 10px 0; - padding:0; -} -ul.blockList li.blockList, ul.blockListLast li.blockList { - list-style:none; - margin-bottom:15px; - line-height:1.4; -} -ul.blockList ul.blockList li.blockList, ul.blockList ul.blockListLast li.blockList { - padding:0px 20px 5px 10px; - border:1px solid #ededed; - background-color:#f8f8f8; -} -ul.blockList ul.blockList ul.blockList li.blockList, ul.blockList ul.blockList ul.blockListLast li.blockList { - padding:0 0 5px 8px; - background-color:#ffffff; - border:none; -} -ul.blockList ul.blockList ul.blockList ul.blockList li.blockList { - margin-left:0; - padding-left:0; - padding-bottom:15px; - border:none; -} -ul.blockList ul.blockList ul.blockList ul.blockList li.blockListLast { - list-style:none; - border-bottom:none; - padding-bottom:0; -} -table tr td dl, table tr td dl dt, table tr td dl dd { - margin-top:0; - margin-bottom:1px; -} -/* -Table styles -*/ -.overviewSummary, .memberSummary, .typeSummary, .useSummary, .constantsSummary, .deprecatedSummary { - width:100%; - border-left:1px solid #EEE; - border-right:1px solid #EEE; - border-bottom:1px solid #EEE; -} -.overviewSummary, .memberSummary { - padding:0px; -} -.overviewSummary caption, .memberSummary caption, .typeSummary caption, -.useSummary caption, .constantsSummary caption, .deprecatedSummary caption { - position:relative; - text-align:left; - background-repeat:no-repeat; - color:#253441; - font-weight:bold; - clear:none; - overflow:hidden; - padding:0px; - padding-top:10px; - padding-left:1px; - margin:0px; - white-space:pre; -} -.overviewSummary caption a:link, .memberSummary caption a:link, .typeSummary caption a:link, -.useSummary caption a:link, .constantsSummary caption a:link, .deprecatedSummary caption a:link, -.overviewSummary caption a:hover, .memberSummary caption a:hover, .typeSummary caption a:hover, -.useSummary caption a:hover, .constantsSummary caption a:hover, .deprecatedSummary caption a:hover, -.overviewSummary caption a:active, .memberSummary caption a:active, .typeSummary caption a:active, -.useSummary caption a:active, .constantsSummary caption a:active, .deprecatedSummary caption a:active, -.overviewSummary caption a:visited, .memberSummary caption a:visited, .typeSummary caption a:visited, -.useSummary caption a:visited, .constantsSummary caption a:visited, .deprecatedSummary caption a:visited { - color:#FFFFFF; -} -.overviewSummary caption span, .memberSummary caption span, .typeSummary caption span, -.useSummary caption span, .constantsSummary caption span, .deprecatedSummary caption span { - white-space:nowrap; - padding-top:5px; - padding-left:12px; - padding-right:12px; - padding-bottom:7px; - display:inline-block; - float:left; - background-color:#F8981D; - border: none; - height:16px; -} -.memberSummary caption span.activeTableTab span { - white-space:nowrap; - padding-top:5px; - padding-left:12px; - padding-right:12px; - margin-right:3px; - display:inline-block; - float:left; - background-color:#F8981D; - height:16px; -} -.memberSummary caption span.tableTab span { - white-space:nowrap; - padding-top:5px; - padding-left:12px; - padding-right:12px; - margin-right:3px; - display:inline-block; - float:left; - background-color:#4D7A97; - height:16px; -} -.memberSummary caption span.tableTab, .memberSummary caption span.activeTableTab { - padding-top:0px; - padding-left:0px; - padding-right:0px; - background-image:none; - float:none; - display:inline; -} -.overviewSummary .tabEnd, .memberSummary .tabEnd, .typeSummary .tabEnd, -.useSummary .tabEnd, .constantsSummary .tabEnd, .deprecatedSummary .tabEnd { - display:none; - width:5px; - position:relative; - float:left; - background-color:#F8981D; -} -.memberSummary .activeTableTab .tabEnd { - display:none; - width:5px; - margin-right:3px; - position:relative; - float:left; - background-color:#F8981D; -} -.memberSummary .tableTab .tabEnd { - display:none; - width:5px; - margin-right:3px; - position:relative; - background-color:#4D7A97; - float:left; - -} -.overviewSummary td, .memberSummary td, .typeSummary td, -.useSummary td, .constantsSummary td, .deprecatedSummary td { - text-align:left; - padding:0px 0px 12px 10px; -} -th.colOne, th.colFirst, th.colLast, .useSummary th, .constantsSummary th, -td.colOne, td.colFirst, td.colLast, .useSummary td, .constantsSummary td{ - vertical-align:top; - padding-right:0px; - padding-top:8px; - padding-bottom:3px; -} -th.colFirst, th.colLast, th.colOne, .constantsSummary th { - background:#dee3e9; - text-align:left; - padding:8px 3px 3px 7px; -} -td.colFirst, th.colFirst { - white-space:nowrap; - font-size:13px; -} -td.colLast, th.colLast { - font-size:13px; -} -td.colOne, th.colOne { - font-size:13px; -} -.overviewSummary td.colFirst, .overviewSummary th.colFirst, -.useSummary td.colFirst, .useSummary th.colFirst, -.overviewSummary td.colOne, .overviewSummary th.colOne, -.memberSummary td.colFirst, .memberSummary th.colFirst, -.memberSummary td.colOne, .memberSummary th.colOne, -.typeSummary td.colFirst{ - width:25%; - vertical-align:top; -} -td.colOne a:link, td.colOne a:active, td.colOne a:visited, td.colOne a:hover, td.colFirst a:link, td.colFirst a:active, td.colFirst a:visited, td.colFirst a:hover, td.colLast a:link, td.colLast a:active, td.colLast a:visited, td.colLast a:hover, .constantValuesContainer td a:link, .constantValuesContainer td a:active, .constantValuesContainer td a:visited, .constantValuesContainer td a:hover { - font-weight:bold; -} -.tableSubHeadingColor { - background-color:#EEEEFF; -} -.altColor { - background-color:#FFFFFF; -} -.rowColor { - background-color:#EEEEEF; -} -/* -Content styles -*/ -.description pre { - margin-top:0; -} -.deprecatedContent { - margin:0; - padding:10px 0; -} -.docSummary { - padding:0; -} - -ul.blockList ul.blockList ul.blockList li.blockList h3 { - font-style:normal; -} - -div.block { - font-size:14px; - font-family:'DejaVu Serif', Georgia, "Times New Roman", Times, serif; -} - -td.colLast div { - padding-top:0px; -} - - -td.colLast a { - padding-bottom:3px; -} -/* -Formatting effect styles -*/ -.sourceLineNo { - color:green; - padding:0 30px 0 0; -} -h1.hidden { - visibility:hidden; - overflow:hidden; - font-size:10px; -} -.block { - display:block; - margin:3px 10px 2px 0px; - color:#474747; -} -.deprecatedLabel, .descfrmTypeLabel, .memberNameLabel, .memberNameLink, -.overrideSpecifyLabel, .packageHierarchyLabel, .paramLabel, .returnLabel, -.seeLabel, .simpleTagLabel, .throwsLabel, .typeNameLabel, .typeNameLink { - font-weight:bold; -} -.deprecationComment, .emphasizedPhrase, .interfaceName { - font-style:italic; -} - -div.block div.block span.deprecationComment, div.block div.block span.emphasizedPhrase, -div.block div.block span.interfaceName { - font-style:normal; -} - -div.contentContainer ul.blockList li.blockList h2{ - padding-bottom:0px; -} +/* Javadoc style sheet */ +/* +Overall document style +*/ + +@import url('resources/fonts/dejavu.css'); + +body { + background-color:#ffffff; + color:#353833; + font-family:'DejaVu Sans', Arial, Helvetica, sans-serif; + font-size:14px; + margin:0; +} +a:link, a:visited { + text-decoration:none; + color:#4A6782; +} +a:hover, a:focus { + text-decoration:none; + color:#bb7a2a; +} +a:active { + text-decoration:none; + color:#4A6782; +} +a[name] { + color:#353833; +} +a[name]:hover { + text-decoration:none; + color:#353833; +} +pre { + font-family:'DejaVu Sans Mono', monospace; + font-size:14px; +} +h1 { + font-size:20px; +} +h2 { + font-size:18px; +} +h3 { + font-size:16px; + font-style:italic; +} +h4 { + font-size:13px; +} +h5 { + font-size:12px; +} +h6 { + font-size:11px; +} +ul { + list-style-type:disc; +} +code, tt { + font-family:'DejaVu Sans Mono', monospace; + font-size:14px; + padding-top:4px; + margin-top:8px; + line-height:1.4em; +} +dt code { + font-family:'DejaVu Sans Mono', monospace; + font-size:14px; + padding-top:4px; +} +table tr td dt code { + font-family:'DejaVu Sans Mono', monospace; + font-size:14px; + vertical-align:top; + padding-top:4px; +} +sup { + font-size:8px; +} +/* +Document title and Copyright styles +*/ +.clear { + clear:both; + height:0px; + overflow:hidden; +} +.aboutLanguage { + float:right; + padding:0px 21px; + font-size:11px; + z-index:200; + margin-top:-9px; +} +.legalCopy { + margin-left:.5em; +} +.bar a, .bar a:link, .bar a:visited, .bar a:active { + color:#FFFFFF; + text-decoration:none; +} +.bar a:hover, .bar a:focus { + color:#bb7a2a; +} +.tab { + background-color:#0066FF; + color:#ffffff; + padding:8px; + width:5em; + font-weight:bold; +} +/* +Navigation bar styles +*/ +.bar { + background-color:#4D7A97; + color:#FFFFFF; + padding:.8em .5em .4em .8em; + height:auto;/*height:1.8em;*/ + font-size:11px; + margin:0; +} +.topNav { + background-color:#4D7A97; + color:#FFFFFF; + float:left; + padding:0; + width:100%; + clear:right; + height:2.8em; + padding-top:10px; + overflow:hidden; + font-size:12px; +} +.bottomNav { + margin-top:10px; + background-color:#4D7A97; + color:#FFFFFF; + float:left; + padding:0; + width:100%; + clear:right; + height:2.8em; + padding-top:10px; + overflow:hidden; + font-size:12px; +} +.subNav { + background-color:#dee3e9; + float:left; + width:100%; + overflow:hidden; + font-size:12px; +} +.subNav div { + clear:left; + float:left; + padding:0 0 5px 6px; + text-transform:uppercase; +} +ul.navList, ul.subNavList { + float:left; + margin:0 25px 0 0; + padding:0; +} +ul.navList li{ + list-style:none; + float:left; + padding: 5px 6px; + text-transform:uppercase; +} +ul.subNavList li{ + list-style:none; + float:left; +} +.topNav a:link, .topNav a:active, .topNav a:visited, .bottomNav a:link, .bottomNav a:active, .bottomNav a:visited { + color:#FFFFFF; + text-decoration:none; + text-transform:uppercase; +} +.topNav a:hover, .bottomNav a:hover { + text-decoration:none; + color:#bb7a2a; + text-transform:uppercase; +} +.navBarCell1Rev { + background-color:#F8981D; + color:#253441; + margin: auto 5px; +} +.skipNav { + position:absolute; + top:auto; + left:-9999px; + overflow:hidden; +} +/* +Page header and footer styles +*/ +.header, .footer { + clear:both; + margin:0 20px; + padding:5px 0 0 0; +} +.indexHeader { + margin:10px; + position:relative; +} +.indexHeader span{ + margin-right:15px; +} +.indexHeader h1 { + font-size:13px; +} +.title { + color:#2c4557; + margin:10px 0; +} +.subTitle { + margin:5px 0 0 0; +} +.header ul { + margin:0 0 15px 0; + padding:0; +} +.footer ul { + margin:20px 0 5px 0; +} +.header ul li, .footer ul li { + list-style:none; + font-size:13px; +} +/* +Heading styles +*/ +div.details ul.blockList ul.blockList ul.blockList li.blockList h4, div.details ul.blockList ul.blockList ul.blockListLast li.blockList h4 { + background-color:#dee3e9; + border:1px solid #d0d9e0; + margin:0 0 6px -8px; + padding:7px 5px; +} +ul.blockList ul.blockList ul.blockList li.blockList h3 { + background-color:#dee3e9; + border:1px solid #d0d9e0; + margin:0 0 6px -8px; + padding:7px 5px; +} +ul.blockList ul.blockList li.blockList h3 { + padding:0; + margin:15px 0; +} +ul.blockList li.blockList h2 { + padding:0px 0 20px 0; +} +/* +Page layout container styles +*/ +.contentContainer, .sourceContainer, .classUseContainer, .serializedFormContainer, .constantValuesContainer { + clear:both; + padding:10px 20px; + position:relative; +} +.indexContainer { + margin:10px; + position:relative; + font-size:12px; +} +.indexContainer h2 { + font-size:13px; + padding:0 0 3px 0; +} +.indexContainer ul { + margin:0; + padding:0; +} +.indexContainer ul li { + list-style:none; + padding-top:2px; +} +.contentContainer .description dl dt, .contentContainer .details dl dt, .serializedFormContainer dl dt { + font-size:12px; + font-weight:bold; + margin:10px 0 0 0; + color:#4E4E4E; +} +.contentContainer .description dl dd, .contentContainer .details dl dd, .serializedFormContainer dl dd { + margin:5px 0 10px 0px; + font-size:14px; + font-family:'DejaVu Sans Mono',monospace; +} +.serializedFormContainer dl.nameValue dt { + margin-left:1px; + font-size:1.1em; + display:inline; + font-weight:bold; +} +.serializedFormContainer dl.nameValue dd { + margin:0 0 0 1px; + font-size:1.1em; + display:inline; +} +/* +List styles +*/ +ul.horizontal li { + display:inline; + font-size:0.9em; +} +ul.inheritance { + margin:0; + padding:0; +} +ul.inheritance li { + display:inline; + list-style:none; +} +ul.inheritance li ul.inheritance { + margin-left:15px; + padding-left:15px; + padding-top:1px; +} +ul.blockList, ul.blockListLast { + margin:10px 0 10px 0; + padding:0; +} +ul.blockList li.blockList, ul.blockListLast li.blockList { + list-style:none; + margin-bottom:15px; + line-height:1.4; +} +ul.blockList ul.blockList li.blockList, ul.blockList ul.blockListLast li.blockList { + padding:0px 20px 5px 10px; + border:1px solid #ededed; + background-color:#f8f8f8; +} +ul.blockList ul.blockList ul.blockList li.blockList, ul.blockList ul.blockList ul.blockListLast li.blockList { + padding:0 0 5px 8px; + background-color:#ffffff; + border:none; +} +ul.blockList ul.blockList ul.blockList ul.blockList li.blockList { + margin-left:0; + padding-left:0; + padding-bottom:15px; + border:none; +} +ul.blockList ul.blockList ul.blockList ul.blockList li.blockListLast { + list-style:none; + border-bottom:none; + padding-bottom:0; +} +table tr td dl, table tr td dl dt, table tr td dl dd { + margin-top:0; + margin-bottom:1px; +} +/* +Table styles +*/ +.overviewSummary, .memberSummary, .typeSummary, .useSummary, .constantsSummary, .deprecatedSummary { + width:100%; + border-left:1px solid #EEE; + border-right:1px solid #EEE; + border-bottom:1px solid #EEE; +} +.overviewSummary, .memberSummary { + padding:0px; +} +.overviewSummary caption, .memberSummary caption, .typeSummary caption, +.useSummary caption, .constantsSummary caption, .deprecatedSummary caption { + position:relative; + text-align:left; + background-repeat:no-repeat; + color:#253441; + font-weight:bold; + clear:none; + overflow:hidden; + padding:0px; + padding-top:10px; + padding-left:1px; + margin:0px; + white-space:pre; +} +.overviewSummary caption a:link, .memberSummary caption a:link, .typeSummary caption a:link, +.useSummary caption a:link, .constantsSummary caption a:link, .deprecatedSummary caption a:link, +.overviewSummary caption a:hover, .memberSummary caption a:hover, .typeSummary caption a:hover, +.useSummary caption a:hover, .constantsSummary caption a:hover, .deprecatedSummary caption a:hover, +.overviewSummary caption a:active, .memberSummary caption a:active, .typeSummary caption a:active, +.useSummary caption a:active, .constantsSummary caption a:active, .deprecatedSummary caption a:active, +.overviewSummary caption a:visited, .memberSummary caption a:visited, .typeSummary caption a:visited, +.useSummary caption a:visited, .constantsSummary caption a:visited, .deprecatedSummary caption a:visited { + color:#FFFFFF; +} +.overviewSummary caption span, .memberSummary caption span, .typeSummary caption span, +.useSummary caption span, .constantsSummary caption span, .deprecatedSummary caption span { + white-space:nowrap; + padding-top:5px; + padding-left:12px; + padding-right:12px; + padding-bottom:7px; + display:inline-block; + float:left; + background-color:#F8981D; + border: none; + height:16px; +} +.memberSummary caption span.activeTableTab span { + white-space:nowrap; + padding-top:5px; + padding-left:12px; + padding-right:12px; + margin-right:3px; + display:inline-block; + float:left; + background-color:#F8981D; + height:16px; +} +.memberSummary caption span.tableTab span { + white-space:nowrap; + padding-top:5px; + padding-left:12px; + padding-right:12px; + margin-right:3px; + display:inline-block; + float:left; + background-color:#4D7A97; + height:16px; +} +.memberSummary caption span.tableTab, .memberSummary caption span.activeTableTab { + padding-top:0px; + padding-left:0px; + padding-right:0px; + background-image:none; + float:none; + display:inline; +} +.overviewSummary .tabEnd, .memberSummary .tabEnd, .typeSummary .tabEnd, +.useSummary .tabEnd, .constantsSummary .tabEnd, .deprecatedSummary .tabEnd { + display:none; + width:5px; + position:relative; + float:left; + background-color:#F8981D; +} +.memberSummary .activeTableTab .tabEnd { + display:none; + width:5px; + margin-right:3px; + position:relative; + float:left; + background-color:#F8981D; +} +.memberSummary .tableTab .tabEnd { + display:none; + width:5px; + margin-right:3px; + position:relative; + background-color:#4D7A97; + float:left; + +} +.overviewSummary td, .memberSummary td, .typeSummary td, +.useSummary td, .constantsSummary td, .deprecatedSummary td { + text-align:left; + padding:0px 0px 12px 10px; +} +th.colOne, th.colFirst, th.colLast, .useSummary th, .constantsSummary th, +td.colOne, td.colFirst, td.colLast, .useSummary td, .constantsSummary td{ + vertical-align:top; + padding-right:0px; + padding-top:8px; + padding-bottom:3px; +} +th.colFirst, th.colLast, th.colOne, .constantsSummary th { + background:#dee3e9; + text-align:left; + padding:8px 3px 3px 7px; +} +td.colFirst, th.colFirst { + white-space:nowrap; + font-size:13px; +} +td.colLast, th.colLast { + font-size:13px; +} +td.colOne, th.colOne { + font-size:13px; +} +.overviewSummary td.colFirst, .overviewSummary th.colFirst, +.useSummary td.colFirst, .useSummary th.colFirst, +.overviewSummary td.colOne, .overviewSummary th.colOne, +.memberSummary td.colFirst, .memberSummary th.colFirst, +.memberSummary td.colOne, .memberSummary th.colOne, +.typeSummary td.colFirst{ + width:25%; + vertical-align:top; +} +td.colOne a:link, td.colOne a:active, td.colOne a:visited, td.colOne a:hover, td.colFirst a:link, td.colFirst a:active, td.colFirst a:visited, td.colFirst a:hover, td.colLast a:link, td.colLast a:active, td.colLast a:visited, td.colLast a:hover, .constantValuesContainer td a:link, .constantValuesContainer td a:active, .constantValuesContainer td a:visited, .constantValuesContainer td a:hover { + font-weight:bold; +} +.tableSubHeadingColor { + background-color:#EEEEFF; +} +.altColor { + background-color:#FFFFFF; +} +.rowColor { + background-color:#EEEEEF; +} +/* +Content styles +*/ +.description pre { + margin-top:0; +} +.deprecatedContent { + margin:0; + padding:10px 0; +} +.docSummary { + padding:0; +} + +ul.blockList ul.blockList ul.blockList li.blockList h3 { + font-style:normal; +} + +div.block { + font-size:14px; + font-family:'DejaVu Serif', Georgia, "Times New Roman", Times, serif; +} + +td.colLast div { + padding-top:0px; +} + + +td.colLast a { + padding-bottom:3px; +} +/* +Formatting effect styles +*/ +.sourceLineNo { + color:green; + padding:0 30px 0 0; +} +h1.hidden { + visibility:hidden; + overflow:hidden; + font-size:10px; +} +.block { + display:block; + margin:3px 10px 2px 0px; + color:#474747; +} +.deprecatedLabel, .descfrmTypeLabel, .memberNameLabel, .memberNameLink, +.overrideSpecifyLabel, .packageHierarchyLabel, .paramLabel, .returnLabel, +.seeLabel, .simpleTagLabel, .throwsLabel, .typeNameLabel, .typeNameLink { + font-weight:bold; +} +.deprecationComment, .emphasizedPhrase, .interfaceName { + font-style:italic; +} + +div.block div.block span.deprecationComment, div.block div.block span.emphasizedPhrase, +div.block div.block span.interfaceName { + font-style:normal; +} + +div.contentContainer ul.blockList li.blockList h2{ + padding-bottom:0px; +} From 9db10a3fa9a63f07f2bc9face006550a0e1af104 Mon Sep 17 00:00:00 2001 From: Thorsten Date: Fri, 31 Mar 2017 16:25:18 +0200 Subject: [PATCH 13/20] New classes --- allclasses-frame.html | 4 +- allclasses-noframe.html | 4 +- .../reportingcloud/AccountSettings.html | 6 +- .../reportingcloud/FindAndReplaceBody.html | 425 ++++++++++++++++++ .../reportingcloud/ImageFormat.html | 6 +- .../reportingcloud/MergeBlock.html | 2 +- com/textcontrol/reportingcloud/MergeBody.html | 2 +- .../reportingcloud/MergeField.html | 2 +- .../reportingcloud/MergeSettings.html | 2 +- .../reportingcloud/ReportingCloud.html | 251 ++++++++++- .../reportingcloud/ReturnFormat.html | 10 +- com/textcontrol/reportingcloud/Template.html | 2 +- .../reportingcloud/TemplateInfo.html | 2 +- .../gson/AccountSettingsDeserializer.html | 6 +- .../gson/FindAndReplaceBodySerializer.html | 284 ++++++++++++ .../gson/MergeBlockDeserializer.html | 6 +- .../gson/MergeBodySerializer.html | 2 +- .../gson/MergeFieldDeserializer.html | 2 +- .../gson/MergeSettingsSerializer.html | 2 +- .../gson/TemplateDeserializer.html | 2 +- .../gson/TemplateInfoDeserializer.html | 2 +- .../reportingcloud/gson/package-frame.html | 3 +- .../reportingcloud/gson/package-summary.html | 19 +- .../reportingcloud/gson/package-tree.html | 3 +- .../reportingcloud/package-frame.html | 3 +- .../reportingcloud/package-summary.html | 20 +- .../reportingcloud/package-tree.html | 3 +- constant-values.html | 2 +- deprecated-list.html | 2 +- help-doc.html | 2 +- index-all.html | 79 +++- index.html | 2 +- overview-frame.html | 2 +- overview-summary.html | 2 +- overview-tree.html | 4 +- 35 files changed, 1094 insertions(+), 76 deletions(-) create mode 100644 com/textcontrol/reportingcloud/FindAndReplaceBody.html create mode 100644 com/textcontrol/reportingcloud/gson/FindAndReplaceBodySerializer.html diff --git a/allclasses-frame.html b/allclasses-frame.html index 9ddf33d..2878017 100644 --- a/allclasses-frame.html +++ b/allclasses-frame.html @@ -2,7 +2,7 @@ - + All Classes (reportingcloud 1.1 API) @@ -14,6 +14,8 @@

All Classes

  • AccountSettings
  • AccountSettingsDeserializer
    • +
  • FindAndReplaceBody
    • +
  • FindAndReplaceBodySerializer
  • ImageFormat
  • MergeBlock
  • MergeBlockDeserializer
    • diff --git a/allclasses-noframe.html b/allclasses-noframe.html index 1306101..4e3194b 100644 --- a/allclasses-noframe.html +++ b/allclasses-noframe.html @@ -2,7 +2,7 @@ - + All Classes (reportingcloud 1.1 API) @@ -14,6 +14,8 @@

    All Classes

    • AccountSettings
    • AccountSettingsDeserializer
      • +
    • FindAndReplaceBody
      • +
    • FindAndReplaceBodySerializer
    • ImageFormat
    • MergeBlock
    • MergeBlockDeserializer
      • diff --git a/com/textcontrol/reportingcloud/AccountSettings.html b/com/textcontrol/reportingcloud/AccountSettings.html index 48e6ff9..77de76b 100644 --- a/com/textcontrol/reportingcloud/AccountSettings.html +++ b/com/textcontrol/reportingcloud/AccountSettings.html @@ -2,7 +2,7 @@ - + AccountSettings (reportingcloud 1.1 API) @@ -49,7 +49,7 @@
      • Frames
        • @@ -345,7 +345,7 @@

        getValidUntil

        • Frames
          • diff --git a/com/textcontrol/reportingcloud/FindAndReplaceBody.html b/com/textcontrol/reportingcloud/FindAndReplaceBody.html new file mode 100644 index 0000000..3065ee1 --- /dev/null +++ b/com/textcontrol/reportingcloud/FindAndReplaceBody.html @@ -0,0 +1,425 @@ + + + + + +FindAndReplaceBody (reportingcloud 1.1 API) + + + + + + + + +
          + + +
          Skip navigation links
          + + + + +
          +
          + + + +
          + +
          +
          +
            +
          • Summary: 
            • +
          • Nested | 
            • +
          • Field | 
            • +
          • Constr | 
            • +
          • Method
            • +
          + +
          + + +
          + + +
          +
          com.textcontrol.reportingcloud
          +

          Class FindAndReplaceBody

          +
          +
          +
            +
          • java.lang.Object
            • +
          • +
              +
            • com.textcontrol.reportingcloud.FindAndReplaceBody
              • +
            +
            • +
          +
          +
            +
          • +
            +
            +
            public class FindAndReplaceBody
+extends java.lang.Object
            +
            Used to pass data to the find and replace method.
            +
            • +
          +
          +
          +
            +
          • + +
              +
            • + + +

              Constructor Summary

              + + + + + + + + + + + + + + +
              Constructors 
              Constructor and Description
              FindAndReplaceBody(java.util.List<javafx.util.Pair<java.lang.String,java.lang.String>> findAndReplaceData) 
              FindAndReplaceBody(java.util.List<javafx.util.Pair<java.lang.String,java.lang.String>> findAndReplaceData, + byte[] templateData) 
              FindAndReplaceBody(java.util.List<javafx.util.Pair<java.lang.String,java.lang.String>> findAndReplaceData, + byte[] templateData, + MergeSettings mergeSettings) 
              +
              • +
            + +
              +
            • + + +

              Method Summary

              + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
              All Methods Instance Methods Concrete Methods 
              Modifier and TypeMethod and Description
              java.util.List<javafx.util.Pair<java.lang.String,java.lang.String>>getFindAndReplaceData() +
              Gets the find and replace data.
              +
              MergeSettingsgetMergeSettings() +
              Returns the merge settings object.
              +
              byte[]getTemplateData() +
              Returns the template document data.
              +
              voidsetFindAndReplaceData(java.util.List<javafx.util.Pair<java.lang.String,java.lang.String>> findAndReplaceData) +
              Sets find and replace data.
              +
              voidsetMergeSettings(MergeSettings mergeSettings) +
              Sets the merge settings.
              +
              voidsetTemplateData(byte[] templateData) +
              Sets the template document data.
              +
              +
                +
              • + + +

                Methods inherited from class java.lang.Object

                +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
                • +
              +
              • +
            +
            • +
          +
          +
          +
            +
          • + +
              +
            • + + +

              Constructor Detail

              + + + +
                +
              • +

                FindAndReplaceBody

                +
                public FindAndReplaceBody(java.util.List<javafx.util.Pair<java.lang.String,java.lang.String>> findAndReplaceData,
+                          byte[] templateData,
+                          MergeSettings mergeSettings)
                +
                +
                Parameters:
                +
                findAndReplaceData - The find and replace pair values.
                +
                templateData - The source document. The supported document formats + are .rtf, .doc, .docx, and .tx.
                +
                mergeSettings - Merge settings to specify merge properties and document + properties such as title and author.
                +
                +
                • +
              + + + +
                +
              • +

                FindAndReplaceBody

                +
                public FindAndReplaceBody(java.util.List<javafx.util.Pair<java.lang.String,java.lang.String>> findAndReplaceData,
+                          byte[] templateData)
                +
                +
                Parameters:
                +
                findAndReplaceData - The find and replace pair values.
                +
                templateData - The source document. The supported document formats + are .rtf, .doc, .docx, and .tx.
                +
                +
                • +
              + + + +
                +
              • +

                FindAndReplaceBody

                +
                public FindAndReplaceBody(java.util.List<javafx.util.Pair<java.lang.String,java.lang.String>> findAndReplaceData)
                +
                +
                Parameters:
                +
                findAndReplaceData - The find and replace pair values.
                +
                +
                • +
              +
              • +
            + +
              +
            • + + +

              Method Detail

              + + + +
                +
              • +

                getMergeSettings

                +
                public MergeSettings getMergeSettings()
                +
                Returns the merge settings object.
                +
                +
                Returns:
                +
                The merge settings object.
                +
                +
                • +
              + + + +
                +
              • +

                setMergeSettings

                +
                public void setMergeSettings(MergeSettings mergeSettings)
                +
                Sets the merge settings.
                +
                +
                Parameters:
                +
                mergeSettings - The merge settings.
                +
                +
                • +
              + + + +
                +
              • +

                getTemplateData

                +
                public byte[] getTemplateData()
                +
                Returns the template document data.
                +
                +
                Returns:
                +
                The template document data.
                +
                +
                • +
              + + + +
                +
              • +

                setTemplateData

                +
                public void setTemplateData(byte[] templateData)
                +
                Sets the template document data.
                +
                +
                Parameters:
                +
                templateData - The template document data.
                +
                +
                • +
              + + + +
                +
              • +

                getFindAndReplaceData

                +
                public java.util.List<javafx.util.Pair<java.lang.String,java.lang.String>> getFindAndReplaceData()
                +
                Gets the find and replace data.
                +
                +
                Returns:
                +
                The find and replace data.
                +
                +
                • +
              + + + +
                +
              • +

                setFindAndReplaceData

                +
                public void setFindAndReplaceData(java.util.List<javafx.util.Pair<java.lang.String,java.lang.String>> findAndReplaceData)
                +
                Sets find and replace data.
                +
                +
                Parameters:
                +
                findAndReplaceData - Find and replace data.
                +
                +
                • +
              +
              • +
            +
            • +
          +
          +
          + + +
          + + +
          Skip navigation links
          + + + + +
          +
          + + + +
          + +
          +
          +
            +
          • Summary: 
            • +
          • Nested | 
            • +
          • Field | 
            • +
          • Constr | 
            • +
          • Method
            • +
          + +
          + + +
          + + + diff --git a/com/textcontrol/reportingcloud/ImageFormat.html b/com/textcontrol/reportingcloud/ImageFormat.html index 78ad7cc..b29c889 100644 --- a/com/textcontrol/reportingcloud/ImageFormat.html +++ b/com/textcontrol/reportingcloud/ImageFormat.html @@ -2,7 +2,7 @@ - + ImageFormat (reportingcloud 1.1 API) @@ -48,7 +48,7 @@
          @@ -331,7 +331,7 @@

          valueOf

          diff --git a/com/textcontrol/reportingcloud/MergeBlock.html b/com/textcontrol/reportingcloud/MergeBlock.html index 1549c95..8e405ea 100644 --- a/com/textcontrol/reportingcloud/MergeBlock.html +++ b/com/textcontrol/reportingcloud/MergeBlock.html @@ -2,7 +2,7 @@ - + MergeBlock (reportingcloud 1.1 API) diff --git a/com/textcontrol/reportingcloud/MergeBody.html b/com/textcontrol/reportingcloud/MergeBody.html index 7c9438b..322a51c 100644 --- a/com/textcontrol/reportingcloud/MergeBody.html +++ b/com/textcontrol/reportingcloud/MergeBody.html @@ -2,7 +2,7 @@ - + MergeBody (reportingcloud 1.1 API) diff --git a/com/textcontrol/reportingcloud/MergeField.html b/com/textcontrol/reportingcloud/MergeField.html index 04671e7..48f85f2 100644 --- a/com/textcontrol/reportingcloud/MergeField.html +++ b/com/textcontrol/reportingcloud/MergeField.html @@ -2,7 +2,7 @@ - + MergeField (reportingcloud 1.1 API) diff --git a/com/textcontrol/reportingcloud/MergeSettings.html b/com/textcontrol/reportingcloud/MergeSettings.html index 8d2bbbb..2bec726 100644 --- a/com/textcontrol/reportingcloud/MergeSettings.html +++ b/com/textcontrol/reportingcloud/MergeSettings.html @@ -2,7 +2,7 @@ - + MergeSettings (reportingcloud 1.1 API) diff --git a/com/textcontrol/reportingcloud/ReportingCloud.html b/com/textcontrol/reportingcloud/ReportingCloud.html index 68017fe..136039c 100644 --- a/com/textcontrol/reportingcloud/ReportingCloud.html +++ b/com/textcontrol/reportingcloud/ReportingCloud.html @@ -2,7 +2,7 @@ - + ReportingCloud (reportingcloud 1.1 API) @@ -18,7 +18,7 @@ catch(err) { } //--> -var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10,"i15":10,"i16":10,"i17":10}; +var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10,"i15":10,"i16":10,"i17":10,"i18":10,"i19":10,"i20":10,"i21":10,"i22":10,"i23":10}; var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; var altColor = "altColor"; var rowColor = "rowColor"; @@ -165,49 +165,87 @@

          Method Summary

          +byte[] +convertDocument(byte[] templateData, + ReturnFormat returnFormat, + boolean test) +
          Converts a document to another format.
          + + + void deleteTemplate(java.lang.String templateName)
          Deletes a template from the template storage.
          - + byte[] downloadTemplate(java.lang.String templateName)
          Returns the selected template from the storage.
          - + +byte[] +findAndReplace(FindAndReplaceBody findAndReplaceBody) +
          Executes a find and replace on a template.
          + + + +byte[] +findAndReplace(FindAndReplaceBody findAndReplaceBody, + java.lang.String templateName) +
          Executes a find and replace on a template.
          + + + +byte[] +findAndReplace(FindAndReplaceBody findAndReplaceBody, + java.lang.String templateName, + ReturnFormat returnFormat) +
          Executes a find and replace on a template.
          + + + +byte[] +findAndReplace(FindAndReplaceBody findAndReplaceBody, + java.lang.String templateName, + ReturnFormat returnFormat, + boolean test) +
          Executes a find and replace on a template.
          + + + AccountSettings getAccountSettings()
          Gets the current user's account settings.
          - + int getTemplateCount()
          Returns the number of templates in the template storage.
          - + TemplateInfo getTemplateInfo(java.lang.String templateName)
          Returns information about a template including merge fields and merge blocks.
          - + int getTemplatePageCount(java.lang.String templateName)
          Returns the number of pages of a template in the template storage.
          - + java.util.List<byte[]> getTemplateThumbnails(java.lang.String templateName, int zoomFactor)
          Returns a list of thumbnails of a specific template.
          - + java.util.List<byte[]> getTemplateThumbnails(java.lang.String templateName, int zoomFactor, @@ -215,7 +253,7 @@

          Method Summary

          Returns a list of thumbnails of a specific template.
          - + java.util.List<byte[]> getTemplateThumbnails(java.lang.String templateName, int zoomFactor, @@ -224,7 +262,7 @@

          Method Summary

          Returns a list of thumbnails of a specific template.
          - + java.util.List<byte[]> getTemplateThumbnails(java.lang.String templateName, int zoomFactor, @@ -234,26 +272,26 @@

          Method Summary

          Returns a list of thumbnails of a specific template.
          - + java.util.List<Template> listTemplates()
          Lists all templates from the template storage.
          - + java.util.List<byte[]> mergeDocument(MergeBody mergeBody)
          Merges and returns a template from the template storage or an uploaded template with JSON data.
          - + java.util.List<byte[]> mergeDocument(MergeBody mergeBody, java.lang.String templateName)
          Merges and returns a template from the template storage or an uploaded template with JSON data.
          - + java.util.List<byte[]> mergeDocument(MergeBody mergeBody, java.lang.String templateName, @@ -261,7 +299,7 @@

          Method Summary

          Merges and returns a template from the template storage or an uploaded template with JSON data.
          - + java.util.List<byte[]> mergeDocument(MergeBody mergeBody, java.lang.String templateName, @@ -270,13 +308,23 @@

          Method Summary

          Merges and returns a template from the template storage or an uploaded template with JSON data.
          - + +java.util.List<byte[]> +mergeDocument(MergeBody mergeBody, + java.lang.String templateName, + ReturnFormat returnFormat, + boolean append, + boolean test) +
          Merges and returns a template from the template storage or an uploaded template with JSON data.
          + + + boolean templateExists(java.lang.String templateName)
          Checks whether a template exists in the template storage.
          - + void uploadTemplate(java.lang.String templateName, byte[] templateData) @@ -649,6 +697,34 @@

          convertDocument

        + + + +
          +
        • +

          convertDocument

          +
          public byte[] convertDocument(byte[] templateData,
+                              ReturnFormat returnFormat,
+                              boolean test)
+                       throws java.lang.IllegalArgumentException,
+                              java.io.IOException
          +
          Converts a document to another format.
          +
          +
          Parameters:
          +
          templateData - The source document encoded as a Base64 string. + The supported document formats are .rtf, .doc, + .docx, .html, .pdf and .tx.
          +
          returnFormat - The format of the created document.
          +
          test - Specifies whether it is a test run or not. A test run is not counted + against the quota and created documents contain a watermark.
          +
          Returns:
          +
          The created document encoded as a Base64 string.
          +
          Throws:
          +
          java.lang.IllegalArgumentException - If something went wrong concerning the HTTP request.
          +
          java.io.IOException - If an I/O error occurs.
          +
          +
          • +
        @@ -756,10 +832,44 @@

        mergeDocument

      + + + +
        +
      • +

        mergeDocument

        +
        public java.util.List<byte[]> mergeDocument(MergeBody mergeBody,
+                                            java.lang.String templateName,
+                                            ReturnFormat returnFormat,
+                                            boolean append,
+                                            boolean test)
+                                     throws java.lang.IllegalArgumentException,
+                                            java.io.IOException
        +
        Merges and returns a template from the template storage or an uploaded template with JSON data.
        +
        +
        Parameters:
        +
        mergeBody - The MergeBody object contains the data source + as a JSON data object and optionally, a template encoded as a Base64 string.
        +
        templateName - The name of the template in the template storage. If no template + name is specified, the template must be uploaded in the MergeBody + object of this request.
        +
        returnFormat - The format of the created document.
        +
        append - Specifies whether the documents should be appended to one resulting + document when more than 1 data row is passed.
        +
        test - Specifies whether it is a test run or not. A test run is not counted + against the quota and created documents contain a watermark.
        +
        Returns:
        +
        The response body contains an array of the created documents.
        +
        Throws:
        +
        java.lang.IllegalArgumentException - If something went wrong concerning the HTTP request.
        +
        java.io.IOException - If an I/O error occurs.
        +
        +
        • +
      -
        +

        • getTemplateInfo

          public TemplateInfo getTemplateInfo(java.lang.String templateName)
@@ -777,6 +887,109 @@ 
          getTemplateInfo
        + + + +
          +
        • +

          findAndReplace

          +
          public byte[] findAndReplace(FindAndReplaceBody findAndReplaceBody)
+                      throws java.lang.IllegalArgumentException,
+                             java.io.IOException
          +
          Executes a find and replace on a template.
          +
          +
          Parameters:
          +
          findAndReplaceBody - The request body.
          +
          Returns:
          +
          The created document.
          +
          Throws:
          +
          java.lang.IllegalArgumentException - If something went wrong concerning the HTTP request.
          +
          java.io.IOException - If an I/O error occurs.
          +
          +
          • +
        + + + +
          +
        • +

          findAndReplace

          +
          public byte[] findAndReplace(FindAndReplaceBody findAndReplaceBody,
+                             java.lang.String templateName)
+                      throws java.lang.IllegalArgumentException,
+                             java.io.IOException
          +
          Executes a find and replace on a template.
          +
          +
          Parameters:
          +
          findAndReplaceBody - The request body.
          +
          templateName - The name of the template in the template storage. If no template + is specified, the template must be included in the + FindAndReplaceBody object of this request.
          +
          Returns:
          +
          The created document.
          +
          Throws:
          +
          java.lang.IllegalArgumentException - If something went wrong concerning the HTTP request.
          +
          java.io.IOException - If an I/O error occurs.
          +
          +
          • +
        + + + +
          +
        • +

          findAndReplace

          +
          public byte[] findAndReplace(FindAndReplaceBody findAndReplaceBody,
+                             java.lang.String templateName,
+                             ReturnFormat returnFormat)
+                      throws java.lang.IllegalArgumentException,
+                             java.io.IOException
          +
          Executes a find and replace on a template.
          +
          +
          Parameters:
          +
          findAndReplaceBody - The request body.
          +
          templateName - The name of the template in the template storage. If no template + is specified, the template must be included in the + FindAndReplaceBody object of this request.
          +
          returnFormat - The format of the created document.
          +
          Returns:
          +
          The created document.
          +
          Throws:
          +
          java.lang.IllegalArgumentException - If something went wrong concerning the HTTP request.
          +
          java.io.IOException - If an I/O error occurs.
          +
          +
          • +
        + + + +
          +
        • +

          findAndReplace

          +
          public byte[] findAndReplace(FindAndReplaceBody findAndReplaceBody,
+                             java.lang.String templateName,
+                             ReturnFormat returnFormat,
+                             boolean test)
+                      throws java.lang.IllegalArgumentException,
+                             java.io.IOException
          +
          Executes a find and replace on a template.
          +
          +
          Parameters:
          +
          findAndReplaceBody - The request body.
          +
          templateName - The name of the template in the template storage. If no template + is specified, the template must be included in the + FindAndReplaceBody object of this request.
          +
          returnFormat - The format of the created document.
          +
          test - Specifies whether it is a test run or not. A test run is not counted + against the quota and created documents contain a watermark.
          +
          Returns:
          +
          The created document.
          +
          Throws:
          +
          java.lang.IllegalArgumentException - If something went wrong concerning the HTTP request.
          +
          java.io.IOException - If an I/O error occurs.
          +
          +
          • +
      diff --git a/com/textcontrol/reportingcloud/ReturnFormat.html b/com/textcontrol/reportingcloud/ReturnFormat.html index 2c2feec..b0c270b 100644 --- a/com/textcontrol/reportingcloud/ReturnFormat.html +++ b/com/textcontrol/reportingcloud/ReturnFormat.html @@ -2,7 +2,7 @@ - + ReturnFormat (reportingcloud 1.1 API) @@ -148,7 +148,7 @@

      Enum Constant Summary

      -HMTL +HTML
      Hypertext Markup Language
      @@ -289,13 +289,13 @@

      TX

      TX Text Control Internal Format
    - + diff --git a/com/textcontrol/reportingcloud/Template.html b/com/textcontrol/reportingcloud/Template.html index 9012ffe..116e2a7 100644 --- a/com/textcontrol/reportingcloud/Template.html +++ b/com/textcontrol/reportingcloud/Template.html @@ -2,7 +2,7 @@ - + Template (reportingcloud 1.1 API) diff --git a/com/textcontrol/reportingcloud/TemplateInfo.html b/com/textcontrol/reportingcloud/TemplateInfo.html index 456641b..70f24ec 100644 --- a/com/textcontrol/reportingcloud/TemplateInfo.html +++ b/com/textcontrol/reportingcloud/TemplateInfo.html @@ -2,7 +2,7 @@ - + TemplateInfo (reportingcloud 1.1 API) diff --git a/com/textcontrol/reportingcloud/gson/AccountSettingsDeserializer.html b/com/textcontrol/reportingcloud/gson/AccountSettingsDeserializer.html index 1173fc8..276763d 100644 --- a/com/textcontrol/reportingcloud/gson/AccountSettingsDeserializer.html +++ b/com/textcontrol/reportingcloud/gson/AccountSettingsDeserializer.html @@ -2,7 +2,7 @@ - + AccountSettingsDeserializer (reportingcloud 1.1 API) @@ -49,7 +49,7 @@
    • Frames
      • @@ -242,7 +242,7 @@

      deserialize

      • Frames
        • diff --git a/com/textcontrol/reportingcloud/gson/FindAndReplaceBodySerializer.html b/com/textcontrol/reportingcloud/gson/FindAndReplaceBodySerializer.html new file mode 100644 index 0000000..bb973f2 --- /dev/null +++ b/com/textcontrol/reportingcloud/gson/FindAndReplaceBodySerializer.html @@ -0,0 +1,284 @@ + + + + + +FindAndReplaceBodySerializer (reportingcloud 1.1 API) + + + + + + + + +
        + + +
        Skip navigation links
        + + + + +
        +
        + + + +
        + +
        +
        +
          +
        • Summary: 
          • +
        • Nested | 
          • +
        • Field | 
          • +
        • Constr | 
          • +
        • Method
          • +
        + +
        + + +
        + + +
        +
        com.textcontrol.reportingcloud.gson
        +

        Class FindAndReplaceBodySerializer

        +
        +
        +
          +
        • java.lang.Object
          • +
        • +
            +
          • com.textcontrol.reportingcloud.gson.FindAndReplaceBodySerializer
            • +
          +
          • +
        +
        +
          +
        • +
          +
          All Implemented Interfaces:
          +
          com.google.gson.JsonSerializer<FindAndReplaceBody>
          +
          +
          +
          +
          public class FindAndReplaceBodySerializer
+extends java.lang.Object
+implements com.google.gson.JsonSerializer<FindAndReplaceBody>
          +
          Needed by GSON to serialize FindAndReplaceBody objects to + JSON.
          +
          • +
        +
        +
        +
          +
        • + + + +
            +
          • + + +

            Method Summary

            + + + + + + + + + + +
            All Methods Instance Methods Concrete Methods 
            Modifier and TypeMethod and Description
            com.google.gson.JsonElementserialize(FindAndReplaceBody src, + java.lang.reflect.Type typeOfSrc, + com.google.gson.JsonSerializationContext context) 
            +
              +
            • + + +

              Methods inherited from class java.lang.Object

              +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
              • +
            +
            • +
          +
          • +
        +
        +
        +
          +
        • + +
            +
          • + + +

            Constructor Detail

            + + + +
              +
            • +

              FindAndReplaceBodySerializer

              +
              public FindAndReplaceBodySerializer()
              +
              • +
            +
            • +
          + +
            +
          • + + +

            Method Detail

            + + + +
              +
            • +

              serialize

              +
              public com.google.gson.JsonElement serialize(FindAndReplaceBody src,
+                                             java.lang.reflect.Type typeOfSrc,
+                                             com.google.gson.JsonSerializationContext context)
              +
              +
              Specified by:
              +
              serialize in interface com.google.gson.JsonSerializer<FindAndReplaceBody>
              +
              +
              • +
            +
            • +
          +
          • +
        +
        +
        + + +
        + + +
        Skip navigation links
        + + + + +
        +
        + + + +
        + +
        +
        +
          +
        • Summary: 
          • +
        • Nested | 
          • +
        • Field | 
          • +
        • Constr | 
          • +
        • Method
          • +
        + +
        + + +
        + + + diff --git a/com/textcontrol/reportingcloud/gson/MergeBlockDeserializer.html b/com/textcontrol/reportingcloud/gson/MergeBlockDeserializer.html index 731f73c..3588ae5 100644 --- a/com/textcontrol/reportingcloud/gson/MergeBlockDeserializer.html +++ b/com/textcontrol/reportingcloud/gson/MergeBlockDeserializer.html @@ -2,7 +2,7 @@ - + MergeBlockDeserializer (reportingcloud 1.1 API) @@ -48,7 +48,7 @@
        @@ -241,7 +241,7 @@

        deserialize

        diff --git a/com/textcontrol/reportingcloud/gson/MergeBodySerializer.html b/com/textcontrol/reportingcloud/gson/MergeBodySerializer.html index c796bb5..923edc7 100644 --- a/com/textcontrol/reportingcloud/gson/MergeBodySerializer.html +++ b/com/textcontrol/reportingcloud/gson/MergeBodySerializer.html @@ -2,7 +2,7 @@ - + MergeBodySerializer (reportingcloud 1.1 API) diff --git a/com/textcontrol/reportingcloud/gson/MergeFieldDeserializer.html b/com/textcontrol/reportingcloud/gson/MergeFieldDeserializer.html index c9b1310..ce191ad 100644 --- a/com/textcontrol/reportingcloud/gson/MergeFieldDeserializer.html +++ b/com/textcontrol/reportingcloud/gson/MergeFieldDeserializer.html @@ -2,7 +2,7 @@ - + MergeFieldDeserializer (reportingcloud 1.1 API) diff --git a/com/textcontrol/reportingcloud/gson/MergeSettingsSerializer.html b/com/textcontrol/reportingcloud/gson/MergeSettingsSerializer.html index 7909757..56810bd 100644 --- a/com/textcontrol/reportingcloud/gson/MergeSettingsSerializer.html +++ b/com/textcontrol/reportingcloud/gson/MergeSettingsSerializer.html @@ -2,7 +2,7 @@ - + MergeSettingsSerializer (reportingcloud 1.1 API) diff --git a/com/textcontrol/reportingcloud/gson/TemplateDeserializer.html b/com/textcontrol/reportingcloud/gson/TemplateDeserializer.html index c59ecb6..616e3bd 100644 --- a/com/textcontrol/reportingcloud/gson/TemplateDeserializer.html +++ b/com/textcontrol/reportingcloud/gson/TemplateDeserializer.html @@ -2,7 +2,7 @@ - + TemplateDeserializer (reportingcloud 1.1 API) diff --git a/com/textcontrol/reportingcloud/gson/TemplateInfoDeserializer.html b/com/textcontrol/reportingcloud/gson/TemplateInfoDeserializer.html index f1a27b9..767301c 100644 --- a/com/textcontrol/reportingcloud/gson/TemplateInfoDeserializer.html +++ b/com/textcontrol/reportingcloud/gson/TemplateInfoDeserializer.html @@ -2,7 +2,7 @@ - + TemplateInfoDeserializer (reportingcloud 1.1 API) diff --git a/com/textcontrol/reportingcloud/gson/package-frame.html b/com/textcontrol/reportingcloud/gson/package-frame.html index 4efef2b..d32297d 100644 --- a/com/textcontrol/reportingcloud/gson/package-frame.html +++ b/com/textcontrol/reportingcloud/gson/package-frame.html @@ -2,7 +2,7 @@ - + com.textcontrol.reportingcloud.gson (reportingcloud 1.1 API) @@ -14,6 +14,7 @@

        Classes

        • AccountSettingsDeserializer
          • +
        • FindAndReplaceBodySerializer
        • MergeBlockDeserializer
        • MergeBodySerializer
        • MergeFieldDeserializer
          • diff --git a/com/textcontrol/reportingcloud/gson/package-summary.html b/com/textcontrol/reportingcloud/gson/package-summary.html index 33acd6c..8a60ed0 100644 --- a/com/textcontrol/reportingcloud/gson/package-summary.html +++ b/com/textcontrol/reportingcloud/gson/package-summary.html @@ -2,7 +2,7 @@ - + com.textcontrol.reportingcloud.gson (reportingcloud 1.1 API) @@ -92,38 +92,45 @@

          Package com.textcontrol.reportingcloud.gs +FindAndReplaceBodySerializer + +
          Needed by GSON to serialize FindAndReplaceBody objects to + JSON.
          + + + MergeBlockDeserializer
          Needed by GSON to create MergeBlock objects from JSON data.
          - + MergeBodySerializer
          Needed by GSON to serialize MergeBody objects to JSON.
          - + MergeFieldDeserializer
          Needed by GSON to create MergeField objects from JSON data.
          - + MergeSettingsSerializer
          Needed by GSON to serialize MergeSettings objects to JSON.
          - + TemplateDeserializer
          Needed by GSON to create Template objects from JSON data.
          - + TemplateInfoDeserializer
          Needed by GSON to create TemplateInfo objects from JSON data.
          diff --git a/com/textcontrol/reportingcloud/gson/package-tree.html b/com/textcontrol/reportingcloud/gson/package-tree.html index 8b82b8f..2d54738 100644 --- a/com/textcontrol/reportingcloud/gson/package-tree.html +++ b/com/textcontrol/reportingcloud/gson/package-tree.html @@ -2,7 +2,7 @@ - + com.textcontrol.reportingcloud.gson Class Hierarchy (reportingcloud 1.1 API) @@ -81,6 +81,7 @@

          Class Hierarchy

        • java.lang.Object
          • com.textcontrol.reportingcloud.gson.AccountSettingsDeserializer (implements com.google.gson.JsonDeserializer<T>)
            • +
          • com.textcontrol.reportingcloud.gson.FindAndReplaceBodySerializer (implements com.google.gson.JsonSerializer<T>)
          • com.textcontrol.reportingcloud.gson.MergeBlockDeserializer (implements com.google.gson.JsonDeserializer<T>)
          • com.textcontrol.reportingcloud.gson.MergeBodySerializer (implements com.google.gson.JsonSerializer<T>)
          • com.textcontrol.reportingcloud.gson.MergeFieldDeserializer (implements com.google.gson.JsonDeserializer<T>)
            • diff --git a/com/textcontrol/reportingcloud/package-frame.html b/com/textcontrol/reportingcloud/package-frame.html index d137ab8..dc64762 100644 --- a/com/textcontrol/reportingcloud/package-frame.html +++ b/com/textcontrol/reportingcloud/package-frame.html @@ -2,7 +2,7 @@ - + com.textcontrol.reportingcloud (reportingcloud 1.1 API) @@ -14,6 +14,7 @@

            Classes

            • AccountSettings
              • +
            • FindAndReplaceBody
            • MergeBlock
            • MergeBody
            • MergeField
              • diff --git a/com/textcontrol/reportingcloud/package-summary.html b/com/textcontrol/reportingcloud/package-summary.html index b3f43f9..69cda7c 100644 --- a/com/textcontrol/reportingcloud/package-summary.html +++ b/com/textcontrol/reportingcloud/package-summary.html @@ -2,7 +2,7 @@ - + com.textcontrol.reportingcloud (reportingcloud 1.1 API) @@ -92,42 +92,48 @@

              Package com.textcontrol.reportingcloud +FindAndReplaceBody + +
              Used to pass data to the find and replace method.
              + + + MergeBlock
              Represents a merge block in a document template.
              - + MergeBody
              Used to pass data to the merge method.
              - + MergeField
              Represents a merge field in a document template.
              - + MergeSettings
              Holds the merge settings needed by the merge method.
              - + ReportingCloud
              The ReportingCloud API wrapper class.
              - + Template
              Holds information about a template in the template storage.
              - + TemplateInfo
              Holds information about the merge blocks and merge fields in a template.
              diff --git a/com/textcontrol/reportingcloud/package-tree.html b/com/textcontrol/reportingcloud/package-tree.html index 9df63e0..8c975e6 100644 --- a/com/textcontrol/reportingcloud/package-tree.html +++ b/com/textcontrol/reportingcloud/package-tree.html @@ -2,7 +2,7 @@ - + com.textcontrol.reportingcloud Class Hierarchy (reportingcloud 1.1 API) @@ -81,6 +81,7 @@

              Class Hierarchy

            • java.lang.Object
              • com.textcontrol.reportingcloud.AccountSettings
                • +
              • com.textcontrol.reportingcloud.FindAndReplaceBody
              • com.textcontrol.reportingcloud.MergeBlock
              • com.textcontrol.reportingcloud.MergeBody
              • com.textcontrol.reportingcloud.MergeField
                • diff --git a/constant-values.html b/constant-values.html index 6517a2c..c30c860 100644 --- a/constant-values.html +++ b/constant-values.html @@ -2,7 +2,7 @@ - + Constant Field Values (reportingcloud 1.1 API) diff --git a/deprecated-list.html b/deprecated-list.html index 96377a8..758e8b7 100644 --- a/deprecated-list.html +++ b/deprecated-list.html @@ -2,7 +2,7 @@ - + Deprecated List (reportingcloud 1.1 API) diff --git a/help-doc.html b/help-doc.html index 9677996..8d134bd 100644 --- a/help-doc.html +++ b/help-doc.html @@ -2,7 +2,7 @@ - + API Help (reportingcloud 1.1 API) diff --git a/index-all.html b/index-all.html index ee688a5..ed2f73b 100644 --- a/index-all.html +++ b/index-all.html @@ -2,7 +2,7 @@ - + Index (reportingcloud 1.1 API) @@ -68,7 +68,7 @@
      -
      A C D G I L M R S T U V  +
      A C D F G I L M R S T U V 

      A

      @@ -103,6 +103,10 @@

      C

      Converts a document to another format.
      +
      convertDocument(byte[], ReturnFormat, boolean) - Method in class com.textcontrol.reportingcloud.ReportingCloud
      +
      +
      Converts a document to another format.
      +
      @@ -128,6 +132,45 @@

      D

      Returns the selected template from the storage.
+ + + +

F

+
+
findAndReplace(FindAndReplaceBody) - Method in class com.textcontrol.reportingcloud.ReportingCloud
+
+
Executes a find and replace on a template.
+
+
findAndReplace(FindAndReplaceBody, String) - Method in class com.textcontrol.reportingcloud.ReportingCloud
+
+
Executes a find and replace on a template.
+
+
findAndReplace(FindAndReplaceBody, String, ReturnFormat) - Method in class com.textcontrol.reportingcloud.ReportingCloud
+
+
Executes a find and replace on a template.
+
+
findAndReplace(FindAndReplaceBody, String, ReturnFormat, boolean) - Method in class com.textcontrol.reportingcloud.ReportingCloud
+
+
Executes a find and replace on a template.
+
+
FindAndReplaceBody - Class in com.textcontrol.reportingcloud
+
+
Used to pass data to the find and replace method.
+
+
FindAndReplaceBody(List<Pair<String, String>>, byte[], MergeSettings) - Constructor for class com.textcontrol.reportingcloud.FindAndReplaceBody
+
 
+
FindAndReplaceBody(List<Pair<String, String>>, byte[]) - Constructor for class com.textcontrol.reportingcloud.FindAndReplaceBody
+
 
+
FindAndReplaceBody(List<Pair<String, String>>) - Constructor for class com.textcontrol.reportingcloud.FindAndReplaceBody
+
 
+
FindAndReplaceBodySerializer - Class in com.textcontrol.reportingcloud.gson
+
+
Needed by GSON to serialize FindAndReplaceBody objects to + JSON.
+
+
FindAndReplaceBodySerializer() - Constructor for class com.textcontrol.reportingcloud.gson.FindAndReplaceBodySerializer
+
 
+
@@ -165,6 +208,10 @@

G

Gets the document's title.
+
getFindAndReplaceData() - Method in class com.textcontrol.reportingcloud.FindAndReplaceBody
+
+
Gets the find and replace data.
+
getLastModificationDate() - Method in class com.textcontrol.reportingcloud.MergeSettings
Gets the last modification date.
@@ -197,6 +244,10 @@

G

Gets all top level merge fields in the template.
+
getMergeSettings() - Method in class com.textcontrol.reportingcloud.FindAndReplaceBody
+
+
Returns the merge settings object.
+
getMergeSettings() - Method in class com.textcontrol.reportingcloud.MergeBody
Gets the merge settings to specify merge properties and document properties such @@ -257,6 +308,10 @@

G

Returns the number of templates in the template storage.
+
getTemplateData() - Method in class com.textcontrol.reportingcloud.FindAndReplaceBody
+
+
Returns the template document data.
+
getTemplateInfo(String) - Method in class com.textcontrol.reportingcloud.ReportingCloud
Returns information about a template including merge fields and merge blocks.
@@ -390,6 +445,10 @@

M

Merges and returns a template from the template storage or an uploaded template with JSON data.
+
mergeDocument(MergeBody, String, ReturnFormat, boolean, boolean) - Method in class com.textcontrol.reportingcloud.ReportingCloud
+
+
Merges and returns a template from the template storage or an uploaded template with JSON data.
+
MergeField - Class in com.textcontrol.reportingcloud
Represents a merge field in a document template.
@@ -444,6 +503,8 @@

R

S

+
serialize(FindAndReplaceBody, Type, JsonSerializationContext) - Method in class com.textcontrol.reportingcloud.gson.FindAndReplaceBodySerializer
+
 
serialize(MergeBody, Type, JsonSerializationContext) - Method in class com.textcontrol.reportingcloud.gson.MergeBodySerializer
 
serialize(MergeSettings, Type, JsonSerializationContext) - Method in class com.textcontrol.reportingcloud.gson.MergeSettingsSerializer
@@ -472,6 +533,10 @@

S

Sets the document's title.
+
setFindAndReplaceData(List<Pair<String, String>>) - Method in class com.textcontrol.reportingcloud.FindAndReplaceBody
+
+
Sets find and replace data.
+
setLastModificationDate(String) - Method in class com.textcontrol.reportingcloud.MergeSettings
Sets the last modification date.
@@ -488,6 +553,10 @@

S

Sets the merge data.
+
setMergeSettings(MergeSettings) - Method in class com.textcontrol.reportingcloud.FindAndReplaceBody
+
+
Sets the merge settings.
+
setMergeSettings(MergeSettings) - Method in class com.textcontrol.reportingcloud.MergeBody
Sets the merge settings to specify merge properties and document properties such @@ -515,6 +584,10 @@

S

Sets the binary template document data.
+
setTemplateData(byte[]) - Method in class com.textcontrol.reportingcloud.FindAndReplaceBody
+
+
Sets the template document data.
+
setUserPassword(String) - Method in class com.textcontrol.reportingcloud.MergeSettings
Sets the password needed to open the document.
@@ -591,7 +664,7 @@

V

the order they are declared.
-A C D G I L M R S T U V  +A C D F G I L M R S T U V 
diff --git a/index.html b/index.html index 2a8fbc9..9722605 100644 --- a/index.html +++ b/index.html @@ -2,7 +2,7 @@ - + reportingcloud 1.1 API @@ -17,6 +17,8 @@

All Classes

  • FindAndReplaceBody
  • FindAndReplaceBodySerializer
  • ImageFormat
    • +
  • IncorrectWord
    • +
  • IncorrectWordDeserializer
  • MergeBlock
  • MergeBlockDeserializer
  • MergeBody
    • diff --git a/allclasses-noframe.html b/allclasses-noframe.html index 681fdde..20d34b0 100644 --- a/allclasses-noframe.html +++ b/allclasses-noframe.html @@ -2,9 +2,9 @@ - -All Classes (reportingcloud 1.1 API) - + +All Classes (reportingcloud 1.2 API) + @@ -17,6 +17,8 @@

    All Classes

  • FindAndReplaceBody
  • FindAndReplaceBodySerializer
  • ImageFormat
    • +
  • IncorrectWord
    • +
  • IncorrectWordDeserializer
  • MergeBlock
  • MergeBlockDeserializer
  • MergeBody
    • diff --git a/com/textcontrol/reportingcloud/AccountSettings.html b/com/textcontrol/reportingcloud/AccountSettings.html index 29d040e..2a7057c 100644 --- a/com/textcontrol/reportingcloud/AccountSettings.html +++ b/com/textcontrol/reportingcloud/AccountSettings.html @@ -2,9 +2,9 @@ - -AccountSettings (reportingcloud 1.1 API) - + +AccountSettings (reportingcloud 1.2 API) + @@ -12,7 +12,7 @@ @@ -12,7 +12,7 @@ @@ -12,7 +12,7 @@ + + + + + +
    + + +
    Skip navigation links
    + + + + +
    +
    + + + +
    + +
    +
    +
      +
    • Summary: 
      • +
    • Nested | 
      • +
    • Field | 
      • +
    • Constr | 
      • +
    • Method
      • +
    + +
    + + +
    + + +
    +
    com.textcontrol.reportingcloud
    +

    Class IncorrectWord

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • com.textcontrol.reportingcloud.IncorrectWord
        • +
      +
      • +
    +
    +
      +
    • +
      +
      +
      public class IncorrectWord
+extends java.lang.Object
      +
      Represents an incorrect word in a spell checked text.
      +
      • +
    +
    +
    +
      +
    • + +
        +
      • + + +

        Constructor Summary

        + + + + + + + + +
        Constructors 
        Constructor and Description
        IncorrectWord(int length, + int start, + java.lang.String text, + boolean isDuplicate, + java.lang.String language) 
        +
        • +
      + +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + + + + + + + + + + + + + + + +
        All Methods Instance Methods Concrete Methods 
        Modifier and TypeMethod and Description
        java.lang.StringgetLanguage() +
        Returns a value indicating the language the incorrect word was spelled.
        +
        intgetLength() +
        Returns the length of the spelled word.
        +
        intgetStart() +
        Returns the starting position of a spelled word.
        +
        java.lang.StringgetText() +
        Returns the text of the spelled word.
        +
        booleanisDuplicate() +
        Returns a value indicating whether the spelled word is declared as incorrect, + because the previous word has the same text.
        +
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

          +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
          • +
        +
        • +
      +
      • +
    +
    +
    +
      +
    • + +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          IncorrectWord

          +
          public IncorrectWord(int length,
+                     int start,
+                     java.lang.String text,
+                     boolean isDuplicate,
+                     java.lang.String language)
          +
          • +
        +
        • +
      + +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          getLength

          +
          public int getLength()
          +
          Returns the length of the spelled word.
          +
          +
          Returns:
          +
          The length of the spelled word.
          +
          +
          • +
        + + + +
          +
        • +

          getStart

          +
          public int getStart()
          +
          Returns the starting position of a spelled word.
          +
          +
          Returns:
          +
          The starting position of a spelled word.
          +
          +
          • +
        + + + +
          +
        • +

          getText

          +
          public java.lang.String getText()
          +
          Returns the text of the spelled word.
          +
          +
          Returns:
          +
          The text of the spelled word.
          +
          +
          • +
        + + + +
          +
        • +

          isDuplicate

          +
          public boolean isDuplicate()
          +
          Returns a value indicating whether the spelled word is declared as incorrect, + because the previous word has the same text.
          +
          +
          Returns:
          +
          a value indicating whether the spelled word is declared as incorrect + because the previous word has the same text.
          +
          +
          • +
        + + + +
          +
        • +

          getLanguage

          +
          public java.lang.String getLanguage()
          +
          Returns a value indicating the language the incorrect word was spelled.
          +
          +
          Returns:
          +
          A value indicating the language the incorrect word was spelled.
          +
          +
          • +
        +
        • +
      +
      • +
    +
    +
    + + +
    + + +
    Skip navigation links
    + + + + +
    +
    + + + +
    + +
    +
    +
      +
    • Summary: 
      • +
    • Nested | 
      • +
    • Field | 
      • +
    • Constr | 
      • +
    • Method
      • +
    + +
    + + +
    + + + diff --git a/com/textcontrol/reportingcloud/MergeBlock.html b/com/textcontrol/reportingcloud/MergeBlock.html index 448d6bb..6fe219e 100644 --- a/com/textcontrol/reportingcloud/MergeBlock.html +++ b/com/textcontrol/reportingcloud/MergeBlock.html @@ -2,9 +2,9 @@ - -MergeBlock (reportingcloud 1.1 API) - + +MergeBlock (reportingcloud 1.2 API) + @@ -12,7 +12,7 @@ @@ -12,7 +12,7 @@ @@ -12,7 +12,7 @@ @@ -12,13 +12,13 @@ @@ -12,13 +12,13 @@ @@ -12,7 +12,7 @@ @@ -12,7 +12,7 @@ @@ -12,7 +12,7 @@ @@ -12,7 +12,7 @@ @@ -12,7 +12,7 @@ + + + + + +
    + + +
    Skip navigation links
    + + + + +
    +
    + + + +
    + +
    +
    +
      +
    • Summary: 
      • +
    • Nested | 
      • +
    • Field | 
      • +
    • Constr | 
      • +
    • Method
      • +
    + +
    + + +
    + + +
    +
    com.textcontrol.reportingcloud.gson
    +

    Class IncorrectWordDeserializer

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • com.textcontrol.reportingcloud.gson.IncorrectWordDeserializer
        • +
      +
      • +
    +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      com.google.gson.JsonDeserializer<IncorrectWord>
      +
      +
      +
      +
      public class IncorrectWordDeserializer
+extends java.lang.Object
+implements com.google.gson.JsonDeserializer<IncorrectWord>
      +
      Needed by GSON to create IncorrectWord objects from JSON data.
      +
      • +
    +
    +
    +
      +
    • + + + +
        +
      • + + +

        Method Summary

        + + + + + + + + + + +
        All Methods Instance Methods Concrete Methods 
        Modifier and TypeMethod and Description
        IncorrectWorddeserialize(com.google.gson.JsonElement json, + java.lang.reflect.Type typeOfT, + com.google.gson.JsonDeserializationContext context) 
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

          +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
          • +
        +
        • +
      +
      • +
    +
    +
    +
      +
    • + +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          IncorrectWordDeserializer

          +
          public IncorrectWordDeserializer()
          +
          • +
        +
        • +
      + +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          deserialize

          +
          public IncorrectWord deserialize(com.google.gson.JsonElement json,
+                                 java.lang.reflect.Type typeOfT,
+                                 com.google.gson.JsonDeserializationContext context)
+                          throws com.google.gson.JsonParseException
          +
          +
          Specified by:
          +
          deserialize in interface com.google.gson.JsonDeserializer<IncorrectWord>
          +
          Throws:
          +
          com.google.gson.JsonParseException
          +
          +
          • +
        +
        • +
      +
      • +
    +
    +
    + + +
    + + +
    Skip navigation links
    + + + + +
    +
    + + + +
    + +
    +
    +
      +
    • Summary: 
      • +
    • Nested | 
      • +
    • Field | 
      • +
    • Constr | 
      • +
    • Method
      • +
    + +
    + + +
    + + + diff --git a/com/textcontrol/reportingcloud/gson/MergeBlockDeserializer.html b/com/textcontrol/reportingcloud/gson/MergeBlockDeserializer.html index 287d6c7..86b7a51 100644 --- a/com/textcontrol/reportingcloud/gson/MergeBlockDeserializer.html +++ b/com/textcontrol/reportingcloud/gson/MergeBlockDeserializer.html @@ -2,9 +2,9 @@ - -MergeBlockDeserializer (reportingcloud 1.1 API) - + +MergeBlockDeserializer (reportingcloud 1.2 API) + @@ -12,7 +12,7 @@ @@ -12,7 +12,7 @@ @@ -12,7 +12,7 @@ @@ -12,7 +12,7 @@ @@ -12,7 +12,7 @@ @@ -12,7 +12,7 @@ @@ -15,6 +15,7 @@

    Classes

    • AccountSettingsDeserializer
    • FindAndReplaceBodySerializer
      • +
    • IncorrectWordDeserializer
    • MergeBlockDeserializer
    • MergeBodySerializer
    • MergeFieldDeserializer
      • diff --git a/com/textcontrol/reportingcloud/gson/package-summary.html b/com/textcontrol/reportingcloud/gson/package-summary.html index 0d18efd..f523273 100644 --- a/com/textcontrol/reportingcloud/gson/package-summary.html +++ b/com/textcontrol/reportingcloud/gson/package-summary.html @@ -2,9 +2,9 @@ - -com.textcontrol.reportingcloud.gson (reportingcloud 1.1 API) - + +com.textcontrol.reportingcloud.gson (reportingcloud 1.2 API) + @@ -12,7 +12,7 @@ @@ -12,7 +12,7 @@ @@ -15,6 +15,7 @@

      Classes

      • AccountSettings
      • FindAndReplaceBody
        • +
      • IncorrectWord
      • MergeBlock
      • MergeBody
      • MergeField
        • diff --git a/com/textcontrol/reportingcloud/package-summary.html b/com/textcontrol/reportingcloud/package-summary.html index 9a38f9d..839efaa 100644 --- a/com/textcontrol/reportingcloud/package-summary.html +++ b/com/textcontrol/reportingcloud/package-summary.html @@ -2,9 +2,9 @@ - -com.textcontrol.reportingcloud (reportingcloud 1.1 API) - + +com.textcontrol.reportingcloud (reportingcloud 1.2 API) + @@ -12,7 +12,7 @@ @@ -12,7 +12,7 @@ @@ -12,7 +12,7 @@ @@ -12,7 +12,7 @@ @@ -12,7 +12,7 @@ @@ -12,7 +12,7 @@ diff --git a/overview-summary.html b/overview-summary.html index 7a34083..495f85b 100644 --- a/overview-summary.html +++ b/overview-summary.html @@ -2,9 +2,9 @@ - -Overview (reportingcloud 1.1 API) - + +Overview (reportingcloud 1.2 API) + @@ -12,7 +12,7 @@ @@ -12,7 +12,7 @@ @@ -14,6 +14,16 @@

        All Classes

        • AccountSettings
        • AccountSettingsDeserializer
          • +
        • APIKey
          • +
        • APIKeyDeserializer
          • +
        • AppendBody
          • +
        • AppendBodySerializer
          • +
        • AppendDocument
          • +
        • AppendDocumentSerializer
          • +
        • Credentials
          • +
        • DocumentDivider
          • +
        • DocumentSettings
          • +
        • DocumentSettingsSerializer
        • FindAndReplaceBody
        • FindAndReplaceBodySerializer
        • ImageFormat
          • diff --git a/allclasses-noframe.html b/allclasses-noframe.html index 20d34b0..52ea180 100644 --- a/allclasses-noframe.html +++ b/allclasses-noframe.html @@ -2,9 +2,9 @@ - -All Classes (reportingcloud 1.2 API) - + +All Classes (reportingcloud 1.3 API) + @@ -14,6 +14,16 @@

          All Classes

          • AccountSettings
          • AccountSettingsDeserializer
            • +
          • APIKey
            • +
          • APIKeyDeserializer
            • +
          • AppendBody
            • +
          • AppendBodySerializer
            • +
          • AppendDocument
            • +
          • AppendDocumentSerializer
            • +
          • Credentials
            • +
          • DocumentDivider
            • +
          • DocumentSettings
            • +
          • DocumentSettingsSerializer
          • FindAndReplaceBody
          • FindAndReplaceBodySerializer
          • ImageFormat
            • diff --git a/com/textcontrol/reportingcloud/APIKey.html b/com/textcontrol/reportingcloud/APIKey.html new file mode 100644 index 0000000..f853191 --- /dev/null +++ b/com/textcontrol/reportingcloud/APIKey.html @@ -0,0 +1,304 @@ + + + + + +APIKey (reportingcloud 1.3 API) + + + + + + + + +
            + + +
            Skip navigation links
            + + + + +
            +
            + + + +
            + +
            +
            +
              +
            • Summary: 
              • +
            • Nested | 
              • +
            • Field | 
              • +
            • Constr | 
              • +
            • Method
              • +
            + +
            + + +
            + + +
            +
            com.textcontrol.reportingcloud
            +

            Class APIKey

            +
            +
            +
              +
            • java.lang.Object
              • +
            • +
                +
              • com.textcontrol.reportingcloud.APIKey
                • +
              +
              • +
            +
            +
              +
            • +
              +
              +
              public class APIKey
+extends java.lang.Object
              +
              Represents a ReportingCloud API key object.
              +
              • +
            +
            +
            +
              +
            • + +
                +
              • + + +

                Constructor Summary

                + + + + + + + + +
                Constructors 
                Constructor and Description
                APIKey(java.lang.String key, + boolean isActive) 
                +
                • +
              + +
                +
              • + + +

                Method Summary

                + + + + + + + + + + + + + + +
                All Methods Instance Methods Concrete Methods 
                Modifier and TypeMethod and Description
                booleangetIsActive() +
                Returns whether the API key is active or not (not used yet).
                +
                java.lang.StringgetKey() +
                Returns the API key.
                +
                +
                  +
                • + + +

                  Methods inherited from class java.lang.Object

                  +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
                  • +
                +
                • +
              +
              • +
            +
            +
            +
              +
            • + +
                +
              • + + +

                Constructor Detail

                + + + +
                  +
                • +

                  APIKey

                  +
                  public APIKey(java.lang.String key,
+              boolean isActive)
                  +
                  +
                  Parameters:
                  +
                  key - The actual API Key that belongs to the account
                  +
                  isActive - Specifies whether the API Key is active or not (not used yet).
                  +
                  +
                  • +
                +
                • +
              + +
                +
              • + + +

                Method Detail

                + + + +
                  +
                • +

                  getKey

                  +
                  public java.lang.String getKey()
                  +
                  Returns the API key.
                  +
                  +
                  Returns:
                  +
                  The API key.
                  +
                  +
                  • +
                + + + +
                  +
                • +

                  getIsActive

                  +
                  public boolean getIsActive()
                  +
                  Returns whether the API key is active or not (not used yet).
                  +
                  +
                  Returns:
                  +
                  The state of the API key (active or inactive).
                  +
                  +
                  • +
                +
                • +
              +
              • +
            +
            +
            + + +
            + + +
            Skip navigation links
            + + + + +
            +
            + + + +
            + +
            +
            +
              +
            • Summary: 
              • +
            • Nested | 
              • +
            • Field | 
              • +
            • Constr | 
              • +
            • Method
              • +
            + +
            + + +
            + + + diff --git a/com/textcontrol/reportingcloud/AccountSettings.html b/com/textcontrol/reportingcloud/AccountSettings.html index 2a7057c..8bbcddf 100644 --- a/com/textcontrol/reportingcloud/AccountSettings.html +++ b/com/textcontrol/reportingcloud/AccountSettings.html @@ -2,9 +2,9 @@ - -AccountSettings (reportingcloud 1.2 API) - + +AccountSettings (reportingcloud 1.3 API) + @@ -12,7 +12,7 @@ + + + + + +
            + + +
            Skip navigation links
            + + + + +
            +
            + + + +
            + +
            +
            +
              +
            • Summary: 
              • +
            • Nested | 
              • +
            • Field | 
              • +
            • Constr | 
              • +
            • Method
              • +
            + +
            + + +
            + + +
            +
            com.textcontrol.reportingcloud
            +

            Class AppendBody

            +
            +
            +
              +
            • java.lang.Object
              • +
            • +
                +
              • com.textcontrol.reportingcloud.AppendBody
                • +
              +
              • +
            +
            +
              +
            • +
              +
              +
              public class AppendBody
+extends java.lang.Object
              +
              Used to pass data to the appendDocuments + method.
              +
              • +
            +
            +
            + +
            +
            +
              +
            • + +
                +
              • + + +

                Constructor Detail

                + + + +
                  +
                • +

                  AppendBody

                  +
                  public AppendBody(java.util.List<AppendDocument> documents)
+           throws java.security.InvalidParameterException
                  +
                  Combines documents by appending them divided by a new section, paragraph or nothing.
                  +
                  +
                  Parameters:
                  +
                  documents - The documents that are appended including divider options.
                  +
                  Throws:
                  +
                  java.security.InvalidParameterException
                  +
                  +
                  • +
                + + + +
                  +
                • +

                  AppendBody

                  +
                  public AppendBody(java.util.List<AppendDocument> documents,
+                  DocumentSettings documentSettings)
+           throws java.security.InvalidParameterException
                  +
                  Combines documents by appending them divided by a new section, paragraph or nothing.
                  +
                  +
                  Parameters:
                  +
                  documents - The documents that are appended including divider options.
                  +
                  documentSettings - Document settings to specify document properties such as title and + author.
                  +
                  Throws:
                  +
                  java.security.InvalidParameterException
                  +
                  +
                  • +
                +
                • +
              + +
                +
              • + + +

                Method Detail

                + + + +
                  +
                • +

                  getDocuments

                  +
                  public java.util.List<AppendDocument> getDocuments()
                  +
                  Returns the documents.
                  +
                  +
                  Returns:
                  +
                  The documents.
                  +
                  +
                  • +
                + + + +
                  +
                • +

                  setDocuments

                  +
                  public void setDocuments(java.util.List<AppendDocument> documents)
                  +
                  Sets the list of documents.
                  +
                  +
                  Parameters:
                  +
                  documents - The list of documents.
                  +
                  +
                  • +
                + + + +
                  +
                • +

                  getDocumentSettings

                  +
                  public DocumentSettings getDocumentSettings()
                  +
                  Returns the document settings.
                  +
                  +
                  Returns:
                  +
                  The document settings.
                  +
                  +
                  • +
                + + + +
                  +
                • +

                  setDocumentSettings

                  +
                  public void setDocumentSettings(DocumentSettings documentSettings)
                  +
                  Sets the document settings.
                  +
                  +
                  Parameters:
                  +
                  documentSettings - The document settings.
                  +
                  +
                  • +
                +
                • +
              +
              • +
            +
            +
            + + +
            + + +
            Skip navigation links
            + + + + +
            +
            + + + +
            + +
            +
            +
              +
            • Summary: 
              • +
            • Nested | 
              • +
            • Field | 
              • +
            • Constr | 
              • +
            • Method
              • +
            + +
            + + +
            + + + diff --git a/com/textcontrol/reportingcloud/AppendDocument.html b/com/textcontrol/reportingcloud/AppendDocument.html new file mode 100644 index 0000000..2596637 --- /dev/null +++ b/com/textcontrol/reportingcloud/AppendDocument.html @@ -0,0 +1,370 @@ + + + + + +AppendDocument (reportingcloud 1.3 API) + + + + + + + + +
            + + +
            Skip navigation links
            + + + + +
            +
            + + + +
            + +
            +
            +
              +
            • Summary: 
              • +
            • Nested | 
              • +
            • Field | 
              • +
            • Constr | 
              • +
            • Method
              • +
            + +
            + + +
            + + +
            +
            com.textcontrol.reportingcloud
            +

            Class AppendDocument

            +
            +
            +
              +
            • java.lang.Object
              • +
            • +
                +
              • com.textcontrol.reportingcloud.AppendDocument
                • +
              +
              • +
            +
            +
              +
            • +
              +
              +
              public class AppendDocument
+extends java.lang.Object
              +
              A document that is appended by the appendDocuments + method.
              +
              • +
            +
            +
            + +
            +
            +
              +
            • + +
                +
              • + + +

                Constructor Detail

                + + + +
                  +
                • +

                  AppendDocument

                  +
                  public AppendDocument(byte[] document)
+               throws java.lang.IllegalArgumentException
                  +
                  +
                  Parameters:
                  +
                  document - The document. Supported formats are .rtf, .doc, .docx and + .tx.
                  +
                  Throws:
                  +
                  java.lang.IllegalArgumentException
                  +
                  +
                  • +
                + + + +
                  +
                • +

                  AppendDocument

                  +
                  public AppendDocument(byte[] document,
+                      DocumentDivider divider)
+               throws java.lang.IllegalArgumentException
                  +
                  +
                  Parameters:
                  +
                  document - The document. Supported formats are .rtf, .doc, .docx and + .tx.
                  +
                  divider - The document divider option.
                  +
                  Throws:
                  +
                  java.lang.IllegalArgumentException
                  +
                  +
                  • +
                +
                • +
              + +
                +
              • + + +

                Method Detail

                + + + +
                  +
                • +

                  getDocument

                  +
                  public byte[] getDocument()
                  +
                  Returns the document.
                  +
                  +
                  Returns:
                  +
                  The document.
                  +
                  +
                  • +
                + + + +
                  +
                • +

                  setDocument

                  +
                  public void setDocument(byte[] document)
                  +
                  Sets the document.
                  +
                  +
                  Parameters:
                  +
                  document - The document. Supported formats are .rtf, .doc, .docx and + .tx.
                  +
                  +
                  • +
                + + + +
                  +
                • +

                  getDivider

                  +
                  public DocumentDivider getDivider()
                  +
                  Returns the document divider option.
                  +
                  +
                  Returns:
                  +
                  The document divider option.
                  +
                  +
                  • +
                + + + +
                  +
                • +

                  setDivider

                  +
                  public void setDivider(DocumentDivider divider)
                  +
                  Sets the document divider option.
                  +
                  +
                  Parameters:
                  +
                  divider - The document divider option.
                  +
                  +
                  • +
                +
                • +
              +
              • +
            +
            +
            + + +
            + + +
            Skip navigation links
            + + + + +
            +
            + + + +
            + +
            +
            +
              +
            • Summary: 
              • +
            • Nested | 
              • +
            • Field | 
              • +
            • Constr | 
              • +
            • Method
              • +
            + +
            + + +
            + + + diff --git a/com/textcontrol/reportingcloud/Credentials.html b/com/textcontrol/reportingcloud/Credentials.html new file mode 100644 index 0000000..4b3347e --- /dev/null +++ b/com/textcontrol/reportingcloud/Credentials.html @@ -0,0 +1,285 @@ + + + + + +Credentials (reportingcloud 1.3 API) + + + + + + + + +
            + + +
            Skip navigation links
            + + + + +
            +
            + + + +
            + +
            +
            + + +
            + + +
            + + +
            +
            com.textcontrol.reportingcloud
            +

            Class Credentials

            +
            +
            +
              +
            • java.lang.Object
              • +
            • +
                +
              • com.textcontrol.reportingcloud.Credentials
                • +
              +
              • +
            +
            +
              +
            • +
              +
              +
              public class Credentials
+extends java.lang.Object
              +
              Small helper class for reading the ReportingCloud credentials from a JSON file.
              +
              • +
            +
            +
            +
              +
            • + +
                +
              • + + +

                Field Summary

                + + + + + + + + + + + + + + +
                Fields 
                Modifier and TypeField and Description
                java.lang.Stringpassword 
                java.lang.Stringusername 
                +
                • +
              + +
                +
              • + + +

                Constructor Summary

                + + + + + + + + +
                Constructors 
                Constructor and Description
                Credentials() 
                +
                • +
              + +
                +
              • + + +

                Method Summary

                +
                  +
                • + + +

                  Methods inherited from class java.lang.Object

                  +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
                  • +
                +
                • +
              +
              • +
            +
            +
            +
              +
            • + +
                +
              • + + +

                Field Detail

                + + + +
                  +
                • +

                  username

                  +
                  public java.lang.String username
                  +
                  • +
                + + + +
                  +
                • +

                  password

                  +
                  public java.lang.String password
                  +
                  • +
                +
                • +
              + +
                +
              • + + +

                Constructor Detail

                + + + +
                  +
                • +

                  Credentials

                  +
                  public Credentials()
                  +
                  • +
                +
                • +
              +
              • +
            +
            +
            + + +
            + + +
            Skip navigation links
            + + + + +
            +
            + + + +
            + +
            +
            + + +
            + + +
            + + + diff --git a/com/textcontrol/reportingcloud/DocumentDivider.html b/com/textcontrol/reportingcloud/DocumentDivider.html new file mode 100644 index 0000000..27f2867 --- /dev/null +++ b/com/textcontrol/reportingcloud/DocumentDivider.html @@ -0,0 +1,382 @@ + + + + + +DocumentDivider (reportingcloud 1.3 API) + + + + + + + + +
            + + +
            Skip navigation links
            + + + + +
            +
            + + + +
            + +
            +
            + + +
            + + +
            + + +
            +
            com.textcontrol.reportingcloud
            +

            Enum DocumentDivider

            +
            +
            +
              +
            • java.lang.Object
              • +
            • +
                +
              • java.lang.Enum<DocumentDivider>
                • +
              • +
                  +
                • com.textcontrol.reportingcloud.DocumentDivider
                  • +
                +
                • +
              +
              • +
            +
            +
              +
            • +
              +
              All Implemented Interfaces:
              +
              java.io.Serializable, java.lang.Comparable<DocumentDivider>
              +
              +
              +
              +
              public enum DocumentDivider
+extends java.lang.Enum<DocumentDivider>
              +
              This enum lists all possible document divider options used by method + appendDocuments.
              +
              • +
            +
            +
            +
              +
            • + +
                +
              • + + +

                Enum Constant Summary

                + + + + + + + + + + + + + + +
                Enum Constants 
                Enum Constant and Description
                NewParagraph +
                Portable Network Graphics
                +
                NewSection +
                Windows Bitmap
                +
                None +
                Joint Photographic Experts Group
                +
                +
                • +
              + +
                +
              • + + +

                Method Summary

                + + + + + + + + + + + + + + + + + + +
                All Methods Static Methods Instance Methods Concrete Methods 
                Modifier and TypeMethod and Description
                inttoInt() +
                Returns the value expected by the ReportingCloud API.
                +
                static DocumentDividervalueOf(java.lang.String name) +
                Returns the enum constant of this type with the specified name.
                +
                static DocumentDivider[]values() +
                Returns an array containing the constants of this enum type, in +the order they are declared.
                +
                +
                  +
                • + + +

                  Methods inherited from class java.lang.Enum

                  +clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
                  • +
                +
                  +
                • + + +

                  Methods inherited from class java.lang.Object

                  +getClass, notify, notifyAll, wait, wait, wait
                  • +
                +
                • +
              +
              • +
            +
            +
            +
              +
            • + +
                +
              • + + +

                Enum Constant Detail

                + + + +
                  +
                • +

                  None

                  +
                  public static final DocumentDivider None
                  +
                  Joint Photographic Experts Group
                  +
                  • +
                + + + +
                  +
                • +

                  NewParagraph

                  +
                  public static final DocumentDivider NewParagraph
                  +
                  Portable Network Graphics
                  +
                  • +
                + + + +
                  +
                • +

                  NewSection

                  +
                  public static final DocumentDivider NewSection
                  +
                  Windows Bitmap
                  +
                  • +
                +
                • +
              + +
                +
              • + + +

                Method Detail

                + + + +
                  +
                • +

                  values

                  +
                  public static DocumentDivider[] values()
                  +
                  Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +
                  +for (DocumentDivider c : DocumentDivider.values())
+    System.out.println(c);
+
                  +
                  +
                  Returns:
                  +
                  an array containing the constants of this enum type, in the order they are declared
                  +
                  +
                  • +
                + + + +
                  +
                • +

                  valueOf

                  +
                  public static DocumentDivider valueOf(java.lang.String name)
                  +
                  Returns the enum constant of this type with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.)
                  +
                  +
                  Parameters:
                  +
                  name - the name of the enum constant to be returned.
                  +
                  Returns:
                  +
                  the enum constant with the specified name
                  +
                  Throws:
                  +
                  java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
                  +
                  java.lang.NullPointerException - if the argument is null
                  +
                  +
                  • +
                + + + +
                  +
                • +

                  toInt

                  +
                  public int toInt()
                  +
                  Returns the value expected by the ReportingCloud API.
                  +
                  +
                  Returns:
                  +
                  The value expected by the ReportingCloud API.
                  +
                  +
                  • +
                +
                • +
              +
              • +
            +
            +
            + + +
            + + +
            Skip navigation links
            + + + + +
            +
            + + + +
            + +
            +
            + + +
            + + +
            + + + diff --git a/com/textcontrol/reportingcloud/DocumentSettings.html b/com/textcontrol/reportingcloud/DocumentSettings.html new file mode 100644 index 0000000..c145053 --- /dev/null +++ b/com/textcontrol/reportingcloud/DocumentSettings.html @@ -0,0 +1,704 @@ + + + + + +DocumentSettings (reportingcloud 1.3 API) + + + + + + + + +
            + + +
            Skip navigation links
            + + + + +
            +
            + + + +
            + +
            +
            + + +
            + + +
            + + +
            +
            com.textcontrol.reportingcloud
            +

            Class DocumentSettings

            +
            +
            +
              +
            • java.lang.Object
              • +
            • +
                +
              • com.textcontrol.reportingcloud.DocumentSettings
                • +
              +
              • +
            +
            +
              +
            • +
              +
              Direct Known Subclasses:
              +
              MergeSettings
              +
              +
              +
              +
              public class DocumentSettings
+extends java.lang.Object
              +
              Holds the merge settings needed by the appendDocuments + method.
              +
              • +
            +
            +
            +
              +
            • + + + +
                +
              • + + +

                Constructor Summary

                + + + + + + + + +
                Constructors 
                Constructor and Description
                DocumentSettings() 
                +
                • +
              + +
                +
              • + + +

                Method Summary

                + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
                All Methods Instance Methods Concrete Methods 
                Modifier and TypeMethod and Description
                java.lang.StringgetAuthor() +
                Gets the document's author.
                +
                java.time.ZonedDateTimegetCreationDate() +
                Gets the creation date.
                +
                java.lang.StringgetCreatorApplication() +
                Gets the application which created the document.
                +
                java.lang.StringgetDocumentSubject() +
                Gets the document's subject.
                +
                java.lang.StringgetdocumentTitle() +
                Gets the document's title.
                +
                java.time.ZonedDateTimegetLastModificationDate() +
                Gets the last modification date.
                +
                java.lang.StringgetUserPassword() +
                Gets the password needed to open the document.
                +
                voidsetAuthor(java.lang.String author) +
                Sets the document's author.
                +
                voidsetCreationDate(java.lang.String creationDate) +
                Sets the creation date.
                +
                voidsetCreationDate(java.time.ZonedDateTime creationDate) +
                Sets the creation date.
                +
                voidsetCreatorApplication(java.lang.String creatorApplication) +
                Sets the application which created the document.
                +
                voidsetDocumentSubject(java.lang.String documentSubject) +
                Sets the document's subject.
                +
                voidsetDocumentTitle(java.lang.String documentTitle) +
                Sets the document's title.
                +
                voidsetLastModificationDate(java.lang.String lastModificationDate) +
                Sets the last modification date.
                +
                voidsetLastModificationDate(java.time.ZonedDateTime lastModificationDate) +
                Sets the last modification date.
                +
                voidsetUserPassword(java.lang.String userPassword) +
                Sets the password needed to open the document.
                +
                +
                  +
                • + + +

                  Methods inherited from class java.lang.Object

                  +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
                  • +
                +
                • +
              +
              • +
            +
            +
            +
              +
            • + +
                +
              • + + +

                Field Detail

                + + + +
                  +
                • +

                  _author

                  +
                  protected java.lang.String _author
                  +
                  • +
                + + + +
                  +
                • +

                  _creatorApplication

                  +
                  protected java.lang.String _creatorApplication
                  +
                  • +
                + + + +
                  +
                • +

                  _documentSubject

                  +
                  protected java.lang.String _documentSubject
                  +
                  • +
                + + + +
                  +
                • +

                  _documentTitle

                  +
                  protected java.lang.String _documentTitle
                  +
                  • +
                + + + +
                  +
                • +

                  _userPassword

                  +
                  protected java.lang.String _userPassword
                  +
                  • +
                + + + +
                  +
                • +

                  _lastModificationDate

                  +
                  protected java.time.ZonedDateTime _lastModificationDate
                  +
                  • +
                + + + +
                  +
                • +

                  _creationDate

                  +
                  protected java.time.ZonedDateTime _creationDate
                  +
                  • +
                +
                • +
              + +
                +
              • + + +

                Constructor Detail

                + + + +
                  +
                • +

                  DocumentSettings

                  +
                  public DocumentSettings()
                  +
                  • +
                +
                • +
              + +
                +
              • + + +

                Method Detail

                + + + +
                  +
                • +

                  getAuthor

                  +
                  public java.lang.String getAuthor()
                  +
                  Gets the document's author.
                  +
                  +
                  Returns:
                  +
                  The document's author.
                  +
                  +
                  • +
                + + + +
                  +
                • +

                  setAuthor

                  +
                  public void setAuthor(java.lang.String author)
                  +
                  Sets the document's author.
                  +
                  +
                  Parameters:
                  +
                  author - The document's author.
                  +
                  +
                  • +
                + + + +
                  +
                • +

                  getCreatorApplication

                  +
                  public java.lang.String getCreatorApplication()
                  +
                  Gets the application which created the document.
                  +
                  +
                  Returns:
                  +
                  The application which created the document.
                  +
                  +
                  • +
                + + + +
                  +
                • +

                  setCreatorApplication

                  +
                  public void setCreatorApplication(java.lang.String creatorApplication)
                  +
                  Sets the application which created the document.
                  +
                  +
                  Parameters:
                  +
                  creatorApplication - The application which created the document.
                  +
                  +
                  • +
                + + + +
                  +
                • +

                  getDocumentSubject

                  +
                  public java.lang.String getDocumentSubject()
                  +
                  Gets the document's subject.
                  +
                  +
                  Returns:
                  +
                  The document's subject.
                  +
                  +
                  • +
                + + + +
                  +
                • +

                  setDocumentSubject

                  +
                  public void setDocumentSubject(java.lang.String documentSubject)
                  +
                  Sets the document's subject.
                  +
                  +
                  Parameters:
                  +
                  documentSubject - The document's subject.
                  +
                  +
                  • +
                + + + +
                  +
                • +

                  getdocumentTitle

                  +
                  public java.lang.String getdocumentTitle()
                  +
                  Gets the document's title.
                  +
                  +
                  Returns:
                  +
                  The document's title.
                  +
                  +
                  • +
                + + + +
                  +
                • +

                  setDocumentTitle

                  +
                  public void setDocumentTitle(java.lang.String documentTitle)
                  +
                  Sets the document's title.
                  +
                  +
                  Parameters:
                  +
                  documentTitle - The document's title.
                  +
                  +
                  • +
                + + + +
                  +
                • +

                  getUserPassword

                  +
                  public java.lang.String getUserPassword()
                  +
                  Gets the password needed to open the document.
                  +
                  +
                  Returns:
                  +
                  The password needed to open the document.
                  +
                  +
                  • +
                + + + +
                  +
                • +

                  setUserPassword

                  +
                  public void setUserPassword(java.lang.String userPassword)
                  +
                  Sets the password needed to open the document.
                  +
                  +
                  Parameters:
                  +
                  userPassword - The password needed to open the document.
                  +
                  +
                  • +
                + + + +
                  +
                • +

                  getCreationDate

                  +
                  public java.time.ZonedDateTime getCreationDate()
                  +
                  Gets the creation date.
                  +
                  +
                  Returns:
                  +
                  The creation date.
                  +
                  +
                  • +
                + + + +
                  +
                • +

                  setCreationDate

                  +
                  public void setCreationDate(java.lang.String creationDate)
+                     throws java.time.format.DateTimeParseException
                  +
                  Sets the creation date.
                  +
                  +
                  Parameters:
                  +
                  creationDate - The creation date (ISO-8601 extended offset date-time format). + Can be null.
                  +
                  Throws:
                  +
                  java.time.format.DateTimeParseException
                  +
                  +
                  • +
                + + + +
                  +
                • +

                  setCreationDate

                  +
                  public void setCreationDate(java.time.ZonedDateTime creationDate)
                  +
                  Sets the creation date.
                  +
                  +
                  Parameters:
                  +
                  creationDate - The creation date. Can be null.
                  +
                  +
                  • +
                + + + +
                  +
                • +

                  getLastModificationDate

                  +
                  public java.time.ZonedDateTime getLastModificationDate()
                  +
                  Gets the last modification date.
                  +
                  +
                  Returns:
                  +
                  The last modification date.
                  +
                  +
                  • +
                + + + +
                  +
                • +

                  setLastModificationDate

                  +
                  public void setLastModificationDate(java.lang.String lastModificationDate)
+                             throws java.time.format.DateTimeParseException
                  +
                  Sets the last modification date.
                  +
                  +
                  Parameters:
                  +
                  lastModificationDate - The last modification date (ISO-8601 extended offset date-time format). + Can be null.
                  +
                  Throws:
                  +
                  java.time.format.DateTimeParseException
                  +
                  +
                  • +
                + + + +
                  +
                • +

                  setLastModificationDate

                  +
                  public void setLastModificationDate(java.time.ZonedDateTime lastModificationDate)
                  +
                  Sets the last modification date.
                  +
                  +
                  Parameters:
                  +
                  lastModificationDate - The last modification date. Can be null.
                  +
                  +
                  • +
                +
                • +
              +
              • +
            +
            +
            + + +
            + + +
            Skip navigation links
            + + + + +
            +
            + + + +
            + +
            +
            + + +
            + + +
            + + + diff --git a/com/textcontrol/reportingcloud/FindAndReplaceBody.html b/com/textcontrol/reportingcloud/FindAndReplaceBody.html index 8380b8a..a47c880 100644 --- a/com/textcontrol/reportingcloud/FindAndReplaceBody.html +++ b/com/textcontrol/reportingcloud/FindAndReplaceBody.html @@ -2,9 +2,9 @@ - -FindAndReplaceBody (reportingcloud 1.2 API) - + +FindAndReplaceBody (reportingcloud 1.3 API) + @@ -12,7 +12,7 @@ @@ -12,7 +12,7 @@ @@ -12,7 +12,7 @@ @@ -12,7 +12,7 @@ @@ -12,7 +12,7 @@ @@ -12,7 +12,7 @@ @@ -12,13 +12,13 @@ @@ -12,13 +12,13 @@ @@ -12,7 +12,7 @@ @@ -12,7 +12,7 @@ @@ -12,7 +12,7 @@ + + + + + +
            + + +
            Skip navigation links
            + + + + +
            +
            + + + +
            + +
            +
            +
              +
            • Summary: 
              • +
            • Nested | 
              • +
            • Field | 
              • +
            • Constr | 
              • +
            • Method
              • +
            + +
            + + +
            + + +
            +
            com.textcontrol.reportingcloud.gson
            +

            Class APIKeyDeserializer

            +
            +
            +
              +
            • java.lang.Object
              • +
            • +
                +
              • com.textcontrol.reportingcloud.gson.APIKeyDeserializer
                • +
              +
              • +
            +
            +
              +
            • +
              +
              All Implemented Interfaces:
              +
              com.google.gson.JsonDeserializer<APIKey>
              +
              +
              +
              +
              public class APIKeyDeserializer
+extends java.lang.Object
+implements com.google.gson.JsonDeserializer<APIKey>
              +
              • +
            +
            +
            +
              +
            • + +
                +
              • + + +

                Constructor Summary

                + + + + + + + + +
                Constructors 
                Constructor and Description
                APIKeyDeserializer() 
                +
                • +
              + +
                +
              • + + +

                Method Summary

                + + + + + + + + + + +
                All Methods Instance Methods Concrete Methods 
                Modifier and TypeMethod and Description
                APIKeydeserialize(com.google.gson.JsonElement json, + java.lang.reflect.Type typeOfT, + com.google.gson.JsonDeserializationContext context) 
                +
                  +
                • + + +

                  Methods inherited from class java.lang.Object

                  +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
                  • +
                +
                • +
              +
              • +
            +
            +
            +
              +
            • + +
                +
              • + + +

                Constructor Detail

                + + + +
                  +
                • +

                  APIKeyDeserializer

                  +
                  public APIKeyDeserializer()
                  +
                  • +
                +
                • +
              + +
                +
              • + + +

                Method Detail

                + + + +
                  +
                • +

                  deserialize

                  +
                  public APIKey deserialize(com.google.gson.JsonElement json,
+                          java.lang.reflect.Type typeOfT,
+                          com.google.gson.JsonDeserializationContext context)
+                   throws com.google.gson.JsonParseException
                  +
                  +
                  Specified by:
                  +
                  deserialize in interface com.google.gson.JsonDeserializer<APIKey>
                  +
                  Throws:
                  +
                  com.google.gson.JsonParseException
                  +
                  +
                  • +
                +
                • +
              +
              • +
            +
            +
            + + +
            + + +
            Skip navigation links
            + + + + +
            +
            + + + +
            + +
            +
            +
              +
            • Summary: 
              • +
            • Nested | 
              • +
            • Field | 
              • +
            • Constr | 
              • +
            • Method
              • +
            + +
            + + +
            + + + diff --git a/com/textcontrol/reportingcloud/gson/AccountSettingsDeserializer.html b/com/textcontrol/reportingcloud/gson/AccountSettingsDeserializer.html index f1dc054..8141163 100644 --- a/com/textcontrol/reportingcloud/gson/AccountSettingsDeserializer.html +++ b/com/textcontrol/reportingcloud/gson/AccountSettingsDeserializer.html @@ -2,9 +2,9 @@ - -AccountSettingsDeserializer (reportingcloud 1.2 API) - + +AccountSettingsDeserializer (reportingcloud 1.3 API) + @@ -12,7 +12,7 @@ + + + + + +
            + + +
            Skip navigation links
            + + + + +
            +
            + + + +
            + +
            +
            +
              +
            • Summary: 
              • +
            • Nested | 
              • +
            • Field | 
              • +
            • Constr | 
              • +
            • Method
              • +
            + +
            + + +
            + + +
            +
            com.textcontrol.reportingcloud.gson
            +

            Class AppendBodySerializer

            +
            +
            +
              +
            • java.lang.Object
              • +
            • +
                +
              • com.textcontrol.reportingcloud.gson.AppendBodySerializer
                • +
              +
              • +
            +
            +
              +
            • +
              +
              All Implemented Interfaces:
              +
              com.google.gson.JsonSerializer<AppendBody>
              +
              +
              +
              +
              public class AppendBodySerializer
+extends java.lang.Object
+implements com.google.gson.JsonSerializer<AppendBody>
              +
              Needed by GSON to serialize AppendBody objects to + JSON.
              +
              • +
            +
            +
            +
              +
            • + + + +
                +
              • + + +

                Method Summary

                + + + + + + + + + + +
                All Methods Instance Methods Concrete Methods 
                Modifier and TypeMethod and Description
                com.google.gson.JsonElementserialize(AppendBody src, + java.lang.reflect.Type typeOfSrc, + com.google.gson.JsonSerializationContext context) 
                +
                  +
                • + + +

                  Methods inherited from class java.lang.Object

                  +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
                  • +
                +
                • +
              +
              • +
            +
            +
            +
              +
            • + +
                +
              • + + +

                Constructor Detail

                + + + +
                  +
                • +

                  AppendBodySerializer

                  +
                  public AppendBodySerializer()
                  +
                  • +
                +
                • +
              + +
                +
              • + + +

                Method Detail

                + + + +
                  +
                • +

                  serialize

                  +
                  public com.google.gson.JsonElement serialize(AppendBody src,
+                                             java.lang.reflect.Type typeOfSrc,
+                                             com.google.gson.JsonSerializationContext context)
                  +
                  +
                  Specified by:
                  +
                  serialize in interface com.google.gson.JsonSerializer<AppendBody>
                  +
                  +
                  • +
                +
                • +
              +
              • +
            +
            +
            + + +
            + + +
            Skip navigation links
            + + + + +
            +
            + + + +
            + +
            +
            +
              +
            • Summary: 
              • +
            • Nested | 
              • +
            • Field | 
              • +
            • Constr | 
              • +
            • Method
              • +
            + +
            + + +
            + + + diff --git a/com/textcontrol/reportingcloud/gson/AppendDocumentSerializer.html b/com/textcontrol/reportingcloud/gson/AppendDocumentSerializer.html new file mode 100644 index 0000000..5910023 --- /dev/null +++ b/com/textcontrol/reportingcloud/gson/AppendDocumentSerializer.html @@ -0,0 +1,284 @@ + + + + + +AppendDocumentSerializer (reportingcloud 1.3 API) + + + + + + + + +
            + + +
            Skip navigation links
            + + + + +
            +
            + + + +
            + +
            +
            +
              +
            • Summary: 
              • +
            • Nested | 
              • +
            • Field | 
              • +
            • Constr | 
              • +
            • Method
              • +
            + +
            + + +
            + + +
            +
            com.textcontrol.reportingcloud.gson
            +

            Class AppendDocumentSerializer

            +
            +
            +
              +
            • java.lang.Object
              • +
            • +
                +
              • com.textcontrol.reportingcloud.gson.AppendDocumentSerializer
                • +
              +
              • +
            +
            +
              +
            • +
              +
              All Implemented Interfaces:
              +
              com.google.gson.JsonSerializer<AppendDocument>
              +
              +
              +
              +
              public class AppendDocumentSerializer
+extends java.lang.Object
+implements com.google.gson.JsonSerializer<AppendDocument>
              +
              Needed by GSON to serialize AppendDocument objects to + JSON.
              +
              • +
            +
            +
            +
              +
            • + + + +
                +
              • + + +

                Method Summary

                + + + + + + + + + + +
                All Methods Instance Methods Concrete Methods 
                Modifier and TypeMethod and Description
                com.google.gson.JsonElementserialize(AppendDocument src, + java.lang.reflect.Type typeOfSrc, + com.google.gson.JsonSerializationContext context) 
                +
                  +
                • + + +

                  Methods inherited from class java.lang.Object

                  +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
                  • +
                +
                • +
              +
              • +
            +
            +
            +
              +
            • + +
                +
              • + + +

                Constructor Detail

                + + + +
                  +
                • +

                  AppendDocumentSerializer

                  +
                  public AppendDocumentSerializer()
                  +
                  • +
                +
                • +
              + +
                +
              • + + +

                Method Detail

                + + + +
                  +
                • +

                  serialize

                  +
                  public com.google.gson.JsonElement serialize(AppendDocument src,
+                                             java.lang.reflect.Type typeOfSrc,
+                                             com.google.gson.JsonSerializationContext context)
                  +
                  +
                  Specified by:
                  +
                  serialize in interface com.google.gson.JsonSerializer<AppendDocument>
                  +
                  +
                  • +
                +
                • +
              +
              • +
            +
            +
            + + +
            + + +
            Skip navigation links
            + + + + +
            +
            + + + +
            + +
            +
            +
              +
            • Summary: 
              • +
            • Nested | 
              • +
            • Field | 
              • +
            • Constr | 
              • +
            • Method
              • +
            + +
            + + +
            + + + diff --git a/com/textcontrol/reportingcloud/gson/DocumentSettingsSerializer.html b/com/textcontrol/reportingcloud/gson/DocumentSettingsSerializer.html new file mode 100644 index 0000000..b01aab0 --- /dev/null +++ b/com/textcontrol/reportingcloud/gson/DocumentSettingsSerializer.html @@ -0,0 +1,284 @@ + + + + + +DocumentSettingsSerializer (reportingcloud 1.3 API) + + + + + + + + +
            + + +
            Skip navigation links
            + + + + +
            +
            + + + +
            + +
            +
            +
              +
            • Summary: 
              • +
            • Nested | 
              • +
            • Field | 
              • +
            • Constr | 
              • +
            • Method
              • +
            + +
            + + +
            + + +
            +
            com.textcontrol.reportingcloud.gson
            +

            Class DocumentSettingsSerializer

            +
            +
            +
              +
            • java.lang.Object
              • +
            • +
                +
              • com.textcontrol.reportingcloud.gson.DocumentSettingsSerializer
                • +
              +
              • +
            +
            +
              +
            • +
              +
              All Implemented Interfaces:
              +
              com.google.gson.JsonSerializer<DocumentSettings>
              +
              +
              +
              +
              public class DocumentSettingsSerializer
+extends java.lang.Object
+implements com.google.gson.JsonSerializer<DocumentSettings>
              +
              Needed by GSON to serialize DocumentSettings objects to + JSON.
              +
              • +
            +
            +
            +
              +
            • + + + +
                +
              • + + +

                Method Summary

                + + + + + + + + + + +
                All Methods Instance Methods Concrete Methods 
                Modifier and TypeMethod and Description
                com.google.gson.JsonElementserialize(DocumentSettings src, + java.lang.reflect.Type typeOfSrc, + com.google.gson.JsonSerializationContext context) 
                +
                  +
                • + + +

                  Methods inherited from class java.lang.Object

                  +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
                  • +
                +
                • +
              +
              • +
            +
            +
            +
              +
            • + +
                +
              • + + +

                Constructor Detail

                + + + +
                  +
                • +

                  DocumentSettingsSerializer

                  +
                  public DocumentSettingsSerializer()
                  +
                  • +
                +
                • +
              + +
                +
              • + + +

                Method Detail

                + + + +
                  +
                • +

                  serialize

                  +
                  public com.google.gson.JsonElement serialize(DocumentSettings src,
+                                             java.lang.reflect.Type typeOfSrc,
+                                             com.google.gson.JsonSerializationContext context)
                  +
                  +
                  Specified by:
                  +
                  serialize in interface com.google.gson.JsonSerializer<DocumentSettings>
                  +
                  +
                  • +
                +
                • +
              +
              • +
            +
            +
            + + +
            + + +
            Skip navigation links
            + + + + +
            +
            + + + +
            + +
            +
            +
              +
            • Summary: 
              • +
            • Nested | 
              • +
            • Field | 
              • +
            • Constr | 
              • +
            • Method
              • +
            + +
            + + +
            + + + diff --git a/com/textcontrol/reportingcloud/gson/FindAndReplaceBodySerializer.html b/com/textcontrol/reportingcloud/gson/FindAndReplaceBodySerializer.html index d22c316..14ac340 100644 --- a/com/textcontrol/reportingcloud/gson/FindAndReplaceBodySerializer.html +++ b/com/textcontrol/reportingcloud/gson/FindAndReplaceBodySerializer.html @@ -2,9 +2,9 @@ - -FindAndReplaceBodySerializer (reportingcloud 1.2 API) - + +FindAndReplaceBodySerializer (reportingcloud 1.3 API) + @@ -12,7 +12,7 @@ @@ -12,7 +12,7 @@ @@ -12,7 +12,7 @@ @@ -12,7 +12,7 @@ @@ -12,7 +12,7 @@ @@ -12,7 +12,7 @@ @@ -12,7 +12,7 @@ @@ -12,7 +12,7 @@ @@ -14,6 +14,10 @@

            Classes

            • AccountSettingsDeserializer
              • +
            • APIKeyDeserializer
              • +
            • AppendBodySerializer
              • +
            • AppendDocumentSerializer
              • +
            • DocumentSettingsSerializer
            • FindAndReplaceBodySerializer
            • IncorrectWordDeserializer
            • MergeBlockDeserializer
              • diff --git a/com/textcontrol/reportingcloud/gson/package-summary.html b/com/textcontrol/reportingcloud/gson/package-summary.html index f523273..dbde215 100644 --- a/com/textcontrol/reportingcloud/gson/package-summary.html +++ b/com/textcontrol/reportingcloud/gson/package-summary.html @@ -2,9 +2,9 @@ - -com.textcontrol.reportingcloud.gson (reportingcloud 1.2 API) - + +com.textcontrol.reportingcloud.gson (reportingcloud 1.3 API) + @@ -12,7 +12,7 @@ @@ -12,7 +12,7 @@ @@ -14,6 +14,11 @@

              Classes

              Enums

              diff --git a/com/textcontrol/reportingcloud/package-summary.html b/com/textcontrol/reportingcloud/package-summary.html index 839efaa..11bf03c 100644 --- a/com/textcontrol/reportingcloud/package-summary.html +++ b/com/textcontrol/reportingcloud/package-summary.html @@ -2,9 +2,9 @@ - -com.textcontrol.reportingcloud (reportingcloud 1.2 API) - + +com.textcontrol.reportingcloud (reportingcloud 1.3 API) + @@ -12,7 +12,7 @@ @@ -12,7 +12,7 @@ @@ -12,7 +12,7 @@ @@ -12,7 +12,7 @@ @@ -12,7 +12,7 @@ @@ -12,7 +12,7 @@ diff --git a/overview-summary.html b/overview-summary.html index 495f85b..5343fcb 100644 --- a/overview-summary.html +++ b/overview-summary.html @@ -2,9 +2,9 @@ - -Overview (reportingcloud 1.2 API) - + +Overview (reportingcloud 1.3 API) + @@ -12,7 +12,7 @@ @@ -12,7 +12,7 @@ @@ -20,7 +20,6 @@

              All Classes

            • AppendBodySerializer
            • AppendDocument
            • AppendDocumentSerializer
              • -
            • Credentials
            • DocumentDivider
            • DocumentSettings
            • DocumentSettingsSerializer
              • diff --git a/allclasses-noframe.html b/allclasses-noframe.html index 52ea180..44f1fa2 100644 --- a/allclasses-noframe.html +++ b/allclasses-noframe.html @@ -2,9 +2,9 @@ - + All Classes (reportingcloud 1.3 API) - + @@ -20,7 +20,6 @@

              All Classes

            • AppendBodySerializer
            • AppendDocument
            • AppendDocumentSerializer
              • -
            • Credentials
            • DocumentDivider
            • DocumentSettings
            • DocumentSettingsSerializer
              • diff --git a/com/textcontrol/reportingcloud/APIKey.html b/com/textcontrol/reportingcloud/APIKey.html index f853191..789286f 100644 --- a/com/textcontrol/reportingcloud/APIKey.html +++ b/com/textcontrol/reportingcloud/APIKey.html @@ -2,9 +2,9 @@ - + APIKey (reportingcloud 1.3 API) - + diff --git a/com/textcontrol/reportingcloud/AccountSettings.html b/com/textcontrol/reportingcloud/AccountSettings.html index 8bbcddf..0e09e2e 100644 --- a/com/textcontrol/reportingcloud/AccountSettings.html +++ b/com/textcontrol/reportingcloud/AccountSettings.html @@ -2,9 +2,9 @@ - + AccountSettings (reportingcloud 1.3 API) - + diff --git a/com/textcontrol/reportingcloud/AppendBody.html b/com/textcontrol/reportingcloud/AppendBody.html index a2ebcab..f7471d3 100644 --- a/com/textcontrol/reportingcloud/AppendBody.html +++ b/com/textcontrol/reportingcloud/AppendBody.html @@ -2,9 +2,9 @@ - + AppendBody (reportingcloud 1.3 API) - + @@ -110,7 +110,7 @@

              Class AppendBody


              public class AppendBody
 extends java.lang.Object
              -
              Used to pass data to the appendDocuments +
              Passes data to the appendDocuments method.
            diff --git a/com/textcontrol/reportingcloud/AppendDocument.html b/com/textcontrol/reportingcloud/AppendDocument.html index 2596637..429b990 100644 --- a/com/textcontrol/reportingcloud/AppendDocument.html +++ b/com/textcontrol/reportingcloud/AppendDocument.html @@ -2,9 +2,9 @@ - + AppendDocument (reportingcloud 1.3 API) - + @@ -49,7 +49,7 @@
            • Frames
              • @@ -326,7 +326,7 @@

              setDivider

              • Frames
                • diff --git a/com/textcontrol/reportingcloud/DocumentDivider.html b/com/textcontrol/reportingcloud/DocumentDivider.html index 27f2867..2ea1cc7 100644 --- a/com/textcontrol/reportingcloud/DocumentDivider.html +++ b/com/textcontrol/reportingcloud/DocumentDivider.html @@ -2,9 +2,9 @@ - + DocumentDivider (reportingcloud 1.3 API) - + @@ -48,7 +48,7 @@
                @@ -337,7 +337,7 @@

                toInt

                diff --git a/com/textcontrol/reportingcloud/DocumentSettings.html b/com/textcontrol/reportingcloud/DocumentSettings.html index c145053..0ddd169 100644 --- a/com/textcontrol/reportingcloud/DocumentSettings.html +++ b/com/textcontrol/reportingcloud/DocumentSettings.html @@ -2,9 +2,9 @@ - + DocumentSettings (reportingcloud 1.3 API) - + @@ -74,13 +74,13 @@ @@ -122,49 +122,6 @@

                Class DocumentSettings

                • - -
                  • @@ -306,77 +263,6 @@

                    Methods inherited from class java.lang.Object

                    • - -
                        -
                      • - - -

                        Field Detail

                        - - - -
                          -
                        • -

                          _author

                          -
                          protected java.lang.String _author
                          -
                          • -
                        - - - -
                          -
                        • -

                          _creatorApplication

                          -
                          protected java.lang.String _creatorApplication
                          -
                          • -
                        - - - -
                          -
                        • -

                          _documentSubject

                          -
                          protected java.lang.String _documentSubject
                          -
                          • -
                        - - - -
                          -
                        • -

                          _documentTitle

                          -
                          protected java.lang.String _documentTitle
                          -
                          • -
                        - - - -
                          -
                        • -

                          _userPassword

                          -
                          protected java.lang.String _userPassword
                          -
                          • -
                        - - - -
                          -
                        • -

                          _lastModificationDate

                          -
                          protected java.time.ZonedDateTime _lastModificationDate
                          -
                          • -
                        - - - -
                          -
                        • -

                          _creationDate

                          -
                          protected java.time.ZonedDateTime _creationDate
                          -
                          • -
                        -
                        • -
                      • @@ -685,13 +571,13 @@

                        setLastModificationDate

                         diff --git a/com/textcontrol/reportingcloud/FindAndReplaceBody.html b/com/textcontrol/reportingcloud/FindAndReplaceBody.html index a47c880..7667f0a 100644 --- a/com/textcontrol/reportingcloud/FindAndReplaceBody.html +++ b/com/textcontrol/reportingcloud/FindAndReplaceBody.html @@ -2,9 +2,9 @@ - + FindAndReplaceBody (reportingcloud 1.3 API) - + @@ -110,7 +110,7 @@

                        Class FindAndReplaceBody


                        public class FindAndReplaceBody
 extends java.lang.Object
                        -
                        Used to pass data to the find and replace method.
                        +
                        Passes data to the find and replace method.
                    diff --git a/com/textcontrol/reportingcloud/ImageFormat.html b/com/textcontrol/reportingcloud/ImageFormat.html index 16688e7..bce2a55 100644 --- a/com/textcontrol/reportingcloud/ImageFormat.html +++ b/com/textcontrol/reportingcloud/ImageFormat.html @@ -2,9 +2,9 @@ - + ImageFormat (reportingcloud 1.3 API) - + diff --git a/com/textcontrol/reportingcloud/IncorrectWord.html b/com/textcontrol/reportingcloud/IncorrectWord.html index 239361f..7a31d00 100644 --- a/com/textcontrol/reportingcloud/IncorrectWord.html +++ b/com/textcontrol/reportingcloud/IncorrectWord.html @@ -2,9 +2,9 @@ - + IncorrectWord (reportingcloud 1.3 API) - + diff --git a/com/textcontrol/reportingcloud/MergeBlock.html b/com/textcontrol/reportingcloud/MergeBlock.html index 454b5e8..f43cbe9 100644 --- a/com/textcontrol/reportingcloud/MergeBlock.html +++ b/com/textcontrol/reportingcloud/MergeBlock.html @@ -2,9 +2,9 @@ - + MergeBlock (reportingcloud 1.3 API) - + diff --git a/com/textcontrol/reportingcloud/MergeBody.html b/com/textcontrol/reportingcloud/MergeBody.html index 051a6f3..e63770e 100644 --- a/com/textcontrol/reportingcloud/MergeBody.html +++ b/com/textcontrol/reportingcloud/MergeBody.html @@ -2,9 +2,9 @@ - + MergeBody (reportingcloud 1.3 API) - + @@ -110,7 +110,7 @@

                    Class MergeBody


                    public class MergeBody
 extends java.lang.Object
                    -
                    Used to pass data to the mergeDocument +
                    Passes data to the mergeDocument method.
                  diff --git a/com/textcontrol/reportingcloud/MergeField.html b/com/textcontrol/reportingcloud/MergeField.html index 0fb3650..03140b4 100644 --- a/com/textcontrol/reportingcloud/MergeField.html +++ b/com/textcontrol/reportingcloud/MergeField.html @@ -2,9 +2,9 @@ - + MergeField (reportingcloud 1.3 API) - + diff --git a/com/textcontrol/reportingcloud/MergeSettings.html b/com/textcontrol/reportingcloud/MergeSettings.html index baf2c8a..b736333 100644 --- a/com/textcontrol/reportingcloud/MergeSettings.html +++ b/com/textcontrol/reportingcloud/MergeSettings.html @@ -2,9 +2,9 @@ - + MergeSettings (reportingcloud 1.3 API) - + @@ -74,7 +74,7 @@ @@ -123,21 +123,6 @@

                  Class MergeSettings

                  • - -
                    • @@ -477,7 +462,7 @@

                      setMergeHtml

                       diff --git a/com/textcontrol/reportingcloud/ReportingCloud.html b/com/textcontrol/reportingcloud/ReportingCloud.html index fa579b8..121a1d0 100644 --- a/com/textcontrol/reportingcloud/ReportingCloud.html +++ b/com/textcontrol/reportingcloud/ReportingCloud.html @@ -2,9 +2,9 @@ - + ReportingCloud (reportingcloud 1.3 API) - + diff --git a/com/textcontrol/reportingcloud/ReturnFormat.html b/com/textcontrol/reportingcloud/ReturnFormat.html index 278aa82..7b710b3 100644 --- a/com/textcontrol/reportingcloud/ReturnFormat.html +++ b/com/textcontrol/reportingcloud/ReturnFormat.html @@ -2,9 +2,9 @@ - + ReturnFormat (reportingcloud 1.3 API) - + diff --git a/com/textcontrol/reportingcloud/Template.html b/com/textcontrol/reportingcloud/Template.html index 583a5d0..900b0e6 100644 --- a/com/textcontrol/reportingcloud/Template.html +++ b/com/textcontrol/reportingcloud/Template.html @@ -2,9 +2,9 @@ - + Template (reportingcloud 1.3 API) - + diff --git a/com/textcontrol/reportingcloud/TemplateInfo.html b/com/textcontrol/reportingcloud/TemplateInfo.html index fe68027..1723a56 100644 --- a/com/textcontrol/reportingcloud/TemplateInfo.html +++ b/com/textcontrol/reportingcloud/TemplateInfo.html @@ -2,9 +2,9 @@ - + TemplateInfo (reportingcloud 1.3 API) - + diff --git a/com/textcontrol/reportingcloud/gson/APIKeyDeserializer.html b/com/textcontrol/reportingcloud/gson/APIKeyDeserializer.html index 377ff28..4644dc6 100644 --- a/com/textcontrol/reportingcloud/gson/APIKeyDeserializer.html +++ b/com/textcontrol/reportingcloud/gson/APIKeyDeserializer.html @@ -2,9 +2,9 @@ - + APIKeyDeserializer (reportingcloud 1.3 API) - + diff --git a/com/textcontrol/reportingcloud/gson/AccountSettingsDeserializer.html b/com/textcontrol/reportingcloud/gson/AccountSettingsDeserializer.html index 8141163..5a25616 100644 --- a/com/textcontrol/reportingcloud/gson/AccountSettingsDeserializer.html +++ b/com/textcontrol/reportingcloud/gson/AccountSettingsDeserializer.html @@ -2,9 +2,9 @@ - + AccountSettingsDeserializer (reportingcloud 1.3 API) - + diff --git a/com/textcontrol/reportingcloud/gson/AppendBodySerializer.html b/com/textcontrol/reportingcloud/gson/AppendBodySerializer.html index 62f274c..8379043 100644 --- a/com/textcontrol/reportingcloud/gson/AppendBodySerializer.html +++ b/com/textcontrol/reportingcloud/gson/AppendBodySerializer.html @@ -2,9 +2,9 @@ - + AppendBodySerializer (reportingcloud 1.3 API) - + diff --git a/com/textcontrol/reportingcloud/gson/AppendDocumentSerializer.html b/com/textcontrol/reportingcloud/gson/AppendDocumentSerializer.html index 5910023..caedf7b 100644 --- a/com/textcontrol/reportingcloud/gson/AppendDocumentSerializer.html +++ b/com/textcontrol/reportingcloud/gson/AppendDocumentSerializer.html @@ -2,9 +2,9 @@ - + AppendDocumentSerializer (reportingcloud 1.3 API) - + diff --git a/com/textcontrol/reportingcloud/gson/DocumentSettingsSerializer.html b/com/textcontrol/reportingcloud/gson/DocumentSettingsSerializer.html index b01aab0..aec3adb 100644 --- a/com/textcontrol/reportingcloud/gson/DocumentSettingsSerializer.html +++ b/com/textcontrol/reportingcloud/gson/DocumentSettingsSerializer.html @@ -2,9 +2,9 @@ - + DocumentSettingsSerializer (reportingcloud 1.3 API) - + diff --git a/com/textcontrol/reportingcloud/gson/FindAndReplaceBodySerializer.html b/com/textcontrol/reportingcloud/gson/FindAndReplaceBodySerializer.html index 14ac340..7a8bfb4 100644 --- a/com/textcontrol/reportingcloud/gson/FindAndReplaceBodySerializer.html +++ b/com/textcontrol/reportingcloud/gson/FindAndReplaceBodySerializer.html @@ -2,9 +2,9 @@ - + FindAndReplaceBodySerializer (reportingcloud 1.3 API) - + diff --git a/com/textcontrol/reportingcloud/gson/IncorrectWordDeserializer.html b/com/textcontrol/reportingcloud/gson/IncorrectWordDeserializer.html index ec282d8..6245e55 100644 --- a/com/textcontrol/reportingcloud/gson/IncorrectWordDeserializer.html +++ b/com/textcontrol/reportingcloud/gson/IncorrectWordDeserializer.html @@ -2,9 +2,9 @@ - + IncorrectWordDeserializer (reportingcloud 1.3 API) - + diff --git a/com/textcontrol/reportingcloud/gson/MergeBlockDeserializer.html b/com/textcontrol/reportingcloud/gson/MergeBlockDeserializer.html index c940397..94f5012 100644 --- a/com/textcontrol/reportingcloud/gson/MergeBlockDeserializer.html +++ b/com/textcontrol/reportingcloud/gson/MergeBlockDeserializer.html @@ -2,9 +2,9 @@ - + MergeBlockDeserializer (reportingcloud 1.3 API) - + diff --git a/com/textcontrol/reportingcloud/gson/MergeBodySerializer.html b/com/textcontrol/reportingcloud/gson/MergeBodySerializer.html index 92cc175..d8c5fa3 100644 --- a/com/textcontrol/reportingcloud/gson/MergeBodySerializer.html +++ b/com/textcontrol/reportingcloud/gson/MergeBodySerializer.html @@ -2,9 +2,9 @@ - + MergeBodySerializer (reportingcloud 1.3 API) - + diff --git a/com/textcontrol/reportingcloud/gson/MergeFieldDeserializer.html b/com/textcontrol/reportingcloud/gson/MergeFieldDeserializer.html index 57ee18a..c45212d 100644 --- a/com/textcontrol/reportingcloud/gson/MergeFieldDeserializer.html +++ b/com/textcontrol/reportingcloud/gson/MergeFieldDeserializer.html @@ -2,9 +2,9 @@ - + MergeFieldDeserializer (reportingcloud 1.3 API) - + diff --git a/com/textcontrol/reportingcloud/gson/MergeSettingsSerializer.html b/com/textcontrol/reportingcloud/gson/MergeSettingsSerializer.html index d28d372..b82d715 100644 --- a/com/textcontrol/reportingcloud/gson/MergeSettingsSerializer.html +++ b/com/textcontrol/reportingcloud/gson/MergeSettingsSerializer.html @@ -2,9 +2,9 @@ - + MergeSettingsSerializer (reportingcloud 1.3 API) - + diff --git a/com/textcontrol/reportingcloud/gson/TemplateDeserializer.html b/com/textcontrol/reportingcloud/gson/TemplateDeserializer.html index b4476c1..537b4e0 100644 --- a/com/textcontrol/reportingcloud/gson/TemplateDeserializer.html +++ b/com/textcontrol/reportingcloud/gson/TemplateDeserializer.html @@ -2,9 +2,9 @@ - + TemplateDeserializer (reportingcloud 1.3 API) - + diff --git a/com/textcontrol/reportingcloud/gson/TemplateInfoDeserializer.html b/com/textcontrol/reportingcloud/gson/TemplateInfoDeserializer.html index 3e421df..e8b1f5c 100644 --- a/com/textcontrol/reportingcloud/gson/TemplateInfoDeserializer.html +++ b/com/textcontrol/reportingcloud/gson/TemplateInfoDeserializer.html @@ -2,9 +2,9 @@ - + TemplateInfoDeserializer (reportingcloud 1.3 API) - + diff --git a/com/textcontrol/reportingcloud/gson/package-frame.html b/com/textcontrol/reportingcloud/gson/package-frame.html index aef2caf..84e588e 100644 --- a/com/textcontrol/reportingcloud/gson/package-frame.html +++ b/com/textcontrol/reportingcloud/gson/package-frame.html @@ -2,9 +2,9 @@ - + com.textcontrol.reportingcloud.gson (reportingcloud 1.3 API) - + diff --git a/com/textcontrol/reportingcloud/gson/package-summary.html b/com/textcontrol/reportingcloud/gson/package-summary.html index dbde215..71a6b45 100644 --- a/com/textcontrol/reportingcloud/gson/package-summary.html +++ b/com/textcontrol/reportingcloud/gson/package-summary.html @@ -2,9 +2,9 @@ - + com.textcontrol.reportingcloud.gson (reportingcloud 1.3 API) - + diff --git a/com/textcontrol/reportingcloud/gson/package-tree.html b/com/textcontrol/reportingcloud/gson/package-tree.html index 8b4dad4..526bae5 100644 --- a/com/textcontrol/reportingcloud/gson/package-tree.html +++ b/com/textcontrol/reportingcloud/gson/package-tree.html @@ -2,9 +2,9 @@ - + com.textcontrol.reportingcloud.gson Class Hierarchy (reportingcloud 1.3 API) - + diff --git a/com/textcontrol/reportingcloud/package-frame.html b/com/textcontrol/reportingcloud/package-frame.html index 17d8baa..9976c62 100644 --- a/com/textcontrol/reportingcloud/package-frame.html +++ b/com/textcontrol/reportingcloud/package-frame.html @@ -2,9 +2,9 @@ - + com.textcontrol.reportingcloud (reportingcloud 1.3 API) - + @@ -17,7 +17,6 @@

                      Classes

                    • APIKey
                    • AppendBody
                    • AppendDocument
                      • -
                    • Credentials
                    • DocumentSettings
                    • FindAndReplaceBody
                    • IncorrectWord
                      • diff --git a/com/textcontrol/reportingcloud/package-summary.html b/com/textcontrol/reportingcloud/package-summary.html index 11bf03c..ac89cea 100644 --- a/com/textcontrol/reportingcloud/package-summary.html +++ b/com/textcontrol/reportingcloud/package-summary.html @@ -2,9 +2,9 @@ - + com.textcontrol.reportingcloud (reportingcloud 1.3 API) - + @@ -100,7 +100,7 @@

                      Package com.textcontrol.reportingcloud AppendBody -
                      Used to pass data to the appendDocuments +
                      Passes data to the appendDocuments method.
                      @@ -112,69 +112,63 @@

                      Package com.textcontrol.reportingcloud -Credentials - -
                      Small helper class for reading the ReportingCloud credentials from a JSON file.
                      - - - DocumentSettings
                      Holds the merge settings needed by the appendDocuments method.
                      - + FindAndReplaceBody -
                      Used to pass data to the find and replace method.
                      +
                      Passes data to the find and replace method.
                      - + IncorrectWord
                      Represents an incorrect word in a spell checked text.
                      - + MergeBlock
                      Represents a merge block in a document template.
                      - + MergeBody -
                      Used to pass data to the mergeDocument +
                      Passes data to the mergeDocument method.
                      - + MergeField
                      Represents a merge field in a document template.
                      - + MergeSettings
                      Holds the merge settings needed by the mergeDocument method.
                      - + ReportingCloud
                      The ReportingCloud API wrapper class.
                      - + Template
                      Holds information about a template in the template storage.
                      - + TemplateInfo
                      Holds information about the merge blocks and merge fields in a template.
                      diff --git a/com/textcontrol/reportingcloud/package-tree.html b/com/textcontrol/reportingcloud/package-tree.html index 89607e6..81ad9e1 100644 --- a/com/textcontrol/reportingcloud/package-tree.html +++ b/com/textcontrol/reportingcloud/package-tree.html @@ -2,9 +2,9 @@ - + com.textcontrol.reportingcloud Class Hierarchy (reportingcloud 1.3 API) - + @@ -84,7 +84,6 @@

                      Class Hierarchy

                    • com.textcontrol.reportingcloud.APIKey
                    • com.textcontrol.reportingcloud.AppendBody
                    • com.textcontrol.reportingcloud.AppendDocument
                      • -
                    • com.textcontrol.reportingcloud.Credentials
                    • com.textcontrol.reportingcloud.DocumentSettings
                      • com.textcontrol.reportingcloud.MergeSettings
                        • diff --git a/constant-values.html b/constant-values.html index 696f9f5..4e7866f 100644 --- a/constant-values.html +++ b/constant-values.html @@ -2,9 +2,9 @@ - + Constant Field Values (reportingcloud 1.3 API) - + diff --git a/deprecated-list.html b/deprecated-list.html index ca23168..c7ecf6b 100644 --- a/deprecated-list.html +++ b/deprecated-list.html @@ -2,9 +2,9 @@ - + Deprecated List (reportingcloud 1.3 API) - + diff --git a/help-doc.html b/help-doc.html index 133e60d..2c47d4b 100644 --- a/help-doc.html +++ b/help-doc.html @@ -2,9 +2,9 @@ - + API Help (reportingcloud 1.3 API) - + diff --git a/index-all.html b/index-all.html index 95f7496..62d52a8 100644 --- a/index-all.html +++ b/index-all.html @@ -2,9 +2,9 @@ - + Index (reportingcloud 1.3 API) - + @@ -68,7 +68,7 @@
                      • -
                      A C D F G I L M P R S T U V _  +
                      A C D F G I L M R S T U V 

                      A

                      @@ -97,7 +97,7 @@

                      A

                       
                      AppendBody - Class in com.textcontrol.reportingcloud
                      -
                      Used to pass data to the appendDocuments +
                      Passes data to the appendDocuments method.
                      AppendBody(List<AppendDocument>) - Constructor for class com.textcontrol.reportingcloud.AppendBody
                      @@ -173,12 +173,6 @@

                      C

                      Creates and returns a new API key.
                      -
                      Credentials - Class in com.textcontrol.reportingcloud
                      -
                      -
                      Small helper class for reading the ReportingCloud credentials from a JSON file.
                      -
                      -
                      Credentials() - Constructor for class com.textcontrol.reportingcloud.Credentials
                      -
                       
                      @@ -254,7 +248,7 @@

                      F

    FindAndReplaceBody - Class in com.textcontrol.reportingcloud
    -
    Used to pass data to the find and replace method.
    +
    Passes data to the find and replace method.
    FindAndReplaceBody(List<Pair<String, String>>, byte[], MergeSettings) - Constructor for class com.textcontrol.reportingcloud.FindAndReplaceBody
     
    @@ -584,7 +578,7 @@

    M

     
    MergeBody - Class in com.textcontrol.reportingcloud
    -
    Used to pass data to the mergeDocument +
    Passes data to the mergeDocument method.
    MergeBody(Iterable<Object>) - Constructor for class com.textcontrol.reportingcloud.MergeBody
    @@ -653,14 +647,6 @@

    M

    MergeSettingsSerializer() - Constructor for class com.textcontrol.reportingcloud.gson.MergeSettingsSerializer
     
    - - - -

    P

    -
    -
    password - Variable in class com.textcontrol.reportingcloud.Credentials
    -
     
    -
    @@ -855,8 +841,6 @@

    U

    Stores an uploaded template in the template storage (.doc, .docx, .rtf and .tx).
    -
    username - Variable in class com.textcontrol.reportingcloud.Credentials
    -
     
    @@ -891,27 +875,7 @@

    V

    the order they are declared. -     - - -

    _

    -
    -
    _author - Variable in class com.textcontrol.reportingcloud.DocumentSettings
    -
     
    -
    _creationDate - Variable in class com.textcontrol.reportingcloud.DocumentSettings
    -
     
    -
    _creatorApplication - Variable in class com.textcontrol.reportingcloud.DocumentSettings
    -
     
    -
    _documentSubject - Variable in class com.textcontrol.reportingcloud.DocumentSettings
    -
     
    -
    _documentTitle - Variable in class com.textcontrol.reportingcloud.DocumentSettings
    -
     
    -
    _lastModificationDate - Variable in class com.textcontrol.reportingcloud.DocumentSettings
    -
     
    -
    _userPassword - Variable in class com.textcontrol.reportingcloud.DocumentSettings
    -
     
    -
    -A C D F G I L M P R S T U V _  +A C D F G I L M R S T U V 
    diff --git a/index.html b/index.html index 6cb0b81..7373896 100644 --- a/index.html +++ b/index.html @@ -2,7 +2,7 @@ - + reportingcloud 1.3 API diff --git a/overview-summary.html b/overview-summary.html index 5343fcb..6b55986 100644 --- a/overview-summary.html +++ b/overview-summary.html @@ -2,9 +2,9 @@ - + Overview (reportingcloud 1.3 API) - + diff --git a/overview-tree.html b/overview-tree.html index 5f257f4..2da6d6b 100644 --- a/overview-tree.html +++ b/overview-tree.html @@ -2,9 +2,9 @@ - + Class Hierarchy (reportingcloud 1.3 API) - + @@ -89,7 +89,6 @@

    Class Hierarchy

  • com.textcontrol.reportingcloud.gson.AppendBodySerializer (implements com.google.gson.JsonSerializer<T>)
  • com.textcontrol.reportingcloud.AppendDocument
  • com.textcontrol.reportingcloud.gson.AppendDocumentSerializer (implements com.google.gson.JsonSerializer<T>)
    • -
  • com.textcontrol.reportingcloud.Credentials
  • com.textcontrol.reportingcloud.DocumentSettings
    • com.textcontrol.reportingcloud.MergeSettings
      • From 89478f2b57567c5af0b15e96ace2f7b67e9fa21d Mon Sep 17 00:00:00 2001 From: Thorsten Date: Mon, 4 Mar 2019 16:22:21 +0100 Subject: [PATCH 19/20] "Wrapper" --> "SDK". Adding plain text as a possible return value. --- allclasses-frame.html | 4 ++-- allclasses-noframe.html | 4 ++-- com/textcontrol/reportingcloud/APIKey.html | 4 ++-- .../reportingcloud/AccountSettings.html | 4 ++-- .../reportingcloud/AppendBody.html | 4 ++-- .../reportingcloud/AppendDocument.html | 4 ++-- .../reportingcloud/DocumentDivider.html | 4 ++-- .../reportingcloud/DocumentSettings.html | 4 ++-- .../reportingcloud/FindAndReplaceBody.html | 4 ++-- .../reportingcloud/ImageFormat.html | 4 ++-- .../reportingcloud/IncorrectWord.html | 4 ++-- .../reportingcloud/MergeBlock.html | 4 ++-- com/textcontrol/reportingcloud/MergeBody.html | 4 ++-- .../reportingcloud/MergeField.html | 4 ++-- .../reportingcloud/MergeSettings.html | 4 ++-- .../reportingcloud/ReportingCloud.html | 18 +++++++++--------- .../reportingcloud/ReturnFormat.html | 19 +++++++++++++++++-- com/textcontrol/reportingcloud/Template.html | 4 ++-- .../reportingcloud/TemplateInfo.html | 4 ++-- .../gson/APIKeyDeserializer.html | 4 ++-- .../gson/AccountSettingsDeserializer.html | 4 ++-- .../gson/AppendBodySerializer.html | 4 ++-- .../gson/AppendDocumentSerializer.html | 4 ++-- .../gson/DocumentSettingsSerializer.html | 4 ++-- .../gson/FindAndReplaceBodySerializer.html | 4 ++-- .../gson/IncorrectWordDeserializer.html | 4 ++-- .../gson/MergeBlockDeserializer.html | 4 ++-- .../gson/MergeBodySerializer.html | 4 ++-- .../gson/MergeFieldDeserializer.html | 4 ++-- .../gson/MergeSettingsSerializer.html | 4 ++-- .../gson/TemplateDeserializer.html | 4 ++-- .../gson/TemplateInfoDeserializer.html | 4 ++-- .../reportingcloud/gson/package-frame.html | 4 ++-- .../reportingcloud/gson/package-summary.html | 4 ++-- .../reportingcloud/gson/package-tree.html | 4 ++-- .../reportingcloud/package-frame.html | 4 ++-- .../reportingcloud/package-summary.html | 10 +++++----- .../reportingcloud/package-tree.html | 6 +++--- constant-values.html | 4 ++-- deprecated-list.html | 4 ++-- help-doc.html | 4 ++-- index-all.html | 14 +++++++------- index.html | 2 +- overview-frame.html | 4 ++-- overview-summary.html | 6 +++--- overview-tree.html | 4 ++-- 46 files changed, 123 insertions(+), 108 deletions(-) diff --git a/allclasses-frame.html b/allclasses-frame.html index b0b5f1d..7f5540e 100644 --- a/allclasses-frame.html +++ b/allclasses-frame.html @@ -2,9 +2,9 @@ - + All Classes (reportingcloud 1.3 API) - + diff --git a/allclasses-noframe.html b/allclasses-noframe.html index 44f1fa2..b7f06c7 100644 --- a/allclasses-noframe.html +++ b/allclasses-noframe.html @@ -2,9 +2,9 @@ - + All Classes (reportingcloud 1.3 API) - + diff --git a/com/textcontrol/reportingcloud/APIKey.html b/com/textcontrol/reportingcloud/APIKey.html index 789286f..6198451 100644 --- a/com/textcontrol/reportingcloud/APIKey.html +++ b/com/textcontrol/reportingcloud/APIKey.html @@ -2,9 +2,9 @@ - + APIKey (reportingcloud 1.3 API) - + diff --git a/com/textcontrol/reportingcloud/AccountSettings.html b/com/textcontrol/reportingcloud/AccountSettings.html index 0e09e2e..fc9e30b 100644 --- a/com/textcontrol/reportingcloud/AccountSettings.html +++ b/com/textcontrol/reportingcloud/AccountSettings.html @@ -2,9 +2,9 @@ - + AccountSettings (reportingcloud 1.3 API) - + diff --git a/com/textcontrol/reportingcloud/AppendBody.html b/com/textcontrol/reportingcloud/AppendBody.html index f7471d3..5207ad7 100644 --- a/com/textcontrol/reportingcloud/AppendBody.html +++ b/com/textcontrol/reportingcloud/AppendBody.html @@ -2,9 +2,9 @@ - + AppendBody (reportingcloud 1.3 API) - + diff --git a/com/textcontrol/reportingcloud/AppendDocument.html b/com/textcontrol/reportingcloud/AppendDocument.html index 429b990..dedadcf 100644 --- a/com/textcontrol/reportingcloud/AppendDocument.html +++ b/com/textcontrol/reportingcloud/AppendDocument.html @@ -2,9 +2,9 @@ - + AppendDocument (reportingcloud 1.3 API) - + diff --git a/com/textcontrol/reportingcloud/DocumentDivider.html b/com/textcontrol/reportingcloud/DocumentDivider.html index 2ea1cc7..c9addda 100644 --- a/com/textcontrol/reportingcloud/DocumentDivider.html +++ b/com/textcontrol/reportingcloud/DocumentDivider.html @@ -2,9 +2,9 @@ - + DocumentDivider (reportingcloud 1.3 API) - + diff --git a/com/textcontrol/reportingcloud/DocumentSettings.html b/com/textcontrol/reportingcloud/DocumentSettings.html index 0ddd169..f7f4cde 100644 --- a/com/textcontrol/reportingcloud/DocumentSettings.html +++ b/com/textcontrol/reportingcloud/DocumentSettings.html @@ -2,9 +2,9 @@ - + DocumentSettings (reportingcloud 1.3 API) - + diff --git a/com/textcontrol/reportingcloud/FindAndReplaceBody.html b/com/textcontrol/reportingcloud/FindAndReplaceBody.html index 7667f0a..75d1078 100644 --- a/com/textcontrol/reportingcloud/FindAndReplaceBody.html +++ b/com/textcontrol/reportingcloud/FindAndReplaceBody.html @@ -2,9 +2,9 @@ - + FindAndReplaceBody (reportingcloud 1.3 API) - + diff --git a/com/textcontrol/reportingcloud/ImageFormat.html b/com/textcontrol/reportingcloud/ImageFormat.html index bce2a55..b9ba6c5 100644 --- a/com/textcontrol/reportingcloud/ImageFormat.html +++ b/com/textcontrol/reportingcloud/ImageFormat.html @@ -2,9 +2,9 @@ - + ImageFormat (reportingcloud 1.3 API) - + diff --git a/com/textcontrol/reportingcloud/IncorrectWord.html b/com/textcontrol/reportingcloud/IncorrectWord.html index 7a31d00..8010e7f 100644 --- a/com/textcontrol/reportingcloud/IncorrectWord.html +++ b/com/textcontrol/reportingcloud/IncorrectWord.html @@ -2,9 +2,9 @@ - + IncorrectWord (reportingcloud 1.3 API) - + diff --git a/com/textcontrol/reportingcloud/MergeBlock.html b/com/textcontrol/reportingcloud/MergeBlock.html index f43cbe9..b3695c2 100644 --- a/com/textcontrol/reportingcloud/MergeBlock.html +++ b/com/textcontrol/reportingcloud/MergeBlock.html @@ -2,9 +2,9 @@ - + MergeBlock (reportingcloud 1.3 API) - + diff --git a/com/textcontrol/reportingcloud/MergeBody.html b/com/textcontrol/reportingcloud/MergeBody.html index e63770e..4f69192 100644 --- a/com/textcontrol/reportingcloud/MergeBody.html +++ b/com/textcontrol/reportingcloud/MergeBody.html @@ -2,9 +2,9 @@ - + MergeBody (reportingcloud 1.3 API) - + diff --git a/com/textcontrol/reportingcloud/MergeField.html b/com/textcontrol/reportingcloud/MergeField.html index 03140b4..d4c31f2 100644 --- a/com/textcontrol/reportingcloud/MergeField.html +++ b/com/textcontrol/reportingcloud/MergeField.html @@ -2,9 +2,9 @@ - + MergeField (reportingcloud 1.3 API) - + diff --git a/com/textcontrol/reportingcloud/MergeSettings.html b/com/textcontrol/reportingcloud/MergeSettings.html index b736333..5b85d55 100644 --- a/com/textcontrol/reportingcloud/MergeSettings.html +++ b/com/textcontrol/reportingcloud/MergeSettings.html @@ -2,9 +2,9 @@ - + MergeSettings (reportingcloud 1.3 API) - + diff --git a/com/textcontrol/reportingcloud/ReportingCloud.html b/com/textcontrol/reportingcloud/ReportingCloud.html index 121a1d0..ef8f4af 100644 --- a/com/textcontrol/reportingcloud/ReportingCloud.html +++ b/com/textcontrol/reportingcloud/ReportingCloud.html @@ -2,9 +2,9 @@ - + ReportingCloud (reportingcloud 1.3 API) - + @@ -110,7 +110,7 @@

      Class ReportingCloud


      public class ReportingCloud
 extends java.lang.Object
      -
      The ReportingCloud API wrapper class.
      +
      The ReportingCloud Java SDK main class.
    • @@ -131,15 +131,15 @@

    Constructor Summary

    ReportingCloud(java.lang.String username, java.lang.String password) -
    Creates a new ReportingCloud wrapper instance with the API base URL - set to "https://api.reporting.cloud".
    +
    Creates a new instance with the API base URL set to + "https://api.reporting.cloud".
    ReportingCloud(java.lang.String username, java.lang.String password, java.lang.String baseUrl) -
    Creates a new ReportingCloud wrapper instance.
    +
    Creates a new instance.
    @@ -429,7 +429,7 @@

    ReportingCloud

    public ReportingCloud(java.lang.String username,
                       java.lang.String password,
                       java.lang.String baseUrl)
    -
    Creates a new ReportingCloud wrapper instance.
    +
    Creates a new instance.
    Parameters:
    username - The username.
    @@ -446,8 +446,8 @@

    ReportingCloud

    ReportingCloud

    public ReportingCloud(java.lang.String username,
                       java.lang.String password)
    -
    Creates a new ReportingCloud wrapper instance with the API base URL - set to "https://api.reporting.cloud".
    +
    Creates a new instance with the API base URL set to + "https://api.reporting.cloud".
    Parameters:
    username - The username.
    diff --git a/com/textcontrol/reportingcloud/ReturnFormat.html b/com/textcontrol/reportingcloud/ReturnFormat.html index 7b710b3..a19071a 100644 --- a/com/textcontrol/reportingcloud/ReturnFormat.html +++ b/com/textcontrol/reportingcloud/ReturnFormat.html @@ -2,9 +2,9 @@ - + ReturnFormat (reportingcloud 1.3 API) - + @@ -172,6 +172,11 @@

    Enum Constant Summary

    TX Text Control Internal Format
    + +TXT +
    Plain text
    + + @@ -289,6 +294,16 @@

    TX

    TX Text Control Internal Format
    + + + +
      +
    • +

      TXT

      +
      public static final ReturnFormat TXT
      +
      Plain text
      +
      • +
    diff --git a/com/textcontrol/reportingcloud/Template.html b/com/textcontrol/reportingcloud/Template.html index 900b0e6..0bd5073 100644 --- a/com/textcontrol/reportingcloud/Template.html +++ b/com/textcontrol/reportingcloud/Template.html @@ -2,9 +2,9 @@ - + Template (reportingcloud 1.3 API) - + diff --git a/com/textcontrol/reportingcloud/TemplateInfo.html b/com/textcontrol/reportingcloud/TemplateInfo.html index 1723a56..ef34ae0 100644 --- a/com/textcontrol/reportingcloud/TemplateInfo.html +++ b/com/textcontrol/reportingcloud/TemplateInfo.html @@ -2,9 +2,9 @@ - + TemplateInfo (reportingcloud 1.3 API) - + diff --git a/com/textcontrol/reportingcloud/gson/APIKeyDeserializer.html b/com/textcontrol/reportingcloud/gson/APIKeyDeserializer.html index 4644dc6..86eae76 100644 --- a/com/textcontrol/reportingcloud/gson/APIKeyDeserializer.html +++ b/com/textcontrol/reportingcloud/gson/APIKeyDeserializer.html @@ -2,9 +2,9 @@ - + APIKeyDeserializer (reportingcloud 1.3 API) - + diff --git a/com/textcontrol/reportingcloud/gson/AccountSettingsDeserializer.html b/com/textcontrol/reportingcloud/gson/AccountSettingsDeserializer.html index 5a25616..66babae 100644 --- a/com/textcontrol/reportingcloud/gson/AccountSettingsDeserializer.html +++ b/com/textcontrol/reportingcloud/gson/AccountSettingsDeserializer.html @@ -2,9 +2,9 @@ - + AccountSettingsDeserializer (reportingcloud 1.3 API) - + diff --git a/com/textcontrol/reportingcloud/gson/AppendBodySerializer.html b/com/textcontrol/reportingcloud/gson/AppendBodySerializer.html index 8379043..f71302c 100644 --- a/com/textcontrol/reportingcloud/gson/AppendBodySerializer.html +++ b/com/textcontrol/reportingcloud/gson/AppendBodySerializer.html @@ -2,9 +2,9 @@ - + AppendBodySerializer (reportingcloud 1.3 API) - + diff --git a/com/textcontrol/reportingcloud/gson/AppendDocumentSerializer.html b/com/textcontrol/reportingcloud/gson/AppendDocumentSerializer.html index caedf7b..aa59cdc 100644 --- a/com/textcontrol/reportingcloud/gson/AppendDocumentSerializer.html +++ b/com/textcontrol/reportingcloud/gson/AppendDocumentSerializer.html @@ -2,9 +2,9 @@ - + AppendDocumentSerializer (reportingcloud 1.3 API) - + diff --git a/com/textcontrol/reportingcloud/gson/DocumentSettingsSerializer.html b/com/textcontrol/reportingcloud/gson/DocumentSettingsSerializer.html index aec3adb..e785d5e 100644 --- a/com/textcontrol/reportingcloud/gson/DocumentSettingsSerializer.html +++ b/com/textcontrol/reportingcloud/gson/DocumentSettingsSerializer.html @@ -2,9 +2,9 @@ - + DocumentSettingsSerializer (reportingcloud 1.3 API) - + diff --git a/com/textcontrol/reportingcloud/gson/FindAndReplaceBodySerializer.html b/com/textcontrol/reportingcloud/gson/FindAndReplaceBodySerializer.html index 7a8bfb4..8f23957 100644 --- a/com/textcontrol/reportingcloud/gson/FindAndReplaceBodySerializer.html +++ b/com/textcontrol/reportingcloud/gson/FindAndReplaceBodySerializer.html @@ -2,9 +2,9 @@ - + FindAndReplaceBodySerializer (reportingcloud 1.3 API) - + diff --git a/com/textcontrol/reportingcloud/gson/IncorrectWordDeserializer.html b/com/textcontrol/reportingcloud/gson/IncorrectWordDeserializer.html index 6245e55..94f2836 100644 --- a/com/textcontrol/reportingcloud/gson/IncorrectWordDeserializer.html +++ b/com/textcontrol/reportingcloud/gson/IncorrectWordDeserializer.html @@ -2,9 +2,9 @@ - + IncorrectWordDeserializer (reportingcloud 1.3 API) - + diff --git a/com/textcontrol/reportingcloud/gson/MergeBlockDeserializer.html b/com/textcontrol/reportingcloud/gson/MergeBlockDeserializer.html index 94f5012..a96f886 100644 --- a/com/textcontrol/reportingcloud/gson/MergeBlockDeserializer.html +++ b/com/textcontrol/reportingcloud/gson/MergeBlockDeserializer.html @@ -2,9 +2,9 @@ - + MergeBlockDeserializer (reportingcloud 1.3 API) - + diff --git a/com/textcontrol/reportingcloud/gson/MergeBodySerializer.html b/com/textcontrol/reportingcloud/gson/MergeBodySerializer.html index d8c5fa3..933b561 100644 --- a/com/textcontrol/reportingcloud/gson/MergeBodySerializer.html +++ b/com/textcontrol/reportingcloud/gson/MergeBodySerializer.html @@ -2,9 +2,9 @@ - + MergeBodySerializer (reportingcloud 1.3 API) - + diff --git a/com/textcontrol/reportingcloud/gson/MergeFieldDeserializer.html b/com/textcontrol/reportingcloud/gson/MergeFieldDeserializer.html index c45212d..38d20fa 100644 --- a/com/textcontrol/reportingcloud/gson/MergeFieldDeserializer.html +++ b/com/textcontrol/reportingcloud/gson/MergeFieldDeserializer.html @@ -2,9 +2,9 @@ - + MergeFieldDeserializer (reportingcloud 1.3 API) - + diff --git a/com/textcontrol/reportingcloud/gson/MergeSettingsSerializer.html b/com/textcontrol/reportingcloud/gson/MergeSettingsSerializer.html index b82d715..2788430 100644 --- a/com/textcontrol/reportingcloud/gson/MergeSettingsSerializer.html +++ b/com/textcontrol/reportingcloud/gson/MergeSettingsSerializer.html @@ -2,9 +2,9 @@ - + MergeSettingsSerializer (reportingcloud 1.3 API) - + diff --git a/com/textcontrol/reportingcloud/gson/TemplateDeserializer.html b/com/textcontrol/reportingcloud/gson/TemplateDeserializer.html index 537b4e0..f485a6d 100644 --- a/com/textcontrol/reportingcloud/gson/TemplateDeserializer.html +++ b/com/textcontrol/reportingcloud/gson/TemplateDeserializer.html @@ -2,9 +2,9 @@ - + TemplateDeserializer (reportingcloud 1.3 API) - + diff --git a/com/textcontrol/reportingcloud/gson/TemplateInfoDeserializer.html b/com/textcontrol/reportingcloud/gson/TemplateInfoDeserializer.html index e8b1f5c..aba4104 100644 --- a/com/textcontrol/reportingcloud/gson/TemplateInfoDeserializer.html +++ b/com/textcontrol/reportingcloud/gson/TemplateInfoDeserializer.html @@ -2,9 +2,9 @@ - + TemplateInfoDeserializer (reportingcloud 1.3 API) - + diff --git a/com/textcontrol/reportingcloud/gson/package-frame.html b/com/textcontrol/reportingcloud/gson/package-frame.html index 84e588e..ab96408 100644 --- a/com/textcontrol/reportingcloud/gson/package-frame.html +++ b/com/textcontrol/reportingcloud/gson/package-frame.html @@ -2,9 +2,9 @@ - + com.textcontrol.reportingcloud.gson (reportingcloud 1.3 API) - + diff --git a/com/textcontrol/reportingcloud/gson/package-summary.html b/com/textcontrol/reportingcloud/gson/package-summary.html index 71a6b45..87471b5 100644 --- a/com/textcontrol/reportingcloud/gson/package-summary.html +++ b/com/textcontrol/reportingcloud/gson/package-summary.html @@ -2,9 +2,9 @@ - + com.textcontrol.reportingcloud.gson (reportingcloud 1.3 API) - + diff --git a/com/textcontrol/reportingcloud/gson/package-tree.html b/com/textcontrol/reportingcloud/gson/package-tree.html index 526bae5..56ba270 100644 --- a/com/textcontrol/reportingcloud/gson/package-tree.html +++ b/com/textcontrol/reportingcloud/gson/package-tree.html @@ -2,9 +2,9 @@ - + com.textcontrol.reportingcloud.gson Class Hierarchy (reportingcloud 1.3 API) - + diff --git a/com/textcontrol/reportingcloud/package-frame.html b/com/textcontrol/reportingcloud/package-frame.html index 9976c62..6d941ad 100644 --- a/com/textcontrol/reportingcloud/package-frame.html +++ b/com/textcontrol/reportingcloud/package-frame.html @@ -2,9 +2,9 @@ - + com.textcontrol.reportingcloud (reportingcloud 1.3 API) - + diff --git a/com/textcontrol/reportingcloud/package-summary.html b/com/textcontrol/reportingcloud/package-summary.html index ac89cea..1da10a8 100644 --- a/com/textcontrol/reportingcloud/package-summary.html +++ b/com/textcontrol/reportingcloud/package-summary.html @@ -2,9 +2,9 @@ - + com.textcontrol.reportingcloud (reportingcloud 1.3 API) - + @@ -71,7 +71,7 @@

    Package com.textcontrol.reportingcloud

    -
    Contains classes and enumerations of the Text Control ReportingCloud Java wrapper.
    +
    Contains classes and enumerations of the Text Control ReportingCloud Java SDK.

    See: Description

    @@ -159,7 +159,7 @@

    Package com.textcontrol.reportingcloud ReportingCloud -
    The ReportingCloud API wrapper class.
    +
    The ReportingCloud Java SDK main class.
    @@ -212,7 +212,7 @@

    Package com.textcontrol.reportingcloud

    Package com.textcontrol.reportingcloud Description

    -
    Contains classes and enumerations of the Text Control ReportingCloud Java wrapper.
    +
    Contains classes and enumerations of the Text Control ReportingCloud Java SDK.
    diff --git a/com/textcontrol/reportingcloud/package-tree.html b/com/textcontrol/reportingcloud/package-tree.html index 81ad9e1..3836a43 100644 --- a/com/textcontrol/reportingcloud/package-tree.html +++ b/com/textcontrol/reportingcloud/package-tree.html @@ -2,9 +2,9 @@ - + com.textcontrol.reportingcloud Class Hierarchy (reportingcloud 1.3 API) - + @@ -106,8 +106,8 @@

    Enum Hierarchy

    • java.lang.Enum<E> (implements java.lang.Comparable<T>, java.io.Serializable)
      • diff --git a/constant-values.html b/constant-values.html index 4e7866f..27c0f2e 100644 --- a/constant-values.html +++ b/constant-values.html @@ -2,9 +2,9 @@ - + Constant Field Values (reportingcloud 1.3 API) - + diff --git a/deprecated-list.html b/deprecated-list.html index c7ecf6b..0ec4a4f 100644 --- a/deprecated-list.html +++ b/deprecated-list.html @@ -2,9 +2,9 @@ - + Deprecated List (reportingcloud 1.3 API) - + diff --git a/help-doc.html b/help-doc.html index 2c47d4b..b9e4087 100644 --- a/help-doc.html +++ b/help-doc.html @@ -2,9 +2,9 @@ - + API Help (reportingcloud 1.3 API) - + diff --git a/index-all.html b/index-all.html index 62d52a8..2f8a6d0 100644 --- a/index-all.html +++ b/index-all.html @@ -2,9 +2,9 @@ - + Index (reportingcloud 1.3 API) - + @@ -155,7 +155,7 @@

      C

      com.textcontrol.reportingcloud - package com.textcontrol.reportingcloud
      -
      Contains classes and enumerations of the Text Control ReportingCloud Java wrapper.
      +
      Contains classes and enumerations of the Text Control ReportingCloud Java SDK.
      com.textcontrol.reportingcloud.gson - package com.textcontrol.reportingcloud.gson
      @@ -654,16 +654,16 @@

      R

      ReportingCloud - Class in com.textcontrol.reportingcloud
      -
      The ReportingCloud API wrapper class.
      +
      The ReportingCloud Java SDK main class.
      ReportingCloud(String, String, String) - Constructor for class com.textcontrol.reportingcloud.ReportingCloud
      -
      Creates a new ReportingCloud wrapper instance.
      +
      Creates a new instance.
      ReportingCloud(String, String) - Constructor for class com.textcontrol.reportingcloud.ReportingCloud
      -
      Creates a new ReportingCloud wrapper instance with the API base URL - set to "https://api.reporting.cloud".
      +
      Creates a new instance with the API base URL set to + "https://api.reporting.cloud".
      ReturnFormat - Enum in com.textcontrol.reportingcloud
      diff --git a/index.html b/index.html index 7373896..3ad7359 100644 --- a/index.html +++ b/index.html @@ -2,7 +2,7 @@ - + reportingcloud 1.3 API diff --git a/overview-summary.html b/overview-summary.html index 6b55986..8820901 100644 --- a/overview-summary.html +++ b/overview-summary.html @@ -2,9 +2,9 @@ - + Overview (reportingcloud 1.3 API) - + @@ -82,7 +82,7 @@

      reportingcloud 1.3 API

      com.textcontrol.reportingcloud -
      Contains classes and enumerations of the Text Control ReportingCloud Java wrapper.
      +
      Contains classes and enumerations of the Text Control ReportingCloud Java SDK.
      diff --git a/overview-tree.html b/overview-tree.html index 2da6d6b..50231a5 100644 --- a/overview-tree.html +++ b/overview-tree.html @@ -2,9 +2,9 @@ - + Class Hierarchy (reportingcloud 1.3 API) - + From ec54303e32ae37445f81116d12e952d9c504627e Mon Sep 17 00:00:00 2001 From: Thorsten Date: Mon, 4 Mar 2019 16:36:26 +0100 Subject: [PATCH 20/20] Incorrect documentation of class DocumentDivider. --- allclasses-frame.html | 2 +- allclasses-noframe.html | 2 +- com/textcontrol/reportingcloud/APIKey.html | 2 +- .../reportingcloud/AccountSettings.html | 2 +- com/textcontrol/reportingcloud/AppendBody.html | 2 +- com/textcontrol/reportingcloud/AppendDocument.html | 2 +- .../reportingcloud/DocumentDivider.html | 14 +++++++------- .../reportingcloud/DocumentSettings.html | 2 +- .../reportingcloud/FindAndReplaceBody.html | 2 +- com/textcontrol/reportingcloud/ImageFormat.html | 2 +- com/textcontrol/reportingcloud/IncorrectWord.html | 2 +- com/textcontrol/reportingcloud/MergeBlock.html | 2 +- com/textcontrol/reportingcloud/MergeBody.html | 2 +- com/textcontrol/reportingcloud/MergeField.html | 2 +- com/textcontrol/reportingcloud/MergeSettings.html | 2 +- com/textcontrol/reportingcloud/ReportingCloud.html | 2 +- com/textcontrol/reportingcloud/ReturnFormat.html | 2 +- com/textcontrol/reportingcloud/Template.html | 2 +- com/textcontrol/reportingcloud/TemplateInfo.html | 2 +- .../reportingcloud/gson/APIKeyDeserializer.html | 2 +- .../gson/AccountSettingsDeserializer.html | 2 +- .../reportingcloud/gson/AppendBodySerializer.html | 2 +- .../gson/AppendDocumentSerializer.html | 2 +- .../gson/DocumentSettingsSerializer.html | 2 +- .../gson/FindAndReplaceBodySerializer.html | 2 +- .../gson/IncorrectWordDeserializer.html | 2 +- .../gson/MergeBlockDeserializer.html | 2 +- .../reportingcloud/gson/MergeBodySerializer.html | 2 +- .../gson/MergeFieldDeserializer.html | 2 +- .../gson/MergeSettingsSerializer.html | 2 +- .../reportingcloud/gson/TemplateDeserializer.html | 2 +- .../gson/TemplateInfoDeserializer.html | 2 +- .../reportingcloud/gson/package-frame.html | 2 +- .../reportingcloud/gson/package-summary.html | 2 +- .../reportingcloud/gson/package-tree.html | 2 +- com/textcontrol/reportingcloud/package-frame.html | 2 +- .../reportingcloud/package-summary.html | 2 +- com/textcontrol/reportingcloud/package-tree.html | 2 +- constant-values.html | 2 +- deprecated-list.html | 2 +- help-doc.html | 2 +- index-all.html | 2 +- index.html | 2 +- overview-frame.html | 2 +- overview-summary.html | 2 +- overview-tree.html | 2 +- 46 files changed, 52 insertions(+), 52 deletions(-) diff --git a/allclasses-frame.html b/allclasses-frame.html index 7f5540e..888f73c 100644 --- a/allclasses-frame.html +++ b/allclasses-frame.html @@ -2,7 +2,7 @@ - + All Classes (reportingcloud 1.3 API) diff --git a/allclasses-noframe.html b/allclasses-noframe.html index b7f06c7..f61223f 100644 --- a/allclasses-noframe.html +++ b/allclasses-noframe.html @@ -2,7 +2,7 @@ - + All Classes (reportingcloud 1.3 API) diff --git a/com/textcontrol/reportingcloud/APIKey.html b/com/textcontrol/reportingcloud/APIKey.html index 6198451..8f92666 100644 --- a/com/textcontrol/reportingcloud/APIKey.html +++ b/com/textcontrol/reportingcloud/APIKey.html @@ -2,7 +2,7 @@ - + APIKey (reportingcloud 1.3 API) diff --git a/com/textcontrol/reportingcloud/AccountSettings.html b/com/textcontrol/reportingcloud/AccountSettings.html index fc9e30b..77ed9c8 100644 --- a/com/textcontrol/reportingcloud/AccountSettings.html +++ b/com/textcontrol/reportingcloud/AccountSettings.html @@ -2,7 +2,7 @@ - + AccountSettings (reportingcloud 1.3 API) diff --git a/com/textcontrol/reportingcloud/AppendBody.html b/com/textcontrol/reportingcloud/AppendBody.html index 5207ad7..643ad37 100644 --- a/com/textcontrol/reportingcloud/AppendBody.html +++ b/com/textcontrol/reportingcloud/AppendBody.html @@ -2,7 +2,7 @@ - + AppendBody (reportingcloud 1.3 API) diff --git a/com/textcontrol/reportingcloud/AppendDocument.html b/com/textcontrol/reportingcloud/AppendDocument.html index dedadcf..5d6e60c 100644 --- a/com/textcontrol/reportingcloud/AppendDocument.html +++ b/com/textcontrol/reportingcloud/AppendDocument.html @@ -2,7 +2,7 @@ - + AppendDocument (reportingcloud 1.3 API) diff --git a/com/textcontrol/reportingcloud/DocumentDivider.html b/com/textcontrol/reportingcloud/DocumentDivider.html index c9addda..3229cd6 100644 --- a/com/textcontrol/reportingcloud/DocumentDivider.html +++ b/com/textcontrol/reportingcloud/DocumentDivider.html @@ -2,7 +2,7 @@ - + DocumentDivider (reportingcloud 1.3 API) @@ -140,17 +140,17 @@

      Enum Constant Summary

      NewParagraph -
      Portable Network Graphics
      +
      New Paragraph.
      NewSection -
      Windows Bitmap
      +
      New Section.
      None -
      Joint Photographic Experts Group
      +
      None.
      @@ -223,7 +223,7 @@

      Enum Constant Detail

    • None

      public static final DocumentDivider None
      -
      Joint Photographic Experts Group
      +
      None.
    @@ -233,7 +233,7 @@

    None

  • NewParagraph

    public static final DocumentDivider NewParagraph
    -
    Portable Network Graphics
    +
    New Paragraph.
    • @@ -243,7 +243,7 @@

    NewParagraph

  • NewSection

    public static final DocumentDivider NewSection
    -
    Windows Bitmap
    +
    New Section.
    • diff --git a/com/textcontrol/reportingcloud/DocumentSettings.html b/com/textcontrol/reportingcloud/DocumentSettings.html index f7f4cde..cc076d4 100644 --- a/com/textcontrol/reportingcloud/DocumentSettings.html +++ b/com/textcontrol/reportingcloud/DocumentSettings.html @@ -2,7 +2,7 @@ - + DocumentSettings (reportingcloud 1.3 API) diff --git a/com/textcontrol/reportingcloud/FindAndReplaceBody.html b/com/textcontrol/reportingcloud/FindAndReplaceBody.html index 75d1078..ea7bc8a 100644 --- a/com/textcontrol/reportingcloud/FindAndReplaceBody.html +++ b/com/textcontrol/reportingcloud/FindAndReplaceBody.html @@ -2,7 +2,7 @@ - + FindAndReplaceBody (reportingcloud 1.3 API) diff --git a/com/textcontrol/reportingcloud/ImageFormat.html b/com/textcontrol/reportingcloud/ImageFormat.html index b9ba6c5..94918b8 100644 --- a/com/textcontrol/reportingcloud/ImageFormat.html +++ b/com/textcontrol/reportingcloud/ImageFormat.html @@ -2,7 +2,7 @@ - + ImageFormat (reportingcloud 1.3 API) diff --git a/com/textcontrol/reportingcloud/IncorrectWord.html b/com/textcontrol/reportingcloud/IncorrectWord.html index 8010e7f..1371201 100644 --- a/com/textcontrol/reportingcloud/IncorrectWord.html +++ b/com/textcontrol/reportingcloud/IncorrectWord.html @@ -2,7 +2,7 @@ - + IncorrectWord (reportingcloud 1.3 API) diff --git a/com/textcontrol/reportingcloud/MergeBlock.html b/com/textcontrol/reportingcloud/MergeBlock.html index b3695c2..3229ffe 100644 --- a/com/textcontrol/reportingcloud/MergeBlock.html +++ b/com/textcontrol/reportingcloud/MergeBlock.html @@ -2,7 +2,7 @@ - + MergeBlock (reportingcloud 1.3 API) diff --git a/com/textcontrol/reportingcloud/MergeBody.html b/com/textcontrol/reportingcloud/MergeBody.html index 4f69192..d78a45a 100644 --- a/com/textcontrol/reportingcloud/MergeBody.html +++ b/com/textcontrol/reportingcloud/MergeBody.html @@ -2,7 +2,7 @@ - + MergeBody (reportingcloud 1.3 API) diff --git a/com/textcontrol/reportingcloud/MergeField.html b/com/textcontrol/reportingcloud/MergeField.html index d4c31f2..84c3fe0 100644 --- a/com/textcontrol/reportingcloud/MergeField.html +++ b/com/textcontrol/reportingcloud/MergeField.html @@ -2,7 +2,7 @@ - + MergeField (reportingcloud 1.3 API) diff --git a/com/textcontrol/reportingcloud/MergeSettings.html b/com/textcontrol/reportingcloud/MergeSettings.html index 5b85d55..94049b8 100644 --- a/com/textcontrol/reportingcloud/MergeSettings.html +++ b/com/textcontrol/reportingcloud/MergeSettings.html @@ -2,7 +2,7 @@ - + MergeSettings (reportingcloud 1.3 API) diff --git a/com/textcontrol/reportingcloud/ReportingCloud.html b/com/textcontrol/reportingcloud/ReportingCloud.html index ef8f4af..5216dbc 100644 --- a/com/textcontrol/reportingcloud/ReportingCloud.html +++ b/com/textcontrol/reportingcloud/ReportingCloud.html @@ -2,7 +2,7 @@ - + ReportingCloud (reportingcloud 1.3 API) diff --git a/com/textcontrol/reportingcloud/ReturnFormat.html b/com/textcontrol/reportingcloud/ReturnFormat.html index a19071a..0f73202 100644 --- a/com/textcontrol/reportingcloud/ReturnFormat.html +++ b/com/textcontrol/reportingcloud/ReturnFormat.html @@ -2,7 +2,7 @@ - + ReturnFormat (reportingcloud 1.3 API) diff --git a/com/textcontrol/reportingcloud/Template.html b/com/textcontrol/reportingcloud/Template.html index 0bd5073..977c02d 100644 --- a/com/textcontrol/reportingcloud/Template.html +++ b/com/textcontrol/reportingcloud/Template.html @@ -2,7 +2,7 @@ - + Template (reportingcloud 1.3 API) diff --git a/com/textcontrol/reportingcloud/TemplateInfo.html b/com/textcontrol/reportingcloud/TemplateInfo.html index ef34ae0..280b831 100644 --- a/com/textcontrol/reportingcloud/TemplateInfo.html +++ b/com/textcontrol/reportingcloud/TemplateInfo.html @@ -2,7 +2,7 @@ - + TemplateInfo (reportingcloud 1.3 API) diff --git a/com/textcontrol/reportingcloud/gson/APIKeyDeserializer.html b/com/textcontrol/reportingcloud/gson/APIKeyDeserializer.html index 86eae76..aac8b48 100644 --- a/com/textcontrol/reportingcloud/gson/APIKeyDeserializer.html +++ b/com/textcontrol/reportingcloud/gson/APIKeyDeserializer.html @@ -2,7 +2,7 @@ - + APIKeyDeserializer (reportingcloud 1.3 API) diff --git a/com/textcontrol/reportingcloud/gson/AccountSettingsDeserializer.html b/com/textcontrol/reportingcloud/gson/AccountSettingsDeserializer.html index 66babae..3e2aeda 100644 --- a/com/textcontrol/reportingcloud/gson/AccountSettingsDeserializer.html +++ b/com/textcontrol/reportingcloud/gson/AccountSettingsDeserializer.html @@ -2,7 +2,7 @@ - + AccountSettingsDeserializer (reportingcloud 1.3 API) diff --git a/com/textcontrol/reportingcloud/gson/AppendBodySerializer.html b/com/textcontrol/reportingcloud/gson/AppendBodySerializer.html index f71302c..de25165 100644 --- a/com/textcontrol/reportingcloud/gson/AppendBodySerializer.html +++ b/com/textcontrol/reportingcloud/gson/AppendBodySerializer.html @@ -2,7 +2,7 @@ - + AppendBodySerializer (reportingcloud 1.3 API) diff --git a/com/textcontrol/reportingcloud/gson/AppendDocumentSerializer.html b/com/textcontrol/reportingcloud/gson/AppendDocumentSerializer.html index aa59cdc..67596d1 100644 --- a/com/textcontrol/reportingcloud/gson/AppendDocumentSerializer.html +++ b/com/textcontrol/reportingcloud/gson/AppendDocumentSerializer.html @@ -2,7 +2,7 @@ - + AppendDocumentSerializer (reportingcloud 1.3 API) diff --git a/com/textcontrol/reportingcloud/gson/DocumentSettingsSerializer.html b/com/textcontrol/reportingcloud/gson/DocumentSettingsSerializer.html index e785d5e..4ae2b7c 100644 --- a/com/textcontrol/reportingcloud/gson/DocumentSettingsSerializer.html +++ b/com/textcontrol/reportingcloud/gson/DocumentSettingsSerializer.html @@ -2,7 +2,7 @@ - + DocumentSettingsSerializer (reportingcloud 1.3 API) diff --git a/com/textcontrol/reportingcloud/gson/FindAndReplaceBodySerializer.html b/com/textcontrol/reportingcloud/gson/FindAndReplaceBodySerializer.html index 8f23957..5285de8 100644 --- a/com/textcontrol/reportingcloud/gson/FindAndReplaceBodySerializer.html +++ b/com/textcontrol/reportingcloud/gson/FindAndReplaceBodySerializer.html @@ -2,7 +2,7 @@ - + FindAndReplaceBodySerializer (reportingcloud 1.3 API) diff --git a/com/textcontrol/reportingcloud/gson/IncorrectWordDeserializer.html b/com/textcontrol/reportingcloud/gson/IncorrectWordDeserializer.html index 94f2836..cda1199 100644 --- a/com/textcontrol/reportingcloud/gson/IncorrectWordDeserializer.html +++ b/com/textcontrol/reportingcloud/gson/IncorrectWordDeserializer.html @@ -2,7 +2,7 @@ - + IncorrectWordDeserializer (reportingcloud 1.3 API) diff --git a/com/textcontrol/reportingcloud/gson/MergeBlockDeserializer.html b/com/textcontrol/reportingcloud/gson/MergeBlockDeserializer.html index a96f886..0038415 100644 --- a/com/textcontrol/reportingcloud/gson/MergeBlockDeserializer.html +++ b/com/textcontrol/reportingcloud/gson/MergeBlockDeserializer.html @@ -2,7 +2,7 @@ - + MergeBlockDeserializer (reportingcloud 1.3 API) diff --git a/com/textcontrol/reportingcloud/gson/MergeBodySerializer.html b/com/textcontrol/reportingcloud/gson/MergeBodySerializer.html index 933b561..6fa596c 100644 --- a/com/textcontrol/reportingcloud/gson/MergeBodySerializer.html +++ b/com/textcontrol/reportingcloud/gson/MergeBodySerializer.html @@ -2,7 +2,7 @@ - + MergeBodySerializer (reportingcloud 1.3 API) diff --git a/com/textcontrol/reportingcloud/gson/MergeFieldDeserializer.html b/com/textcontrol/reportingcloud/gson/MergeFieldDeserializer.html index 38d20fa..8a3030a 100644 --- a/com/textcontrol/reportingcloud/gson/MergeFieldDeserializer.html +++ b/com/textcontrol/reportingcloud/gson/MergeFieldDeserializer.html @@ -2,7 +2,7 @@ - + MergeFieldDeserializer (reportingcloud 1.3 API) diff --git a/com/textcontrol/reportingcloud/gson/MergeSettingsSerializer.html b/com/textcontrol/reportingcloud/gson/MergeSettingsSerializer.html index 2788430..a4e4602 100644 --- a/com/textcontrol/reportingcloud/gson/MergeSettingsSerializer.html +++ b/com/textcontrol/reportingcloud/gson/MergeSettingsSerializer.html @@ -2,7 +2,7 @@ - + MergeSettingsSerializer (reportingcloud 1.3 API) diff --git a/com/textcontrol/reportingcloud/gson/TemplateDeserializer.html b/com/textcontrol/reportingcloud/gson/TemplateDeserializer.html index f485a6d..f9aea8b 100644 --- a/com/textcontrol/reportingcloud/gson/TemplateDeserializer.html +++ b/com/textcontrol/reportingcloud/gson/TemplateDeserializer.html @@ -2,7 +2,7 @@ - + TemplateDeserializer (reportingcloud 1.3 API) diff --git a/com/textcontrol/reportingcloud/gson/TemplateInfoDeserializer.html b/com/textcontrol/reportingcloud/gson/TemplateInfoDeserializer.html index aba4104..bf1ff53 100644 --- a/com/textcontrol/reportingcloud/gson/TemplateInfoDeserializer.html +++ b/com/textcontrol/reportingcloud/gson/TemplateInfoDeserializer.html @@ -2,7 +2,7 @@ - + TemplateInfoDeserializer (reportingcloud 1.3 API) diff --git a/com/textcontrol/reportingcloud/gson/package-frame.html b/com/textcontrol/reportingcloud/gson/package-frame.html index ab96408..dad51a3 100644 --- a/com/textcontrol/reportingcloud/gson/package-frame.html +++ b/com/textcontrol/reportingcloud/gson/package-frame.html @@ -2,7 +2,7 @@ - + com.textcontrol.reportingcloud.gson (reportingcloud 1.3 API) diff --git a/com/textcontrol/reportingcloud/gson/package-summary.html b/com/textcontrol/reportingcloud/gson/package-summary.html index 87471b5..86b9a72 100644 --- a/com/textcontrol/reportingcloud/gson/package-summary.html +++ b/com/textcontrol/reportingcloud/gson/package-summary.html @@ -2,7 +2,7 @@ - + com.textcontrol.reportingcloud.gson (reportingcloud 1.3 API) diff --git a/com/textcontrol/reportingcloud/gson/package-tree.html b/com/textcontrol/reportingcloud/gson/package-tree.html index 56ba270..52da4ff 100644 --- a/com/textcontrol/reportingcloud/gson/package-tree.html +++ b/com/textcontrol/reportingcloud/gson/package-tree.html @@ -2,7 +2,7 @@ - + com.textcontrol.reportingcloud.gson Class Hierarchy (reportingcloud 1.3 API) diff --git a/com/textcontrol/reportingcloud/package-frame.html b/com/textcontrol/reportingcloud/package-frame.html index 6d941ad..ec1901c 100644 --- a/com/textcontrol/reportingcloud/package-frame.html +++ b/com/textcontrol/reportingcloud/package-frame.html @@ -2,7 +2,7 @@ - + com.textcontrol.reportingcloud (reportingcloud 1.3 API) diff --git a/com/textcontrol/reportingcloud/package-summary.html b/com/textcontrol/reportingcloud/package-summary.html index 1da10a8..29febf0 100644 --- a/com/textcontrol/reportingcloud/package-summary.html +++ b/com/textcontrol/reportingcloud/package-summary.html @@ -2,7 +2,7 @@ - + com.textcontrol.reportingcloud (reportingcloud 1.3 API) diff --git a/com/textcontrol/reportingcloud/package-tree.html b/com/textcontrol/reportingcloud/package-tree.html index 3836a43..9741dbf 100644 --- a/com/textcontrol/reportingcloud/package-tree.html +++ b/com/textcontrol/reportingcloud/package-tree.html @@ -2,7 +2,7 @@ - + com.textcontrol.reportingcloud Class Hierarchy (reportingcloud 1.3 API) diff --git a/constant-values.html b/constant-values.html index 27c0f2e..154147c 100644 --- a/constant-values.html +++ b/constant-values.html @@ -2,7 +2,7 @@ - + Constant Field Values (reportingcloud 1.3 API) diff --git a/deprecated-list.html b/deprecated-list.html index 0ec4a4f..281c8b1 100644 --- a/deprecated-list.html +++ b/deprecated-list.html @@ -2,7 +2,7 @@ - + Deprecated List (reportingcloud 1.3 API) diff --git a/help-doc.html b/help-doc.html index b9e4087..0f0f1c7 100644 --- a/help-doc.html +++ b/help-doc.html @@ -2,7 +2,7 @@ - + API Help (reportingcloud 1.3 API) diff --git a/index-all.html b/index-all.html index 2f8a6d0..bbb6752 100644 --- a/index-all.html +++ b/index-all.html @@ -2,7 +2,7 @@ - + Index (reportingcloud 1.3 API) diff --git a/index.html b/index.html index 3ad7359..7246d46 100644 --- a/index.html +++ b/index.html @@ -2,7 +2,7 @@ - + reportingcloud 1.3 API