Compare commits

...

21 Commits

Author SHA1 Message Date
Sathish Kumar
af8106bbe4 [APPS-3172] Update License Header 2025-01-07 16:30:50 +05:30
Sathish Kumar
011a98f9a7 [APPS-3172] Update License Header 2025-01-07 16:14:33 +05:30
Sathish Kumar
0b5211f7a9 [APPS-3172] Update License Header 2025-01-07 15:30:29 +05:30
Sathish Kumar
1ad97022a2 Update License Header 2025-01-07 14:31:23 +05:30
Sathish Kumar
567405dc1c Update License Header 2025-01-07 14:16:07 +05:30
Sathish Kumar
8d6973a132 update license header 2025-01-07 13:42:10 +05:30
Sathish Kumar
629c874bc8 update license header 2025-01-07 11:59:24 +05:30
Sathish Kumar
19ec861873 Revert "update license header"
This reverts commit 7f8dd30305.
2025-01-07 11:54:06 +05:30
Sathish Kumar
7f8dd30305 update license header 2025-01-07 11:47:14 +05:30
Sathish Kumar
40c7b5fd9f update license header 2025-01-07 11:33:59 +05:30
Sathish Kumar
3f6a1c6880 update license header 2025-01-07 11:24:41 +05:30
Sathish Kumar
b3f2cb95c8 update license header 2025-01-07 11:09:14 +05:30
Sathish Kumar
d694959587 update license header 2025-01-07 11:00:40 +05:30
Sathish Kumar
56aae78015 update license header 2025-01-07 10:52:28 +05:30
Sathish Kumar
edba5b8754 update license header 2025-01-07 10:37:27 +05:30
Sathish Kumar
5f8879feb7 update license header 2025-01-07 10:25:00 +05:30
Sathish Kumar
ca575bc47e update license header 2025-01-07 10:14:15 +05:30
Sathish Kumar
4fcb962a3c update license header 2025-01-07 10:06:00 +05:30
Sathish Kumar
5397d88f4a update license header 2025-01-07 09:55:48 +05:30
Sathish Kumar
448e49d8bb Revert "update license header"
This reverts commit b825b5f18e.
2025-01-07 09:50:44 +05:30
Sathish Kumar
b825b5f18e update license header 2025-01-06 10:53:48 +05:30
1381 changed files with 39309 additions and 39503 deletions

View File

@@ -166,7 +166,7 @@
"filename": "amps/ags/rm-automation/rm-automation-community-rest-api/src/test/java/org/alfresco/rest/rm/community/base/TestData.java", "filename": "amps/ags/rm-automation/rm-automation-community-rest-api/src/test/java/org/alfresco/rest/rm/community/base/TestData.java",
"hashed_secret": "5baa61e4c9b93f3f0682250b6cf8331b7ee68fd8", "hashed_secret": "5baa61e4c9b93f3f0682250b6cf8331b7ee68fd8",
"is_verified": false, "is_verified": false,
"line_number": 57, "line_number": 58,
"is_secret": false "is_secret": false
} }
], ],
@@ -176,7 +176,7 @@
"filename": "amps/ags/rm-automation/rm-automation-community-rest-api/src/test/java/org/alfresco/rest/rm/community/retentionschedule/RetentionScheduleStepTests.java", "filename": "amps/ags/rm-automation/rm-automation-community-rest-api/src/test/java/org/alfresco/rest/rm/community/retentionschedule/RetentionScheduleStepTests.java",
"hashed_secret": "e3557f3b0f2189660980d213f75d1a7828d56af1", "hashed_secret": "e3557f3b0f2189660980d213f75d1a7828d56af1",
"is_verified": false, "is_verified": false,
"line_number": 83, "line_number": 85,
"is_secret": false "is_secret": false
} }
], ],
@@ -1599,7 +1599,7 @@
"filename": "repository/src/test/java/org/alfresco/repo/security/authentication/identityservice/IdentityServiceFacadeFactoryBeanTest.java", "filename": "repository/src/test/java/org/alfresco/repo/security/authentication/identityservice/IdentityServiceFacadeFactoryBeanTest.java",
"hashed_secret": "c4b66dbe168ad1d2b19119494a0da063801bc3bb", "hashed_secret": "c4b66dbe168ad1d2b19119494a0da063801bc3bb",
"is_verified": false, "is_verified": false,
"line_number": 83, "line_number": 82,
"is_secret": false "is_secret": false
}, },
{ {
@@ -1607,7 +1607,7 @@
"filename": "repository/src/test/java/org/alfresco/repo/security/authentication/identityservice/IdentityServiceFacadeFactoryBeanTest.java", "filename": "repository/src/test/java/org/alfresco/repo/security/authentication/identityservice/IdentityServiceFacadeFactoryBeanTest.java",
"hashed_secret": "c5aad1895e1dcff195992938f1bcc9954d575ac9", "hashed_secret": "c5aad1895e1dcff195992938f1bcc9954d575ac9",
"is_verified": false, "is_verified": false,
"line_number": 92, "line_number": 91,
"is_secret": false "is_secret": false
} }
], ],
@@ -1627,7 +1627,7 @@
"filename": "repository/src/test/java/org/alfresco/repo/security/authentication/identityservice/SpringBasedIdentityServiceFacadeUnitTest.java", "filename": "repository/src/test/java/org/alfresco/repo/security/authentication/identityservice/SpringBasedIdentityServiceFacadeUnitTest.java",
"hashed_secret": "5baa61e4c9b93f3f0682250b6cf8331b7ee68fd8", "hashed_secret": "5baa61e4c9b93f3f0682250b6cf8331b7ee68fd8",
"is_verified": false, "is_verified": false,
"line_number": 46, "line_number": 47,
"is_secret": false "is_secret": false
} }
], ],
@@ -1888,5 +1888,5 @@
} }
] ]
}, },
"generated_at": "2024-12-19T08:58:42Z" "generated_at": "2025-01-07T10:56:22Z"
} }

View File

