RM-4550: javadocs for exceptions

This commit is contained in:
Kristijan Conkas
2017-01-06 16:50:19 +00:00
parent caae2ec01d
commit 6ff8f4cec3
2 changed files with 6 additions and 7 deletions

View File

@@ -60,7 +60,7 @@ public class FilesAPI extends RMModelRequest
* @param fileId The Id of a file to declare as record * @param fileId The Id of a file to declare as record
* @param parameters Request parameters, refer to API documentation for more details * @param parameters Request parameters, refer to API documentation for more details
* @return The {@link FilePlanComponent} for created record * @return The {@link FilePlanComponent} for created record
* @throws Exception * @throws Exception for malformed JSON responses
*/ */
public FilePlanComponent declareAsRecord(String fileId, String parameters) throws Exception 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} * A no-parameter version of {@link FilesAPI#declareAsRecord}
* @param fileId The Id of a file to declare as record * @param fileId The Id of a file to declare as record
* @return The {@link FilePlanComponent} for created record * @return The {@link FilePlanComponent} for created record
* @throws Exception * @throws Exception for malformed JSON responses
*/ */
public FilePlanComponent declareAsRecord(String fileId) throws Exception public FilePlanComponent declareAsRecord(String fileId) throws Exception
{ {

View File

@@ -73,7 +73,6 @@ public class DeclareDocumentAsRecordTests extends BaseRMRestTest
private SiteModel testSite; private SiteModel testSite;
private FolderModel testFolder; private FolderModel testFolder;
@BeforeClass(alwaysRun=true) @BeforeClass(alwaysRun=true)
public void declareDocumentAsRecordSetup() throws Exception public void declareDocumentAsRecordSetup() throws Exception
{ {
@@ -99,7 +98,7 @@ public class DeclareDocumentAsRecordTests extends BaseRMRestTest
* And it is now a record * And it is now a record
* And it remains a secondary child of the starting location where I can still view it * And it remains a secondary child of the starting location where I can still view it
* <pre> * <pre>
* @throws Exception * @throws Exception for malformed JSON API response
*/ */
@Test(description = "User with correct permissions can declare document as a record") @Test(description = "User with correct permissions can declare document as a record")
@AlfrescoTest(jira = "RM-4429") @AlfrescoTest(jira = "RM-4429")
@@ -169,7 +168,7 @@ public class DeclareDocumentAsRecordTests extends BaseRMRestTest
* When I declare the document as a record * When I declare the document as a record
* Then I get a permission denied exception * Then I get a permission denied exception
* </pre> * </pre>
* @throws Exception * @throws Exception for malformed JSON API response
*/ */
@Test(description = "User with read-only permissions can't declare document a record") @Test(description = "User with read-only permissions can't declare document a record")
@AlfrescoTest(jira = "RM-4429") @AlfrescoTest(jira = "RM-4429")
@@ -202,7 +201,7 @@ public class DeclareDocumentAsRecordTests extends BaseRMRestTest
* When I declare the record as a record * When I declare the record as a record
* Then I get a invalid operation exception * Then I get a invalid operation exception
* </pre> * </pre>
* @throws Exception * @throws Exception for malformed JSON API response
*/ */
@Test(description = "Record can't be declared a record") @Test(description = "Record can't be declared a record")
@AlfrescoTest(jira = "RM-4429") @AlfrescoTest(jira = "RM-4429")
@@ -232,7 +231,7 @@ public class DeclareDocumentAsRecordTests extends BaseRMRestTest
* When I declare the node as a record * When I declare the node as a record
* Then I get a invalid operation exception * Then I get a invalid operation exception
* </pre> * </pre>
* @throws Exception * @throws Exception for malformed JSON API response
*/ */
@Test(description = "Node that is not a document can't be declared a record") @Test(description = "Node that is not a document can't be declared a record")
@AlfrescoTest(jira = "RM-4429") @AlfrescoTest(jira = "RM-4429")