From e9e70df1e8c55ff85200d9a32bf2567a9084288d Mon Sep 17 00:00:00 2001
From: Kristijan Conkas <kristijan.conkas@alfresco.com>
Date: Fri, 6 Jan 2017 16:50:19 +0000
Subject: [PATCH] RM-4550: javadocs for exceptions

---
 .../rest/rm/community/requests/igCoreAPI/FilesAPI.java   | 4 ++--
 .../rm/community/files/DeclareDocumentAsRecordTests.java | 9 ++++-----
 2 files changed, 6 insertions(+), 7 deletions(-)

diff --git a/rm-automation/rm-automation-community-rest-api/src/main/java/org/alfresco/rest/rm/community/requests/igCoreAPI/FilesAPI.java b/rm-automation/rm-automation-community-rest-api/src/main/java/org/alfresco/rest/rm/community/requests/igCoreAPI/FilesAPI.java
index ee4c138122..83df47ab11 100644
--- a/rm-automation/rm-automation-community-rest-api/src/main/java/org/alfresco/rest/rm/community/requests/igCoreAPI/FilesAPI.java
+++ b/rm-automation/rm-automation-community-rest-api/src/main/java/org/alfresco/rest/rm/community/requests/igCoreAPI/FilesAPI.java
@@ -60,7 +60,7 @@ public class FilesAPI extends RMModelRequest
      * @param fileId The Id of a file to declare as record
      * @param parameters Request parameters, refer to API documentation for more details
      * @return The {@link FilePlanComponent} for created record
-     * @throws Exception
+     * @throws Exception for malformed JSON responses
      */
     public FilePlanComponent declareAsRecord(String fileId, String parameters) throws Exception
     {
@@ -78,7 +78,7 @@ public class FilesAPI extends RMModelRequest
      * A no-parameter version of {@link FilesAPI#declareAsRecord}
      * @param fileId The Id of a file to declare as record
      * @return The {@link FilePlanComponent} for created record
-     * @throws Exception
+     * @throws Exception for malformed JSON responses
      */
     public FilePlanComponent declareAsRecord(String fileId) throws Exception
     {
diff --git a/rm-automation/rm-automation-community-rest-api/src/test/java/org/alfresco/rest/rm/community/files/DeclareDocumentAsRecordTests.java b/rm-automation/rm-automation-community-rest-api/src/test/java/org/alfresco/rest/rm/community/files/DeclareDocumentAsRecordTests.java
index 0c366d48e7..7af83f1291 100644
--- a/rm-automation/rm-automation-community-rest-api/src/test/java/org/alfresco/rest/rm/community/files/DeclareDocumentAsRecordTests.java
+++ b/rm-automation/rm-automation-community-rest-api/src/test/java/org/alfresco/rest/rm/community/files/DeclareDocumentAsRecordTests.java
@@ -73,7 +73,6 @@ public class DeclareDocumentAsRecordTests extends BaseRMRestTest
     private SiteModel testSite;
     private FolderModel testFolder;
 
-
     @BeforeClass(alwaysRun=true)
     public void declareDocumentAsRecordSetup() throws Exception
     {
@@ -99,7 +98,7 @@ public class DeclareDocumentAsRecordTests extends BaseRMRestTest
      * And it is now a record
      * And it remains a secondary child of the starting location where I can still view it
      * <pre>
-     * @throws Exception 
+     * @throws Exception for malformed JSON API response
      */
     @Test(description = "User with correct permissions can declare document as a record")
     @AlfrescoTest(jira = "RM-4429")
@@ -169,7 +168,7 @@ public class DeclareDocumentAsRecordTests extends BaseRMRestTest
      * When I declare the document as a record
      * Then I get a permission denied exception
      * </pre>
-     * @throws Exception 
+     * @throws Exception for malformed JSON API response
      */
     @Test(description = "User with read-only permissions can't declare document a record")
     @AlfrescoTest(jira = "RM-4429")
@@ -202,7 +201,7 @@ public class DeclareDocumentAsRecordTests extends BaseRMRestTest
      * When I declare the record as a record
      * Then I get a invalid operation exception
      * </pre>
-     * @throws Exception
+     * @throws Exception for malformed JSON API response
      */
     @Test(description = "Record can't be declared a record")
     @AlfrescoTest(jira = "RM-4429")
@@ -232,7 +231,7 @@ public class DeclareDocumentAsRecordTests extends BaseRMRestTest
      * When I declare the node as a record
      * Then I get a invalid operation exception
      * </pre>
-     * @throws Exception 
+     * @throws Exception for malformed JSON API response
      */
     @Test(description = "Node that is not a document can't be declared a record")
     @AlfrescoTest(jira = "RM-4429")