@@ -2,7 +2,7 @@
* #%L * #%L
* Alfresco Records Management Module * Alfresco Records Management Module
* %% * %%
* Copyright (C) 2005 - 2024 Alfresco Software Limited * Copyright (C) 2005 - 2025 Alfresco Software Limited
* %% * %%
* This file is part of the Alfresco software. * This file is part of the Alfresco software.
* - * -
@@ -26,12 +26,11 @@
*/ */
package org.alfresco.rest.core; package org.alfresco.rest.core;
import lombok.Getter;
import org.springframework.beans.factory.annotation.Value; import org.springframework.beans.factory.annotation.Value;
import org.springframework.context.annotation.Configuration; import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.PropertySource; import org.springframework.context.annotation.PropertySource;
import lombok.Getter;
/** /**
* Extends {@link RestProperties} to be able to change/add properties * Extends {@link RestProperties} to be able to change/add properties
* *

View File

@@ -2,7 +2,7 @@
* #%L * #%L
* Alfresco Records Management Module * Alfresco Records Management Module
* %% * %%
* Copyright (C) 2005 - 2024 Alfresco Software Limited * Copyright (C) 2005 - 2025 Alfresco Software Limited
* %% * %%
* This file is part of the Alfresco software. * This file is part of the Alfresco software.
* - * -
@@ -27,6 +27,11 @@
package org.alfresco.rest.core; package org.alfresco.rest.core;
import io.restassured.builder.RequestSpecBuilder; import io.restassured.builder.RequestSpecBuilder;
import lombok.Getter;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.context.annotation.Scope;
import org.springframework.http.HttpStatus;
import org.springframework.stereotype.Service;
import org.alfresco.rest.exception.EmptyJsonResponseException; import org.alfresco.rest.exception.EmptyJsonResponseException;
import org.alfresco.rest.model.RestErrorModel; import org.alfresco.rest.model.RestErrorModel;
@@ -38,12 +43,6 @@ import org.alfresco.rest.requests.search.SearchAPI;
import org.alfresco.rest.rm.community.requests.gscore.GSCoreAPI; import org.alfresco.rest.rm.community.requests.gscore.GSCoreAPI;
import org.alfresco.utility.model.StatusModel; import org.alfresco.utility.model.StatusModel;
import org.alfresco.utility.model.UserModel; import org.alfresco.utility.model.UserModel;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.context.annotation.Scope;
import org.springframework.http.HttpStatus;
import org.springframework.stereotype.Service;
import lombok.Getter;
/** /**
* Extends {@link RestWrapper} in order to call GS APIs with our own properties * Extends {@link RestWrapper} in order to call GS APIs with our own properties
@@ -153,15 +152,18 @@ public class RMRestWrapper
} }
/** /**
* You can handle the request sent to server by calling this method. * You can handle the request sent to server by calling this method. If for example you want to sent multipart form data you can use:
* If for example you want to sent multipart form data you can use: <pre> *
* <pre>
* restClient.configureRequestSpec() * restClient.configureRequestSpec()
* .addMultiPart("filedata", Utility.getResourceTestDataFile("restapi-resource")) * .addMultiPart("filedata", Utility.getResourceTestDataFile("restapi-resource"))
* .addFormParam("renditions", "doclib") * .addFormParam("renditions", "doclib")
* .addFormParam("autoRename", true); * .addFormParam("autoRename", true);
* *
* restClient.withCoreAPI().usingNode(ContentModel.my()).createNode(); * restClient.withCoreAPI().usingNode(ContentModel.my()).createNode();
* </pre> This will create the node using the multipart data defined. * </pre>
*
* This will create the node using the multipart data defined.
*/ */
public RequestSpecBuilder configureRequestSpec() public RequestSpecBuilder configureRequestSpec()
{ {
@@ -171,7 +173,8 @@ public class RMRestWrapper
/** /**
* Process a response that returns a html * Process a response that returns a html
* *
* @throws EmptyJsonResponseException If there is no response from the server. * @throws EmptyJsonResponseException
* If there is no response from the server.
*/ */
public RestHtmlResponse processHtmlResponse(RestRequest simpleRequest) public RestHtmlResponse processHtmlResponse(RestRequest simpleRequest)
{ {

View File

@@ -2,7 +2,7 @@
* #%L * #%L
* Alfresco Records Management Module * Alfresco Records Management Module
* %% * %%
* Copyright (C) 2005 - 2024 Alfresco Software Limited * Copyright (C) 2005 - 2025 Alfresco Software Limited
* %% * %%
* This file is part of the Alfresco software. * This file is part of the Alfresco software.
* - * -
@@ -32,6 +32,10 @@ import jakarta.annotation.Resource;
import lombok.Getter; import lombok.Getter;
import lombok.Setter; import lombok.Setter;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.context.annotation.Scope;
import org.springframework.stereotype.Service;
import org.alfresco.rest.requests.Node; import org.alfresco.rest.requests.Node;
import org.alfresco.rest.requests.coreAPI.RestCoreAPI; import org.alfresco.rest.requests.coreAPI.RestCoreAPI;
import org.alfresco.rest.requests.search.SearchAPI; import org.alfresco.rest.requests.search.SearchAPI;
@@ -45,17 +49,14 @@ import org.alfresco.rest.rm.community.requests.gscore.api.RMUserAPI;
import org.alfresco.rest.rm.community.requests.gscore.api.RecordCategoryAPI; import org.alfresco.rest.rm.community.requests.gscore.api.RecordCategoryAPI;
import org.alfresco.rest.rm.community.requests.gscore.api.RecordFolderAPI; import org.alfresco.rest.rm.community.requests.gscore.api.RecordFolderAPI;
import org.alfresco.rest.rm.community.requests.gscore.api.RecordsAPI; import org.alfresco.rest.rm.community.requests.gscore.api.RecordsAPI;
import org.alfresco.rest.rm.community.requests.gscore.api.RetentionScheduleAPI;
import org.alfresco.rest.rm.community.requests.gscore.api.TransferAPI; import org.alfresco.rest.rm.community.requests.gscore.api.TransferAPI;
import org.alfresco.rest.rm.community.requests.gscore.api.TransferContainerAPI; import org.alfresco.rest.rm.community.requests.gscore.api.TransferContainerAPI;
import org.alfresco.rest.rm.community.requests.gscore.api.UnfiledContainerAPI; import org.alfresco.rest.rm.community.requests.gscore.api.UnfiledContainerAPI;
import org.alfresco.rest.rm.community.requests.gscore.api.UnfiledRecordFolderAPI; import org.alfresco.rest.rm.community.requests.gscore.api.UnfiledRecordFolderAPI;
import org.alfresco.rest.rm.community.requests.gscore.api.RetentionScheduleAPI;
import org.alfresco.utility.data.DataUserAIS; import org.alfresco.utility.data.DataUserAIS;
import org.alfresco.utility.model.RepoTestModel; import org.alfresco.utility.model.RepoTestModel;
import org.alfresco.utility.model.UserModel; import org.alfresco.utility.model.UserModel;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.context.annotation.Scope;
import org.springframework.stereotype.Service;
/** /**
* REST API Factory which provides access to the APIs * REST API Factory which provides access to the APIs

View File

@@ -2,7 +2,7 @@
* #%L * #%L
* Alfresco Records Management Module * Alfresco Records Management Module
* %% * %%
* Copyright (C) 2005 - 2024 Alfresco Software Limited * Copyright (C) 2005 - 2025 Alfresco Software Limited
* %% * %%
* This file is part of the Alfresco software. * This file is part of the Alfresco software.
* - * -
@@ -44,10 +44,12 @@ public class SearchRequestBuilder extends SearchRequest
{ {
new SearchRequest(); new SearchRequest();
} }
/** /**
* Set the sql statement for the SearchRequest * Set the sql statement for the SearchRequest
* *
* @param query sql statement * @param query
* sql statement
* @return search request * @return search request
*/ */
public SearchRequestBuilder setQueryBuilder(RestRequestQueryModel query) public SearchRequestBuilder setQueryBuilder(RestRequestQueryModel query)
@@ -59,7 +61,8 @@ public class SearchRequestBuilder extends SearchRequest
/** /**
* Set the paging statement for the SearchRequest * Set the paging statement for the SearchRequest
* *
* @param paging pagination requested * @param paging
* pagination requested
* @return search request * @return search request
*/ */
public SearchRequestBuilder setPagingBuilder(Pagination paging) public SearchRequestBuilder setPagingBuilder(Pagination paging)
@@ -82,7 +85,8 @@ public class SearchRequestBuilder extends SearchRequest
/** /**
* Set the requested fields for the SearchRequest * Set the requested fields for the SearchRequest
* *
* @param fields requested fields * @param fields
* requested fields
* @return search request * @return search request
*/ */
public SearchRequestBuilder setFieldsBuilder(List<String> fields) public SearchRequestBuilder setFieldsBuilder(List<String> fields)

View File

@@ -2,7 +2,7 @@
* #%L * #%L
* Alfresco Records Management Module * Alfresco Records Management Module
* %% * %%
* Copyright (C) 2005 - 2024 Alfresco Software Limited * Copyright (C) 2005 - 2025 Alfresco Software Limited
* %% * %%
* This file is part of the Alfresco software. * This file is part of the Alfresco software.
* - * -
@@ -26,12 +26,12 @@
*/ */
package org.alfresco.rest.core.v0; package org.alfresco.rest.core.v0;
import jakarta.json.Json;
import jakarta.json.JsonReader;
import java.io.IOException; import java.io.IOException;
import java.io.InputStream; import java.io.InputStream;
import java.time.format.DateTimeFormatter; import java.time.format.DateTimeFormatter;
import java.time.format.DateTimeFormatterBuilder; import java.time.format.DateTimeFormatterBuilder;
import jakarta.json.Json;
import jakarta.json.JsonReader;
import org.apache.commons.io.IOUtils; import org.apache.commons.io.IOUtils;
import org.apache.http.HttpEntity; import org.apache.http.HttpEntity;
@@ -52,20 +52,20 @@ public class APIUtils
{ {
/** Logger for this class. */ /** Logger for this class. */
private static final Logger LOGGER = LoggerFactory.getLogger(APIUtils.class); private static final Logger LOGGER = LoggerFactory.getLogger(APIUtils.class);
/** The ISO instant formatter that formats or parses an instant in UTC, such as '2011-12-03T10:15:305Z' /**
* similar with {@link DateTimeFormatter#ISO_INSTANT}, but with only 3 nanoseconds*/ * The ISO instant formatter that formats or parses an instant in UTC, such as '2011-12-03T10:15:305Z' similar with {@link DateTimeFormatter#ISO_INSTANT}, but with only 3 nanoseconds
public static final DateTimeFormatter ISO_INSTANT_FORMATTER = */
new DateTimeFormatterBuilder().appendInstant(3).toFormatter(); public static final DateTimeFormatter ISO_INSTANT_FORMATTER = new DateTimeFormatterBuilder().appendInstant(3).toFormatter();
/** Private constructor for helper class. */ /** Private constructor for helper class. */
private APIUtils() private APIUtils()
{ {}
}
/** /**
* Extract the body of a HTTP response as a JSON object. * Extract the body of a HTTP response as a JSON object.
* *
* @param httpResponse The HTTP response. * @param httpResponse
* The HTTP response.
* @return A JSON representation of the object. * @return A JSON representation of the object.
*/ */
public static JSONObject convertHTTPResponseToJSON(HttpResponse httpResponse) public static JSONObject convertHTTPResponseToJSON(HttpResponse httpResponse)
@@ -86,7 +86,8 @@ public class APIUtils
/** /**
* Util method to extract the message string from the HTTP response * Util method to extract the message string from the HTTP response
* *
* @param httpResponse http response * @param httpResponse
* http response
* @return error message from the http response * @return error message from the http response
*/ */
public static String extractErrorMessageFromHttpResponse(HttpResponse httpResponse) public static String extractErrorMessageFromHttpResponse(HttpResponse httpResponse)

View File

@@ -2,7 +2,7 @@
* #%L * #%L
* Alfresco Records Management Module * Alfresco Records Management Module
* %% * %%
* Copyright (C) 2005 - 2024 Alfresco Software Limited * Copyright (C) 2005 - 2025 Alfresco Software Limited
* %% * %%
* This file is part of the Alfresco software. * This file is part of the Alfresco software.
* - * -
@@ -39,9 +39,6 @@ import java.util.HashMap;
import java.util.List; import java.util.List;
import java.util.Map; import java.util.Map;
import org.alfresco.dataprep.AlfrescoHttpClient;
import org.alfresco.dataprep.AlfrescoHttpClientFactory;
import org.alfresco.dataprep.ContentService;
import org.apache.chemistry.opencmis.client.api.CmisObject; import org.apache.chemistry.opencmis.client.api.CmisObject;
import org.apache.chemistry.opencmis.commons.exceptions.CmisObjectNotFoundException; import org.apache.chemistry.opencmis.commons.exceptions.CmisObjectNotFoundException;
import org.apache.http.HttpResponse; import org.apache.http.HttpResponse;
@@ -64,6 +61,10 @@ import org.slf4j.Logger;
import org.slf4j.LoggerFactory; import org.slf4j.LoggerFactory;
import org.springframework.beans.factory.annotation.Autowired; import org.springframework.beans.factory.annotation.Autowired;
import org.alfresco.dataprep.AlfrescoHttpClient;
import org.alfresco.dataprep.AlfrescoHttpClientFactory;
import org.alfresco.dataprep.ContentService;
/** /**
* The base API class containing common methods for making v0 API requests * The base API class containing common methods for making v0 API requests
* *
@@ -98,9 +99,11 @@ public abstract class BaseAPI
/** /**
* Helper method to extract list of properties values from result. * Helper method to extract list of properties values from result.
* *
* @param result the response * @param result
* the response
* @return list of specified property values in result * @return list of specified property values in result
* @throws RuntimeException for malformed response * @throws RuntimeException
* for malformed response
*/ */
protected List<String> getPropertyValues(JSONObject result, String propertyName) protected List<String> getPropertyValues(JSONObject result, String propertyName)
{ {
@@ -156,9 +159,11 @@ public abstract class BaseAPI
/** /**
* Helper method to extract property values from request result and put them in map as a list that corresponds to a unique property value. * Helper method to extract property values from request result and put them in map as a list that corresponds to a unique property value.
* *
* @param requestResult the request response * @param requestResult
* the request response
* @return a map containing information about multiple properties values that correspond to a unique one * @return a map containing information about multiple properties values that correspond to a unique one
* @throws RuntimeException for malformed response * @throws RuntimeException
* for malformed response
*/ */
protected Map<String, List<String>> getPropertyValuesByUniquePropertyValue(JSONObject requestResult, String uniqueProperty, List<String> otherProperties) protected Map<String, List<String>> getPropertyValuesByUniquePropertyValue(JSONObject requestResult, String uniqueProperty, List<String> otherProperties)
{ {
@@ -189,11 +194,12 @@ public abstract class BaseAPI
/** /**
* Retrieves the nodeRef of an item (category, folder or record) with the given path * Retrieves the nodeRef of an item (category, folder or record) with the given path
* *
* @param username the username * @param username
* @param password the password * the username
* @param path the path to the container eg. in case of a category it would be the category name, * @param password
* in case of a folder it would be /categoryName/folderName * the password
* when trying to get File Plan, the path would be "" * @param path
* the path to the container eg. in case of a category it would be the category name, in case of a folder it would be /categoryName/folderName when trying to get File Plan, the path would be ""
* @return the container nodeRef * @return the container nodeRef
*/ */
public String getItemNodeRef(String username, String password, String path) public String getItemNodeRef(String username, String password, String path)
@@ -204,9 +210,12 @@ public abstract class BaseAPI
/** /**
* Retrieve a Cmis object by its path * Retrieve a Cmis object by its path
* *
* @param username the user's username * @param username
* @param password its password * the user's username
* @param path the object path * @param password
* its password
* @param path
* the object path
* @return the object in case it exists, null if its does not exist * @return the object in case it exists, null if its does not exist
*/ */
protected CmisObject getObjectByPath(String username, String password, String path) protected CmisObject getObjectByPath(String username, String password, String path)
@@ -215,7 +224,8 @@ public abstract class BaseAPI
try try
{ {
object = contentService.getCMISSession(username, password).getObjectByPath(path); object = contentService.getCMISSession(username, password).getObjectByPath(path);
} catch (CmisObjectNotFoundException notFoundError) }
catch (CmisObjectNotFoundException notFoundError)
{ {
return null; return null;
} }
@@ -225,9 +235,12 @@ public abstract class BaseAPI
/** /**
* Generic faceted request. * Generic faceted request.
* *
* @param username the username * @param username
* @param password the password * the username
* @param parameters if the request has parameters * @param password
* the password
* @param parameters
* if the request has parameters
* @return result object (see API reference for more details), null for any errors * @return result object (see API reference for more details), null for any errors
*/ */
protected JSONObject facetedRequest(String username, String password, List<NameValuePair> parameters, String requestURI) protected JSONObject facetedRequest(String username, String password, List<NameValuePair> parameters, String requestURI)
@@ -255,10 +268,15 @@ public abstract class BaseAPI
/** /**
* Helper method for GET requests * Helper method for GET requests
* @param adminUser user with administrative privileges *
* @param adminPassword password for adminUser * @param adminUser
* @param urlTemplate request URL template * user with administrative privileges
* @param urlTemplateParams zero or more parameters used with <i>urlTemplate</i> * @param adminPassword
* password for adminUser
* @param urlTemplate
* request URL template
* @param urlTemplateParams
* zero or more parameters used with <i>urlTemplate</i>
*/ */
protected JSONObject doGetRequest(String adminUser, protected JSONObject doGetRequest(String adminUser,
String adminPassword, String adminPassword,
@@ -284,10 +302,15 @@ public abstract class BaseAPI
/** /**
* Helper method for Delete requests * Helper method for Delete requests
* @param adminUser user with administrative privileges *
* @param adminPassword password for adminUser * @param adminUser
* @param urlTemplate request URL template * user with administrative privileges
* @param urlTemplateParams zero or more parameters used with <i>urlTemplate</i> * @param adminPassword
* password for adminUser
* @param urlTemplate
* request URL template
* @param urlTemplateParams
* zero or more parameters used with <i>urlTemplate</i>
*/ */
protected JSONObject doDeleteRequest(String adminUser, protected JSONObject doDeleteRequest(String adminUser,
String adminPassword, String adminPassword,
@@ -313,11 +336,17 @@ public abstract class BaseAPI
/** /**
* Helper method for PUT requests * Helper method for PUT requests
* @param adminUser user with administrative privileges *
* @param adminPassword password for adminUser * @param adminUser
* @param requestParams zero or more endpoint specific request parameters * user with administrative privileges
* @param urlTemplate request URL template * @param adminPassword
* @param urlTemplateParams zero or more parameters used with <i>urlTemplate</i> * password for adminUser
* @param requestParams
* zero or more endpoint specific request parameters
* @param urlTemplate
* request URL template
* @param urlTemplateParams
* zero or more parameters used with <i>urlTemplate</i>
*/ */
protected JSONObject doPutRequest(String adminUser, protected JSONObject doPutRequest(String adminUser,
String adminPassword, String adminPassword,
@@ -345,12 +374,18 @@ public abstract class BaseAPI
/** /**
* Helper method for PUT requests * Helper method for PUT requests
* *
* @param adminUser user with administrative privileges * @param adminUser
* @param adminPassword password for adminUser * user with administrative privileges
* @param expectedStatusCode The expected return status code. * @param adminPassword
* @param requestParams zero or more endpoint specific request parameters * password for adminUser
* @param urlTemplate request URL template * @param expectedStatusCode
* @param urlTemplateParams zero or more parameters used with <i>urlTemplate</i> * The expected return status code.
* @param requestParams
* zero or more endpoint specific request parameters
* @param urlTemplate
* request URL template
* @param urlTemplateParams
* zero or more parameters used with <i>urlTemplate</i>
*/ */
protected HttpResponse doPutJsonRequest(String adminUser, protected HttpResponse doPutJsonRequest(String adminUser,
String adminPassword, String adminPassword,
@@ -366,14 +401,22 @@ public abstract class BaseAPI
/** /**
* Helper method for PUT requests * Helper method for PUT requests
* *
* @param adminUser user with administrative privileges * @param adminUser
* @param adminPassword password for adminUser * user with administrative privileges
* @param expectedStatusCode The expected return status code. * @param adminPassword
* @param urlStart the start of the URL (for example "alfresco/s/slingshot"). * password for adminUser
* @param requestParams zero or more endpoint specific request parameters * @param expectedStatusCode
* @param urlTemplate request URL template * The expected return status code.
* @param urlTemplateParams zero or more parameters used with <i>urlTemplate</i> * @param urlStart
* @throws AssertionError if the returned status code is not as expected. * the start of the URL (for example "alfresco/s/slingshot").
* @param requestParams
* zero or more endpoint specific request parameters
* @param urlTemplate
* request URL template
* @param urlTemplateParams
* zero or more parameters used with <i>urlTemplate</i>
* @throws AssertionError
* if the returned status code is not as expected.
*/ */
private HttpResponse doPutJsonRequest(String adminUser, private HttpResponse doPutJsonRequest(String adminUser,
String adminPassword, String adminPassword,
@@ -399,9 +442,12 @@ public abstract class BaseAPI
/** /**
* Fill in the parameters for a URL template. * Fill in the parameters for a URL template.
* *
* @param urlStart The start of the URL. * @param urlStart
* @param urlTemplate The template. * The start of the URL.
* @param urlTemplateParams Any parameters that need to be filled into the URL template. * @param urlTemplate
* The template.
* @param urlTemplateParams
* Any parameters that need to be filled into the URL template.
* @return The resultant URL. * @return The resultant URL.
*/ */
private String formatRequestUrl(String urlStart, String urlTemplate, String[] urlTemplateParams) private String formatRequestUrl(String urlStart, String urlTemplate, String[] urlTemplateParams)
@@ -416,11 +462,17 @@ public abstract class BaseAPI
/** /**
* Helper method for POST requests * Helper method for POST requests
* @param adminUser user with administrative privileges *
* @param adminPassword password for adminUser * @param adminUser
* @param requestParams zero or more endpoint specific request parameters * user with administrative privileges
* @param urlTemplate request URL template * @param adminPassword
* @param urlTemplateParams zero or more parameters used with <i>urlTemplate</i> * password for adminUser
* @param requestParams
* zero or more endpoint specific request parameters
* @param urlTemplate
* request URL template
* @param urlTemplateParams
* zero or more parameters used with <i>urlTemplate</i>
*/ */
protected JSONObject doPostRequest(String adminUser, protected JSONObject doPostRequest(String adminUser,
String adminPassword, String adminPassword,
@@ -448,12 +500,18 @@ public abstract class BaseAPI
/** /**
* Helper method for POST requests * Helper method for POST requests
* *
* @param adminUser user with administrative privileges * @param adminUser
* @param adminPassword password for adminUser * user with administrative privileges
* @param expectedStatusCode The expected return status code. * @param adminPassword
* @param requestParams zero or more endpoint specific request parameters * password for adminUser
* @param urlTemplate request URL template * @param expectedStatusCode
* @param urlTemplateParams zero or more parameters used with <i>urlTemplate</i> * The expected return status code.
* @param requestParams
* zero or more endpoint specific request parameters
* @param urlTemplate
* request URL template
* @param urlTemplateParams
* zero or more parameters used with <i>urlTemplate</i>
*/ */
protected HttpResponse doPostJsonRequest(String adminUser, protected HttpResponse doPostJsonRequest(String adminUser,
String adminPassword, String adminPassword,
@@ -469,12 +527,18 @@ public abstract class BaseAPI
/** /**
* Helper method for POST requests to slingshot. * Helper method for POST requests to slingshot.
* *
* @param adminUser user with administrative privileges * @param adminUser
* @param adminPassword password for adminUser * user with administrative privileges
* @param expectedStatusCode The expected return status code. * @param adminPassword
* @param requestParams zero or more endpoint specific request parameters * password for adminUser
* @param urlTemplate request URL template * @param expectedStatusCode
* @param urlTemplateParams zero or more parameters used with <i>urlTemplate</i> * The expected return status code.
* @param requestParams
* zero or more endpoint specific request parameters
* @param urlTemplate
* request URL template
* @param urlTemplateParams
* zero or more parameters used with <i>urlTemplate</i>
*/ */
protected HttpResponse doSlingshotPostJsonRequest(String adminUser, protected HttpResponse doSlingshotPostJsonRequest(String adminUser,
String adminPassword, String adminPassword,
@@ -490,14 +554,22 @@ public abstract class BaseAPI
/** /**
* Helper method for POST requests * Helper method for POST requests
* *
* @param adminUser user with administrative privileges * @param adminUser
* @param adminPassword password for adminUser * user with administrative privileges
* @param expectedStatusCode The expected return status code. * @param adminPassword
* @param urlStart the start of the URL (for example "alfresco/s/slingshot"). * password for adminUser
* @param requestParams zero or more endpoint specific request parameters * @param expectedStatusCode
* @param urlTemplate request URL template * The expected return status code.
* @param urlTemplateParams zero or more parameters used with <i>urlTemplate</i> * @param urlStart
* @throws AssertionError if the returned status code is not as expected. * the start of the URL (for example "alfresco/s/slingshot").
* @param requestParams
* zero or more endpoint specific request parameters
* @param urlTemplate
* request URL template
* @param urlTemplateParams
* zero or more parameters used with <i>urlTemplate</i>
* @throws AssertionError
* if the returned status code is not as expected.
*/ */
private HttpResponse doPostJsonRequest(String adminUser, private HttpResponse doPostJsonRequest(String adminUser,
String adminPassword, String adminPassword,
@@ -529,7 +601,8 @@ public abstract class BaseAPI
/** /**
* Try to convert the response body to a JSON object. * Try to convert the response body to a JSON object.
* *
* @param response The response. * @param response
* The response.
* @return The JSON object or null if it was not possible to convert the response. * @return The JSON object or null if it was not possible to convert the response.
*/ */
private JSONObject responseBodyToJson(HttpResponse response) private JSONObject responseBodyToJson(HttpResponse response)
@@ -554,14 +627,22 @@ public abstract class BaseAPI
/** /**
* Helper method for handling generic HTTP requests * Helper method for handling generic HTTP requests
* @param requestType request type (a subclass of {@link HttpRequestBase}) *
* @param requestUrl URL the request is to be sent to * @param requestType
* @param adminUser user with administrative privileges * request type (a subclass of {@link HttpRequestBase})
* @param adminPassword password for adminUser * @param requestUrl
* @param requestParams endpoint specific request parameters * URL the request is to be sent to
* @param adminUser
* user with administrative privileges
* @param adminPassword
* password for adminUser
* @param requestParams
* endpoint specific request parameters
* @return response body * @return response body
* @throws IllegalAccessException for invalid <i>requestType</i> * @throws IllegalAccessException
* @throws InstantiationException for invalid <i>requestType</i> * for invalid <i>requestType</i>
* @throws InstantiationException
* for invalid <i>requestType</i>
*/ */
private <T extends HttpRequestBase> JSONObject doRequest( private <T extends HttpRequestBase> JSONObject doRequest(
Class<T> requestType, Class<T> requestType,
@@ -686,40 +767,16 @@ public abstract class BaseAPI
} }
/** /**
* Used to set RM items properties * Used to set RM items properties including records, categories and folders
* including records, categories and folders
*/ */
public enum RMProperty public enum RMProperty
{ {
NAME, NAME, TITLE, CONTENT, DESCRIPTION, AUTHOR, PHYSICAL_SIZE, NUMBER_OF_COPIES, STORAGE_LOCATION, SHELF, BOX, FILE, ORIGINATOR, ORIGINATING_ORGANIZATION, PUBLICATION_DATE
TITLE,
CONTENT,
DESCRIPTION,
AUTHOR,
PHYSICAL_SIZE,
NUMBER_OF_COPIES,
STORAGE_LOCATION,
SHELF,
BOX,
FILE,
ORIGINATOR,
ORIGINATING_ORGANIZATION,
PUBLICATION_DATE
} }
public enum RETENTION_SCHEDULE public enum RETENTION_SCHEDULE
{ {
NAME, NAME, DESCRIPTION, RETENTION_AUTHORITY, RETENTION_INSTRUCTIONS, RETENTION_PERIOD, RETENTION_LOCATION, RETENTION_PERIOD_PROPERTY, RETENTION_GHOST, RETENTION_ELIGIBLE_FIRST_EVENT, RETENTION_EVENTS, COMBINE_DISPOSITION_STEP_CONDITIONS
DESCRIPTION,
RETENTION_AUTHORITY,
RETENTION_INSTRUCTIONS,
RETENTION_PERIOD,
RETENTION_LOCATION,
RETENTION_PERIOD_PROPERTY,
RETENTION_GHOST,
RETENTION_ELIGIBLE_FIRST_EVENT,
RETENTION_EVENTS,
COMBINE_DISPOSITION_STEP_CONDITIONS
} }
/** /**
@@ -727,14 +784,8 @@ public abstract class BaseAPI
*/ */
public enum RM_ACTIONS public enum RM_ACTIONS
{ {
EDIT_DISPOSITION_DATE("editDispositionActionAsOfDate"), EDIT_DISPOSITION_DATE("editDispositionActionAsOfDate"), END_RETENTION("retain"), CUT_OFF("cutoff"), UNDO_CUT_OFF("undoCutoff"), TRANSFER("transfer"), COMPLETE_EVENT("completeEvent"), UNDO_EVENT("undoEvent"), DESTROY("destroy");
END_RETENTION("retain"),
CUT_OFF("cutoff"),
UNDO_CUT_OFF("undoCutoff"),
TRANSFER("transfer"),
COMPLETE_EVENT("completeEvent"),
UNDO_EVENT("undoEvent"),
DESTROY("destroy");
String action; String action;
private RM_ACTIONS(String action) private RM_ACTIONS(String action)
@@ -750,17 +801,16 @@ public abstract class BaseAPI
public enum PermissionType public enum PermissionType
{ {
SET_READ, SET_READ, REMOVE_READ, SET_READ_AND_FILE, REMOVE_READ_AND_FILE,
REMOVE_READ,
SET_READ_AND_FILE,
REMOVE_READ_AND_FILE,
} }
/** /**
* Util to return the property value from a map * Util to return the property value from a map
* *
* @param properties the map containing properties * @param properties
* @param property to get value for * the map containing properties
* @param property
* to get value for
* @return the property value * @return the property value
*/ */
public <K extends Enum<?>> String getPropertyValue(Map<K, String> properties, Enum<?> property) public <K extends Enum<?>> String getPropertyValue(Map<K, String> properties, Enum<?> property)
@@ -776,10 +826,14 @@ public abstract class BaseAPI
/** /**
* Retrieves the property value and decides if that gets to be added to the request * Retrieves the property value and decides if that gets to be added to the request
* *
* @param requestParams the request parameters * @param requestParams
* @param propertyRequestValue the property name in the request, eg. "prop_cm_name" * the request parameters
* @param itemProperties map of item's properties values * @param propertyRequestValue
* @param property the property in the property map to check value for * the property name in the request, eg. "prop_cm_name"
* @param itemProperties
* map of item's properties values
* @param property
* the property in the property map to check value for
* @return the json object used in request with the property with its value added if that is not null or empty * @return the json object used in request with the property with its value added if that is not null or empty
*/ */
protected <K extends Enum<?>> JSONObject addPropertyToRequest(JSONObject requestParams, String propertyRequestValue, Map<K, String> itemProperties, Enum<?> property) throws JSONException protected <K extends Enum<?>> JSONObject addPropertyToRequest(JSONObject requestParams, String propertyRequestValue, Map<K, String> itemProperties, Enum<?> property) throws JSONException
@@ -796,12 +850,14 @@ public abstract class BaseAPI
/** /**
* Deletes the category, folder or record given as parameter * Deletes the category, folder or record given as parameter
* *
* @param username the username with whom the delete is performed * @param username
* @param password the user's password * the username with whom the delete is performed
* @param itemPath the path to the item eg. in case of a category it would be the "/" + category name, * @param password
* in case of a folder or subCategory it would be /categoryName/folderName or /categoryName/subCategoryName/ * the user's password
* in case of a record /categoryName/folderName/recordName * @param itemPath
* @throws AssertionError if the delete was not successful. * the path to the item eg. in case of a category it would be the "/" + category name, in case of a folder or subCategory it would be /categoryName/folderName or /categoryName/subCategoryName/ in case of a record /categoryName/folderName/recordName
* @throws AssertionError
* if the delete was not successful.
*/ */
protected void deleteItem(String username, String password, String itemPath) protected void deleteItem(String username, String password, String itemPath)
{ {

View File

@@ -2,7 +2,7 @@
* #%L * #%L
* Alfresco Records Management Module * Alfresco Records Management Module
* %% * %%
* Copyright (C) 2005 - 2024 Alfresco Software Limited * Copyright (C) 2005 - 2025 Alfresco Software Limited
* %% * %%
* This file is part of the Alfresco software. * This file is part of the Alfresco software.
* - * -
@@ -28,13 +28,8 @@ package org.alfresco.rest.core.v0;
public enum RMEvents public enum RMEvents
{ {
ABOLISHED("abolished"), ABOLISHED("abolished"), ALL_ALLOWANCES_GRANTED_ARE_TERMINATED("all_allowances_granted_are_terminated"), CASE_CLOSED("case_closed"), DECLASSIFICATION_REVIEW("declassification_review"), OBSOLETE("obsolete"), NO_LONGER_NEEDED("no_longer_needed"), STUDY_COMPLETE("study_complete");
ALL_ALLOWANCES_GRANTED_ARE_TERMINATED("all_allowances_granted_are_terminated"),
CASE_CLOSED("case_closed"),
DECLASSIFICATION_REVIEW("declassification_review"),
OBSOLETE("obsolete"),
NO_LONGER_NEEDED("no_longer_needed"),
STUDY_COMPLETE("study_complete");
private String eventName; private String eventName;
RMEvents(String eventName) RMEvents(String eventName)

View File

@@ -2,7 +2,7 @@
* #%L * #%L
* Alfresco Records Management Module * Alfresco Records Management Module
* %% * %%
* Copyright (C) 2005 - 2024 Alfresco Software Limited * Copyright (C) 2005 - 2025 Alfresco Software Limited
* %% * %%
* This file is part of the Alfresco software. * This file is part of the Alfresco software.
* - * -
@@ -30,11 +30,11 @@ import java.util.List;
import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonIgnoreProperties;
import com.fasterxml.jackson.annotation.JsonProperty; import com.fasterxml.jackson.annotation.JsonProperty;
import lombok.AllArgsConstructor; import lombok.AllArgsConstructor;
import lombok.Builder; import lombok.Builder;
import lombok.Data; import lombok.Data;
import lombok.NoArgsConstructor; import lombok.NoArgsConstructor;
import org.alfresco.utility.model.TestModel; import org.alfresco.utility.model.TestModel;
/** /**

View File

@@ -2,7 +2,7 @@
* #%L * #%L
* Alfresco Records Management Module * Alfresco Records Management Module
* %% * %%
* Copyright (C) 2005 - 2024 Alfresco Software Limited * Copyright (C) 2005 - 2025 Alfresco Software Limited
* %% * %%
* This file is part of the Alfresco software. * This file is part of the Alfresco software.
* - * -
@@ -35,18 +35,7 @@ package org.alfresco.rest.rm.community.model.audit;
*/ */
public enum AuditEvents public enum AuditEvents
{ {
CREATE_PERSON("Create Person", "Create User"), CREATE_PERSON("Create Person", "Create User"), DELETE_PERSON("Delete Person", "Delete User"), CREATE_USER_GROUP("Create User Group", "Create User Group"), DELETE_USER_GROUP("Delete User Group", "Delete User Group"), ADD_TO_USER_GROUP("Add To User Group", "Add To User Group"), REMOVE_FROM_USER_GROUP("Remove From User Group", "Remove From User Group"), LOGIN_UNSUCCESSFUL("Login.Failure", "Login Unsuccessful"), LOGIN_SUCCESSFUL("Login.Success", "Login Successful"), CREATE_HOLD("Create Hold", "Create Hold"), DELETE_HOLD("Delete Hold", "Delete Hold"), ADD_TO_HOLD("Add To Hold", "Add To Hold"), REMOVE_FROM_HOLD("Remove From Hold", "Remove From Hold");
DELETE_PERSON("Delete Person", "Delete User"),
CREATE_USER_GROUP("Create User Group", "Create User Group"),
DELETE_USER_GROUP("Delete User Group", "Delete User Group"),
ADD_TO_USER_GROUP("Add To User Group", "Add To User Group"),
REMOVE_FROM_USER_GROUP("Remove From User Group", "Remove From User Group"),
LOGIN_UNSUCCESSFUL("Login.Failure", "Login Unsuccessful"),
LOGIN_SUCCESSFUL("Login.Success", "Login Successful"),
CREATE_HOLD("Create Hold", "Create Hold"),
DELETE_HOLD("Delete Hold", "Delete Hold"),
ADD_TO_HOLD("Add To Hold", "Add To Hold"),
REMOVE_FROM_HOLD("Remove From Hold", "Remove From Hold");
/** event audited */ /** event audited */
public final String event; public final String event;

View File

@@ -2,7 +2,7 @@
* #%L * #%L
* Alfresco Records Management Module * Alfresco Records Management Module
* %% * %%
* Copyright (C) 2005 - 2024 Alfresco Software Limited * Copyright (C) 2005 - 2025 Alfresco Software Limited
* %% * %%
* This file is part of the Alfresco software. * This file is part of the Alfresco software.
* - * -
@@ -29,7 +29,6 @@ package org.alfresco.rest.rm.community.model.common;
import java.util.List; import java.util.List;
import com.fasterxml.jackson.annotation.JsonProperty; import com.fasterxml.jackson.annotation.JsonProperty;
import lombok.AllArgsConstructor; import lombok.AllArgsConstructor;
import lombok.Builder; import lombok.Builder;
import lombok.Data; import lombok.Data;

View File

@@ -2,7 +2,7 @@
* #%L * #%L
* Alfresco Records Management Module * Alfresco Records Management Module
* %% * %%
* Copyright (C) 2005 - 2024 Alfresco Software Limited * Copyright (C) 2005 - 2025 Alfresco Software Limited
* %% * %%
* This file is part of the Alfresco software. * This file is part of the Alfresco software.
* - * -
@@ -27,10 +27,10 @@
package org.alfresco.rest.rm.community.model.common; package org.alfresco.rest.rm.community.model.common;
import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonIgnoreProperties;
import lombok.Builder; import lombok.Builder;
import lombok.Data; import lombok.Data;
import lombok.EqualsAndHashCode; import lombok.EqualsAndHashCode;
import org.alfresco.utility.model.TestModel; import org.alfresco.utility.model.TestModel;
/** /**

View File

@@ -2,7 +2,7 @@
* #%L * #%L
* Alfresco Records Management Module * Alfresco Records Management Module
* %% * %%
* Copyright (C) 2005 - 2024 Alfresco Software Limited * Copyright (C) 2005 - 2025 Alfresco Software Limited
* %% * %%
* This file is part of the Alfresco software. * This file is part of the Alfresco software.
* - * -
@@ -29,15 +29,14 @@ package org.alfresco.rest.rm.community.model.common;
import java.util.List; import java.util.List;
import com.fasterxml.jackson.annotation.JsonProperty; import com.fasterxml.jackson.annotation.JsonProperty;
import org.alfresco.utility.model.TestModel;
import lombok.AllArgsConstructor; import lombok.AllArgsConstructor;
import lombok.Builder; import lombok.Builder;
import lombok.Data; import lombok.Data;
import lombok.EqualsAndHashCode; import lombok.EqualsAndHashCode;
import lombok.NoArgsConstructor; import lombok.NoArgsConstructor;
import org.alfresco.utility.model.TestModel;
/** /**
* POJO for path parameter * POJO for path parameter
* *

View File

@@ -2,7 +2,7 @@
* #%L * #%L
* Alfresco Records Management Module * Alfresco Records Management Module
* %% * %%
* Copyright (C) 2005 - 2024 Alfresco Software Limited * Copyright (C) 2005 - 2025 Alfresco Software Limited
* %% * %%
* This file is part of the Alfresco software. * This file is part of the Alfresco software.
* - * -
@@ -27,7 +27,6 @@
package org.alfresco.rest.rm.community.model.common; package org.alfresco.rest.rm.community.model.common;
import com.fasterxml.jackson.annotation.JsonProperty; import com.fasterxml.jackson.annotation.JsonProperty;
import lombok.AllArgsConstructor; import lombok.AllArgsConstructor;
import lombok.Builder; import lombok.Builder;
import lombok.Data; import lombok.Data;

View File

@@ -2,7 +2,7 @@
* #%L * #%L
* Alfresco Records Management Module * Alfresco Records Management Module
* %% * %%
* Copyright (C) 2005 - 2024 Alfresco Software Limited * Copyright (C) 2005 - 2025 Alfresco Software Limited
* %% * %%
* This file is part of the Alfresco software. * This file is part of the Alfresco software.
* - * -
@@ -34,10 +34,8 @@ package org.alfresco.rest.rm.community.model.custom;
*/ */
public enum CustomDefinitions public enum CustomDefinitions
{ {
ATTACHMENT("Attachment"), ATTACHMENT("Attachment"), MESSAGE("Message"), NEXT_VERSION("Next Version"), RENDITION("Rendition");
MESSAGE("Message"),
NEXT_VERSION("Next Version"),
RENDITION("Rendition");
/** /**
* The name of custom reference. * The name of custom reference.
*/ */

View File

@@ -2,7 +2,7 @@
* #%L * #%L
* Alfresco Records Management Module * Alfresco Records Management Module
* %% * %%
* Copyright (C) 2005 - 2024 Alfresco Software Limited * Copyright (C) 2005 - 2025 Alfresco Software Limited
* %% * %%
* This file is part of the Alfresco software. * This file is part of the Alfresco software.
* - * -
@@ -29,17 +29,16 @@ package org.alfresco.rest.rm.community.model.fileplan;
import java.util.List; import java.util.List;
import com.fasterxml.jackson.annotation.JsonProperty; import com.fasterxml.jackson.annotation.JsonProperty;
import org.alfresco.rest.model.RestByUserModel;
import org.alfresco.rest.rm.community.model.common.Path;
import org.alfresco.utility.model.TestModel;
import lombok.AllArgsConstructor; import lombok.AllArgsConstructor;
import lombok.Builder; import lombok.Builder;
import lombok.Data; import lombok.Data;
import lombok.EqualsAndHashCode; import lombok.EqualsAndHashCode;
import lombok.NoArgsConstructor; import lombok.NoArgsConstructor;
import org.alfresco.rest.model.RestByUserModel;
import org.alfresco.rest.rm.community.model.common.Path;
import org.alfresco.utility.model.TestModel;
/** /**
* POJO for file plan * POJO for file plan
* *

View File

@@ -2,7 +2,7 @@
* #%L * #%L
* Alfresco Records Management Module * Alfresco Records Management Module
* %% * %%
* Copyright (C) 2005 - 2024 Alfresco Software Limited * Copyright (C) 2005 - 2025 Alfresco Software Limited
* %% * %%
* This file is part of the Alfresco software. * This file is part of the Alfresco software.
* - * -
@@ -34,15 +34,14 @@ import static org.alfresco.rest.rm.community.model.fileplancomponents.FilePlanCo
import static org.alfresco.rest.rm.community.model.fileplancomponents.FilePlanComponentFields.PROPERTIES_TITLE; import static org.alfresco.rest.rm.community.model.fileplancomponents.FilePlanComponentFields.PROPERTIES_TITLE;
import com.fasterxml.jackson.annotation.JsonProperty; import com.fasterxml.jackson.annotation.JsonProperty;
import org.alfresco.utility.model.TestModel;
import lombok.AllArgsConstructor; import lombok.AllArgsConstructor;
import lombok.Builder; import lombok.Builder;
import lombok.Data; import lombok.Data;
import lombok.EqualsAndHashCode; import lombok.EqualsAndHashCode;
import lombok.NoArgsConstructor; import lombok.NoArgsConstructor;
import org.alfresco.utility.model.TestModel;
/** /**
* POJO for file plan properties * POJO for file plan properties
* *

View File

@@ -2,7 +2,7 @@
* #%L * #%L
* Alfresco Records Management Module * Alfresco Records Management Module
* %% * %%
* Copyright (C) 2005 - 2024 Alfresco Software Limited * Copyright (C) 2005 - 2025 Alfresco Software Limited
* %% * %%
* This file is part of the Alfresco software. * This file is part of the Alfresco software.
* - * -

View File

@@ -2,7 +2,7 @@
* #%L * #%L
* Alfresco Records Management Module * Alfresco Records Management Module
* %% * %%
* Copyright (C) 2005 - 2024 Alfresco Software Limited * Copyright (C) 2005 - 2025 Alfresco Software Limited
* %% * %%
* This file is part of the Alfresco software. * This file is part of the Alfresco software.
* - * -
@@ -36,8 +36,7 @@ public class FilePlanComponentAspects
{ {
/** Private constructor to prevent instantiation. */ /** Private constructor to prevent instantiation. */
private FilePlanComponentAspects() private FilePlanComponentAspects()
{ {}
}
// aspect present on completed records // aspect present on completed records
public static final String ASPECTS_COMPLETED_RECORD = "rma:declaredRecord"; public static final String ASPECTS_COMPLETED_RECORD = "rma:declaredRecord";

View File

@@ -2,7 +2,7 @@
* #%L * #%L
* Alfresco Records Management Module * Alfresco Records Management Module
* %% * %%
* Copyright (C) 2005 - 2024 Alfresco Software Limited * Copyright (C) 2005 - 2025 Alfresco Software Limited
* %% * %%
* This file is part of the Alfresco software. * This file is part of the Alfresco software.
* - * -

View File

@@ -2,7 +2,7 @@
* #%L * #%L
* Alfresco Records Management Module * Alfresco Records Management Module
* %% * %%
* Copyright (C) 2005 - 2024 Alfresco Software Limited * Copyright (C) 2005 - 2025 Alfresco Software Limited
* %% * %%
* This file is part of the Alfresco software. * This file is part of the Alfresco software.
* - * -

View File

@@ -2,7 +2,7 @@
* #%L * #%L
* Alfresco Records Management Module * Alfresco Records Management Module
* %% * %%
* Copyright (C) 2005 - 2024 Alfresco Software Limited * Copyright (C) 2005 - 2025 Alfresco Software Limited
* %% * %%
* This file is part of the Alfresco software. * This file is part of the Alfresco software.
* - * -

View File

@@ -2,7 +2,7 @@
* #%L * #%L
* Alfresco Records Management Module * Alfresco Records Management Module
* %% * %%
* Copyright (C) 2005 - 2024 Alfresco Software Limited * Copyright (C) 2005 - 2025 Alfresco Software Limited
* %% * %%
* This file is part of the Alfresco software. * This file is part of the Alfresco software.
* - * -
@@ -29,11 +29,11 @@ package org.alfresco.rest.rm.community.model.hold;
import java.util.Objects; import java.util.Objects;
import com.fasterxml.jackson.annotation.JsonProperty; import com.fasterxml.jackson.annotation.JsonProperty;
import lombok.AllArgsConstructor; import lombok.AllArgsConstructor;
import lombok.Builder; import lombok.Builder;
import lombok.Data; import lombok.Data;
import lombok.NoArgsConstructor; import lombok.NoArgsConstructor;
import org.alfresco.utility.model.TestModel; import org.alfresco.utility.model.TestModel;
/** /**

View File

@@ -2,7 +2,7 @@
* #%L * #%L
* Alfresco Records Management Module * Alfresco Records Management Module
* %% * %%
* Copyright (C) 2005 - 2024 Alfresco Software Limited * Copyright (C) 2005 - 2025 Alfresco Software Limited
* %% * %%
* This file is part of the Alfresco software. * This file is part of the Alfresco software.
* - * -
@@ -27,11 +27,11 @@
package org.alfresco.rest.rm.community.model.hold; package org.alfresco.rest.rm.community.model.hold;
import com.fasterxml.jackson.annotation.JsonProperty; import com.fasterxml.jackson.annotation.JsonProperty;
import lombok.AllArgsConstructor; import lombok.AllArgsConstructor;
import lombok.Builder; import lombok.Builder;
import lombok.Data; import lombok.Data;
import lombok.NoArgsConstructor; import lombok.NoArgsConstructor;
import org.alfresco.rest.search.RestRequestQueryModel; import org.alfresco.rest.search.RestRequestQueryModel;
import org.alfresco.utility.model.TestModel; import org.alfresco.utility.model.TestModel;

View File

@@ -2,7 +2,7 @@
* #%L * #%L
* Alfresco Records Management Module * Alfresco Records Management Module
* %% * %%
* Copyright (C) 2005 - 2024 Alfresco Software Limited * Copyright (C) 2005 - 2025 Alfresco Software Limited
* %% * %%
* This file is part of the Alfresco software. * This file is part of the Alfresco software.
* - * -
@@ -26,8 +26,6 @@
*/ */
package org.alfresco.rest.rm.community.model.hold; package org.alfresco.rest.rm.community.model.hold;
import com.fasterxml.jackson.annotation.JsonProperty;
import lombok.AllArgsConstructor; import lombok.AllArgsConstructor;
import lombok.Builder; import lombok.Builder;
import lombok.Data; import lombok.Data;

View File

@@ -2,7 +2,7 @@
* #%L * #%L
* Alfresco Records Management Module * Alfresco Records Management Module
* %% * %%
* Copyright (C) 2005 - 2024 Alfresco Software Limited * Copyright (C) 2005 - 2025 Alfresco Software Limited
* %% * %%
* This file is part of the Alfresco software. * This file is part of the Alfresco software.
* - * -
@@ -30,6 +30,7 @@ import lombok.AllArgsConstructor;
import lombok.Builder; import lombok.Builder;
import lombok.Data; import lombok.Data;
import lombok.NoArgsConstructor; import lombok.NoArgsConstructor;
import org.alfresco.utility.model.TestModel; import org.alfresco.utility.model.TestModel;
/** /**

View File

@@ -2,7 +2,7 @@
* #%L * #%L
* Alfresco Records Management Module * Alfresco Records Management Module
* %% * %%
* Copyright (C) 2005 - 2024 Alfresco Software Limited * Copyright (C) 2005 - 2025 Alfresco Software Limited
* %% * %%
* This file is part of the Alfresco software. * This file is part of the Alfresco software.
* - * -
@@ -34,5 +34,4 @@ import org.alfresco.rest.core.RestModels;
* @author Damian Ujma * @author Damian Ujma
*/ */
public class HoldBulkStatusCollection extends RestModels<HoldBulkStatusEntry, HoldBulkStatusCollection> public class HoldBulkStatusCollection extends RestModels<HoldBulkStatusEntry, HoldBulkStatusCollection>
{ {}
}

View File

@@ -2,7 +2,7 @@
* #%L * #%L
* Alfresco Records Management Module * Alfresco Records Management Module
* %% * %%
* Copyright (C) 2005 - 2024 Alfresco Software Limited * Copyright (C) 2005 - 2025 Alfresco Software Limited
* %% * %%
* This file is part of the Alfresco software. * This file is part of the Alfresco software.
* - * -
@@ -26,13 +26,12 @@
*/ */
package org.alfresco.rest.rm.community.model.hold; package org.alfresco.rest.rm.community.model.hold;
import com.fasterxml.jackson.annotation.JsonProperty;
import lombok.AllArgsConstructor; import lombok.AllArgsConstructor;
import lombok.Builder; import lombok.Builder;
import lombok.Data; import lombok.Data;
import lombok.EqualsAndHashCode; import lombok.EqualsAndHashCode;
import lombok.NoArgsConstructor; import lombok.NoArgsConstructor;
import org.alfresco.rest.core.RestModels; import org.alfresco.rest.core.RestModels;
@Builder @Builder

View File

@@ -2,7 +2,7 @@
* #%L * #%L
* Alfresco Records Management Module * Alfresco Records Management Module
* %% * %%
* Copyright (C) 2005 - 2024 Alfresco Software Limited * Copyright (C) 2005 - 2025 Alfresco Software Limited
* %% * %%
* This file is part of the Alfresco software. * This file is part of the Alfresco software.
* - * -
@@ -27,12 +27,12 @@
package org.alfresco.rest.rm.community.model.hold; package org.alfresco.rest.rm.community.model.hold;
import com.fasterxml.jackson.annotation.JsonProperty; import com.fasterxml.jackson.annotation.JsonProperty;
import lombok.AllArgsConstructor; import lombok.AllArgsConstructor;
import lombok.Builder; import lombok.Builder;
import lombok.Data; import lombok.Data;
import lombok.EqualsAndHashCode; import lombok.EqualsAndHashCode;
import lombok.NoArgsConstructor; import lombok.NoArgsConstructor;
import org.alfresco.utility.model.TestModel; import org.alfresco.utility.model.TestModel;
/** /**

View File

@@ -2,7 +2,7 @@
* #%L * #%L
* Alfresco Records Management Module * Alfresco Records Management Module
* %% * %%
* Copyright (C) 2005 - 2024 Alfresco Software Limited * Copyright (C) 2005 - 2025 Alfresco Software Limited
* %% * %%
* This file is part of the Alfresco software. * This file is part of the Alfresco software.
* - * -
@@ -34,5 +34,4 @@ import org.alfresco.rest.core.RestModels;
* @author Damian Ujma * @author Damian Ujma
*/ */
public class HoldChildCollection extends RestModels<HoldChildEntry, HoldChildCollection> public class HoldChildCollection extends RestModels<HoldChildEntry, HoldChildCollection>
{ {}
}

View File

@@ -2,7 +2,7 @@
* #%L * #%L
* Alfresco Records Management Module * Alfresco Records Management Module
* %% * %%
* Copyright (C) 2005 - 2024 Alfresco Software Limited * Copyright (C) 2005 - 2025 Alfresco Software Limited
* %% * %%
* This file is part of the Alfresco software. * This file is part of the Alfresco software.
* - * -
@@ -27,12 +27,12 @@
package org.alfresco.rest.rm.community.model.hold; package org.alfresco.rest.rm.community.model.hold;
import com.fasterxml.jackson.annotation.JsonProperty; import com.fasterxml.jackson.annotation.JsonProperty;
import lombok.AllArgsConstructor; import lombok.AllArgsConstructor;
import lombok.Builder; import lombok.Builder;
import lombok.Data; import lombok.Data;
import lombok.EqualsAndHashCode; import lombok.EqualsAndHashCode;
import lombok.NoArgsConstructor; import lombok.NoArgsConstructor;
import org.alfresco.rest.core.RestModels; import org.alfresco.rest.core.RestModels;
/** /**

View File

@@ -2,7 +2,7 @@
* #%L * #%L
* Alfresco Records Management Module * Alfresco Records Management Module
* %% * %%
* Copyright (C) 2005 - 2024 Alfresco Software Limited * Copyright (C) 2005 - 2025 Alfresco Software Limited
* %% * %%
* This file is part of the Alfresco software. * This file is part of the Alfresco software.
* - * -
@@ -34,5 +34,4 @@ import org.alfresco.rest.core.RestModels;
* @author Damian Ujma * @author Damian Ujma
*/ */
public class HoldCollection extends RestModels<HoldEntry, HoldCollection> public class HoldCollection extends RestModels<HoldEntry, HoldCollection>
{ {}
}

View File

@@ -2,7 +2,7 @@
* #%L * #%L
* Alfresco Records Management Module * Alfresco Records Management Module
* %% * %%
* Copyright (C) 2005 - 2024 Alfresco Software Limited * Copyright (C) 2005 - 2025 Alfresco Software Limited
* %% * %%
* This file is part of the Alfresco software. * This file is part of the Alfresco software.
* - * -
@@ -27,12 +27,12 @@
package org.alfresco.rest.rm.community.model.hold; package org.alfresco.rest.rm.community.model.hold;
import com.fasterxml.jackson.annotation.JsonProperty; import com.fasterxml.jackson.annotation.JsonProperty;
import lombok.AllArgsConstructor; import lombok.AllArgsConstructor;
import lombok.Builder; import lombok.Builder;
import lombok.Data; import lombok.Data;
import lombok.EqualsAndHashCode; import lombok.EqualsAndHashCode;
import lombok.NoArgsConstructor; import lombok.NoArgsConstructor;
import org.alfresco.utility.model.TestModel; import org.alfresco.utility.model.TestModel;
/** /**

View File

@@ -2,7 +2,7 @@
* #%L * #%L
* Alfresco Records Management Module * Alfresco Records Management Module
* %% * %%
* Copyright (C) 2005 - 2024 Alfresco Software Limited * Copyright (C) 2005 - 2025 Alfresco Software Limited
* %% * %%
* This file is part of the Alfresco software. * This file is part of the Alfresco software.
* - * -
@@ -27,12 +27,12 @@
package org.alfresco.rest.rm.community.model.hold; package org.alfresco.rest.rm.community.model.hold;
import com.fasterxml.jackson.annotation.JsonProperty; import com.fasterxml.jackson.annotation.JsonProperty;
import lombok.AllArgsConstructor; import lombok.AllArgsConstructor;
import lombok.Builder; import lombok.Builder;
import lombok.Data; import lombok.Data;
import lombok.EqualsAndHashCode; import lombok.EqualsAndHashCode;
import lombok.NoArgsConstructor; import lombok.NoArgsConstructor;
import org.alfresco.rest.core.RestModels; import org.alfresco.rest.core.RestModels;
/** /**

View File

@@ -2,7 +2,7 @@
* #%L * #%L
* Alfresco Records Management Module * Alfresco Records Management Module
* %% * %%
* Copyright (C) 2005 - 2024 Alfresco Software Limited * Copyright (C) 2005 - 2025 Alfresco Software Limited
* %% * %%
* This file is part of the Alfresco software. * This file is part of the Alfresco software.
* - * -
@@ -27,12 +27,12 @@
package org.alfresco.rest.rm.community.model.hold; package org.alfresco.rest.rm.community.model.hold;
import com.fasterxml.jackson.annotation.JsonProperty; import com.fasterxml.jackson.annotation.JsonProperty;
import lombok.AllArgsConstructor; import lombok.AllArgsConstructor;
import lombok.Builder; import lombok.Builder;
import lombok.Data; import lombok.Data;
import lombok.EqualsAndHashCode; import lombok.EqualsAndHashCode;
import lombok.NoArgsConstructor; import lombok.NoArgsConstructor;
import org.alfresco.rest.core.RestModels; import org.alfresco.rest.core.RestModels;
/** /**

View File

@@ -2,7 +2,7 @@
* #%L * #%L
* Alfresco Records Management Module * Alfresco Records Management Module
* %% * %%
* Copyright (C) 2005 - 2024 Alfresco Software Limited * Copyright (C) 2005 - 2025 Alfresco Software Limited
* %% * %%
* This file is part of the Alfresco software. * This file is part of the Alfresco software.
* - * -
@@ -28,11 +28,11 @@ package org.alfresco.rest.rm.community.model.hold.v0;
import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonIgnoreProperties;
import com.fasterxml.jackson.annotation.JsonProperty; import com.fasterxml.jackson.annotation.JsonProperty;
import lombok.AllArgsConstructor; import lombok.AllArgsConstructor;
import lombok.Builder; import lombok.Builder;
import lombok.Data; import lombok.Data;
import lombok.NoArgsConstructor; import lombok.NoArgsConstructor;
import org.alfresco.utility.model.TestModel; import org.alfresco.utility.model.TestModel;
/** /**

View File

@@ -2,7 +2,7 @@
* #%L * #%L
* Alfresco Records Management Module * Alfresco Records Management Module
* %% * %%
* Copyright (C) 2005 - 2024 Alfresco Software Limited * Copyright (C) 2005 - 2025 Alfresco Software Limited
* %% * %%
* This file is part of the Alfresco software. * This file is part of the Alfresco software.
* - * -
@@ -29,6 +29,11 @@ package org.alfresco.rest.rm.community.model.record;
import java.util.List; import java.util.List;
import com.fasterxml.jackson.annotation.JsonProperty; import com.fasterxml.jackson.annotation.JsonProperty;
import lombok.AllArgsConstructor;
import lombok.Builder;
import lombok.Data;
import lombok.EqualsAndHashCode;
import lombok.NoArgsConstructor;
import org.alfresco.rest.core.IRestModel; import org.alfresco.rest.core.IRestModel;
import org.alfresco.rest.core.assertion.ModelAssertion; import org.alfresco.rest.core.assertion.ModelAssertion;
@@ -37,12 +42,6 @@ import org.alfresco.rest.model.RestNodeModel;
import org.alfresco.rest.rm.community.model.common.Path; import org.alfresco.rest.rm.community.model.common.Path;
import org.alfresco.utility.model.TestModel; import org.alfresco.utility.model.TestModel;
import lombok.AllArgsConstructor;
import lombok.Builder;
import lombok.Data;
import lombok.EqualsAndHashCode;
import lombok.NoArgsConstructor;
/** /**
* POJO for record * POJO for record
* *

View File

@@ -2,7 +2,7 @@
* #%L * #%L
* Alfresco Records Management Module * Alfresco Records Management Module
* %% * %%
* Copyright (C) 2005 - 2024 Alfresco Software Limited * Copyright (C) 2005 - 2025 Alfresco Software Limited
* %% * %%
* This file is part of the Alfresco software. * This file is part of the Alfresco software.
* - * -
@@ -27,15 +27,14 @@
package org.alfresco.rest.rm.community.model.record; package org.alfresco.rest.rm.community.model.record;
import com.fasterxml.jackson.annotation.JsonProperty; import com.fasterxml.jackson.annotation.JsonProperty;
import org.alfresco.utility.model.TestModel;
import lombok.AllArgsConstructor; import lombok.AllArgsConstructor;
import lombok.Builder; import lombok.Builder;
import lombok.Data; import lombok.Data;
import lombok.EqualsAndHashCode; import lombok.EqualsAndHashCode;
import lombok.NoArgsConstructor; import lombok.NoArgsConstructor;
import org.alfresco.utility.model.TestModel;
/** /**
* POJO for File records * POJO for File records
* *

View File

@@ -2,7 +2,7 @@
* #%L * #%L
* Alfresco Records Management Module * Alfresco Records Management Module
* %% * %%
* Copyright (C) 2005 - 2024 Alfresco Software Limited * Copyright (C) 2005 - 2025 Alfresco Software Limited
* %% * %%
* This file is part of the Alfresco software. * This file is part of the Alfresco software.
* - * -
@@ -27,15 +27,14 @@
package org.alfresco.rest.rm.community.model.record; package org.alfresco.rest.rm.community.model.record;
import com.fasterxml.jackson.annotation.JsonProperty; import com.fasterxml.jackson.annotation.JsonProperty;
import org.alfresco.utility.model.TestModel;
import lombok.AllArgsConstructor; import lombok.AllArgsConstructor;
import lombok.Builder; import lombok.Builder;
import lombok.Data; import lombok.Data;
import lombok.EqualsAndHashCode; import lombok.EqualsAndHashCode;
import lombok.NoArgsConstructor; import lombok.NoArgsConstructor;
import org.alfresco.utility.model.TestModel;
/** /**
* POJO for record content field * POJO for record content field
* *

View File

@@ -2,7 +2,7 @@
* #%L * #%L
* Alfresco Records Management Module * Alfresco Records Management Module
* %% * %%
* Copyright (C) 2005 - 2024 Alfresco Software Limited * Copyright (C) 2005 - 2025 Alfresco Software Limited
* %% * %%
* This file is part of the Alfresco software. * This file is part of the Alfresco software.
* - * -
@@ -64,7 +64,6 @@ import static org.alfresco.rest.rm.community.model.fileplancomponents.FilePlanCo
import static org.alfresco.rest.rm.community.model.fileplancomponents.FilePlanComponentFields.PROPERTIES_RECORD_SEARCH_VITAL_RECORD_REVIEW_PERIOD; import static org.alfresco.rest.rm.community.model.fileplancomponents.FilePlanComponentFields.PROPERTIES_RECORD_SEARCH_VITAL_RECORD_REVIEW_PERIOD;
import static org.alfresco.rest.rm.community.model.fileplancomponents.FilePlanComponentFields.PROPERTIES_RECORD_SEARCH_VITAL_RECORD_REVIEW_PERIOD_EXPRESSION; import static org.alfresco.rest.rm.community.model.fileplancomponents.FilePlanComponentFields.PROPERTIES_RECORD_SEARCH_VITAL_RECORD_REVIEW_PERIOD_EXPRESSION;
import static org.alfresco.rest.rm.community.model.fileplancomponents.FilePlanComponentFields.PROPERTIES_RESOLUTION_UNIT; import static org.alfresco.rest.rm.community.model.fileplancomponents.FilePlanComponentFields.PROPERTIES_RESOLUTION_UNIT;
import static org.alfresco.rest.rm.community.model.fileplancomponents.FilePlanComponentFields.PROPERTIES_REVIEW_AS_OF; import static org.alfresco.rest.rm.community.model.fileplancomponents.FilePlanComponentFields.PROPERTIES_REVIEW_AS_OF;
import static org.alfresco.rest.rm.community.model.fileplancomponents.FilePlanComponentFields.PROPERTIES_RMV_VERSIONED; import static org.alfresco.rest.rm.community.model.fileplancomponents.FilePlanComponentFields.PROPERTIES_RMV_VERSIONED;
import static org.alfresco.rest.rm.community.model.fileplancomponents.FilePlanComponentFields.PROPERTIES_ROOT_NODE_REF; import static org.alfresco.rest.rm.community.model.fileplancomponents.FilePlanComponentFields.PROPERTIES_ROOT_NODE_REF;
@@ -85,12 +84,12 @@ import java.util.List;
import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonIgnoreProperties;
import com.fasterxml.jackson.annotation.JsonProperty; import com.fasterxml.jackson.annotation.JsonProperty;
import lombok.AllArgsConstructor; import lombok.AllArgsConstructor;
import lombok.Builder; import lombok.Builder;
import lombok.Data; import lombok.Data;
import lombok.EqualsAndHashCode; import lombok.EqualsAndHashCode;
import lombok.NoArgsConstructor; import lombok.NoArgsConstructor;
import org.alfresco.rest.rm.community.model.common.Owner; import org.alfresco.rest.rm.community.model.common.Owner;
import org.alfresco.utility.model.TestModel; import org.alfresco.utility.model.TestModel;

View File

@@ -2,7 +2,7 @@
* #%L * #%L
* Alfresco Records Management Module * Alfresco Records Management Module
* %% * %%
* Copyright (C) 2005 - 2024 Alfresco Software Limited * Copyright (C) 2005 - 2025 Alfresco Software Limited
* %% * %%
* This file is part of the Alfresco software. * This file is part of the Alfresco software.
* - * -
@@ -29,17 +29,16 @@ package org.alfresco.rest.rm.community.model.recordcategory;
import java.util.List; import java.util.List;
import com.fasterxml.jackson.annotation.JsonProperty; import com.fasterxml.jackson.annotation.JsonProperty;
import org.alfresco.rest.model.RestByUserModel;
import org.alfresco.rest.rm.community.model.common.Path;
import org.alfresco.utility.model.TestModel;
import lombok.AllArgsConstructor; import lombok.AllArgsConstructor;
import lombok.Builder; import lombok.Builder;
import lombok.Data; import lombok.Data;
import lombok.EqualsAndHashCode; import lombok.EqualsAndHashCode;
import lombok.NoArgsConstructor; import lombok.NoArgsConstructor;
import org.alfresco.rest.model.RestByUserModel;
import org.alfresco.rest.rm.community.model.common.Path;
import org.alfresco.utility.model.TestModel;
/** /**
* POJO for record category * POJO for record category
* *

View File

@@ -2,7 +2,7 @@
* #%L * #%L
* Alfresco Records Management Module * Alfresco Records Management Module
* %% * %%
* Copyright (C) 2005 - 2024 Alfresco Software Limited * Copyright (C) 2005 - 2025 Alfresco Software Limited
* %% * %%
* This file is part of the Alfresco software. * This file is part of the Alfresco software.
* - * -
@@ -29,17 +29,16 @@ package org.alfresco.rest.rm.community.model.recordcategory;
import java.util.List; import java.util.List;
import com.fasterxml.jackson.annotation.JsonProperty; import com.fasterxml.jackson.annotation.JsonProperty;
import org.alfresco.rest.model.RestByUserModel;
import org.alfresco.rest.rm.community.model.common.Path;
import org.alfresco.utility.model.TestModel;
import lombok.AllArgsConstructor; import lombok.AllArgsConstructor;
import lombok.Builder; import lombok.Builder;
import lombok.Data; import lombok.Data;
import lombok.EqualsAndHashCode; import lombok.EqualsAndHashCode;
import lombok.NoArgsConstructor; import lombok.NoArgsConstructor;
import org.alfresco.rest.model.RestByUserModel;
import org.alfresco.rest.rm.community.model.common.Path;
import org.alfresco.utility.model.TestModel;
/** /**
* POJO for record category child * POJO for record category child
* *

View File

@@ -2,7 +2,7 @@
* #%L * #%L
* Alfresco Records Management Module * Alfresco Records Management Module
* %% * %%
* Copyright (C) 2005 - 2024 Alfresco Software Limited * Copyright (C) 2005 - 2025 Alfresco Software Limited
* %% * %%
* This file is part of the Alfresco software. * This file is part of the Alfresco software.
* - * -

View File

@@ -2,7 +2,7 @@
* #%L * #%L
* Alfresco Records Management Module * Alfresco Records Management Module
* %% * %%
* Copyright (C) 2005 - 2024 Alfresco Software Limited * Copyright (C) 2005 - 2025 Alfresco Software Limited
* %% * %%
* This file is part of the Alfresco software. * This file is part of the Alfresco software.
* - * -
@@ -27,12 +27,11 @@
package org.alfresco.rest.rm.community.model.recordcategory; package org.alfresco.rest.rm.community.model.recordcategory;
import com.fasterxml.jackson.annotation.JsonProperty; import com.fasterxml.jackson.annotation.JsonProperty;
import org.alfresco.rest.core.RestModels;
import lombok.Data; import lombok.Data;
import lombok.EqualsAndHashCode; import lombok.EqualsAndHashCode;
import org.alfresco.rest.core.RestModels;
/** /**
* POJO for record category child entry * POJO for record category child entry
* *

View File

@@ -2,7 +2,7 @@
* #%L * #%L
* Alfresco Records Management Module * Alfresco Records Management Module
* %% * %%
* Copyright (C) 2005 - 2024 Alfresco Software Limited * Copyright (C) 2005 - 2025 Alfresco Software Limited
* %% * %%
* This file is part of the Alfresco software. * This file is part of the Alfresco software.
* - * -
@@ -32,15 +32,15 @@ import static org.alfresco.rest.rm.community.model.fileplancomponents.FilePlanCo
import static org.alfresco.rest.rm.community.model.fileplancomponents.FilePlanComponentFields.PROPERTIES_IS_CLOSED; import static org.alfresco.rest.rm.community.model.fileplancomponents.FilePlanComponentFields.PROPERTIES_IS_CLOSED;
import static org.alfresco.rest.rm.community.model.fileplancomponents.FilePlanComponentFields.PROPERTIES_LOCATION; import static org.alfresco.rest.rm.community.model.fileplancomponents.FilePlanComponentFields.PROPERTIES_LOCATION;
import static org.alfresco.rest.rm.community.model.fileplancomponents.FilePlanComponentFields.PROPERTIES_OWNER; import static org.alfresco.rest.rm.community.model.fileplancomponents.FilePlanComponentFields.PROPERTIES_OWNER;
import static org.alfresco.rest.rm.community.model.fileplancomponents.FilePlanComponentFields.PROPERTIES_RECORD_SEARCH_DISPOSITION_EVENTS;
import static org.alfresco.rest.rm.community.model.fileplancomponents.FilePlanComponentFields.PROPERTIES_RECORD_SEARCH_HAS_DISPOSITION_SCHEDULE;
import static org.alfresco.rest.rm.community.model.fileplancomponents.FilePlanComponentFields.PROPERTIES_RECORD_SEARCH_DISPOSITION_PERIOD_EXPRESSION;
import static org.alfresco.rest.rm.community.model.fileplancomponents.FilePlanComponentFields.PROPERTIES_RECORD_SEARCH_DISPOSITION_AUTHORITY;
import static org.alfresco.rest.rm.community.model.fileplancomponents.FilePlanComponentFields.PROPERTIES_RECORD_SEARCH_DISPOSITION_ACTION_AS_OF; import static org.alfresco.rest.rm.community.model.fileplancomponents.FilePlanComponentFields.PROPERTIES_RECORD_SEARCH_DISPOSITION_ACTION_AS_OF;
import static org.alfresco.rest.rm.community.model.fileplancomponents.FilePlanComponentFields.PROPERTIES_RECORD_SEARCH_DISPOSITION_PERIOD;
import static org.alfresco.rest.rm.community.model.fileplancomponents.FilePlanComponentFields.PROPERTIES_RECORD_SEARCH_DISPOSITION_ACTION_NAME; import static org.alfresco.rest.rm.community.model.fileplancomponents.FilePlanComponentFields.PROPERTIES_RECORD_SEARCH_DISPOSITION_ACTION_NAME;
import static org.alfresco.rest.rm.community.model.fileplancomponents.FilePlanComponentFields.PROPERTIES_RECORD_SEARCH_DISPOSITION_AUTHORITY;
import static org.alfresco.rest.rm.community.model.fileplancomponents.FilePlanComponentFields.PROPERTIES_RECORD_SEARCH_DISPOSITION_EVENTS;
import static org.alfresco.rest.rm.community.model.fileplancomponents.FilePlanComponentFields.PROPERTIES_RECORD_SEARCH_DISPOSITION_EVENTS_ELIGIBLE; import static org.alfresco.rest.rm.community.model.fileplancomponents.FilePlanComponentFields.PROPERTIES_RECORD_SEARCH_DISPOSITION_EVENTS_ELIGIBLE;
import static org.alfresco.rest.rm.community.model.fileplancomponents.FilePlanComponentFields.PROPERTIES_RECORD_SEARCH_DISPOSITION_INSTRUCTIONS; import static org.alfresco.rest.rm.community.model.fileplancomponents.FilePlanComponentFields.PROPERTIES_RECORD_SEARCH_DISPOSITION_INSTRUCTIONS;
import static org.alfresco.rest.rm.community.model.fileplancomponents.FilePlanComponentFields.PROPERTIES_RECORD_SEARCH_DISPOSITION_PERIOD;
import static org.alfresco.rest.rm.community.model.fileplancomponents.FilePlanComponentFields.PROPERTIES_RECORD_SEARCH_DISPOSITION_PERIOD_EXPRESSION;
import static org.alfresco.rest.rm.community.model.fileplancomponents.FilePlanComponentFields.PROPERTIES_RECORD_SEARCH_HAS_DISPOSITION_SCHEDULE;
import static org.alfresco.rest.rm.community.model.fileplancomponents.FilePlanComponentFields.PROPERTIES_REVIEW_PERIOD; import static org.alfresco.rest.rm.community.model.fileplancomponents.FilePlanComponentFields.PROPERTIES_REVIEW_PERIOD;
import static org.alfresco.rest.rm.community.model.fileplancomponents.FilePlanComponentFields.PROPERTIES_ROOT_NODE_REF; import static org.alfresco.rest.rm.community.model.fileplancomponents.FilePlanComponentFields.PROPERTIES_ROOT_NODE_REF;
import static org.alfresco.rest.rm.community.model.fileplancomponents.FilePlanComponentFields.PROPERTIES_TITLE; import static org.alfresco.rest.rm.community.model.fileplancomponents.FilePlanComponentFields.PROPERTIES_TITLE;
@@ -51,18 +51,17 @@ import java.util.List;
import com.fasterxml.jackson.annotation.JsonProperty; import com.fasterxml.jackson.annotation.JsonProperty;
import com.fasterxml.jackson.databind.annotation.JsonSerialize; import com.fasterxml.jackson.databind.annotation.JsonSerialize;
import org.alfresco.rest.rm.community.model.common.Owner;
import org.alfresco.rest.rm.community.model.common.ReviewPeriod;
import org.alfresco.rest.rm.community.util.ReviewPeriodSerializer;
import org.alfresco.utility.model.TestModel;
import lombok.AllArgsConstructor; import lombok.AllArgsConstructor;
import lombok.Builder; import lombok.Builder;
import lombok.Data; import lombok.Data;
import lombok.EqualsAndHashCode; import lombok.EqualsAndHashCode;
import lombok.NoArgsConstructor; import lombok.NoArgsConstructor;
import org.alfresco.rest.rm.community.model.common.Owner;
import org.alfresco.rest.rm.community.model.common.ReviewPeriod;
import org.alfresco.rest.rm.community.util.ReviewPeriodSerializer;
import org.alfresco.utility.model.TestModel;
/** /**
* POJO for record category child properties * POJO for record category child properties
* *

View File

@@ -2,7 +2,7 @@
* #%L * #%L
* Alfresco Records Management Module * Alfresco Records Management Module
* %% * %%
* Copyright (C) 2005 - 2024 Alfresco Software Limited * Copyright (C) 2005 - 2025 Alfresco Software Limited
* %% * %%
* This file is part of the Alfresco software. * This file is part of the Alfresco software.
* - * -

View File

@@ -2,7 +2,7 @@
* #%L * #%L
* Alfresco Records Management Module * Alfresco Records Management Module
* %% * %%
* Copyright (C) 2005 - 2024 Alfresco Software Limited * Copyright (C) 2005 - 2025 Alfresco Software Limited
* %% * %%
* This file is part of the Alfresco software. * This file is part of the Alfresco software.
* - * -
@@ -27,13 +27,12 @@
package org.alfresco.rest.rm.community.model.recordcategory; package org.alfresco.rest.rm.community.model.recordcategory;
import com.fasterxml.jackson.annotation.JsonProperty; import com.fasterxml.jackson.annotation.JsonProperty;
import lombok.Data;
import lombok.EqualsAndHashCode;
import org.alfresco.rest.core.RestModels; import org.alfresco.rest.core.RestModels;
import org.alfresco.rest.rm.community.model.fileplan.FilePlan; import org.alfresco.rest.rm.community.model.fileplan.FilePlan;
import lombok.Data;
import lombok.EqualsAndHashCode;
/** /**
* POJO for file plan entry * POJO for file plan entry
* *

View File

@@ -2,7 +2,7 @@
* #%L * #%L
* Alfresco Records Management Module * Alfresco Records Management Module
* %% * %%
* Copyright (C) 2005 - 2024 Alfresco Software Limited * Copyright (C) 2005 - 2025 Alfresco Software Limited
* %% * %%
* This file is part of the Alfresco software. * This file is part of the Alfresco software.
* - * -
@@ -35,24 +35,22 @@ import static org.alfresco.rest.rm.community.model.fileplancomponents.FilePlanCo
import static org.alfresco.rest.rm.community.model.fileplancomponents.FilePlanComponentFields.PROPERTIES_TITLE; import static org.alfresco.rest.rm.community.model.fileplancomponents.FilePlanComponentFields.PROPERTIES_TITLE;
import static org.alfresco.rest.rm.community.model.fileplancomponents.FilePlanComponentFields.PROPERTIES_VITAL_RECORD_INDICATOR; import static org.alfresco.rest.rm.community.model.fileplancomponents.FilePlanComponentFields.PROPERTIES_VITAL_RECORD_INDICATOR;
import java.util.List; import java.util.List;
import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonIgnoreProperties;
import com.fasterxml.jackson.annotation.JsonProperty; import com.fasterxml.jackson.annotation.JsonProperty;
import com.fasterxml.jackson.databind.annotation.JsonSerialize; import com.fasterxml.jackson.databind.annotation.JsonSerialize;
import org.alfresco.rest.rm.community.model.common.Owner;
import org.alfresco.rest.rm.community.model.common.ReviewPeriod;
import org.alfresco.rest.rm.community.util.ReviewPeriodSerializer;
import org.alfresco.utility.model.TestModel;
import lombok.AllArgsConstructor; import lombok.AllArgsConstructor;
import lombok.Builder; import lombok.Builder;
import lombok.Data; import lombok.Data;
import lombok.EqualsAndHashCode; import lombok.EqualsAndHashCode;
import lombok.NoArgsConstructor; import lombok.NoArgsConstructor;
import org.alfresco.rest.rm.community.model.common.Owner;
import org.alfresco.rest.rm.community.model.common.ReviewPeriod;
import org.alfresco.rest.rm.community.util.ReviewPeriodSerializer;
import org.alfresco.utility.model.TestModel;
/** /**
* POJO for record category properties * POJO for record category properties
* *

View File

@@ -2,7 +2,7 @@
* #%L * #%L
* Alfresco Records Management Module * Alfresco Records Management Module
* %% * %%
* Copyright (C) 2005 - 2024 Alfresco Software Limited * Copyright (C) 2005 - 2025 Alfresco Software Limited
* %% * %%
* This file is part of the Alfresco software. * This file is part of the Alfresco software.
* - * -

View File

@@ -2,7 +2,7 @@
* #%L * #%L
* Alfresco Records Management Module * Alfresco Records Management Module
* %% * %%
* Copyright (C) 2005 - 2024 Alfresco Software Limited * Copyright (C) 2005 - 2025 Alfresco Software Limited
* %% * %%
* This file is part of the Alfresco software. * This file is part of the Alfresco software.
* - * -
@@ -29,17 +29,16 @@ package org.alfresco.rest.rm.community.model.recordfolder;
import java.util.List; import java.util.List;
import com.fasterxml.jackson.annotation.JsonProperty; import com.fasterxml.jackson.annotation.JsonProperty;
import org.alfresco.rest.model.RestByUserModel;
import org.alfresco.rest.rm.community.model.common.Path;
import org.alfresco.utility.model.TestModel;
import lombok.AllArgsConstructor; import lombok.AllArgsConstructor;
import lombok.Builder; import lombok.Builder;
import lombok.Data; import lombok.Data;
import lombok.EqualsAndHashCode; import lombok.EqualsAndHashCode;
import lombok.NoArgsConstructor; import lombok.NoArgsConstructor;
import org.alfresco.rest.model.RestByUserModel;
import org.alfresco.rest.rm.community.model.common.Path;
import org.alfresco.utility.model.TestModel;
/** /**
* POJO for record folder * POJO for record folder
* *

View File

@@ -2,7 +2,7 @@
* #%L * #%L
* Alfresco Records Management Module * Alfresco Records Management Module
* %% * %%
* Copyright (C) 2005 - 2024 Alfresco Software Limited * Copyright (C) 2005 - 2025 Alfresco Software Limited
* %% * %%
* This file is part of the Alfresco software. * This file is part of the Alfresco software.
* - * -

View File

@@ -2,7 +2,7 @@
* #%L * #%L
* Alfresco Records Management Module * Alfresco Records Management Module
* %% * %%
* Copyright (C) 2005 - 2024 Alfresco Software Limited * Copyright (C) 2005 - 2025 Alfresco Software Limited
* %% * %%
* This file is part of the Alfresco software. * This file is part of the Alfresco software.
* - * -
@@ -27,16 +27,15 @@
package org.alfresco.rest.rm.community.model.recordfolder; package org.alfresco.rest.rm.community.model.recordfolder;
import com.fasterxml.jackson.annotation.JsonProperty; import com.fasterxml.jackson.annotation.JsonProperty;
import org.alfresco.rest.core.RestModels;
import org.alfresco.rest.rm.community.model.record.Record;
import lombok.AllArgsConstructor; import lombok.AllArgsConstructor;
import lombok.Builder; import lombok.Builder;
import lombok.Data; import lombok.Data;
import lombok.EqualsAndHashCode; import lombok.EqualsAndHashCode;
import lombok.NoArgsConstructor; import lombok.NoArgsConstructor;
import org.alfresco.rest.core.RestModels;
import org.alfresco.rest.rm.community.model.record.Record;
/** /**
* POJO for record folder entry * POJO for record folder entry
* *

View File

@@ -2,7 +2,7 @@
* #%L * #%L
* Alfresco Records Management Module * Alfresco Records Management Module
* %% * %%
* Copyright (C) 2005 - 2024 Alfresco Software Limited * Copyright (C) 2005 - 2025 Alfresco Software Limited
* %% * %%
* This file is part of the Alfresco software. * This file is part of the Alfresco software.
* - * -
@@ -33,10 +33,8 @@ import static org.alfresco.rest.rm.community.model.fileplancomponents.FilePlanCo
import static org.alfresco.rest.rm.community.model.fileplancomponents.FilePlanComponentFields.PROPERTIES_IS_CLOSED; import static org.alfresco.rest.rm.community.model.fileplancomponents.FilePlanComponentFields.PROPERTIES_IS_CLOSED;
import static org.alfresco.rest.rm.community.model.fileplancomponents.FilePlanComponentFields.PROPERTIES_LOCATION; import static org.alfresco.rest.rm.community.model.fileplancomponents.FilePlanComponentFields.PROPERTIES_LOCATION;
import static org.alfresco.rest.rm.community.model.fileplancomponents.FilePlanComponentFields.PROPERTIES_OWNER; import static org.alfresco.rest.rm.community.model.fileplancomponents.FilePlanComponentFields.PROPERTIES_OWNER;
import static org.alfresco.rest.rm.community.model.fileplancomponents.FilePlanComponentFields import static org.alfresco.rest.rm.community.model.fileplancomponents.FilePlanComponentFields.PROPERTIES_RECORD_SEARCH_DISPOSITION_AUTHORITY;
.PROPERTIES_RECORD_SEARCH_DISPOSITION_AUTHORITY; import static org.alfresco.rest.rm.community.model.fileplancomponents.FilePlanComponentFields.PROPERTIES_RECORD_SEARCH_DISPOSITION_INSTRUCTIONS;
import static org.alfresco.rest.rm.community.model.fileplancomponents.FilePlanComponentFields
.PROPERTIES_RECORD_SEARCH_DISPOSITION_INSTRUCTIONS;
import static org.alfresco.rest.rm.community.model.fileplancomponents.FilePlanComponentFields.PROPERTIES_RECORD_SEARCH_HAS_DISPOSITION_SCHEDULE; import static org.alfresco.rest.rm.community.model.fileplancomponents.FilePlanComponentFields.PROPERTIES_RECORD_SEARCH_HAS_DISPOSITION_SCHEDULE;
import static org.alfresco.rest.rm.community.model.fileplancomponents.FilePlanComponentFields.PROPERTIES_RECORD_SEARCH_VITAL_RECORD_REVIEW_PERIOD; import static org.alfresco.rest.rm.community.model.fileplancomponents.FilePlanComponentFields.PROPERTIES_RECORD_SEARCH_VITAL_RECORD_REVIEW_PERIOD;
import static org.alfresco.rest.rm.community.model.fileplancomponents.FilePlanComponentFields.PROPERTIES_RECORD_SEARCH_VITAL_RECORD_REVIEW_PERIOD_EXPRESSION; import static org.alfresco.rest.rm.community.model.fileplancomponents.FilePlanComponentFields.PROPERTIES_RECORD_SEARCH_VITAL_RECORD_REVIEW_PERIOD_EXPRESSION;
@@ -50,18 +48,17 @@ import java.util.List;
import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonIgnoreProperties;
import com.fasterxml.jackson.annotation.JsonProperty; import com.fasterxml.jackson.annotation.JsonProperty;
import com.fasterxml.jackson.databind.annotation.JsonSerialize; import com.fasterxml.jackson.databind.annotation.JsonSerialize;
import org.alfresco.rest.rm.community.model.common.Owner;
import org.alfresco.rest.rm.community.model.common.ReviewPeriod;
import org.alfresco.rest.rm.community.util.ReviewPeriodSerializer;
import org.alfresco.utility.model.TestModel;
import lombok.AllArgsConstructor; import lombok.AllArgsConstructor;
import lombok.Builder; import lombok.Builder;
import lombok.Data; import lombok.Data;
import lombok.EqualsAndHashCode; import lombok.EqualsAndHashCode;
import lombok.NoArgsConstructor; import lombok.NoArgsConstructor;
import org.alfresco.rest.rm.community.model.common.Owner;
import org.alfresco.rest.rm.community.model.common.ReviewPeriod;
import org.alfresco.rest.rm.community.util.ReviewPeriodSerializer;
import org.alfresco.utility.model.TestModel;
/** /**
* POJO for record folder properties * POJO for record folder properties
* *

View File

@@ -2,7 +2,7 @@
* #%L * #%L
* Alfresco Records Management Module * Alfresco Records Management Module
* %% * %%
* Copyright (C) 2005 - 2024 Alfresco Software Limited * Copyright (C) 2005 - 2025 Alfresco Software Limited
* %% * %%
* This file is part of the Alfresco software. * This file is part of the Alfresco software.
* - * -
@@ -26,12 +26,13 @@
*/ */
package org.alfresco.rest.rm.community.model.retentionschedule; package org.alfresco.rest.rm.community.model.retentionschedule;
import lombok.EqualsAndHashCode;
import org.alfresco.utility.model.TestModel;
import lombok.Data;
import java.util.List; import java.util.List;
import lombok.Data;
import lombok.EqualsAndHashCode;
import org.alfresco.utility.model.TestModel;
/** /**
* retention schedule * retention schedule
*/ */
@@ -52,7 +53,8 @@ public class RetentionSchedule extends TestModel
return isRecordLevel; return isRecordLevel;
} }
public void setIsRecordLevel(boolean recordLevel) { public void setIsRecordLevel(boolean recordLevel)
{
isRecordLevel = recordLevel; isRecordLevel = recordLevel;
} }
} }

View File

@@ -2,7 +2,7 @@
* #%L * #%L
* Alfresco Records Management Module * Alfresco Records Management Module
* %% * %%
* Copyright (C) 2005 - 2024 Alfresco Software Limited * Copyright (C) 2005 - 2025 Alfresco Software Limited
* %% * %%
* This file is part of the Alfresco software. * This file is part of the Alfresco software.
* - * -
@@ -27,6 +27,7 @@
package org.alfresco.rest.rm.community.model.retentionschedule; package org.alfresco.rest.rm.community.model.retentionschedule;
import java.util.List; import java.util.List;
import lombok.Data; import lombok.Data;
/** /**

View File

@@ -2,7 +2,7 @@
* #%L * #%L
* Alfresco Records Management Module * Alfresco Records Management Module
* %% * %%
* Copyright (C) 2005 - 2024 Alfresco Software Limited * Copyright (C) 2005 - 2025 Alfresco Software Limited
* %% * %%
* This file is part of the Alfresco software. * This file is part of the Alfresco software.
* - * -
@@ -27,6 +27,6 @@
package org.alfresco.rest.rm.community.model.retentionschedule; package org.alfresco.rest.rm.community.model.retentionschedule;
import org.alfresco.rest.core.RestModels; import org.alfresco.rest.core.RestModels;
public class RetentionScheduleCollection extends RestModels<RetentionScheduleEntry, RetentionScheduleCollection> public class RetentionScheduleCollection extends RestModels<RetentionScheduleEntry, RetentionScheduleCollection>
{ {}
}

View File

@@ -2,7 +2,7 @@
* #%L * #%L
* Alfresco Records Management Module * Alfresco Records Management Module
* %% * %%
* Copyright (C) 2005 - 2024 Alfresco Software Limited * Copyright (C) 2005 - 2025 Alfresco Software Limited
* %% * %%
* This file is part of the Alfresco software. * This file is part of the Alfresco software.
* - * -
@@ -28,7 +28,9 @@ package org.alfresco.rest.rm.community.model.retentionschedule;
import com.fasterxml.jackson.annotation.JsonProperty; import com.fasterxml.jackson.annotation.JsonProperty;
import lombok.Data; import lombok.Data;
import org.alfresco.rest.core.RestModels; import org.alfresco.rest.core.RestModels;
@Data @Data
public class RetentionScheduleEntry extends RestModels<RetentionSchedule, RetentionScheduleEntry> public class RetentionScheduleEntry extends RestModels<RetentionSchedule, RetentionScheduleEntry>
{ {

View File

@@ -2,7 +2,7 @@
* #%L * #%L
* Alfresco Records Management Module * Alfresco Records Management Module
* %% * %%
* Copyright (C) 2005 - 2024 Alfresco Software Limited * Copyright (C) 2005 - 2025 Alfresco Software Limited
* %% * %%
* This file is part of the Alfresco software. * This file is part of the Alfresco software.
* - * -
@@ -29,5 +29,4 @@ package org.alfresco.rest.rm.community.model.retentionschedule;
import org.alfresco.rest.core.RestModels; import org.alfresco.rest.core.RestModels;
public class RetentionScheduleStepCollection extends RestModels<RetentionScheduleStepEntry, RetentionScheduleStepCollection> public class RetentionScheduleStepCollection extends RestModels<RetentionScheduleStepEntry, RetentionScheduleStepCollection>
{ {}
}

View File

@@ -2,7 +2,7 @@
* #%L * #%L
* Alfresco Records Management Module * Alfresco Records Management Module
* %% * %%
* Copyright (C) 2005 - 2024 Alfresco Software Limited * Copyright (C) 2005 - 2025 Alfresco Software Limited
* %% * %%
* This file is part of the Alfresco software. * This file is part of the Alfresco software.
* - * -
@@ -28,6 +28,7 @@ package org.alfresco.rest.rm.community.model.retentionschedule;
import com.fasterxml.jackson.annotation.JsonProperty; import com.fasterxml.jackson.annotation.JsonProperty;
import lombok.Data; import lombok.Data;
import org.alfresco.rest.core.RestModels; import org.alfresco.rest.core.RestModels;
@Data @Data

View File

@@ -2,7 +2,7 @@
* #%L * #%L
* Alfresco Records Management Module * Alfresco Records Management Module
* %% * %%
* Copyright (C) 2005 - 2024 Alfresco Software Limited * Copyright (C) 2005 - 2025 Alfresco Software Limited
* %% * %%
* This file is part of the Alfresco software. * This file is part of the Alfresco software.
* - * -
@@ -31,26 +31,7 @@ package org.alfresco.rest.rm.community.model.rules;
*/ */
public enum ActionsOnRule public enum ActionsOnRule
{ {
COMPLETE_RECORD("declareRecord"), COMPLETE_RECORD("declareRecord"), REOPEN_RECORD("undeclareRecord"), OPEN_RECORD_FOLDER("openRecordFolder"), CLOSE_RECORD_FOLDER("closeRecordFolder"), FILE_TO("fileTo"), COPY_TO("copyTo"), MOVE_TO("moveTo"), LINK_TO("linkTo"), REJECT("reject"), REQUEST_INFORMATION("requestInfo"), COMPLETE_EVENT("completeEvent"), ADD_RECORD_TYPES("addRecordTypes"), EXECUTE_SCRIPT("executeScript"), SEND_EMAIL("sendEmail"), SET_PROPERTY_VALUE_COLL_SITE("set-property-value"), SET_PROPERTY_VALUE_RM("setPropertyValue"), HIDE_RECORD("hide-record"), DECLARE_VERSION_AS_RECORD("declare-as-version-record"), DECLARE_AS_RECORD("create-record"), WORM_LOCK("wormLock");
REOPEN_RECORD("undeclareRecord"),
OPEN_RECORD_FOLDER("openRecordFolder"),
CLOSE_RECORD_FOLDER("closeRecordFolder"),
FILE_TO("fileTo"),
COPY_TO("copyTo"),
MOVE_TO("moveTo"),
LINK_TO("linkTo"),
REJECT("reject"),
REQUEST_INFORMATION("requestInfo"),
COMPLETE_EVENT("completeEvent"),
ADD_RECORD_TYPES("addRecordTypes"),
EXECUTE_SCRIPT("executeScript"),
SEND_EMAIL("sendEmail"),
SET_PROPERTY_VALUE_COLL_SITE("set-property-value"),
SET_PROPERTY_VALUE_RM("setPropertyValue"),
HIDE_RECORD("hide-record"),
DECLARE_VERSION_AS_RECORD("declare-as-version-record"),
DECLARE_AS_RECORD("create-record"),
WORM_LOCK("wormLock");
private String actionValue; private String actionValue;

View File

@@ -2,7 +2,7 @@
* #%L * #%L
* Alfresco Records Management Module * Alfresco Records Management Module
* %% * %%
* Copyright (C) 2005 - 2024 Alfresco Software Limited * Copyright (C) 2005 - 2025 Alfresco Software Limited
* %% * %%
* This file is part of the Alfresco software. * This file is part of the Alfresco software.
* - * -
@@ -31,9 +31,8 @@ package org.alfresco.rest.rm.community.model.rules;
*/ */
public enum ConditionsOnRule public enum ConditionsOnRule
{ {
UPDATE("update"), UPDATE("update"), ADDED("inbound"), REMOVED("outbound");
ADDED("inbound"),
REMOVED("outbound");
private String whenConditionValue; private String whenConditionValue;
ConditionsOnRule(String value) ConditionsOnRule(String value)

View File

@@ -2,7 +2,7 @@
* #%L * #%L
* Alfresco Records Management Module * Alfresco Records Management Module
* %% * %%
* Copyright (C) 2005 - 2024 Alfresco Software Limited * Copyright (C) 2005 - 2025 Alfresco Software Limited
* %% * %%
* This file is part of the Alfresco software. * This file is part of the Alfresco software.
* - * -
@@ -200,4 +200,3 @@ public class RuleDefinition
return this; return this;
} }
} }

View File

@@ -2,7 +2,7 @@
* #%L * #%L
* Alfresco Records Management Module * Alfresco Records Management Module
* %% * %%
* Copyright (C) 2005 - 2024 Alfresco Software Limited * Copyright (C) 2005 - 2025 Alfresco Software Limited
* %% * %%
* This file is part of the Alfresco software. * This file is part of the Alfresco software.
* - * -
@@ -27,15 +27,14 @@
package org.alfresco.rest.rm.community.model.site; package org.alfresco.rest.rm.community.model.site;
import com.fasterxml.jackson.annotation.JsonProperty; import com.fasterxml.jackson.annotation.JsonProperty;
import org.alfresco.rest.model.RestSiteModel;
import lombok.AllArgsConstructor; import lombok.AllArgsConstructor;
import lombok.Builder; import lombok.Builder;
import lombok.Data; import lombok.Data;
import lombok.EqualsAndHashCode; import lombok.EqualsAndHashCode;
import lombok.NoArgsConstructor; import lombok.NoArgsConstructor;
import org.alfresco.rest.model.RestSiteModel;
/** /**
* POJO for RM Site component * POJO for RM Site component
* *

View File

@@ -2,7 +2,7 @@
* #%L * #%L
* Alfresco Records Management Module * Alfresco Records Management Module
* %% * %%
* Copyright (C) 2005 - 2024 Alfresco Software Limited * Copyright (C) 2005 - 2025 Alfresco Software Limited
* %% * %%
* This file is part of the Alfresco software. * This file is part of the Alfresco software.
* - * -
@@ -34,6 +34,5 @@ package org.alfresco.rest.rm.community.model.site;
*/ */
public enum RMSiteCompliance public enum RMSiteCompliance
{ {
STANDARD, STANDARD, DOD5015
DOD5015
} }

View File

@@ -2,7 +2,7 @@
* #%L * #%L
* Alfresco Records Management Module * Alfresco Records Management Module
* %% * %%
* Copyright (C) 2005 - 2024 Alfresco Software Limited * Copyright (C) 2005 - 2025 Alfresco Software Limited
* %% * %%
* This file is part of the Alfresco software. * This file is part of the Alfresco software.
* - * -
@@ -27,16 +27,8 @@
package org.alfresco.rest.rm.community.model.site; package org.alfresco.rest.rm.community.model.site;
/** /**
*RM Site properties from the RM Model Schema * RM Site properties from the RM Model Schema "entry": { "id": "string", "guid": "string", "title": "string", "description": "string", "visibility": "{@link org.springframework.social.alfresco.api.entities.Site.Visibility}", "compliance": "{@link RMSiteCompliance}", "role": "{@link org.alfresco.utility.constants.UserRole}" }
*"entry": { *
* "id": "string",
* "guid": "string",
* "title": "string",
* "description": "string",
* "visibility": "{@link org.springframework.social.alfresco.api.entities.Site.Visibility}",
* "compliance": "{@link RMSiteCompliance}",
* "role": "{@link org.alfresco.utility.constants.UserRole}"
*}
* @author Tuna Aksoy * @author Tuna Aksoy
* @author Rodica Sutu * @author Rodica Sutu
* @since 2.6 * @since 2.6

View File

@@ -2,7 +2,7 @@
* #%L * #%L
* Alfresco Records Management Module * Alfresco Records Management Module
* %% * %%
* Copyright (C) 2005 - 2024 Alfresco Software Limited * Copyright (C) 2005 - 2025 Alfresco Software Limited
* %% * %%
* This file is part of the Alfresco software. * This file is part of the Alfresco software.
* - * -
@@ -30,16 +30,15 @@ package org.alfresco.rest.rm.community.model.transfer;
import java.util.List; import java.util.List;
import com.fasterxml.jackson.annotation.JsonProperty; import com.fasterxml.jackson.annotation.JsonProperty;
import org.alfresco.rest.model.RestByUserModel;
import org.alfresco.utility.model.TestModel;
import lombok.AllArgsConstructor; import lombok.AllArgsConstructor;
import lombok.Builder; import lombok.Builder;
import lombok.Data; import lombok.Data;
import lombok.EqualsAndHashCode; import lombok.EqualsAndHashCode;
import lombok.NoArgsConstructor; import lombok.NoArgsConstructor;
import org.alfresco.rest.model.RestByUserModel;
import org.alfresco.utility.model.TestModel;
/** /**
* POJO for Transfer * POJO for Transfer
* *

View File

@@ -2,7 +2,7 @@
* #%L * #%L
* Alfresco Records Management Module * Alfresco Records Management Module
* %% * %%
* Copyright (C) 2005 - 2024 Alfresco Software Limited * Copyright (C) 2005 - 2025 Alfresco Software Limited
* %% * %%
* This file is part of the Alfresco software. * This file is part of the Alfresco software.
* - * -
@@ -30,17 +30,16 @@ package org.alfresco.rest.rm.community.model.transfer;
import java.util.List; import java.util.List;
import com.fasterxml.jackson.annotation.JsonProperty; import com.fasterxml.jackson.annotation.JsonProperty;
import org.alfresco.rest.model.RestByUserModel;
import org.alfresco.rest.rm.community.model.common.Path;
import org.alfresco.utility.model.TestModel;
import lombok.AllArgsConstructor; import lombok.AllArgsConstructor;
import lombok.Builder; import lombok.Builder;
import lombok.Data; import lombok.Data;
import lombok.EqualsAndHashCode; import lombok.EqualsAndHashCode;
import lombok.NoArgsConstructor; import lombok.NoArgsConstructor;
import org.alfresco.rest.model.RestByUserModel;
import org.alfresco.rest.rm.community.model.common.Path;
import org.alfresco.utility.model.TestModel;
/** /**
* POJO for transfer child * POJO for transfer child
* *

View File

@@ -2,7 +2,7 @@
* #%L * #%L
* Alfresco Records Management Module * Alfresco Records Management Module
* %% * %%
* Copyright (C) 2005 - 2024 Alfresco Software Limited * Copyright (C) 2005 - 2025 Alfresco Software Limited
* %% * %%
* This file is part of the Alfresco software. * This file is part of the Alfresco software.
* - * -
@@ -31,6 +31,7 @@ import org.alfresco.rest.core.RestModels;
/** /**
* Handle collection of {@link TransferChildEntry} * Handle collection of {@link TransferChildEntry}
*
* @author Silviu Dinuta * @author Silviu Dinuta
* @since 2.6 * @since 2.6
*/ */

View File

@@ -2,7 +2,7 @@
* #%L * #%L
* Alfresco Records Management Module * Alfresco Records Management Module
* %% * %%
* Copyright (C) 2005 - 2024 Alfresco Software Limited * Copyright (C) 2005 - 2025 Alfresco Software Limited
* %% * %%
* This file is part of the Alfresco software. * This file is part of the Alfresco software.
* - * -
@@ -27,16 +27,15 @@
package org.alfresco.rest.rm.community.model.transfer; package org.alfresco.rest.rm.community.model.transfer;
import org.alfresco.rest.core.RestModels;
import com.fasterxml.jackson.annotation.JsonProperty; import com.fasterxml.jackson.annotation.JsonProperty;
import lombok.AllArgsConstructor; import lombok.AllArgsConstructor;
import lombok.Builder; import lombok.Builder;
import lombok.Data; import lombok.Data;
import lombok.EqualsAndHashCode; import lombok.EqualsAndHashCode;
import lombok.NoArgsConstructor; import lombok.NoArgsConstructor;
import org.alfresco.rest.core.RestModels;
/** /**
* POJO for transfer child entry * POJO for transfer child entry
* *

View File

@@ -2,7 +2,7 @@
* #%L * #%L
* Alfresco Records Management Module * Alfresco Records Management Module
* %% * %%
* Copyright (C) 2005 - 2024 Alfresco Software Limited * Copyright (C) 2005 - 2025 Alfresco Software Limited
* %% * %%
* This file is part of the Alfresco software. * This file is part of the Alfresco software.
* - * -
@@ -64,20 +64,19 @@ import static org.alfresco.rest.rm.community.model.fileplancomponents.FilePlanCo
import static org.alfresco.rest.rm.community.model.fileplancomponents.FilePlanComponentFields.PROPERTIES_X_RESOLUTION; import static org.alfresco.rest.rm.community.model.fileplancomponents.FilePlanComponentFields.PROPERTIES_X_RESOLUTION;
import static org.alfresco.rest.rm.community.model.fileplancomponents.FilePlanComponentFields.PROPERTIES_Y_RESOLUTION; import static org.alfresco.rest.rm.community.model.fileplancomponents.FilePlanComponentFields.PROPERTIES_Y_RESOLUTION;
import org.alfresco.rest.rm.community.model.common.Owner;
import org.alfresco.rest.rm.community.model.common.ReviewPeriod;
import org.alfresco.rest.rm.community.util.ReviewPeriodSerializer;
import org.alfresco.utility.model.TestModel;
import com.fasterxml.jackson.annotation.JsonProperty; import com.fasterxml.jackson.annotation.JsonProperty;
import com.fasterxml.jackson.databind.annotation.JsonSerialize; import com.fasterxml.jackson.databind.annotation.JsonSerialize;
import lombok.AllArgsConstructor; import lombok.AllArgsConstructor;
import lombok.Builder; import lombok.Builder;
import lombok.Data; import lombok.Data;
import lombok.EqualsAndHashCode; import lombok.EqualsAndHashCode;
import lombok.NoArgsConstructor; import lombok.NoArgsConstructor;
import org.alfresco.rest.rm.community.model.common.Owner;
import org.alfresco.rest.rm.community.model.common.ReviewPeriod;
import org.alfresco.rest.rm.community.util.ReviewPeriodSerializer;
import org.alfresco.utility.model.TestModel;
/** /**
* POJO for transfer child properties * POJO for transfer child properties
* *
@@ -137,7 +136,6 @@ public class TransferChildProperties extends TestModel
@JsonProperty(PROPERTIES_ORIGINAL_NAME) @JsonProperty(PROPERTIES_ORIGINAL_NAME)
private String originalName; private String originalName;
/*********************************/ /*********************************/
/** Electronic record parameters */ /** Electronic record parameters */
/*********************************/ /*********************************/

View File

@@ -2,7 +2,7 @@
* #%L * #%L
* Alfresco Records Management Module * Alfresco Records Management Module
* %% * %%
* Copyright (C) 2005 - 2024 Alfresco Software Limited * Copyright (C) 2005 - 2025 Alfresco Software Limited
* %% * %%
* This file is part of the Alfresco software. * This file is part of the Alfresco software.
* - * -
@@ -31,6 +31,7 @@ import org.alfresco.rest.core.RestModels;
/** /**
* Handle collection of {@link TransferEntry} * Handle collection of {@link TransferEntry}
*
* @author Silviu Dinuta * @author Silviu Dinuta
* @since 2.6 * @since 2.6
*/ */

View File

@@ -2,7 +2,7 @@
* #%L * #%L
* Alfresco Records Management Module * Alfresco Records Management Module
* %% * %%
* Copyright (C) 2005 - 2024 Alfresco Software Limited * Copyright (C) 2005 - 2025 Alfresco Software Limited
* %% * %%
* This file is part of the Alfresco software. * This file is part of the Alfresco software.
* - * -
@@ -27,17 +27,16 @@
package org.alfresco.rest.rm.community.model.transfer; package org.alfresco.rest.rm.community.model.transfer;
import org.alfresco.rest.core.RestModels;
import org.alfresco.rest.rm.community.model.transfercontainer.TransferContainer;
import com.fasterxml.jackson.annotation.JsonProperty; import com.fasterxml.jackson.annotation.JsonProperty;
import lombok.AllArgsConstructor; import lombok.AllArgsConstructor;
import lombok.Builder; import lombok.Builder;
import lombok.Data; import lombok.Data;
import lombok.EqualsAndHashCode; import lombok.EqualsAndHashCode;
import lombok.NoArgsConstructor; import lombok.NoArgsConstructor;
import org.alfresco.rest.core.RestModels;
import org.alfresco.rest.rm.community.model.transfercontainer.TransferContainer;
/** /**
* POJO for transfer entry * POJO for transfer entry
* *

View File

@@ -2,7 +2,7 @@
* #%L * #%L
* Alfresco Records Management Module * Alfresco Records Management Module
* %% * %%
* Copyright (C) 2005 - 2024 Alfresco Software Limited * Copyright (C) 2005 - 2025 Alfresco Software Limited
* %% * %%
* This file is part of the Alfresco software. * This file is part of the Alfresco software.
* - * -
@@ -27,24 +27,23 @@
package org.alfresco.rest.rm.community.model.transfer; package org.alfresco.rest.rm.community.model.transfer;
import static org.alfresco.rest.rm.community.model.fileplancomponents.FilePlanComponentFields.PROPERTIES_ACCESSION_INDICATOR;
import static org.alfresco.rest.rm.community.model.fileplancomponents.FilePlanComponentFields.PROPERTIES_IDENTIFIER; import static org.alfresco.rest.rm.community.model.fileplancomponents.FilePlanComponentFields.PROPERTIES_IDENTIFIER;
import static org.alfresco.rest.rm.community.model.fileplancomponents.FilePlanComponentFields.PROPERTIES_OWNER; import static org.alfresco.rest.rm.community.model.fileplancomponents.FilePlanComponentFields.PROPERTIES_OWNER;
import static org.alfresco.rest.rm.community.model.fileplancomponents.FilePlanComponentFields.PROPERTIES_ROOT_NODE_REF;
import static org.alfresco.rest.rm.community.model.fileplancomponents.FilePlanComponentFields.PROPERTIES_PDF_INDICATOR; import static org.alfresco.rest.rm.community.model.fileplancomponents.FilePlanComponentFields.PROPERTIES_PDF_INDICATOR;
import static org.alfresco.rest.rm.community.model.fileplancomponents.FilePlanComponentFields.PROPERTIES_ROOT_NODE_REF;
import static org.alfresco.rest.rm.community.model.fileplancomponents.FilePlanComponentFields.PROPERTIES_TRANSFER_LOCATION; import static org.alfresco.rest.rm.community.model.fileplancomponents.FilePlanComponentFields.PROPERTIES_TRANSFER_LOCATION;
import static org.alfresco.rest.rm.community.model.fileplancomponents.FilePlanComponentFields.PROPERTIES_ACCESSION_INDICATOR;
import org.alfresco.rest.rm.community.model.common.Owner;
import org.alfresco.utility.model.TestModel;
import com.fasterxml.jackson.annotation.JsonProperty; import com.fasterxml.jackson.annotation.JsonProperty;
import lombok.AllArgsConstructor; import lombok.AllArgsConstructor;
import lombok.Builder; import lombok.Builder;
import lombok.Data; import lombok.Data;
import lombok.EqualsAndHashCode; import lombok.EqualsAndHashCode;
import lombok.NoArgsConstructor; import lombok.NoArgsConstructor;
import org.alfresco.rest.rm.community.model.common.Owner;
import org.alfresco.utility.model.TestModel;
/** /**
* POJO for Transfer properties * POJO for Transfer properties
* *

View File

@@ -2,7 +2,7 @@
* #%L * #%L
* Alfresco Records Management Module * Alfresco Records Management Module
* %% * %%
* Copyright (C) 2005 - 2024 Alfresco Software Limited * Copyright (C) 2005 - 2025 Alfresco Software Limited
* %% * %%
* This file is part of the Alfresco software. * This file is part of the Alfresco software.
* - * -
@@ -30,16 +30,15 @@ package org.alfresco.rest.rm.community.model.transfercontainer;
import java.util.List; import java.util.List;
import com.fasterxml.jackson.annotation.JsonProperty; import com.fasterxml.jackson.annotation.JsonProperty;
import org.alfresco.rest.model.RestByUserModel;
import org.alfresco.utility.model.TestModel;
import lombok.AllArgsConstructor; import lombok.AllArgsConstructor;
import lombok.Builder; import lombok.Builder;
import lombok.Data; import lombok.Data;
import lombok.EqualsAndHashCode; import lombok.EqualsAndHashCode;
import lombok.NoArgsConstructor; import lombok.NoArgsConstructor;
import org.alfresco.rest.model.RestByUserModel;
import org.alfresco.utility.model.TestModel;
/** /**
* POJO for Transfer Container * POJO for Transfer Container
* *

View File

@@ -2,7 +2,7 @@
* #%L * #%L
* Alfresco Records Management Module * Alfresco Records Management Module
* %% * %%
* Copyright (C) 2005 - 2024 Alfresco Software Limited * Copyright (C) 2005 - 2025 Alfresco Software Limited
* %% * %%
* This file is part of the Alfresco software. * This file is part of the Alfresco software.
* - * -
@@ -31,16 +31,15 @@ import static org.alfresco.rest.rm.community.model.fileplancomponents.FilePlanCo
import static org.alfresco.rest.rm.community.model.fileplancomponents.FilePlanComponentFields.PROPERTIES_IDENTIFIER; import static org.alfresco.rest.rm.community.model.fileplancomponents.FilePlanComponentFields.PROPERTIES_IDENTIFIER;
import static org.alfresco.rest.rm.community.model.fileplancomponents.FilePlanComponentFields.PROPERTIES_ROOT_NODE_REF; import static org.alfresco.rest.rm.community.model.fileplancomponents.FilePlanComponentFields.PROPERTIES_ROOT_NODE_REF;
import org.alfresco.utility.model.TestModel;
import com.fasterxml.jackson.annotation.JsonProperty; import com.fasterxml.jackson.annotation.JsonProperty;
import lombok.AllArgsConstructor; import lombok.AllArgsConstructor;
import lombok.Builder; import lombok.Builder;
import lombok.Data; import lombok.Data;
import lombok.EqualsAndHashCode; import lombok.EqualsAndHashCode;
import lombok.NoArgsConstructor; import lombok.NoArgsConstructor;
import org.alfresco.utility.model.TestModel;
/** /**
* POJO for Transfer Container properties * POJO for Transfer Container properties
* *

View File

@@ -2,7 +2,7 @@
* #%L * #%L
* Alfresco Records Management Module * Alfresco Records Management Module
* %% * %%
* Copyright (C) 2005 - 2024 Alfresco Software Limited * Copyright (C) 2005 - 2025 Alfresco Software Limited
* %% * %%
* This file is part of the Alfresco software. * This file is part of the Alfresco software.
* - * -
@@ -28,18 +28,17 @@ package org.alfresco.rest.rm.community.model.unfiledcontainer;
import java.util.List; import java.util.List;
import org.alfresco.rest.model.RestByUserModel;
import org.alfresco.rest.rm.community.model.common.Path;
import org.alfresco.utility.model.TestModel;
import com.fasterxml.jackson.annotation.JsonProperty; import com.fasterxml.jackson.annotation.JsonProperty;
import lombok.AllArgsConstructor; import lombok.AllArgsConstructor;
import lombok.Builder; import lombok.Builder;
import lombok.Data; import lombok.Data;
import lombok.EqualsAndHashCode; import lombok.EqualsAndHashCode;
import lombok.NoArgsConstructor; import lombok.NoArgsConstructor;
import org.alfresco.rest.model.RestByUserModel;
import org.alfresco.rest.rm.community.model.common.Path;
import org.alfresco.utility.model.TestModel;
/** /**
* POJO for unfiled container * POJO for unfiled container
* *

View File

@@ -2,7 +2,7 @@
* #%L * #%L
* Alfresco Records Management Module * Alfresco Records Management Module
* %% * %%
* Copyright (C) 2005 - 2024 Alfresco Software Limited * Copyright (C) 2005 - 2025 Alfresco Software Limited
* %% * %%
* This file is part of the Alfresco software. * This file is part of the Alfresco software.
* - * -
@@ -28,20 +28,19 @@ package org.alfresco.rest.rm.community.model.unfiledcontainer;
import java.util.List; import java.util.List;
import org.alfresco.rest.model.RestByUserModel;
import org.alfresco.rest.rm.community.model.common.Path;
import org.alfresco.rest.rm.community.model.record.RecordContent;
import org.alfresco.utility.model.TestModel;
import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonIgnoreProperties;
import com.fasterxml.jackson.annotation.JsonProperty; import com.fasterxml.jackson.annotation.JsonProperty;
import lombok.AllArgsConstructor; import lombok.AllArgsConstructor;
import lombok.Builder; import lombok.Builder;
import lombok.Data; import lombok.Data;
import lombok.EqualsAndHashCode; import lombok.EqualsAndHashCode;
import lombok.NoArgsConstructor; import lombok.NoArgsConstructor;
import org.alfresco.rest.model.RestByUserModel;
import org.alfresco.rest.rm.community.model.common.Path;
import org.alfresco.rest.rm.community.model.record.RecordContent;
import org.alfresco.utility.model.TestModel;
/** /**
* POJO for record category child * POJO for record category child
* *

View File

@@ -2,7 +2,7 @@
* #%L * #%L
* Alfresco Records Management Module * Alfresco Records Management Module
* %% * %%
* Copyright (C) 2005 - 2024 Alfresco Software Limited * Copyright (C) 2005 - 2025 Alfresco Software Limited
* %% * %%
* This file is part of the Alfresco software. * This file is part of the Alfresco software.
* - * -

View File

@@ -2,7 +2,7 @@
* #%L * #%L
* Alfresco Records Management Module * Alfresco Records Management Module
* %% * %%
* Copyright (C) 2005 - 2024 Alfresco Software Limited * Copyright (C) 2005 - 2025 Alfresco Software Limited
* %% * %%
* This file is part of the Alfresco software. * This file is part of the Alfresco software.
* - * -
@@ -27,12 +27,11 @@
package org.alfresco.rest.rm.community.model.unfiledcontainer; package org.alfresco.rest.rm.community.model.unfiledcontainer;
import com.fasterxml.jackson.annotation.JsonProperty; import com.fasterxml.jackson.annotation.JsonProperty;
import org.alfresco.rest.core.RestModels;
import lombok.Data; import lombok.Data;
import lombok.EqualsAndHashCode; import lombok.EqualsAndHashCode;
import org.alfresco.rest.core.RestModels;
/** /**
* POJO for record category child entry * POJO for record category child entry
* *

View File

@@ -2,7 +2,7 @@
* #%L * #%L
* Alfresco Records Management Module * Alfresco Records Management Module
* %% * %%
* Copyright (C) 2005 - 2024 Alfresco Software Limited * Copyright (C) 2005 - 2025 Alfresco Software Limited
* %% * %%
* This file is part of the Alfresco software. * This file is part of the Alfresco software.
* - * -
@@ -61,16 +61,15 @@ import static org.alfresco.rest.rm.community.model.fileplancomponents.FilePlanCo
import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonIgnoreProperties;
import com.fasterxml.jackson.annotation.JsonProperty; import com.fasterxml.jackson.annotation.JsonProperty;
import org.alfresco.rest.rm.community.model.common.Owner;
import org.alfresco.utility.model.TestModel;
import lombok.AllArgsConstructor; import lombok.AllArgsConstructor;
import lombok.Builder; import lombok.Builder;
import lombok.Data; import lombok.Data;
import lombok.EqualsAndHashCode; import lombok.EqualsAndHashCode;
import lombok.NoArgsConstructor; import lombok.NoArgsConstructor;
import org.alfresco.rest.rm.community.model.common.Owner;
import org.alfresco.utility.model.TestModel;
/** /**
* POJO for record category child properties * POJO for record category child properties
* *

View File

@@ -2,7 +2,7 @@
* #%L * #%L
* Alfresco Records Management Module * Alfresco Records Management Module
* %% * %%
* Copyright (C) 2005 - 2024 Alfresco Software Limited * Copyright (C) 2005 - 2025 Alfresco Software Limited
* %% * %%
* This file is part of the Alfresco software. * This file is part of the Alfresco software.
* - * -
@@ -31,15 +31,14 @@ import static org.alfresco.rest.rm.community.model.fileplancomponents.FilePlanCo
import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonIgnoreProperties;
import com.fasterxml.jackson.annotation.JsonProperty; import com.fasterxml.jackson.annotation.JsonProperty;
import org.alfresco.utility.model.TestModel;
import lombok.AllArgsConstructor; import lombok.AllArgsConstructor;
import lombok.Builder; import lombok.Builder;
import lombok.Data; import lombok.Data;
import lombok.EqualsAndHashCode; import lombok.EqualsAndHashCode;
import lombok.NoArgsConstructor; import lombok.NoArgsConstructor;
import org.alfresco.utility.model.TestModel;
/** /**
* POJO for file plan properties * POJO for file plan properties
* *

View File

@@ -2,7 +2,7 @@
* #%L * #%L
* Alfresco Records Management Module * Alfresco Records Management Module
* %% * %%
* Copyright (C) 2005 - 2024 Alfresco Software Limited * Copyright (C) 2005 - 2025 Alfresco Software Limited
* %% * %%
* This file is part of the Alfresco software. * This file is part of the Alfresco software.
* - * -
@@ -28,19 +28,18 @@ package org.alfresco.rest.rm.community.model.unfiledcontainer;
import java.util.List; import java.util.List;
import org.alfresco.rest.model.RestByUserModel;
import org.alfresco.rest.rm.community.model.common.Path;
import org.alfresco.rest.rm.community.model.record.RecordContent;
import org.alfresco.utility.model.TestModel;
import com.fasterxml.jackson.annotation.JsonProperty; import com.fasterxml.jackson.annotation.JsonProperty;
import lombok.AllArgsConstructor; import lombok.AllArgsConstructor;
import lombok.Builder; import lombok.Builder;
import lombok.Data; import lombok.Data;
import lombok.EqualsAndHashCode; import lombok.EqualsAndHashCode;
import lombok.NoArgsConstructor; import lombok.NoArgsConstructor;
import org.alfresco.rest.model.RestByUserModel;
import org.alfresco.rest.rm.community.model.common.Path;
import org.alfresco.rest.rm.community.model.record.RecordContent;
import org.alfresco.utility.model.TestModel;
/** /**
* POJO for unfiled container * POJO for unfiled container
* *

View File

@@ -2,7 +2,7 @@
* #%L * #%L
* Alfresco Records Management Module * Alfresco Records Management Module
* %% * %%
* Copyright (C) 2005 - 2024 Alfresco Software Limited * Copyright (C) 2005 - 2025 Alfresco Software Limited
* %% * %%
* This file is part of the Alfresco software. * This file is part of the Alfresco software.
* - * -

View File

@@ -2,7 +2,7 @@
* #%L * #%L
* Alfresco Records Management Module * Alfresco Records Management Module
* %% * %%
* Copyright (C) 2005 - 2024 Alfresco Software Limited * Copyright (C) 2005 - 2025 Alfresco Software Limited
* %% * %%
* This file is part of the Alfresco software. * This file is part of the Alfresco software.
* - * -
@@ -34,9 +34,7 @@ package org.alfresco.rest.rm.community.model.user;
*/ */
public enum UserPermissions public enum UserPermissions
{ {
PERMISSION_FILING("Filing"), PERMISSION_FILING("Filing"), PERMISSION_READ_RECORDS("ReadRecords"), PERMISSION_FILE_RECORDS("FileRecords");
PERMISSION_READ_RECORDS("ReadRecords"),
PERMISSION_FILE_RECORDS("FileRecords");
public final String permissionId; public final String permissionId;

View File

@@ -2,7 +2,7 @@
* #%L * #%L
* Alfresco Records Management Module * Alfresco Records Management Module
* %% * %%
* Copyright (C) 2005 - 2024 Alfresco Software Limited * Copyright (C) 2005 - 2025 Alfresco Software Limited
* %% * %%
* This file is part of the Alfresco software. * This file is part of the Alfresco software.
* - * -
@@ -35,12 +35,7 @@ package org.alfresco.rest.rm.community.model.user;
*/ */
public enum UserRoles public enum UserRoles
{ {
IN_PLACE_WRITERS("ExtendedWriters", "In-Place Writers"), IN_PLACE_WRITERS("ExtendedWriters", "In-Place Writers"), ROLE_RM_ADMIN("Administrator", "Records Management Administrator"), ROLE_RM_MANAGER("RecordsManager", "Records Management Manager"), ROLE_RM_POWER_USER("PowerUser", "Records Management Power User"), ROLE_RM_SECURITY_OFFICER("SecurityOfficer", "Records Management Security Officer"), ROLE_RM_USER("User", "Records Management User");
ROLE_RM_ADMIN("Administrator", "Records Management Administrator"),
ROLE_RM_MANAGER("RecordsManager", "Records Management Manager"),
ROLE_RM_POWER_USER("PowerUser", "Records Management Power User"),
ROLE_RM_SECURITY_OFFICER("SecurityOfficer", "Records Management Security Officer"),
ROLE_RM_USER("User", "Records Management User");
public final String roleId; public final String roleId;
public final String displayName; public final String displayName;
@@ -51,5 +46,4 @@ public enum UserRoles
this.displayName = displayName; this.displayName = displayName;
} }
} }

View File

@@ -2,7 +2,7 @@
* #%L * #%L
* Alfresco Records Management Module * Alfresco Records Management Module
* %% * %%
* Copyright (C) 2005 - 2024 Alfresco Software Limited * Copyright (C) 2005 - 2025 Alfresco Software Limited
* %% * %%
* This file is part of the Alfresco software. * This file is part of the Alfresco software.
* - * -
@@ -29,12 +29,12 @@ package org.alfresco.rest.rm.community.requests;
import static lombok.AccessLevel.PRIVATE; import static lombok.AccessLevel.PRIVATE;
import static lombok.AccessLevel.PROTECTED; import static lombok.AccessLevel.PROTECTED;
import org.alfresco.rest.core.RMRestWrapper;
import org.alfresco.rest.requests.ModelRequest;
import lombok.Getter; import lombok.Getter;
import lombok.Setter; import lombok.Setter;
import org.alfresco.rest.core.RMRestWrapper;
import org.alfresco.rest.requests.ModelRequest;
/** /**
* Extends {@link ModelRequest} to set {@link RMRestWrapper} * Extends {@link ModelRequest} to set {@link RMRestWrapper}
* *

View File

@@ -2,7 +2,7 @@
* #%L * #%L
* Alfresco Records Management Module * Alfresco Records Management Module
* %% * %%
* Copyright (C) 2005 - 2024 Alfresco Software Limited * Copyright (C) 2005 - 2025 Alfresco Software Limited
* %% * %%
* This file is part of the Alfresco software. * This file is part of the Alfresco software.
* - * -
@@ -33,8 +33,8 @@ import io.restassured.RestAssured;
import org.alfresco.rest.core.RMRestProperties; import org.alfresco.rest.core.RMRestProperties;
import org.alfresco.rest.core.RMRestWrapper; import org.alfresco.rest.core.RMRestWrapper;
import org.alfresco.rest.rm.community.requests.gscore.api.ActionsExecutionAPI;
import org.alfresco.rest.rm.community.requests.RMModelRequest; import org.alfresco.rest.rm.community.requests.RMModelRequest;
import org.alfresco.rest.rm.community.requests.gscore.api.ActionsExecutionAPI;
import org.alfresco.rest.rm.community.requests.gscore.api.FilePlanAPI; import org.alfresco.rest.rm.community.requests.gscore.api.FilePlanAPI;
import org.alfresco.rest.rm.community.requests.gscore.api.FilesAPI; import org.alfresco.rest.rm.community.requests.gscore.api.FilesAPI;
import org.alfresco.rest.rm.community.requests.gscore.api.HoldsAPI; import org.alfresco.rest.rm.community.requests.gscore.api.HoldsAPI;
@@ -43,15 +43,14 @@ import org.alfresco.rest.rm.community.requests.gscore.api.RMUserAPI;
import org.alfresco.rest.rm.community.requests.gscore.api.RecordCategoryAPI; import org.alfresco.rest.rm.community.requests.gscore.api.RecordCategoryAPI;
import org.alfresco.rest.rm.community.requests.gscore.api.RecordFolderAPI; import org.alfresco.rest.rm.community.requests.gscore.api.RecordFolderAPI;
import org.alfresco.rest.rm.community.requests.gscore.api.RecordsAPI; import org.alfresco.rest.rm.community.requests.gscore.api.RecordsAPI;
import org.alfresco.rest.rm.community.requests.gscore.api.RetentionScheduleAPI;
import org.alfresco.rest.rm.community.requests.gscore.api.TransferAPI; import org.alfresco.rest.rm.community.requests.gscore.api.TransferAPI;
import org.alfresco.rest.rm.community.requests.gscore.api.TransferContainerAPI; import org.alfresco.rest.rm.community.requests.gscore.api.TransferContainerAPI;
import org.alfresco.rest.rm.community.requests.gscore.api.UnfiledContainerAPI; import org.alfresco.rest.rm.community.requests.gscore.api.UnfiledContainerAPI;
import org.alfresco.rest.rm.community.requests.gscore.api.UnfiledRecordFolderAPI; import org.alfresco.rest.rm.community.requests.gscore.api.UnfiledRecordFolderAPI;
import org.alfresco.rest.rm.community.requests.gscore.api.RetentionScheduleAPI;
/** /**
* Defines the entire GS Core API * Defines the entire GS Core API {@link http://host:port/gs-api-explorer} select "GS Core API"
* {@link http://host:port/gs-api-explorer} select "GS Core API"
* *
* @author Tuna Aksoy * @author Tuna Aksoy
* @since 2.6 * @since 2.6
@@ -61,8 +60,10 @@ public class GSCoreAPI extends RMModelRequest
/** /**
* Constructor * Constructor
* *
* @param rmRestWrapper RM REST Wrapper * @param rmRestWrapper
* @param rmRestProperties RM REST Properties * RM REST Wrapper
* @param rmRestProperties
* RM REST Properties
*/ */
public GSCoreAPI(RMRestWrapper rmRestWrapper, RMRestProperties rmRestProperties) public GSCoreAPI(RMRestWrapper rmRestWrapper, RMRestProperties rmRestProperties)
{ {
@@ -193,7 +194,10 @@ public class GSCoreAPI extends RMModelRequest
return new ActionsExecutionAPI(getRmRestWrapper()); return new ActionsExecutionAPI(getRmRestWrapper());
} }
public HoldsAPI usingHoldsAPI() { return new HoldsAPI(getRmRestWrapper()); } public HoldsAPI usingHoldsAPI()
{
return new HoldsAPI(getRmRestWrapper());
}
public RetentionScheduleAPI usingRetentionScheduleAPI() public RetentionScheduleAPI usingRetentionScheduleAPI()
{ {

View File

@@ -2,7 +2,7 @@
* #%L * #%L
* Alfresco Records Management Module * Alfresco Records Management Module
* %% * %%
* Copyright (C) 2005 - 2024 Alfresco Software Limited * Copyright (C) 2005 - 2025 Alfresco Software Limited
* %% * %%
* This file is part of the Alfresco software. * This file is part of the Alfresco software.
* - * -
@@ -27,13 +27,13 @@
package org.alfresco.rest.rm.community.requests.gscore.api; package org.alfresco.rest.rm.community.requests.gscore.api;
import com.google.common.collect.ImmutableMap; import com.google.common.collect.ImmutableMap;
import lombok.SneakyThrows; import lombok.SneakyThrows;
import org.json.JSONObject;
import org.alfresco.rest.core.RMRestWrapper; import org.alfresco.rest.core.RMRestWrapper;
import org.alfresco.rest.rm.community.model.rules.ActionsOnRule; import org.alfresco.rest.rm.community.model.rules.ActionsOnRule;
import org.alfresco.rest.rm.community.requests.RMModelRequest; import org.alfresco.rest.rm.community.requests.RMModelRequest;
import org.alfresco.utility.model.RepoTestModel; import org.alfresco.utility.model.RepoTestModel;
import org.json.JSONObject;
/** /**
* Produces processed results from Core Actions API calls * Produces processed results from Core Actions API calls
@@ -44,7 +44,8 @@ import org.json.JSONObject;
public class ActionsExecutionAPI extends RMModelRequest public class ActionsExecutionAPI extends RMModelRequest
{ {
/** /**
* @param rmRestWrapper RM REST Wrapper * @param rmRestWrapper
* RM REST Wrapper
*/ */
public ActionsExecutionAPI(RMRestWrapper rmRestWrapper) public ActionsExecutionAPI(RMRestWrapper rmRestWrapper)
{ {
@@ -54,8 +55,10 @@ public class ActionsExecutionAPI extends RMModelRequest
/** /**
* Declares and files a document as record to a record folder using v1 actions api * Declares and files a document as record to a record folder using v1 actions api
* *
* @param targetNode the node on which the action is executed * @param targetNode
* @param destinationPath the path to the record folder * the node on which the action is executed
* @param destinationPath
* the path to the record folder
* @throws Exception * @throws Exception
*/ */
public JSONObject declareAndFile(RepoTestModel targetNode, String destinationPath) throws Exception public JSONObject declareAndFile(RepoTestModel targetNode, String destinationPath) throws Exception
@@ -68,7 +71,8 @@ public class ActionsExecutionAPI extends RMModelRequest
/** /**
* Declares a document as record using v1 actions api * Declares a document as record using v1 actions api
* *
* @param targetNode the node on which the action is executed * @param targetNode
* the node on which the action is executed
* @throws Exception * @throws Exception
*/ */
public JSONObject declareAsRecord(RepoTestModel targetNode) throws Exception public JSONObject declareAsRecord(RepoTestModel targetNode) throws Exception
@@ -77,12 +81,13 @@ public class ActionsExecutionAPI extends RMModelRequest
.executeAction(ActionsOnRule.DECLARE_AS_RECORD.getActionValue(), targetNode); .executeAction(ActionsOnRule.DECLARE_AS_RECORD.getActionValue(), targetNode);
} }
/** /**
* Declares and file a document version as record to a record folder using v1 actions api * Declares and file a document version as record to a record folder using v1 actions api
* *
* @param targetNode the node on which the action is executed * @param targetNode
* @param destinationPath the path to the record folder * the node on which the action is executed
* @param destinationPath
* the path to the record folder
* @throws Exception * @throws Exception
*/ */
public JSONObject declareAndFileVersionAsRecord(RepoTestModel targetNode, String destinationPath) throws Exception public JSONObject declareAndFileVersionAsRecord(RepoTestModel targetNode, String destinationPath) throws Exception
@@ -95,7 +100,8 @@ public class ActionsExecutionAPI extends RMModelRequest
/** /**
* Declares a document version as record using v1 actions api * Declares a document version as record using v1 actions api
* *
* @param targetNode the node on which the action is executed * @param targetNode
* the node on which the action is executed
* @throws Exception * @throws Exception
*/ */
public JSONObject declareVersionAsRecord(RepoTestModel targetNode) throws Exception public JSONObject declareVersionAsRecord(RepoTestModel targetNode) throws Exception
@@ -107,7 +113,8 @@ public class ActionsExecutionAPI extends RMModelRequest
/** /**
* Add WORM lock to a node using v1 actions api * Add WORM lock to a node using v1 actions api
* *
* @param targetNode the node on which the action is executed * @param targetNode
* the node on which the action is executed
* @throws Exception * @throws Exception
*/ */
@SneakyThrows @SneakyThrows
@@ -120,8 +127,10 @@ public class ActionsExecutionAPI extends RMModelRequest
/** /**
* WORM lock a node for a period of days * WORM lock a node for a period of days
* *
* @param targetNode the node on which the action is executed * @param targetNode
* @param retentionPeriod the retention period in days for the WORM lock * the node on which the action is executed
* @param retentionPeriod
* the retention period in days for the WORM lock
* @throws Exception * @throws Exception
*/ */
@SneakyThrows @SneakyThrows

View File

@@ -2,7 +2,7 @@
* #%L * #%L
* Alfresco Records Management Module * Alfresco Records Management Module
* %% * %%
* Copyright (C) 2005 - 2024 Alfresco Software Limited * Copyright (C) 2005 - 2025 Alfresco Software Limited
* %% * %%
* This file is part of the Alfresco software. * This file is part of the Alfresco software.
* - * -
@@ -26,15 +26,16 @@
*/ */
package org.alfresco.rest.rm.community.requests.gscore.api; package org.alfresco.rest.rm.community.requests.gscore.api;
import static org.apache.commons.lang3.StringUtils.EMPTY;
import static org.springframework.http.HttpMethod.GET;
import static org.springframework.http.HttpMethod.POST;
import static org.springframework.http.HttpMethod.PUT;
import static org.alfresco.rest.core.RestRequest.requestWithBody; import static org.alfresco.rest.core.RestRequest.requestWithBody;
import static org.alfresco.rest.core.RestRequest.simpleRequest; import static org.alfresco.rest.core.RestRequest.simpleRequest;
import static org.alfresco.rest.rm.community.util.ParameterCheck.mandatoryObject; import static org.alfresco.rest.rm.community.util.ParameterCheck.mandatoryObject;
import static org.alfresco.rest.rm.community.util.ParameterCheck.mandatoryString; import static org.alfresco.rest.rm.community.util.ParameterCheck.mandatoryString;
import static org.alfresco.rest.rm.community.util.PojoUtility.toJson; import static org.alfresco.rest.rm.community.util.PojoUtility.toJson;
import static org.apache.commons.lang3.StringUtils.EMPTY;
import static org.springframework.http.HttpMethod.GET;
import static org.springframework.http.HttpMethod.POST;
import static org.springframework.http.HttpMethod.PUT;
import org.alfresco.rest.core.RMRestWrapper; import org.alfresco.rest.core.RMRestWrapper;
import org.alfresco.rest.rm.community.model.fileplan.FilePlan; import org.alfresco.rest.rm.community.model.fileplan.FilePlan;
@@ -56,7 +57,8 @@ public class FilePlanAPI extends RMModelRequest
/** /**
* Constructor. * Constructor.
* *
* @param rmRestWrapper RM REST Wrapper * @param rmRestWrapper
* RM REST Wrapper
*/ */
public FilePlanAPI(RMRestWrapper rmRestWrapper) public FilePlanAPI(RMRestWrapper rmRestWrapper)
{ {
@@ -76,10 +78,13 @@ public class FilePlanAPI extends RMModelRequest
/** /**
* Gets a file plan. * Gets a file plan.
* *
* @param filePlanId The identifier of a file plan * @param filePlanId
* @param parameters The URL parameters to add * The identifier of a file plan
* @param parameters
* The URL parameters to add
* @return The {@link FilePlan} for the given {@code filePlanId} * @return The {@link FilePlan} for the given {@code filePlanId}
* @throws RuntimeException for the following cases: * @throws RuntimeException
* for the following cases:
* <ul> * <ul>
* <li>{@code filePlanId} is not a valid format</li> * <li>{@code filePlanId} is not a valid format</li>
* <li>authentication fails</li> * <li>authentication fails</li>
@@ -95,8 +100,7 @@ public class FilePlanAPI extends RMModelRequest
GET, GET,
"/file-plans/{filePlanId}?{parameters}", "/file-plans/{filePlanId}?{parameters}",
filePlanId, filePlanId,
parameters parameters));
));
} }
/** /**
@@ -112,10 +116,13 @@ public class FilePlanAPI extends RMModelRequest
/** /**
* Gets the children (root categories) of a file plan. * Gets the children (root categories) of a file plan.
* *
* @param filePlanId The identifier of a file plan * @param filePlanId
* @param parameters The URL parameters to add * The identifier of a file plan
* @param parameters
* The URL parameters to add
* @return The {@link RecordCategoryCollection} for the given {@code filePlanId} * @return The {@link RecordCategoryCollection} for the given {@code filePlanId}
* @throws RuntimeException for the following cases: * @throws RuntimeException
* for the following cases:
* <ul> * <ul>
* <li>authentication fails</li> * <li>authentication fails</li>
* <li>current user does not have permission to read {@code filePlanId}</li> * <li>current user does not have permission to read {@code filePlanId}</li>
@@ -130,8 +137,7 @@ public class FilePlanAPI extends RMModelRequest
GET, GET,
"file-plans/{filePlanId}/categories?{parameters}", "file-plans/{filePlanId}/categories?{parameters}",
filePlanId, filePlanId,
parameters parameters));
));
} }
/** /**
@@ -148,11 +154,15 @@ public class FilePlanAPI extends RMModelRequest
/** /**
* Creates a root record category. * Creates a root record category.
* *
* @param recordCategoryModel The record category model which holds the information * @param recordCategoryModel
* @param filePlanId The identifier of a file plan * The record category model which holds the information
* @param parameters The URL parameters to add * @param filePlanId
* The identifier of a file plan
* @param parameters
* The URL parameters to add
* @return The created {@link RecordCategory} * @return The created {@link RecordCategory}
* @throws RuntimeException for the following cases: * @throws RuntimeException
* for the following cases:
* <ul> * <ul>
* <li>{@code filePlanId} is not a valid format or {@code filePlanId} is invalid</li> * <li>{@code filePlanId} is not a valid format or {@code filePlanId} is invalid</li>
* <li>authentication fails</li> * <li>authentication fails</li>
@@ -172,8 +182,7 @@ public class FilePlanAPI extends RMModelRequest
toJson(recordCategoryModel), toJson(recordCategoryModel),
"file-plans/{filePlanId}/categories?{parameters}", "file-plans/{filePlanId}/categories?{parameters}",
filePlanId, filePlanId,
parameters parameters));
));
} }
/** /**
@@ -190,10 +199,14 @@ public class FilePlanAPI extends RMModelRequest
/** /**
* Updates a file plan. * Updates a file plan.
* *
* @param filePlanModel The file plan model which holds the information * @param filePlanModel
* @param filePlanId The identifier of the file plan * The file plan model which holds the information
* @param parameters The URL parameters to add * @param filePlanId
* @throws RuntimeException for the following cases: * The identifier of the file plan
* @param parameters
* The URL parameters to add
* @throws RuntimeException
* for the following cases:
* <ul> * <ul>
* <li>the update request is invalid or {@code filePlanId} is not a valid format or {@code filePlanModel} is invalid</li> * <li>the update request is invalid or {@code filePlanId} is not a valid format or {@code filePlanModel} is invalid</li>
* <li>authentication fails</li> * <li>authentication fails</li>
@@ -218,11 +231,15 @@ public class FilePlanAPI extends RMModelRequest
/** /**
* Creates a hold. * Creates a hold.
* *
* @param holdModel The hold model * @param holdModel
* @param filePlanId The identifier of a file plan * The hold model
* @param parameters The URL parameters to add * @param filePlanId
* The identifier of a file plan
* @param parameters
* The URL parameters to add
* @return The created {@link Hold} * @return The created {@link Hold}
* @throws RuntimeException for the following cases: * @throws RuntimeException
* for the following cases:
* <ul> * <ul>
* <li>{@code filePlanId} is not a valid format or {@code filePlanId} is invalid</li> * <li>{@code filePlanId} is not a valid format or {@code filePlanId} is invalid</li>
* <li>authentication fails</li> * <li>authentication fails</li>
@@ -241,8 +258,7 @@ public class FilePlanAPI extends RMModelRequest
toJson(holdModel), toJson(holdModel),
"file-plans/{filePlanId}/holds", "file-plans/{filePlanId}/holds",
filePlanId, filePlanId,
parameters parameters));
));
} }
/** /**
@@ -256,10 +272,13 @@ public class FilePlanAPI extends RMModelRequest
/** /**
* Gets the holds of a file plan. * Gets the holds of a file plan.
* *
* @param filePlanId The identifier of a file plan * @param filePlanId
* @param parameters The URL parameters to add * The identifier of a file plan
* @param parameters
* The URL parameters to add
* @return The {@link HoldCollection} for the given {@code filePlanId} * @return The {@link HoldCollection} for the given {@code filePlanId}
* @throws RuntimeException for the following cases: * @throws RuntimeException
* for the following cases:
* <ul> * <ul>
* <li>authentication fails</li> * <li>authentication fails</li>
* <li>current user does not have permission to read {@code filePlanId}</li> * <li>current user does not have permission to read {@code filePlanId}</li>
@@ -274,8 +293,7 @@ public class FilePlanAPI extends RMModelRequest
GET, GET,
"file-plans/{filePlanId}/holds?{parameters}", "file-plans/{filePlanId}/holds?{parameters}",
filePlanId, filePlanId,
parameters parameters));
));
} }
/** /**

View File

@@ -2,7 +2,7 @@
* #%L * #%L
* Alfresco Records Management Module * Alfresco Records Management Module
* %% * %%
* Copyright (C) 2005 - 2024 Alfresco Software Limited * Copyright (C) 2005 - 2025 Alfresco Software Limited
* %% * %%
* This file is part of the Alfresco software. * This file is part of the Alfresco software.
* - * -
@@ -26,9 +26,10 @@
*/ */
package org.alfresco.rest.rm.community.requests.gscore.api; package org.alfresco.rest.rm.community.requests.gscore.api;
import static org.springframework.http.HttpMethod.POST;
import static org.alfresco.rest.core.RestRequest.simpleRequest; import static org.alfresco.rest.core.RestRequest.simpleRequest;
import static org.alfresco.rest.rm.community.util.ParameterCheck.mandatoryString; import static org.alfresco.rest.rm.community.util.ParameterCheck.mandatoryString;
import static org.springframework.http.HttpMethod.POST;
import org.alfresco.rest.core.RMRestWrapper; import org.alfresco.rest.core.RMRestWrapper;
import org.alfresco.rest.rm.community.model.record.Record; import org.alfresco.rest.rm.community.model.record.Record;
@@ -45,7 +46,8 @@ public class FilesAPI extends RMModelRequest<FilesAPI>
public static final String PARENT_ID_PARAM = "parentId"; public static final String PARENT_ID_PARAM = "parentId";
/** /**
* @param rmRestWrapper RM REST Wrapper * @param rmRestWrapper
* RM REST Wrapper
*/ */
public FilesAPI(RMRestWrapper rmRestWrapper) public FilesAPI(RMRestWrapper rmRestWrapper)
{ {
@@ -55,9 +57,11 @@ public class FilesAPI extends RMModelRequest<FilesAPI>
/** /**
* Declare file as record * Declare file as record
* *
* @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 Record} for created record * @return The {@link Record} for created record
* @throws RuntimeException for malformed JSON responses * @throws RuntimeException
* for malformed JSON responses
*/ */
public Record declareAsRecord(String fileId) public Record declareAsRecord(String fileId)
{ {
@@ -67,8 +71,6 @@ public class FilesAPI extends RMModelRequest<FilesAPI>
POST, POST,
"/files/{fileId}/declare?{parameters}", "/files/{fileId}/declare?{parameters}",
fileId, fileId,
getRmRestWrapper().getParameters() getRmRestWrapper().getParameters()));
));
} }
} }

View File

@@ -2,7 +2,7 @@
* #%L * #%L
* Alfresco Records Management Module * Alfresco Records Management Module
* %% * %%
* Copyright (C) 2005 - 2024 Alfresco Software Limited * Copyright (C) 2005 - 2025 Alfresco Software Limited
* %% * %%
* This file is part of the Alfresco software. * This file is part of the Alfresco software.
* - * -
@@ -26,17 +26,18 @@
*/ */
package org.alfresco.rest.rm.community.requests.gscore.api; package org.alfresco.rest.rm.community.requests.gscore.api;
import static org.alfresco.rest.core.RestRequest.requestWithBody;
import static org.alfresco.rest.core.RestRequest.simpleRequest;
import static org.alfresco.rest.rm.community.util.ParameterCheck.mandatoryObject;
import static org.alfresco.rest.rm.community.util.ParameterCheck.mandatoryString;
import static org.alfresco.rest.rm.community.util.PojoUtility.toJson;
import static org.apache.commons.lang3.StringUtils.EMPTY; import static org.apache.commons.lang3.StringUtils.EMPTY;
import static org.springframework.http.HttpMethod.DELETE; import static org.springframework.http.HttpMethod.DELETE;
import static org.springframework.http.HttpMethod.GET; import static org.springframework.http.HttpMethod.GET;
import static org.springframework.http.HttpMethod.POST; import static org.springframework.http.HttpMethod.POST;
import static org.springframework.http.HttpMethod.PUT; import static org.springframework.http.HttpMethod.PUT;
import static org.alfresco.rest.core.RestRequest.requestWithBody;
import static org.alfresco.rest.core.RestRequest.simpleRequest;
import static org.alfresco.rest.rm.community.util.ParameterCheck.mandatoryObject;
import static org.alfresco.rest.rm.community.util.ParameterCheck.mandatoryString;
import static org.alfresco.rest.rm.community.util.PojoUtility.toJson;
import org.alfresco.rest.core.RMRestWrapper; import org.alfresco.rest.core.RMRestWrapper;
import org.alfresco.rest.rm.community.model.hold.BulkBodyCancel; import org.alfresco.rest.rm.community.model.hold.BulkBodyCancel;
import org.alfresco.rest.rm.community.model.hold.Hold; import org.alfresco.rest.rm.community.model.hold.Hold;
@@ -68,10 +69,13 @@ public class HoldsAPI extends RMModelRequest
/** /**
* Gets a hold. * Gets a hold.
* *
* @param holdId The identifier of a hold * @param holdId
* @param parameters The URL parameters to add * The identifier of a hold
* @param parameters
* The URL parameters to add
* @return The {@link Hold} for the given {@code holdId} * @return The {@link Hold} for the given {@code holdId}
* @throws RuntimeException for the following cases: * @throws RuntimeException
* for the following cases:
* <ul> * <ul>
* <li>{@code holdId} is not a valid format</li> * <li>{@code holdId} is not a valid format</li>
* <li>authentication fails</li> * <li>authentication fails</li>
@@ -87,8 +91,7 @@ public class HoldsAPI extends RMModelRequest
GET, GET,
"holds/{holdId}?{parameters}", "holds/{holdId}?{parameters}",
holdId, holdId,
parameters parameters));
));
} }
/** /**
@@ -104,10 +107,14 @@ public class HoldsAPI extends RMModelRequest
/** /**
* Updates a hold. * Updates a hold.
* *
* @param holdModel The hold model which holds the information * @param holdModel
* @param holdId The identifier of the hold * The hold model which holds the information
* @param parameters The URL parameters to add * @param holdId
* @throws RuntimeException for the following cases: * The identifier of the hold
* @param parameters
* The URL parameters to add
* @throws RuntimeException
* for the following cases:
* <ul> * <ul>
* <li>the update request is invalid or {@code holdId} is not a valid format or {@code holdModel} is invalid</li> * <li>the update request is invalid or {@code holdId} is not a valid format or {@code holdModel} is invalid</li>
* <li>authentication fails</li> * <li>authentication fails</li>
@@ -125,8 +132,7 @@ public class HoldsAPI extends RMModelRequest
toJson(holdModel), toJson(holdModel),
"holds/{holdId}?{parameters}", "holds/{holdId}?{parameters}",
holdId, holdId,
parameters parameters));
));
} }
/** /**
@@ -143,8 +149,10 @@ public class HoldsAPI extends RMModelRequest
/** /**
* Deletes a hold. * Deletes a hold.
* *
* @param holdId The identifier of a hold * @param holdId
* @throws RuntimeException for the following cases: * The identifier of a hold
* @throws RuntimeException
* for the following cases:
* <ul> * <ul>
* <li>{@code holdId} is not a valid format</li> * <li>{@code holdId} is not a valid format</li>
* <li>authentication fails</li> * <li>authentication fails</li>
@@ -159,16 +167,18 @@ public class HoldsAPI extends RMModelRequest
getRmRestWrapper().processEmptyModel(simpleRequest( getRmRestWrapper().processEmptyModel(simpleRequest(
DELETE, DELETE,
"holds/{holdId}", "holds/{holdId}",
holdId holdId));
));
} }
/** /**
* Deletes a hold and stores a reason for deletion in the audit log. * Deletes a hold and stores a reason for deletion in the audit log.
* *
* @param reason The reason for hold deletion * @param reason
* @param holdId The identifier of a hold * The reason for hold deletion
* @throws RuntimeException for the following cases: * @param holdId
* The identifier of a hold
* @throws RuntimeException
* for the following cases:
* <ul> * <ul>
* <li>{@code holdId} is not a valid format or {@code reason} is invalid</li> * <li>{@code holdId} is not a valid format or {@code reason} is invalid</li>
* <li>authentication fails</li> * <li>authentication fails</li>
@@ -185,18 +195,21 @@ public class HoldsAPI extends RMModelRequest
POST, POST,
toJson(reason), toJson(reason),
"holds/{holdId}/delete", "holds/{holdId}/delete",
holdId holdId));
));
} }
/** /**
* Adds the relationship between a child and a parent hold. * Adds the relationship between a child and a parent hold.
* *
* @param holdChild The hold child model * @param holdChild
* @param holdId The identifier of a hold * The hold child model
* @param parameters The URL parameters to add * @param holdId
* The identifier of a hold
* @param parameters
* The URL parameters to add
* @return The created {@link Hold} * @return The created {@link Hold}
* @throws RuntimeException for the following cases: * @throws RuntimeException
* for the following cases:
* <ul> * <ul>
* <li>{@code holdId} is not a valid format or {@code holdId} is invalid</li> * <li>{@code holdId} is not a valid format or {@code holdId} is invalid</li>
* <li>authentication fails</li> * <li>authentication fails</li>
@@ -227,10 +240,13 @@ public class HoldsAPI extends RMModelRequest
/** /**
* Gets the children of a hold. * Gets the children of a hold.
* *
* @param holdId The identifier of a hold * @param holdId
* @param parameters The URL parameters to add * The identifier of a hold
* @param parameters
* The URL parameters to add
* @return The {@link HoldChildCollection} for the given {@code holdId} * @return The {@link HoldChildCollection} for the given {@code holdId}
* @throws RuntimeException for the following cases: * @throws RuntimeException
* for the following cases:
* <ul> * <ul>
* <li>authentication fails</li> * <li>authentication fails</li>
* <li>current user does not have permission to read {@code holdId}</li> * <li>current user does not have permission to read {@code holdId}</li>
@@ -245,8 +261,7 @@ public class HoldsAPI extends RMModelRequest
GET, GET,
"holds/{holdId}/children", "holds/{holdId}/children",
holdId, holdId,
parameters parameters));
));
} }
/** /**
@@ -260,10 +275,14 @@ public class HoldsAPI extends RMModelRequest
/** /**
* Deletes the relationship between a child and a parent hold. * Deletes the relationship between a child and a parent hold.
* *
* @param holdChildId The identifier of hold child * @param holdChildId
* @param holdId The identifier of a hold * The identifier of hold child
* @param parameters The URL parameters to add * @param holdId
* @throws RuntimeException for the following cases: * The identifier of a hold
* @param parameters
* The URL parameters to add
* @throws RuntimeException
* for the following cases:
* <ul> * <ul>
* <li>{@code holdId} or {@code holdChildId} is invalid</li> * <li>{@code holdId} or {@code holdChildId} is invalid</li>
* <li>authentication fails</li> * <li>authentication fails</li>
@@ -281,8 +300,7 @@ public class HoldsAPI extends RMModelRequest
"holds/{holdId}/children/{holdChildId}", "holds/{holdId}/children/{holdChildId}",
holdId, holdId,
holdChildId, holdChildId,
parameters parameters));
));
} }
/** /**
@@ -296,11 +314,15 @@ public class HoldsAPI extends RMModelRequest
/** /**
* Starts a bulk process for a hold. * Starts a bulk process for a hold.
* *
* @param holdBulkOperation The bulk operation details * @param holdBulkOperation
* @param hold The identifier of a hold * The bulk operation details
* @param parameters The URL parameters to add * @param hold
* The identifier of a hold
* @param parameters
* The URL parameters to add
* @return The {@link HoldBulkOperationEntry} for the started bulk process * @return The {@link HoldBulkOperationEntry} for the started bulk process
* @throws RuntimeException for the following cases: * @throws RuntimeException
* for the following cases:
* <ul> * <ul>
* <li>{@code hold} or {@code holdBulkOperation} is invalid</li> * <li>{@code hold} or {@code holdBulkOperation} is invalid</li>
* <li>authentication fails</li> * <li>authentication fails</li>
@@ -318,8 +340,7 @@ public class HoldsAPI extends RMModelRequest
toJson(holdBulkOperation), toJson(holdBulkOperation),
"holds/{hold}/bulk", "holds/{hold}/bulk",
hold, hold,
parameters parameters));
));
} }
/** /**
@@ -333,11 +354,15 @@ public class HoldsAPI extends RMModelRequest
/** /**
* Gets the status of a bulk process for a hold. * Gets the status of a bulk process for a hold.
* *
* @param holdId The identifier of a hold * @param holdId
* @param holdBulkStatusId The identifier of a bulk status operation * The identifier of a hold
* @param parameters The URL parameters to add * @param holdBulkStatusId
* The identifier of a bulk status operation
* @param parameters
* The URL parameters to add
* @return The {@link HoldBulkStatus} for the given {@code holdId} and {@code holdBulkStatusId} * @return The {@link HoldBulkStatus} for the given {@code holdId} and {@code holdBulkStatusId}
* @throws RuntimeException for the following cases: * @throws RuntimeException
* for the following cases:
* <ul> * <ul>
* <li>{@code holdId} or {@code holdBulkStatusId} is invalid</li> * <li>{@code holdId} or {@code holdBulkStatusId} is invalid</li>
* <li>authentication fails</li> * <li>authentication fails</li>
@@ -355,8 +380,7 @@ public class HoldsAPI extends RMModelRequest
"holds/{holdId}/bulk-statuses/{holdBulkStatusId}", "holds/{holdId}/bulk-statuses/{holdBulkStatusId}",
holdId, holdId,
holdBulkStatusId, holdBulkStatusId,
parameters parameters));
));
} }
/** /**
@@ -370,10 +394,13 @@ public class HoldsAPI extends RMModelRequest
/** /**
* Gets the statuses of all bulk processes for a hold. * Gets the statuses of all bulk processes for a hold.
* *
* @param holdId The identifier of a hold * @param holdId
* @param parameters The URL parameters to add * The identifier of a hold
* @param parameters
* The URL parameters to add
* @return The {@link HoldBulkStatusCollection} for the given {@code holdId} * @return The {@link HoldBulkStatusCollection} for the given {@code holdId}
* @throws RuntimeException for the following cases: * @throws RuntimeException
* for the following cases:
* <ul> * <ul>
* <li>{@code holdId} is invalid</li> * <li>{@code holdId} is invalid</li>
* <li>authentication fails</li> * <li>authentication fails</li>
@@ -389,8 +416,7 @@ public class HoldsAPI extends RMModelRequest
GET, GET,
"holds/{holdId}/bulk-statuses", "holds/{holdId}/bulk-statuses",
holdId, holdId,
parameters parameters));
));
} }
/** /**
@@ -404,11 +430,16 @@ public class HoldsAPI extends RMModelRequest
/** /**
* Cancels a bulk operation for a hold. * Cancels a bulk operation for a hold.
* *
* @param holdId The identifier of a hold * @param holdId
* @param bulkStatusId The identifier of a bulk status operation * The identifier of a hold
* @param bulkBodyCancel The bulk body cancel model * @param bulkStatusId
* @param parameters The URL parameters to add * The identifier of a bulk status operation
* @throws RuntimeException for the following cases: * @param bulkBodyCancel
* The bulk body cancel model
* @param parameters
* The URL parameters to add
* @throws RuntimeException
* for the following cases:
* <ul> * <ul>
* <li>{@code holdId}, {@code bulkStatusId} or {@code bulkBodyCancel} is invalid</li> * <li>{@code holdId}, {@code bulkStatusId} or {@code bulkBodyCancel} is invalid</li>
* <li>authentication fails</li> * <li>authentication fails</li>
@@ -428,8 +459,7 @@ public class HoldsAPI extends RMModelRequest
"holds/{holdId}/bulk-statuses/{bulkStatusId}/cancel", "holds/{holdId}/bulk-statuses/{bulkStatusId}/cancel",
holdId, holdId,
bulkStatusId, bulkStatusId,
parameters parameters));
));
} }
/** /**

View File

@@ -2,7 +2,7 @@
* #%L * #%L
* Alfresco Records Management Module * Alfresco Records Management Module
* %% * %%
* Copyright (C) 2005 - 2024 Alfresco Software Limited * Copyright (C) 2005 - 2025 Alfresco Software Limited
* %% * %%
* This file is part of the Alfresco software. * This file is part of the Alfresco software.
* - * -
@@ -26,16 +26,17 @@
*/ */
package org.alfresco.rest.rm.community.requests.gscore.api; package org.alfresco.rest.rm.community.requests.gscore.api;
import static org.alfresco.rest.core.RestRequest.requestWithBody;
import static org.alfresco.rest.core.RestRequest.simpleRequest;
import static org.alfresco.rest.rm.community.util.ParameterCheck.mandatoryObject;
import static org.alfresco.rest.rm.community.util.PojoUtility.toJson;
import static org.springframework.http.HttpMethod.DELETE; import static org.springframework.http.HttpMethod.DELETE;
import static org.springframework.http.HttpMethod.GET; import static org.springframework.http.HttpMethod.GET;
import static org.springframework.http.HttpMethod.POST; import static org.springframework.http.HttpMethod.POST;
import static org.springframework.http.HttpMethod.PUT; import static org.springframework.http.HttpMethod.PUT;
import static org.springframework.http.HttpStatus.OK; import static org.springframework.http.HttpStatus.OK;
import static org.alfresco.rest.core.RestRequest.requestWithBody;
import static org.alfresco.rest.core.RestRequest.simpleRequest;
import static org.alfresco.rest.rm.community.util.ParameterCheck.mandatoryObject;
import static org.alfresco.rest.rm.community.util.PojoUtility.toJson;
import org.alfresco.rest.core.RMRestWrapper; import org.alfresco.rest.core.RMRestWrapper;
import org.alfresco.rest.rm.community.model.site.RMSite; import org.alfresco.rest.rm.community.model.site.RMSite;
import org.alfresco.rest.rm.community.requests.RMModelRequest; import org.alfresco.rest.rm.community.requests.RMModelRequest;
@@ -51,7 +52,8 @@ public class RMSiteAPI extends RMModelRequest
/** /**
* Constructor * Constructor
* *
* @param rmRestWrapper RM REST Wrapper * @param rmRestWrapper
* RM REST Wrapper
*/ */
public RMSiteAPI(RMRestWrapper rmRestWrapper) public RMSiteAPI(RMRestWrapper rmRestWrapper)
{ {
@@ -62,7 +64,8 @@ public class RMSiteAPI extends RMModelRequest
* Get the RM site * Get the RM site
* *
* @return The {@link RMSite} for the given file plan component id * @return The {@link RMSite} for the given file plan component id
* @throws RuntimeException for the following cases: * @throws RuntimeException
* for the following cases:
* <ul> * <ul>
* <li>Api Response code 400 Invalid parameter: GET request is supported only for the RM site</li> * <li>Api Response code 400 Invalid parameter: GET request is supported only for the RM site</li>
* <li>Api Response code 401 If authentication failed</li> * <li>Api Response code 401 If authentication failed</li>
@@ -74,20 +77,20 @@ public class RMSiteAPI extends RMModelRequest
{ {
return getRmRestWrapper().processModel(RMSite.class, simpleRequest( return getRmRestWrapper().processModel(RMSite.class, simpleRequest(
GET, GET,
"gs-sites/rm" "gs-sites/rm"));
));
} }
/** /**
* Create the RM site * Create the RM site
* *
* @param rmSiteModel The properties of the rm site to be created * @param rmSiteModel
* The properties of the rm site to be created
* @return The {@link RMSite} with the given properties * @return The {@link RMSite} with the given properties
* @throws RuntimeException for the following cases: * @throws RuntimeException
* for the following cases:
* <ul> * <ul>
* <li>Api Response code 400 Invalid parameter: title, or description exceed the maximum length; or siteBodyCreate invalid</li> * <li>Api Response code 400 Invalid parameter: title, or description exceed the maximum length; or siteBodyCreate invalid</li>
* <li>Api Response code 401 If authentication failed</ * <li>Api Response code 401 If authentication failed</<li>Api Response code 409 RM Site already exists</li>
* <li>Api Response code 409 RM Site already exists</li>
* <li>Api Response code default Unexpected error</li> * <li>Api Response code default Unexpected error</li>
* </ul> * </ul>
*/ */
@@ -98,17 +101,17 @@ public class RMSiteAPI extends RMModelRequest
return getRmRestWrapper().processModel(RMSite.class, requestWithBody( return getRmRestWrapper().processModel(RMSite.class, requestWithBody(
POST, POST,
toJson(rmSiteModel), toJson(rmSiteModel),
"gs-sites" "gs-sites"));
));
} }
/** /**
* Delete RM site * Delete RM site
* @throws RuntimeException for the following cases: *
* @throws RuntimeException
* for the following cases:
* <ul> * <ul>
* <li>Api Response code 400 Invalid parameter: DELETE request is supported only for the RM site</li> * <li>Api Response code 400 Invalid parameter: DELETE request is supported only for the RM site</li>
* <li>Api Response code 401 If authentication failed</ * <li>Api Response code 401 If authentication failed</<li>Api Response code 403 Current user does not have permission to delete the site that is visible to them.</li>
* <li>Api Response code 403 Current user does not have permission to delete the site that is visible to them.</li>
* <li>Api Response code 404 RM site does not exist</li> * <li>Api Response code 404 RM site does not exist</li>
* <li>Api Response code default Unexpected error</li> * <li>Api Response code default Unexpected error</li>
* </ul> * </ul>
@@ -117,16 +120,17 @@ public class RMSiteAPI extends RMModelRequest
{ {
getRmRestWrapper().processEmptyModel(simpleRequest( getRmRestWrapper().processEmptyModel(simpleRequest(
DELETE, DELETE,
"gs-sites/rm" "gs-sites/rm"));
));
} }
/** /**
* Update RM site * Update RM site
* *
* @param rmSiteModel The properties to be updated * @param rmSiteModel
* The properties to be updated
* @return The updated {@link RMSite} * @return The updated {@link RMSite}
* @throws RuntimeException for the following cases: * @throws RuntimeException
* for the following cases:
* <ul> * <ul>
* <li>Api Response code 400 the update request is invalid {@code rmSiteModel} is invalid</li> * <li>Api Response code 400 the update request is invalid {@code rmSiteModel} is invalid</li>
* <li>Api Response code 401 If authentication fails</li> * <li>Api Response code 401 If authentication fails</li>
@@ -142,15 +146,15 @@ public class RMSiteAPI extends RMModelRequest
return getRmRestWrapper().processModel(RMSite.class, requestWithBody( return getRmRestWrapper().processModel(RMSite.class, requestWithBody(
PUT, PUT,
toJson(rmSiteModel), toJson(rmSiteModel),
"gs-sites/rm" "gs-sites/rm"));
));
} }
/** /**
* Checks if the RM site exists or not * Checks if the RM site exists or not
* *
* @return <code>true</code> if the RM site exists, <code>false</code> otherwise * @return <code>true</code> if the RM site exists, <code>false</code> otherwise
* @throws RuntimeException for the following cases: * @throws RuntimeException
* for the following cases:
* <ul> * <ul>
* <li>Api Response code 400 Invalid parameter: GET request is supported only for the RM site</li> * <li>Api Response code 400 Invalid parameter: GET request is supported only for the RM site</li>
* <li>Api Response code 401 If authentication failed</li> * <li>Api Response code 401 If authentication failed</li>

View File

@@ -2,7 +2,7 @@
* #%L * #%L
* Alfresco Records Management Module * Alfresco Records Management Module
* %% * %%
* Copyright (C) 2005 - 2024 Alfresco Software Limited * Copyright (C) 2005 - 2025 Alfresco Software Limited
* %% * %%
* This file is part of the Alfresco software. * This file is part of the Alfresco software.
* - * -
@@ -26,17 +26,16 @@
*/ */
package org.alfresco.rest.rm.community.requests.gscore.api; package org.alfresco.rest.rm.community.requests.gscore.api;
import static io.restassured.RestAssured.basic;
import static io.restassured.RestAssured.given;
import static org.jglue.fluentjson.JsonBuilderFactory.buildObject; import static org.jglue.fluentjson.JsonBuilderFactory.buildObject;
import static org.springframework.http.HttpStatus.OK; import static org.springframework.http.HttpStatus.OK;
import com.google.gson.JsonObject; import com.google.gson.JsonObject;
import io.restassured.builder.RequestSpecBuilder; import io.restassured.builder.RequestSpecBuilder;
import io.restassured.http.ContentType; import io.restassured.http.ContentType;
import io.restassured.response.Response; import io.restassured.response.Response;
import io.restassured.specification.RequestSpecification; import io.restassured.specification.RequestSpecification;
import static io.restassured.RestAssured.basic;
import static io.restassured.RestAssured.given;
import org.alfresco.dataprep.AlfrescoHttpClient; import org.alfresco.dataprep.AlfrescoHttpClient;
import org.alfresco.dataprep.AlfrescoHttpClientFactory; import org.alfresco.dataprep.AlfrescoHttpClientFactory;
@@ -59,7 +58,8 @@ import org.alfresco.utility.model.UserModel;
public class RMUserAPI extends RMModelRequest public class RMUserAPI extends RMModelRequest
{ {
/** /**
* @param rmRestWrapper RM REST Wrapper * @param rmRestWrapper
* RM REST Wrapper
*/ */
public RMUserAPI(RMRestWrapper rmRestWrapper) public RMUserAPI(RMRestWrapper rmRestWrapper)
{ {
@@ -68,6 +68,7 @@ public class RMUserAPI extends RMModelRequest
/** /**
* Helper method to obtain {@link AlfrescoHttpClient} * Helper method to obtain {@link AlfrescoHttpClient}
*
* @return Initialized {@link AlfrescoHttpClient} instance * @return Initialized {@link AlfrescoHttpClient} instance
*/ */
private AlfrescoHttpClient getAlfrescoHttpClient() private AlfrescoHttpClient getAlfrescoHttpClient()
@@ -85,9 +86,12 @@ public class RMUserAPI extends RMModelRequest
/** /**
* Assign RM role to user * Assign RM role to user
* *
* @param userName User's username * @param userName
* @param userRole User's RM role, one of {@link UserRoles} roles * User's username
* @throws RuntimeException for failed requests * @param userRole
* User's RM role, one of {@link UserRoles} roles
* @throws RuntimeException
* for failed requests
*/ */
public void assignRoleToUser(String userName, String userRole) public void assignRoleToUser(String userName, String userRole)
{ {
@@ -118,9 +122,13 @@ public class RMUserAPI extends RMModelRequest
/** /**
* Helper method to add permission on a component to user * Helper method to add permission on a component to user
* @param filePlanComponentId The id of the file plan component on which permission should be given *
* @param user {@link UserModel} for a user to be granted permission * @param filePlanComponentId
* @param permission {@link UserPermissions} to be granted * The id of the file plan component on which permission should be given
* @param user
* {@link UserModel} for a user to be granted permission
* @param permission
* {@link UserPermissions} to be granted
*/ */
public void addUserPermission(String filePlanComponentId, UserModel user, UserPermissions permission) public void addUserPermission(String filePlanComponentId, UserModel user, UserPermissions permission)
{ {
@@ -161,9 +169,10 @@ public class RMUserAPI extends RMModelRequest
/** /**
* Helper method to set permission inheritance on a file plan component * Helper method to set permission inheritance on a file plan component
* *
* @param filePlanComponentId The id of the file plan component on which inherited permission should be set * @param filePlanComponentId
* @param isInherited true if the permission is inherited * The id of the file plan component on which inherited permission should be set
* false if the permission inheritance is disabled * @param isInherited
* true if the permission is inherited false if the permission inheritance is disabled
*/ */
public void setUserPermissionInheritance(String filePlanComponentId, Boolean isInherited) public void setUserPermissionInheritance(String filePlanComponentId, Boolean isInherited)
{ {
@@ -199,13 +208,15 @@ public class RMUserAPI extends RMModelRequest
getRmRestWrapper().setStatusCode(Integer.toString(response.getStatusCode())); getRmRestWrapper().setStatusCode(Integer.toString(response.getStatusCode()));
} }
/** /**
* Creates a user with the given name using the old APIs * Creates a user with the given name using the old APIs
* *
* @param userName The user name * @param userName
* @param userPassword The user's password * The user name
* @param userEmail The user's e-mail address * @param userPassword
* The user's password
* @param userEmail
* The user's e-mail address
* @return <code>true</code> if the user was created successfully, <code>false</code> otherwise. * @return <code>true</code> if the user was created successfully, <code>false</code> otherwise.
*/ */
public boolean createUser(String userName, String userPassword, String userEmail) public boolean createUser(String userName, String userPassword, String userEmail)

View File

@@ -2,7 +2,7 @@
* #%L * #%L
* Alfresco Records Management Module * Alfresco Records Management Module
* %% * %%
* Copyright (C) 2005 - 2024 Alfresco Software Limited * Copyright (C) 2005 - 2025 Alfresco Software Limited
* %% * %%
* This file is part of the Alfresco software. * This file is part of the Alfresco software.
* - * -
@@ -26,17 +26,18 @@
*/ */
package org.alfresco.rest.rm.community.requests.gscore.api; package org.alfresco.rest.rm.community.requests.gscore.api;
import static org.alfresco.rest.core.RestRequest.requestWithBody;
import static org.alfresco.rest.core.RestRequest.simpleRequest;
import static org.alfresco.rest.rm.community.util.ParameterCheck.mandatoryObject;
import static org.alfresco.rest.rm.community.util.ParameterCheck.mandatoryString;
import static org.alfresco.rest.rm.community.util.PojoUtility.toJson;
import static org.apache.commons.lang3.StringUtils.EMPTY; import static org.apache.commons.lang3.StringUtils.EMPTY;
import static org.springframework.http.HttpMethod.DELETE; import static org.springframework.http.HttpMethod.DELETE;
import static org.springframework.http.HttpMethod.GET; import static org.springframework.http.HttpMethod.GET;
import static org.springframework.http.HttpMethod.POST; import static org.springframework.http.HttpMethod.POST;
import static org.springframework.http.HttpMethod.PUT; import static org.springframework.http.HttpMethod.PUT;
import static org.alfresco.rest.core.RestRequest.requestWithBody;
import static org.alfresco.rest.core.RestRequest.simpleRequest;
import static org.alfresco.rest.rm.community.util.ParameterCheck.mandatoryObject;
import static org.alfresco.rest.rm.community.util.ParameterCheck.mandatoryString;
import static org.alfresco.rest.rm.community.util.PojoUtility.toJson;
import org.alfresco.rest.core.RMRestWrapper; import org.alfresco.rest.core.RMRestWrapper;
import org.alfresco.rest.rm.community.model.recordcategory.RecordCategory; import org.alfresco.rest.rm.community.model.recordcategory.RecordCategory;
import org.alfresco.rest.rm.community.model.recordcategory.RecordCategoryChild; import org.alfresco.rest.rm.community.model.recordcategory.RecordCategoryChild;
@@ -54,7 +55,8 @@ public class RecordCategoryAPI extends RMModelRequest
/** /**
* Constructor. * Constructor.
* *
* @param rmRestWrapper RM REST Wrapper * @param rmRestWrapper
* RM REST Wrapper
*/ */
public RecordCategoryAPI(RMRestWrapper rmRestWrapper) public RecordCategoryAPI(RMRestWrapper rmRestWrapper)
{ {
@@ -64,8 +66,10 @@ public class RecordCategoryAPI extends RMModelRequest
/** /**
* Deletes a record category. * Deletes a record category.
* *
* @param recordCategoryId The identifier of a record category * @param recordCategoryId
* @throws RuntimeException for the following cases: * The identifier of a record category
* @throws RuntimeException
* for the following cases:
* <ul> * <ul>
* <li>{@code recordCategoryId} is not a valid format</li> * <li>{@code recordCategoryId} is not a valid format</li>
* <li>authentication fails</li> * <li>authentication fails</li>
@@ -81,8 +85,7 @@ public class RecordCategoryAPI extends RMModelRequest
getRmRestWrapper().processEmptyModel(simpleRequest( getRmRestWrapper().processEmptyModel(simpleRequest(
DELETE, DELETE,
"record-categories/{recordCategoryId}", "record-categories/{recordCategoryId}",
recordCategoryId recordCategoryId));
));
} }
/** /**
@@ -98,10 +101,13 @@ public class RecordCategoryAPI extends RMModelRequest
/** /**
* Gets a record category. * Gets a record category.
* *
* @param recordCategoryId The identifier of a record category * @param recordCategoryId
* @param parameters The URL parameters to add * The identifier of a record category
* @param parameters
* The URL parameters to add
* @return The {@link RecordCategory} for the given {@code recordCategoryId} * @return The {@link RecordCategory} for the given {@code recordCategoryId}
* @throws RuntimeException for the following cases: * @throws RuntimeException
* for the following cases:
* <ul> * <ul>
* <li>{@code recordCategoryId} is not a valid format</li> * <li>{@code recordCategoryId} is not a valid format</li>
* <li>authentication fails</li> * <li>authentication fails</li>
@@ -117,8 +123,7 @@ public class RecordCategoryAPI extends RMModelRequest
GET, GET,
"record-categories/{recordCategoryId}?{parameters}", "record-categories/{recordCategoryId}?{parameters}",
recordCategoryId, recordCategoryId,
parameters parameters));
));
} }
/** /**
@@ -135,11 +140,16 @@ public class RecordCategoryAPI extends RMModelRequest
/** /**
* Updates a record category. * Updates a record category.
* *
* @param recordCategoryModel The record category model which holds the information * @param recordCategoryModel
* @param recordCategoryId The identifier of a record category * The record category model which holds the information
* @param parameters The URL parameters to add * @param recordCategoryId
* @param returns The updated {@link RecordCategory} * The identifier of a record category
* @throws RuntimeException for the following cases: * @param parameters
* The URL parameters to add
* @param returns
* The updated {@link RecordCategory}
* @throws RuntimeException
* for the following cases:
* <ul> * <ul>
* <li>the update request is invalid or {@code recordCategoryId} is not a valid format or {@code recordCategoryModel} is invalid</li> * <li>the update request is invalid or {@code recordCategoryId} is not a valid format or {@code recordCategoryModel} is invalid</li>
* <li>authentication fails</li> * <li>authentication fails</li>
@@ -159,8 +169,7 @@ public class RecordCategoryAPI extends RMModelRequest
toJson(recordCategoryModel), toJson(recordCategoryModel),
"record-categories/{recordCategoryId}?{parameters}", "record-categories/{recordCategoryId}?{parameters}",
recordCategoryId, recordCategoryId,
parameters parameters));
));
} }
/** /**
@@ -176,10 +185,13 @@ public class RecordCategoryAPI extends RMModelRequest
/** /**
* Gets the children of a record category. * Gets the children of a record category.
* *
* @param recordCategoryId The identifier of a record category * @param recordCategoryId
* @param parameters The URL parameters to add * The identifier of a record category
* @param parameters
* The URL parameters to add
* @return The {@link RecordCategoryChildCollection} for the given {@code recordCategoryId} * @return The {@link RecordCategoryChildCollection} for the given {@code recordCategoryId}
* @throws RuntimeException for the following cases: * @throws RuntimeException
* for the following cases:
* <ul> * <ul>
* <li>authentication fails</li> * <li>authentication fails</li>
* <li>current user does not have permission to read {@code recordCategoryId}</li> * <li>current user does not have permission to read {@code recordCategoryId}</li>
@@ -194,8 +206,7 @@ public class RecordCategoryAPI extends RMModelRequest
GET, GET,
"record-categories/{recordCategoryId}/children?{parameters}", "record-categories/{recordCategoryId}/children?{parameters}",
recordCategoryId, recordCategoryId,
parameters parameters));
));
} }
/** /**
@@ -212,11 +223,15 @@ public class RecordCategoryAPI extends RMModelRequest
/** /**
* Creates a record category child. Can be a record category or a record folder. * Creates a record category child. Can be a record category or a record folder.
* *
* @param recordCategoryChildModel The record category child model which holds the information * @param recordCategoryChildModel
* @param recordCategoryId The identifier of a record category * The record category child model which holds the information
* @param parameters The URL parameters to add * @param recordCategoryId
* The identifier of a record category
* @param parameters
* The URL parameters to add
* @return The created {@link RecordCategoryChild} * @return The created {@link RecordCategoryChild}
* @throws RuntimeException for the following cases: * @throws RuntimeException
* for the following cases:
* <ul> * <ul>
* <li>{@code recordCategoryId} is not a valid format or {@code recordCategoryChildModel} is invalid</li> * <li>{@code recordCategoryId} is not a valid format or {@code recordCategoryChildModel} is invalid</li>
* <li>authentication fails</li> * <li>authentication fails</li>
@@ -236,7 +251,6 @@ public class RecordCategoryAPI extends RMModelRequest
toJson(recordCategoryChildModel), toJson(recordCategoryChildModel),
"record-categories/{recordCategoryId}/children?{parameters}", "record-categories/{recordCategoryId}/children?{parameters}",
recordCategoryId, recordCategoryId,
parameters parameters));
));
} }
} }

View File

@@ -2,7 +2,7 @@
* #%L * #%L
* Alfresco Records Management Module * Alfresco Records Management Module
* %% * %%
* Copyright (C) 2005 - 2024 Alfresco Software Limited * Copyright (C) 2005 - 2025 Alfresco Software Limited
* %% * %%
* This file is part of the Alfresco software. * This file is part of the Alfresco software.
* - * -
@@ -26,12 +26,6 @@
*/ */
package org.alfresco.rest.rm.community.requests.gscore.api; package org.alfresco.rest.rm.community.requests.gscore.api;
import static org.alfresco.rest.core.RestRequest.requestWithBody;
import static org.alfresco.rest.core.RestRequest.simpleRequest;
import static org.alfresco.rest.rm.community.model.fileplancomponents.FilePlanComponentType.CONTENT_TYPE;
import static org.alfresco.rest.rm.community.util.ParameterCheck.mandatoryObject;
import static org.alfresco.rest.rm.community.util.ParameterCheck.mandatoryString;
import static org.alfresco.rest.rm.community.util.PojoUtility.toJson;
import static org.apache.commons.lang3.StringUtils.EMPTY; import static org.apache.commons.lang3.StringUtils.EMPTY;
import static org.springframework.http.HttpMethod.DELETE; import static org.springframework.http.HttpMethod.DELETE;
import static org.springframework.http.HttpMethod.GET; import static org.springframework.http.HttpMethod.GET;
@@ -39,6 +33,13 @@ import static org.springframework.http.HttpMethod.POST;
import static org.springframework.http.HttpMethod.PUT; import static org.springframework.http.HttpMethod.PUT;
import static org.testng.Assert.fail; import static org.testng.Assert.fail;
import static org.alfresco.rest.core.RestRequest.requestWithBody;
import static org.alfresco.rest.core.RestRequest.simpleRequest;
import static org.alfresco.rest.rm.community.model.fileplancomponents.FilePlanComponentType.CONTENT_TYPE;
import static org.alfresco.rest.rm.community.util.ParameterCheck.mandatoryObject;
import static org.alfresco.rest.rm.community.util.ParameterCheck.mandatoryString;
import static org.alfresco.rest.rm.community.util.PojoUtility.toJson;
import java.io.File; import java.io.File;
import java.io.IOException; import java.io.IOException;
import java.util.Iterator; import java.util.Iterator;
@@ -66,7 +67,8 @@ public class RecordFolderAPI extends RMModelRequest
/** /**
* Constructor. * Constructor.
* *
* @param rmRestWrapper RM REST Wrapper * @param rmRestWrapper
* RM REST Wrapper
*/ */
public RecordFolderAPI(RMRestWrapper rmRestWrapper) public RecordFolderAPI(RMRestWrapper rmRestWrapper)
{ {
@@ -76,8 +78,10 @@ public class RecordFolderAPI extends RMModelRequest
/** /**
* Deletes a record folder. * Deletes a record folder.
* *
* @param recordFolderId The identifier of a record folder * @param recordFolderId
* @throws RuntimeException for the following cases: * The identifier of a record folder
* @throws RuntimeException
* for the following cases:
* <ul> * <ul>
* <li>{@code recordFolderId} is not a valid format</li> * <li>{@code recordFolderId} is not a valid format</li>
* <li>authentication fails</li> * <li>authentication fails</li>
@@ -93,8 +97,7 @@ public class RecordFolderAPI extends RMModelRequest
getRmRestWrapper().processEmptyModel(simpleRequest( getRmRestWrapper().processEmptyModel(simpleRequest(
DELETE, DELETE,
"record-folders/{recordFolderId}", "record-folders/{recordFolderId}",
recordFolderId recordFolderId));
));
} }
/** /**
@@ -110,10 +113,13 @@ public class RecordFolderAPI extends RMModelRequest
/** /**
* Gets a record folder. * Gets a record folder.
* *
* @param recordFolderId The identifier of a record folder * @param recordFolderId
* @param parameters The URL parameters to add * The identifier of a record folder
* @param parameters
* The URL parameters to add
* @return The {@link RecordFolder} for the given {@code recordFolderId} * @return The {@link RecordFolder} for the given {@code recordFolderId}
* @throws RuntimeException for the following cases: * @throws RuntimeException
* for the following cases:
* <ul> * <ul>
* <li>{@code recordFolderId} is not a valid format</li> * <li>{@code recordFolderId} is not a valid format</li>
* <li>authentication fails</li> * <li>authentication fails</li>
@@ -129,8 +135,7 @@ public class RecordFolderAPI extends RMModelRequest
GET, GET,
"record-folders/{recordFolderId}?{parameters}", "record-folders/{recordFolderId}?{parameters}",
recordFolderId, recordFolderId,
parameters parameters));
));
} }
/** /**
@@ -147,11 +152,16 @@ public class RecordFolderAPI extends RMModelRequest
/** /**
* Updates a record folder. * Updates a record folder.
* *
* @param recordFolderModel The record folder model which holds the information * @param recordFolderModel
* @param recordFolderId The identifier of a record folder * The record folder model which holds the information
* @param parameters The URL parameters to add * @param recordFolderId
* @param returns The updated {@link RecordFolder} * The identifier of a record folder
* @throws RuntimeException for the following cases: * @param parameters
* The URL parameters to add
* @param returns
* The updated {@link RecordFolder}
* @throws RuntimeException
* for the following cases:
* <ul> * <ul>
* <li>the update request is invalid or {@code recordFolderId} is not a valid format or {@code recordFolderModel} is invalid</li> * <li>the update request is invalid or {@code recordFolderId} is not a valid format or {@code recordFolderModel} is invalid</li>
* <li>authentication fails</li> * <li>authentication fails</li>
@@ -171,8 +181,7 @@ public class RecordFolderAPI extends RMModelRequest
toJson(recordFolderModel), toJson(recordFolderModel),
"record-folders/{recordFolderId}?{parameters}", "record-folders/{recordFolderId}?{parameters}",
recordFolderId, recordFolderId,
parameters parameters));
));
} }
/** /**
@@ -188,10 +197,13 @@ public class RecordFolderAPI extends RMModelRequest
/** /**
* Gets the children of a record folder. * Gets the children of a record folder.
* *
* @param recordFolderId The identifier of a record folder * @param recordFolderId
* @param parameters The URL parameters to add * The identifier of a record folder
* @param parameters
* The URL parameters to add
* @return The {@link RecordFolderCollection} for the given {@code recordFolderId} * @return The {@link RecordFolderCollection} for the given {@code recordFolderId}
* @throws RuntimeException for the following cases: * @throws RuntimeException
* for the following cases:
* <ul> * <ul>
* <li>authentication fails</li> * <li>authentication fails</li>
* <li>current user does not have permission to read {@code recordFolderId}</li> * <li>current user does not have permission to read {@code recordFolderId}</li>
@@ -206,8 +218,7 @@ public class RecordFolderAPI extends RMModelRequest
GET, GET,
"record-folders/{recordFolderId}/records?{parameters}", "record-folders/{recordFolderId}/records?{parameters}",
recordFolderId, recordFolderId,
parameters parameters));
));
} }
/** /**
@@ -224,11 +235,15 @@ public class RecordFolderAPI extends RMModelRequest
/** /**
* Create a record from file resource * Create a record from file resource
* *
* @param recordModel {@link Record} for electronic record to be created * @param recordModel
* @param recordContent {@link File} pointing to the content of the electronic record to be created * {@link Record} for electronic record to be created
* @param recordFolderId The identifier of a record folder * @param recordContent
* {@link File} pointing to the content of the electronic record to be created
* @param recordFolderId
* The identifier of a record folder
* @return newly created {@link Record} * @return newly created {@link Record}
* @throws RuntimeException for invalid recordModel JSON strings * @throws RuntimeException
* for invalid recordModel JSON strings
*/ */
public Record createRecord(Record recordModel, String recordFolderId, File recordContent) throws RuntimeException public Record createRecord(Record recordModel, String recordFolderId, File recordContent) throws RuntimeException
{ {
@@ -241,10 +256,7 @@ public class RecordFolderAPI extends RMModelRequest
fail("Only electronic records are supported"); fail("Only electronic records are supported");
} }
/* /* For file uploads nodeBodyCreate is ignored hence can't be used. Append all Record fields to the request. */
* For file uploads nodeBodyCreate is ignored hence can't be used. Append all Record fields
* to the request.
*/
RequestSpecBuilder builder = getRmRestWrapper().configureRequestSpec(); RequestSpecBuilder builder = getRmRestWrapper().configureRequestSpec();
JsonNode root; JsonNode root;
try try
@@ -271,11 +283,15 @@ public class RecordFolderAPI extends RMModelRequest
/** /**
* Creates a record in a record folder child, i.e. a record. * Creates a record in a record folder child, i.e. a record.
* *
* @param recordModel The record model which holds the information * @param recordModel
* @param recordFolderId The identifier of a record folder * The record model which holds the information
* @param parameters The URL parameters to add * @param recordFolderId
* The identifier of a record folder
* @param parameters
* The URL parameters to add
* @return The created {@link Record} * @return The created {@link Record}
* @throws RuntimeException for the following cases: * @throws RuntimeException
* for the following cases:
* <ul> * <ul>
* <li>{@code recordFolderId is not a valid format or {@code recordModel} is invalid</li> * <li>{@code recordFolderId is not a valid format or {@code recordModel} is invalid</li>
* <li>authentication fails</li> * <li>authentication fails</li>
@@ -294,7 +310,6 @@ public class RecordFolderAPI extends RMModelRequest
toJson(recordModel), toJson(recordModel),
"record-folders/{recordFolderId}/records?{parameters}", "record-folders/{recordFolderId}/records?{parameters}",
recordFolderId, recordFolderId,
parameters parameters));
));
} }
} }

View File

@@ -2,7 +2,7 @@
* #%L * #%L
* Alfresco Records Management Module * Alfresco Records Management Module
* %% * %%
* Copyright (C) 2005 - 2024 Alfresco Software Limited * Copyright (C) 2005 - 2025 Alfresco Software Limited
* %% * %%
* This file is part of the Alfresco software. * This file is part of the Alfresco software.
* - * -
@@ -26,25 +26,25 @@
*/ */
package org.alfresco.rest.rm.community.requests.gscore.api; package org.alfresco.rest.rm.community.requests.gscore.api;
import static org.alfresco.rest.core.RestRequest.requestWithBody;
import static org.alfresco.rest.core.RestRequest.simpleRequest;
import static org.alfresco.rest.rm.community.util.ParameterCheck.mandatoryObject;
import static org.alfresco.rest.rm.community.util.ParameterCheck.mandatoryString;
import static org.alfresco.rest.rm.community.util.PojoUtility.toJson;
import static org.apache.commons.lang3.StringUtils.EMPTY; import static org.apache.commons.lang3.StringUtils.EMPTY;
import static org.springframework.http.HttpMethod.DELETE; import static org.springframework.http.HttpMethod.DELETE;
import static org.springframework.http.HttpMethod.GET; import static org.springframework.http.HttpMethod.GET;
import static org.springframework.http.HttpMethod.POST; import static org.springframework.http.HttpMethod.POST;
import static org.springframework.http.HttpMethod.PUT; import static org.springframework.http.HttpMethod.PUT;
import static org.alfresco.rest.core.RestRequest.requestWithBody;
import static org.alfresco.rest.core.RestRequest.simpleRequest;
import static org.alfresco.rest.rm.community.util.ParameterCheck.mandatoryObject;
import static org.alfresco.rest.rm.community.util.ParameterCheck.mandatoryString;
import static org.alfresco.rest.rm.community.util.PojoUtility.toJson;
import io.restassured.response.ResponseBody;
import org.alfresco.rest.core.RMRestWrapper; import org.alfresco.rest.core.RMRestWrapper;
import org.alfresco.rest.rm.community.model.record.Record; import org.alfresco.rest.rm.community.model.record.Record;
import org.alfresco.rest.rm.community.model.record.RecordBodyFile; import org.alfresco.rest.rm.community.model.record.RecordBodyFile;
import org.alfresco.rest.rm.community.requests.RMModelRequest; import org.alfresco.rest.rm.community.requests.RMModelRequest;
import io.restassured.response.ResponseBody;
/** /**
* Records REST API Wrapper * Records REST API Wrapper
* *
@@ -54,7 +54,8 @@ import io.restassured.response.ResponseBody;
public class RecordsAPI extends RMModelRequest public class RecordsAPI extends RMModelRequest
{ {
/** /**
* @param rmRestWrapper RM REST Wrapper * @param rmRestWrapper
* RM REST Wrapper
*/ */
public RecordsAPI(RMRestWrapper rmRestWrapper) public RecordsAPI(RMRestWrapper rmRestWrapper)
{ {
@@ -64,9 +65,11 @@ public class RecordsAPI extends RMModelRequest
/** /**
* Get the content for the electronic record * Get the content for the electronic record
* *
* @param recordId The id of the electronic record * @param recordId
* The id of the electronic record
* @return {@link ResponseBody} representing content for the given record id * @return {@link ResponseBody} representing content for the given record id
* @throws RuntimeException for the following cases: * @throws RuntimeException
* for the following cases:
* <ul> * <ul>
* <li>{@code recordId} has no content</li> * <li>{@code recordId} has no content</li>
* <li>{@code recordId} is not a valid format, or is not a record</li> * <li>{@code recordId} is not a valid format, or is not a record</li>
@@ -87,10 +90,13 @@ public class RecordsAPI extends RMModelRequest
/** /**
* File the record recordId into file plan structure based on the location sent via the request body * File the record recordId into file plan structure based on the location sent via the request body
* *
* @param recordBodyFile The properties where to file the record * @param recordBodyFile
* @param recordId The id of the record to file * The properties where to file the record
* @param recordId
* The id of the record to file
* @return The {@link Record} with the given properties * @return The {@link Record} with the given properties
* @throws RuntimeException for the following cases: * @throws RuntimeException
* for the following cases:
* <ul> * <ul>
* <li>Invalid parameter: {@code recordBodyFile} is not a valid format,{@code recordId} is not a record</li> * <li>Invalid parameter: {@code recordBodyFile} is not a valid format,{@code recordId} is not a record</li>
* <li>authentication fails</li> * <li>authentication fails</li>
@@ -112,10 +118,13 @@ public class RecordsAPI extends RMModelRequest
/** /**
* File the record recordId into file plan structure based on the location sent via the request body * File the record recordId into file plan structure based on the location sent via the request body
* *
* @param recordBodyFile The properties where to file the record * @param recordBodyFile
* @param recordId The id of the record to file * The properties where to file the record
* @param recordId
* The id of the record to file
* @return The {@link Record} with the given properties * @return The {@link Record} with the given properties
* @throws RuntimeException for the following cases: * @throws RuntimeException
* for the following cases:
* <ul> * <ul>
* <li>Invalid parameter: {@code recordBodyFile} is not a valid format,{@code recordId} is not a record</li> * <li>Invalid parameter: {@code recordBodyFile} is not a valid format,{@code recordId} is not a record</li>
* <li>authentication fails</li> * <li>authentication fails</li>
@@ -136,8 +145,7 @@ public class RecordsAPI extends RMModelRequest
toJson(recordBodyFile), toJson(recordBodyFile),
"/records/{recordId}/file?{parameters}", "/records/{recordId}/file?{parameters}",
recordId, recordId,
parameters parameters));
));
} }
/** /**
@@ -153,9 +161,11 @@ public class RecordsAPI extends RMModelRequest
/** /**
* Complete the record recordId * Complete the record recordId
* *
* @param recordId The id of the record to complete * @param recordId
* The id of the record to complete
* @return The completed {@link Record} with the given properties * @return The completed {@link Record} with the given properties
* @throws RuntimeException for the following cases: * @throws RuntimeException
* for the following cases:
* <ul> * <ul>
* <li>Invalid parameter: {@code recordId} is not a record</li> * <li>Invalid parameter: {@code recordId} is not a record</li>
* <li>authentication fails</li> * <li>authentication fails</li>
@@ -173,14 +183,16 @@ public class RecordsAPI extends RMModelRequest
POST, POST,
"/records/{recordId}/complete?{parameters}", "/records/{recordId}/complete?{parameters}",
recordId, recordId,
parameters parameters));
));
} }
/** /**
* Deletes a record. * Deletes a record.
* *
* @param recordId The identifier of a record * @param recordId
* @throws RuntimeException for the following cases: * The identifier of a record
* @throws RuntimeException
* for the following cases:
* <ul> * <ul>
* <li>{@code recordId} is not a valid format</li> * <li>{@code recordId} is not a valid format</li>
* <li>authentication fails</li> * <li>authentication fails</li>
@@ -196,8 +208,7 @@ public class RecordsAPI extends RMModelRequest
getRmRestWrapper().processEmptyModel(simpleRequest( getRmRestWrapper().processEmptyModel(simpleRequest(
DELETE, DELETE,
"records/{recordId}", "records/{recordId}",
recordId recordId));
));
} }
/** /**
@@ -213,10 +224,13 @@ public class RecordsAPI extends RMModelRequest
/** /**
* Gets a record. * Gets a record.
* *
* @param recordId The identifier of a record * @param recordId
* @param parameters The URL parameters to add * The identifier of a record
* @param parameters
* The URL parameters to add
* @return The {@link Record} for the given {@code recordId} * @return The {@link Record} for the given {@code recordId}
* @throws RuntimeException for the following cases: * @throws RuntimeException
* for the following cases:
* <ul> * <ul>
* <li>{@code recordId} is not a valid format</li> * <li>{@code recordId} is not a valid format</li>
* <li>authentication fails</li> * <li>authentication fails</li>
@@ -232,8 +246,7 @@ public class RecordsAPI extends RMModelRequest
GET, GET,
"records/{recordId}?{parameters}", "records/{recordId}?{parameters}",
recordId, recordId,
parameters parameters));
));
} }
/** /**
@@ -250,11 +263,15 @@ public class RecordsAPI extends RMModelRequest
/** /**
* Updates a record. * Updates a record.
* *
* @param recordModel The record model which holds the information * @param recordModel
* @param recordId The identifier of a record * The record model which holds the information
* @param parameters The URL parameters to add * @param recordId
* The identifier of a record
* @param parameters
* The URL parameters to add
* @return The updated {@link Record} * @return The updated {@link Record}
* @throws RuntimeException for the following cases: * @throws RuntimeException
* for the following cases:
* <ul> * <ul>
* <li>the update request is invalid or {@code recordId} is not a valid format or {@code recordModel} is invalid</li> * <li>the update request is invalid or {@code recordId} is not a valid format or {@code recordModel} is invalid</li>
* <li>authentication fails</li> * <li>authentication fails</li>
@@ -274,7 +291,6 @@ public class RecordsAPI extends RMModelRequest
toJson(recordModel), toJson(recordModel),
"records/{recordId}?{parameters}", "records/{recordId}?{parameters}",
recordId, recordId,
parameters parameters));
));
} }
} }

View File

@@ -2,7 +2,7 @@
* #%L * #%L
* Alfresco Records Management Module * Alfresco Records Management Module
* %% * %%
* Copyright (C) 2005 - 2024 Alfresco Software Limited * Copyright (C) 2005 - 2025 Alfresco Software Limited
* %% * %%
* This file is part of the Alfresco software. * This file is part of the Alfresco software.
* - * -
@@ -26,21 +26,22 @@
*/ */
package org.alfresco.rest.rm.community.requests.gscore.api; package org.alfresco.rest.rm.community.requests.gscore.api;
import org.alfresco.rest.core.RMRestWrapper; import static org.apache.commons.lang3.StringUtils.EMPTY;
import org.alfresco.rest.rm.community.model.retentionschedule.RetentionSchedule; import static org.springframework.http.HttpMethod.GET;
import org.alfresco.rest.rm.community.model.retentionschedule.RetentionScheduleActionDefinition; import static org.springframework.http.HttpMethod.POST;
import org.alfresco.rest.rm.community.model.retentionschedule.RetentionScheduleCollection;
import org.alfresco.rest.rm.community.model.retentionschedule.RetentionScheduleStepCollection;
import org.alfresco.rest.rm.community.requests.RMModelRequest;
import static org.alfresco.rest.core.RestRequest.requestWithBody; import static org.alfresco.rest.core.RestRequest.requestWithBody;
import static org.alfresco.rest.core.RestRequest.simpleRequest; import static org.alfresco.rest.core.RestRequest.simpleRequest;
import static org.alfresco.rest.rm.community.util.ParameterCheck.mandatoryObject; import static org.alfresco.rest.rm.community.util.ParameterCheck.mandatoryObject;
import static org.alfresco.rest.rm.community.util.ParameterCheck.mandatoryString; import static org.alfresco.rest.rm.community.util.ParameterCheck.mandatoryString;
import static org.alfresco.rest.rm.community.util.PojoUtility.toJson; import static org.alfresco.rest.rm.community.util.PojoUtility.toJson;
import static org.apache.commons.lang3.StringUtils.EMPTY;
import static org.springframework.http.HttpMethod.GET; import org.alfresco.rest.core.RMRestWrapper;
import static org.springframework.http.HttpMethod.POST; import org.alfresco.rest.rm.community.model.retentionschedule.RetentionSchedule;
import org.alfresco.rest.rm.community.model.retentionschedule.RetentionScheduleActionDefinition;
import org.alfresco.rest.rm.community.model.retentionschedule.RetentionScheduleCollection;
import org.alfresco.rest.rm.community.model.retentionschedule.RetentionScheduleStepCollection;
import org.alfresco.rest.rm.community.requests.RMModelRequest;
public class RetentionScheduleAPI extends RMModelRequest public class RetentionScheduleAPI extends RMModelRequest
{ {
@@ -53,15 +54,18 @@ public class RetentionScheduleAPI extends RMModelRequest
super(rmRestWrapper); super(rmRestWrapper);
} }
/** /**
* Creates a retention schedule. * Creates a retention schedule.
* *
* @param retentionScheduleModel The retentionSchedule model * @param retentionScheduleModel
* @param recordCategoryId The identifier of a record category * The retentionSchedule model
* @param parameters The URL parameters to add * @param recordCategoryId
* The identifier of a record category
* @param parameters
* The URL parameters to add
* @return The created {@link RetentionSchedule} * @return The created {@link RetentionSchedule}
* @throws RuntimeException for the following cases: * @throws RuntimeException
* for the following cases:
* <ul> * <ul>
* <li>{@code recordCategoryId} is not a valid format or {@code recordCategoryId} is invalid</li> * <li>{@code recordCategoryId} is not a valid format or {@code recordCategoryId} is invalid</li>
* <li>authentication fails</li> * <li>authentication fails</li>
@@ -80,8 +84,7 @@ public class RetentionScheduleAPI extends RMModelRequest
toJson(retentionScheduleModel), toJson(retentionScheduleModel),
"record-categories/{recordCategoryId}/retention-schedules", "record-categories/{recordCategoryId}/retention-schedules",
recordCategoryId, recordCategoryId,
parameters parameters));
));
} }
/** /**
@@ -95,10 +98,13 @@ public class RetentionScheduleAPI extends RMModelRequest
/** /**
* Gets the retentionSchedule of a record category. * Gets the retentionSchedule of a record category.
* *
* @param recordCategoryId The identifier of a record category * @param recordCategoryId
* @param parameters The URL parameters to add * The identifier of a record category
* @param parameters
* The URL parameters to add
* @return The {@link RetentionSchedule} for the given {@code recordCategoryId} * @return The {@link RetentionSchedule} for the given {@code recordCategoryId}
* @throws RuntimeException for the following cases: * @throws RuntimeException
* for the following cases:
* <ul> * <ul>
* <li>authentication fails</li> * <li>authentication fails</li>
* <li>current user does not have permission to read {@code recordCategoryId}</li> * <li>current user does not have permission to read {@code recordCategoryId}</li>
@@ -113,8 +119,7 @@ public class RetentionScheduleAPI extends RMModelRequest
GET, GET,
"record-categories/{recordCategoryId}/retention-schedules?{parameters}", "record-categories/{recordCategoryId}/retention-schedules?{parameters}",
recordCategoryId, recordCategoryId,
parameters parameters));
));
} }
/** /**
@@ -128,11 +133,15 @@ public class RetentionScheduleAPI extends RMModelRequest
/** /**
* Creates a step in the retention schedule. * Creates a step in the retention schedule.
* *
* @param retentionScheduleActionDefinition The retentionScheduleActionDefinition model * @param retentionScheduleActionDefinition
* @param retentionScheduleId The identifier of a retention schedule id * The retentionScheduleActionDefinition model
* @param parameters The URL parameters to add * @param retentionScheduleId
* The identifier of a retention schedule id
* @param parameters
* The URL parameters to add
* @return The created {@link RetentionScheduleActionDefinition} * @return The created {@link RetentionScheduleActionDefinition}
* @throws RuntimeException for the following cases: * @throws RuntimeException
* for the following cases:
* <ul> * <ul>
* <li>{@code retentionScheduleId} is not a valid format or {@code retentionScheduleId} is invalid</li> * <li>{@code retentionScheduleId} is not a valid format or {@code retentionScheduleId} is invalid</li>
* <li>authentication fails</li> * <li>authentication fails</li>
@@ -151,8 +160,7 @@ public class RetentionScheduleAPI extends RMModelRequest
toJson(retentionScheduleActionDefinition), toJson(retentionScheduleActionDefinition),
"retention-schedules/{retentionScheduleId}/retention-steps", "retention-schedules/{retentionScheduleId}/retention-steps",
retentionScheduleId, retentionScheduleId,
parameters parameters));
));
} }
/** /**
@@ -166,10 +174,13 @@ public class RetentionScheduleAPI extends RMModelRequest
/** /**
* Gets the retentionSchedule of a record category. * Gets the retentionSchedule of a record category.
* *
* @param retentionScheduleId The identifier of a record category * @param retentionScheduleId
* @param parameters The URL parameters to add * The identifier of a record category
* @param parameters
* The URL parameters to add
* @return The {@link RetentionScheduleActionDefinition} for the given {@code recordCategoryId} * @return The {@link RetentionScheduleActionDefinition} for the given {@code recordCategoryId}
* @throws RuntimeException for the following cases: * @throws RuntimeException
* for the following cases:
* <ul> * <ul>
* <li>authentication fails</li> * <li>authentication fails</li>
* <li>current user does not have permission to read {@code recordCategoryId}</li> * <li>current user does not have permission to read {@code recordCategoryId}</li>
@@ -184,8 +195,7 @@ public class RetentionScheduleAPI extends RMModelRequest
GET, GET,
"retention-schedules/{retentionScheduleId}/retention-steps?{parameters}", "retention-schedules/{retentionScheduleId}/retention-steps?{parameters}",
retentionScheduleId, retentionScheduleId,
parameters parameters));
));
} }
/** /**

View File

@@ -2,7 +2,7 @@
* #%L * #%L
* Alfresco Records Management Module * Alfresco Records Management Module
* %% * %%
* Copyright (C) 2005 - 2024 Alfresco Software Limited * Copyright (C) 2005 - 2025 Alfresco Software Limited
* %% * %%
* This file is part of the Alfresco software. * This file is part of the Alfresco software.
* - * -
@@ -27,11 +27,12 @@
package org.alfresco.rest.rm.community.requests.gscore.api; package org.alfresco.rest.rm.community.requests.gscore.api;
import static org.alfresco.rest.core.RestRequest.simpleRequest;
import static org.alfresco.rest.rm.community.util.ParameterCheck.mandatoryString;
import static org.apache.commons.lang3.StringUtils.EMPTY; import static org.apache.commons.lang3.StringUtils.EMPTY;
import static org.springframework.http.HttpMethod.GET; import static org.springframework.http.HttpMethod.GET;
import static org.alfresco.rest.core.RestRequest.simpleRequest;
import static org.alfresco.rest.rm.community.util.ParameterCheck.mandatoryString;
import org.alfresco.rest.core.RMRestWrapper; import org.alfresco.rest.core.RMRestWrapper;
import org.alfresco.rest.rm.community.model.transfer.Transfer; import org.alfresco.rest.rm.community.model.transfer.Transfer;
import org.alfresco.rest.rm.community.model.transfer.TransferChildCollection; import org.alfresco.rest.rm.community.model.transfer.TransferChildCollection;
@@ -46,7 +47,8 @@ import org.alfresco.rest.rm.community.requests.RMModelRequest;
public class TransferAPI extends RMModelRequest public class TransferAPI extends RMModelRequest
{ {
/** /**
* @param rmRestWrapper RM REST Wrapper * @param rmRestWrapper
* RM REST Wrapper
*/ */
public TransferAPI(RMRestWrapper rmRestWrapper) public TransferAPI(RMRestWrapper rmRestWrapper)
{ {
@@ -66,10 +68,13 @@ public class TransferAPI extends RMModelRequest
/** /**
* Gets a transfer. * Gets a transfer.
* *
* @param transferId The identifier of a transfer * @param transferId
* @param parameters The URL parameters to add * The identifier of a transfer
* @param parameters
* The URL parameters to add
* @return The {@link Transfer} for the given {@code transferId} * @return The {@link Transfer} for the given {@code transferId}
* @throws RuntimeException for the following cases: * @throws RuntimeException
* for the following cases:
* <ul> * <ul>
* <li>{@code transferId} is not a valid format</li> * <li>{@code transferId} is not a valid format</li>
* <li>authentication fails</li> * <li>authentication fails</li>
@@ -85,9 +90,9 @@ public class TransferAPI extends RMModelRequest
GET, GET,
"/transfers/{transferId}?{parameters}", "/transfers/{transferId}?{parameters}",
transferId, transferId,
parameters parameters));
));
} }
/** /**
* see {@link #getTransfersChildren(String, String)} * see {@link #getTransfersChildren(String, String)}
*/ */
@@ -101,10 +106,13 @@ public class TransferAPI extends RMModelRequest
/** /**
* Gets the children (record folder or record) of a transfer. * Gets the children (record folder or record) of a transfer.
* *
* @param transferId The identifier of a transfer * @param transferId
* @param parameters The URL parameters to add * The identifier of a transfer
* @param parameters
* The URL parameters to add
* @return The {@link TransferChildCollection} for the given {@code transferId} * @return The {@link TransferChildCollection} for the given {@code transferId}
* @throws RuntimeException for the following cases: * @throws RuntimeException
* for the following cases:
* <ul> * <ul>
* <li>authentication fails</li> * <li>authentication fails</li>
* <li>current user does not have permission to read {@code transferId}</li> * <li>current user does not have permission to read {@code transferId}</li>
@@ -119,7 +127,6 @@ public class TransferAPI extends RMModelRequest
GET, GET,
"transfers/{filePlanId}/children?{parameters}", "transfers/{filePlanId}/children?{parameters}",
transferId, transferId,
parameters parameters));
));
} }
} }

View File

@@ -2,7 +2,7 @@
* #%L * #%L
* Alfresco Records Management Module * Alfresco Records Management Module
* %% * %%
* Copyright (C) 2005 - 2024 Alfresco Software Limited * Copyright (C) 2005 - 2025 Alfresco Software Limited
* %% * %%
* This file is part of the Alfresco software. * This file is part of the Alfresco software.
* - * -
@@ -27,14 +27,15 @@
package org.alfresco.rest.rm.community.requests.gscore.api; package org.alfresco.rest.rm.community.requests.gscore.api;
import static org.apache.commons.lang3.StringUtils.EMPTY;
import static org.springframework.http.HttpMethod.GET;
import static org.springframework.http.HttpMethod.PUT;
import static org.alfresco.rest.core.RestRequest.requestWithBody; import static org.alfresco.rest.core.RestRequest.requestWithBody;
import static org.alfresco.rest.core.RestRequest.simpleRequest; import static org.alfresco.rest.core.RestRequest.simpleRequest;
import static org.alfresco.rest.rm.community.util.ParameterCheck.mandatoryObject; import static org.alfresco.rest.rm.community.util.ParameterCheck.mandatoryObject;
import static org.alfresco.rest.rm.community.util.ParameterCheck.mandatoryString; import static org.alfresco.rest.rm.community.util.ParameterCheck.mandatoryString;
import static org.alfresco.rest.rm.community.util.PojoUtility.toJson; import static org.alfresco.rest.rm.community.util.PojoUtility.toJson;
import static org.apache.commons.lang3.StringUtils.EMPTY;
import static org.springframework.http.HttpMethod.GET;
import static org.springframework.http.HttpMethod.PUT;
import org.alfresco.rest.core.RMRestWrapper; import org.alfresco.rest.core.RMRestWrapper;
import org.alfresco.rest.rm.community.model.transfer.TransferCollection; import org.alfresco.rest.rm.community.model.transfer.TransferCollection;
@@ -50,7 +51,8 @@ import org.alfresco.rest.rm.community.requests.RMModelRequest;
public class TransferContainerAPI extends RMModelRequest public class TransferContainerAPI extends RMModelRequest
{ {
/** /**
* @param rmRestWrapper RM REST Wrapper * @param rmRestWrapper
* RM REST Wrapper
*/ */
public TransferContainerAPI(RMRestWrapper rmRestWrapper) public TransferContainerAPI(RMRestWrapper rmRestWrapper)
{ {
@@ -70,10 +72,13 @@ public class TransferContainerAPI extends RMModelRequest
/** /**
* Gets a transfer container. * Gets a transfer container.
* *
* @param transferContainerId The identifier of a transfer container * @param transferContainerId
* @param parameters The URL parameters to add * The identifier of a transfer container
* @param parameters
* The URL parameters to add
* @return The {@link TransferContainer} for the given {@code transferContainerId} * @return The {@link TransferContainer} for the given {@code transferContainerId}
* @throws RuntimeException for the following cases: * @throws RuntimeException
* for the following cases:
* <ul> * <ul>
* <li>{@code transferContainerId} is not a valid format</li> * <li>{@code transferContainerId} is not a valid format</li>
* <li>authentication fails</li> * <li>authentication fails</li>
@@ -89,8 +94,7 @@ public class TransferContainerAPI extends RMModelRequest
GET, GET,
"/transfer-containers/{transferContainerId}?{parameters}", "/transfer-containers/{transferContainerId}?{parameters}",
transferContainerId, transferContainerId,
parameters parameters));
));
} }
/** /**
@@ -107,11 +111,16 @@ public class TransferContainerAPI extends RMModelRequest
/** /**
* Updates a transfer container. * Updates a transfer container.
* *
* @param transferContainerModel The transfer container model which holds the information * @param transferContainerModel
* @param transferContainerId The identifier of a transfer container * The transfer container model which holds the information
* @param parameters The URL parameters to add * @param transferContainerId
* @param returns The updated {@link TransferContainer} * The identifier of a transfer container
* @throws RuntimeException for the following cases: * @param parameters
* The URL parameters to add
* @param returns
* The updated {@link TransferContainer}
* @throws RuntimeException
* for the following cases:
* <ul> * <ul>
* <li>the update request is invalid or {@code transferContainerId} is not a valid format or {@code transferContainerModel} is invalid</li> * <li>the update request is invalid or {@code transferContainerId} is not a valid format or {@code transferContainerModel} is invalid</li>
* <li>authentication fails</li> * <li>authentication fails</li>
@@ -131,8 +140,7 @@ public class TransferContainerAPI extends RMModelRequest
toJson(transferContainerModel), toJson(transferContainerModel),
"transfer-containers/{transferContainerId}?{parameters}", "transfer-containers/{transferContainerId}?{parameters}",
transferContainerId, transferContainerId,
parameters parameters));
));
} }
/** /**
@@ -148,10 +156,13 @@ public class TransferContainerAPI extends RMModelRequest
/** /**
* Gets the children (transfers) of a transfer container. * Gets the children (transfers) of a transfer container.
* *
* @param transferContainerId The identifier of a transfer container * @param transferContainerId
* @param parameters The URL parameters to add * The identifier of a transfer container
* @param parameters
* The URL parameters to add
* @return The {@link TransferCollection} for the given {@code transferContainerId} * @return The {@link TransferCollection} for the given {@code transferContainerId}
* @throws RuntimeException for the following cases: * @throws RuntimeException
* for the following cases:
* <ul> * <ul>
* <li>authentication fails</li> * <li>authentication fails</li>
* <li>current user does not have permission to read {@code transferContainerId}</li> * <li>current user does not have permission to read {@code transferContainerId}</li>
@@ -166,7 +177,6 @@ public class TransferContainerAPI extends RMModelRequest
GET, GET,
"transfer-containers/{filePlanId}/transfers?{parameters}", "transfer-containers/{filePlanId}/transfers?{parameters}",
transferContainerId, transferContainerId,
parameters parameters));
));
} }
} }

View File

@@ -2,7 +2,7 @@
* #%L * #%L
* Alfresco Records Management Module * Alfresco Records Management Module
* %% * %%
* Copyright (C) 2005 - 2024 Alfresco Software Limited * Copyright (C) 2005 - 2025 Alfresco Software Limited
* %% * %%
* This file is part of the Alfresco software. * This file is part of the Alfresco software.
* - * -
@@ -26,17 +26,18 @@
*/ */
package org.alfresco.rest.rm.community.requests.gscore.api; package org.alfresco.rest.rm.community.requests.gscore.api;
import static org.apache.commons.lang3.StringUtils.EMPTY;
import static org.springframework.http.HttpMethod.GET;
import static org.springframework.http.HttpMethod.POST;
import static org.springframework.http.HttpMethod.PUT;
import static org.testng.Assert.fail;
import static org.alfresco.rest.core.RestRequest.requestWithBody; import static org.alfresco.rest.core.RestRequest.requestWithBody;
import static org.alfresco.rest.core.RestRequest.simpleRequest; import static org.alfresco.rest.core.RestRequest.simpleRequest;
import static org.alfresco.rest.rm.community.model.fileplancomponents.FilePlanComponentType.CONTENT_TYPE; import static org.alfresco.rest.rm.community.model.fileplancomponents.FilePlanComponentType.CONTENT_TYPE;
import static org.alfresco.rest.rm.community.util.ParameterCheck.mandatoryObject; import static org.alfresco.rest.rm.community.util.ParameterCheck.mandatoryObject;
import static org.alfresco.rest.rm.community.util.ParameterCheck.mandatoryString; import static org.alfresco.rest.rm.community.util.ParameterCheck.mandatoryString;
import static org.alfresco.rest.rm.community.util.PojoUtility.toJson; import static org.alfresco.rest.rm.community.util.PojoUtility.toJson;
import static org.apache.commons.lang3.StringUtils.EMPTY;
import static org.springframework.http.HttpMethod.GET;
import static org.springframework.http.HttpMethod.POST;
import static org.springframework.http.HttpMethod.PUT;
import static org.testng.Assert.fail;
import java.io.File; import java.io.File;
import java.io.IOException; import java.io.IOException;
@@ -44,7 +45,6 @@ import java.util.Iterator;
import com.fasterxml.jackson.databind.JsonNode; import com.fasterxml.jackson.databind.JsonNode;
import com.fasterxml.jackson.databind.ObjectMapper; import com.fasterxml.jackson.databind.ObjectMapper;
import io.restassured.builder.RequestSpecBuilder; import io.restassured.builder.RequestSpecBuilder;
import io.restassured.http.ContentType; import io.restassured.http.ContentType;
@@ -65,7 +65,8 @@ import org.alfresco.rest.rm.community.util.UnfiledContainerChildMixin;
public class UnfiledContainerAPI extends RMModelRequest public class UnfiledContainerAPI extends RMModelRequest
{ {
/** /**
* @param rmRestWrapper RM REST Wrapper * @param rmRestWrapper
* RM REST Wrapper
*/ */
public UnfiledContainerAPI(RMRestWrapper rmRestWrapper) public UnfiledContainerAPI(RMRestWrapper rmRestWrapper)
{ {
@@ -85,10 +86,13 @@ public class UnfiledContainerAPI extends RMModelRequest
/** /**
* Gets an unfiled record container. * Gets an unfiled record container.
* *
* @param unfiledContainerId The identifier of a unfiled record container * @param unfiledContainerId
* @param parameters The URL parameters to add * The identifier of a unfiled record container
* @param parameters
* The URL parameters to add
* @return The {@link UnfiledContainer} for the given {@code unfiledContainerId} * @return The {@link UnfiledContainer} for the given {@code unfiledContainerId}
* @throws RuntimeException for the following cases: * @throws RuntimeException
* for the following cases:
* <ul> * <ul>
* <li>{@code unfiledContainerId} is not a valid format</li> * <li>{@code unfiledContainerId} is not a valid format</li>
* <li>authentication fails</li> * <li>authentication fails</li>
@@ -104,8 +108,7 @@ public class UnfiledContainerAPI extends RMModelRequest
GET, GET,
"unfiled-containers/{unfiledContainerId}?{parameters}", "unfiled-containers/{unfiledContainerId}?{parameters}",
unfiledContainerId, unfiledContainerId,
parameters parameters));
));
} }
/** /**
@@ -121,10 +124,13 @@ public class UnfiledContainerAPI extends RMModelRequest
/** /**
* Gets the children of an unfiled records container * Gets the children of an unfiled records container
* *
* @param unfiledContainerId The identifier of an unfiled records container * @param unfiledContainerId
* @param parameters The URL parameters to add * The identifier of an unfiled records container
* @param parameters
* The URL parameters to add
* @return The {@link UnfiledContainerChildCollection} for the given {@code unfiledContainerId} * @return The {@link UnfiledContainerChildCollection} for the given {@code unfiledContainerId}
* @throws RuntimeException for the following cases: * @throws RuntimeException
* for the following cases:
* <ul> * <ul>
* <li>authentication fails</li> * <li>authentication fails</li>
* <li>current user does not have permission to read {@code unfiledContainerId}</li> * <li>current user does not have permission to read {@code unfiledContainerId}</li>
@@ -139,8 +145,7 @@ public class UnfiledContainerAPI extends RMModelRequest
GET, GET,
"unfiled-containers/{unfiledContainerId}/children?{parameters}", "unfiled-containers/{unfiledContainerId}/children?{parameters}",
unfiledContainerId, unfiledContainerId,
parameters parameters));
));
} }
/** /**
@@ -157,11 +162,15 @@ public class UnfiledContainerAPI extends RMModelRequest
/** /**
* Creates an unfiled container child. Can be a record or an unfiled record folder. * Creates an unfiled container child. Can be a record or an unfiled record folder.
* *
* @param unfiledContainerChildModel The unfiled container child model which holds the information * @param unfiledContainerChildModel
* @param unfiledContainerId The identifier of an unfiled container * The unfiled container child model which holds the information
* @param parameters The URL parameters to add * @param unfiledContainerId
* The identifier of an unfiled container
* @param parameters
* The URL parameters to add
* @return The created {@link UnfiledContainerChild} * @return The created {@link UnfiledContainerChild}
* @throws RuntimeException for the following cases: * @throws RuntimeException
* for the following cases:
* <ul> * <ul>
* <li>{@code unfiledContainerId} is not a valid format or {@code unfiledContainerChildModel} is invalid</li> * <li>{@code unfiledContainerId} is not a valid format or {@code unfiledContainerChildModel} is invalid</li>
* <li>authentication fails</li> * <li>authentication fails</li>
@@ -181,18 +190,21 @@ public class UnfiledContainerAPI extends RMModelRequest
toJson(unfiledContainerChildModel), toJson(unfiledContainerChildModel),
"unfiled-containers/{unfiledContainerId}/children?{parameters}", "unfiled-containers/{unfiledContainerId}/children?{parameters}",
unfiledContainerId, unfiledContainerId,
parameters parameters));
));
} }
/** /**
* Create a record from file resource * Create a record from file resource
* *
* @param unfiledContainerChildModel {@link UnfiledContainerChild} for electronic record to be created * @param unfiledContainerChildModel
* @param unfiledContainerChildContent {@link File} pointing to the content of the electronic record to be created * {@link UnfiledContainerChild} for electronic record to be created
* @param unfiledContainerId The identifier of a unfiled container * @param unfiledContainerChildContent
* {@link File} pointing to the content of the electronic record to be created
* @param unfiledContainerId
* The identifier of a unfiled container
* @return newly created {@link UnfiledContainerChild} * @return newly created {@link UnfiledContainerChild}
* @throws RuntimeException for invalid recordModel JSON strings * @throws RuntimeException
* for invalid recordModel JSON strings
*/ */
public UnfiledContainerChild uploadRecord(UnfiledContainerChild unfiledContainerChildModel, String unfiledContainerId, File unfiledContainerChildContent) public UnfiledContainerChild uploadRecord(UnfiledContainerChild unfiledContainerChildModel, String unfiledContainerId, File unfiledContainerChildContent)
{ {
@@ -205,10 +217,7 @@ public class UnfiledContainerAPI extends RMModelRequest
fail("Only electronic records are supported"); fail("Only electronic records are supported");
} }
/* /* For file uploads nodeBodyCreate is ignored hence can't be used. Append all Record fields to the request. */
* For file uploads nodeBodyCreate is ignored hence can't be used. Append all Record fields
* to the request.
*/
RequestSpecBuilder builder = getRmRestWrapper().configureRequestSpec(); RequestSpecBuilder builder = getRmRestWrapper().configureRequestSpec();
JsonNode root; JsonNode root;
try try
@@ -246,11 +255,16 @@ public class UnfiledContainerAPI extends RMModelRequest
/** /**
* Updates an unfiled record container * Updates an unfiled record container
* *
* @param unfiledContainerModel The unfiled record container model which holds the information * @param unfiledContainerModel
* @param unfiledContainerId The identifier of an unfiled record container * The unfiled record container model which holds the information
* @param parameters The URL parameters to add * @param unfiledContainerId
* @param returns The updated {@link UnfiledContainer} * The identifier of an unfiled record container
* @throws RuntimeException for the following cases: * @param parameters
* The URL parameters to add
* @param returns
* The updated {@link UnfiledContainer}
* @throws RuntimeException
* for the following cases:
* <ul> * <ul>
* <li>the update request is invalid or {@code unfiledContainerId} is not a valid format or {@code unfiledContainerModel} is invalid</li> * <li>the update request is invalid or {@code unfiledContainerId} is not a valid format or {@code unfiledContainerModel} is invalid</li>
* <li>authentication fails</li> * <li>authentication fails</li>
@@ -270,8 +284,7 @@ public class UnfiledContainerAPI extends RMModelRequest
toJson(unfiledContainerModel), toJson(unfiledContainerModel),
"unfiled-containers/{unfiledContainerId}?{parameters}", "unfiled-containers/{unfiledContainerId}?{parameters}",
unfiledContainerId, unfiledContainerId,
parameters parameters));
));
} }
} }

Some files were not shown because too many files have changed in this diff Show More