Merge branch 'xperimental/RM-2812_MarkPublicAPIs' into 'master'

Xperimental/rm 2812 Mark Public APIs First attempt to mark classes that should be part of the public API with \@AlfrescoPublicAPI. I have also added a couple of \@deprecated annotations to classes where I thought it made sense, and added comments to classes that I wanted to add to the public API but couldn't (due to their contract being dependent on non-public API classes). See merge request !138
2025-07-31 17:39:05 +00:00 · 2016-04-27 09:23:58 +01:00
parent 6629b10b8a c28264c8c0
commit 3314b1737c
63 changed files with 473 additions and 338 deletions
--- a/rm-community/rm-community-repo/source/compatibility/org/alfresco/module/org_alfresco_module_rm/audit/RecordsManagementAuditServiceDeprecated.java
+++ b/rm-community/rm-community-repo/source/compatibility/org/alfresco/module/org_alfresco_module_rm/audit/RecordsManagementAuditServiceDeprecated.java
@@ -31,6 +31,7 @@ import java.io.Serializable;
 import java.util.Date;
 import java.util.Map;

+import org.alfresco.api.AlfrescoPublicApi;
 import org.alfresco.module.org_alfresco_module_rm.action.RecordsManagementAction;
 import org.alfresco.service.cmr.repository.NodeRef;

@@ -39,7 +40,9 @@ import org.alfresco.service.cmr.repository.NodeRef;
 *
 * @author Roy Wetherall
 * @since 2.1
+ * @deprecated as of 2.1, see {@link RecordsManagementAuditService}.
 */
+@AlfrescoPublicApi
 public interface RecordsManagementAuditServiceDeprecated
 {
    /**
--- a/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/action/RecordsManagementAction.java
+++ b/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/action/RecordsManagementAction.java
@@ -30,6 +30,7 @@ package org.alfresco.module.org_alfresco_module_rm.action;
 import java.io.Serializable;
 import java.util.Map;

+import org.alfresco.api.AlfrescoPublicApi;
 import org.alfresco.service.cmr.repository.NodeRef;

 /**
@@ -37,6 +38,7 @@ import org.alfresco.service.cmr.repository.NodeRef;
 *
 * @author Roy Wetherall
 */
+@AlfrescoPublicApi
 public interface RecordsManagementAction
 {
    /**
--- a/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/action/RecordsManagementActionCondition.java
+++ b/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/action/RecordsManagementActionCondition.java
@@ -27,12 +27,15 @@

 package org.alfresco.module.org_alfresco_module_rm.action;

+import org.alfresco.api.AlfrescoPublicApi;
+
 /**
 * Record Management Action Condition
 *
 * @author Roy Wetherall
 * @since 2.1
 */
+@AlfrescoPublicApi
 public interface RecordsManagementActionCondition
 {
    /**
--- a/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/action/RecordsManagementActionConditionDefinition.java
+++ b/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/action/RecordsManagementActionConditionDefinition.java
@@ -27,6 +27,7 @@

 package org.alfresco.module.org_alfresco_module_rm.action;

+import org.alfresco.api.AlfrescoPublicApi;
 import org.alfresco.service.cmr.action.ActionConditionDefinition;

 /**
@@ -37,6 +38,7 @@ import org.alfresco.service.cmr.action.ActionConditionDefinition;
 * @author Roy Wetherall
 * @since 2.1
 */
+@AlfrescoPublicApi
 public interface RecordsManagementActionConditionDefinition extends ActionConditionDefinition
 {
 }
--- a/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/action/RecordsManagementActionDefinition.java
+++ b/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/action/RecordsManagementActionDefinition.java
@@ -29,6 +29,7 @@ package org.alfresco.module.org_alfresco_module_rm.action;

 import java.util.Set;

+import org.alfresco.api.AlfrescoPublicApi;
 import org.alfresco.module.org_alfresco_module_rm.fileplan.FilePlanComponentKind;
 import org.alfresco.service.cmr.action.ActionDefinition;

@@ -38,6 +39,7 @@ import org.alfresco.service.cmr.action.ActionDefinition;
 * @author Roy Wetherall
 * @since 2.1
 */
+@AlfrescoPublicApi
 public interface RecordsManagementActionDefinition extends ActionDefinition
 {
    /**
--- a/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/action/RecordsManagementActionResult.java
+++ b/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/action/RecordsManagementActionResult.java
@@ -27,11 +27,14 @@

 package org.alfresco.module.org_alfresco_module_rm.action;

+import org.alfresco.api.AlfrescoPublicApi;
+
 /**
 * Records management action result.
 *
 * @author Roy Wetherall
 */
+@AlfrescoPublicApi
 public class RecordsManagementActionResult
 {
    /** Result value */
--- a/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/action/RecordsManagementActionService.java
+++ b/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/action/RecordsManagementActionService.java
@@ -31,6 +31,7 @@ import java.io.Serializable;
 import java.util.List;
 import java.util.Map;

+import org.alfresco.api.AlfrescoPublicApi;
 import org.alfresco.service.cmr.repository.NodeRef;


@@ -39,6 +40,7 @@ import org.alfresco.service.cmr.repository.NodeRef;
 *
 * @author Roy Wetherall
 */
+@AlfrescoPublicApi
 public interface RecordsManagementActionService
 {
    /**
--- a/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/admin/CustomMetadataException.java
+++ b/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/admin/CustomMetadataException.java
@@ -27,6 +27,8 @@

 package org.alfresco.module.org_alfresco_module_rm.admin;

+import org.alfresco.api.AlfrescoPublicApi;
+
 /**
 * Custom metadata exception.
 *
@@ -34,6 +36,7 @@ package org.alfresco.module.org_alfresco_module_rm.admin;
 * @since 2.1
 * @see org.alfresco.module.org_alfresco_module_rm.CustomMetadataException
 */
+@AlfrescoPublicApi
 public abstract class CustomMetadataException extends Exception
 {
    private static final long serialVersionUID = -6676112294794381360L;
--- a/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/admin/PropertyAlreadyExistsMetadataException.java
+++ b/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/admin/PropertyAlreadyExistsMetadataException.java
@@ -27,6 +27,7 @@

 package org.alfresco.module.org_alfresco_module_rm.admin;

+import org.alfresco.api.AlfrescoPublicApi;
 import org.springframework.extensions.surf.util.I18NUtil;

 /**
@@ -36,6 +37,7 @@ import org.springframework.extensions.surf.util.I18NUtil;
 * @since 2.1
 * @see org.alfresco.module.org_alfresco_module_rm.PropertyAlreadyExistsMetadataException
 */
+@AlfrescoPublicApi
 public class PropertyAlreadyExistsMetadataException extends CustomMetadataException
 {
    private static final long serialVersionUID = -6194867814140009959L;
--- a/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/admin/RecordsManagementAdminService.java
+++ b/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/admin/RecordsManagementAdminService.java
@@ -52,6 +52,7 @@ import org.alfresco.service.namespace.RegexQNamePattern;
 * @since 2.1
 * @see org.alfresco.module.org_alfresco_module_rm.RecordsManagementAdminService
 */
+// Not @AlfrescoPublicApi at the moment as it requires MatchLogic which is not public API.
 public interface RecordsManagementAdminService
 {
    /**
--- a/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/audit/RecordsManagementAuditEntry.java
+++ b/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/audit/RecordsManagementAuditEntry.java
@@ -32,6 +32,7 @@ import java.util.Date;
 import java.util.HashMap;
 import java.util.Map;

+import org.alfresco.api.AlfrescoPublicApi;
 import org.alfresco.service.cmr.repository.NodeRef;
 import org.alfresco.service.namespace.QName;
 import org.alfresco.util.Pair;
@@ -43,6 +44,7 @@ import org.springframework.extensions.surf.util.ISO8601DateFormat;
 *
 * @author Gavin Cornwell
 */
+@AlfrescoPublicApi
 public final class RecordsManagementAuditEntry
 {
    private final Date timestamp;
--- a/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/audit/RecordsManagementAuditQueryParameters.java
+++ b/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/audit/RecordsManagementAuditQueryParameters.java
@@ -29,6 +29,7 @@ package org.alfresco.module.org_alfresco_module_rm.audit;

 import java.util.Date;

+import org.alfresco.api.AlfrescoPublicApi;
 import org.alfresco.service.cmr.repository.NodeRef;
 import org.alfresco.service.namespace.QName;

@@ -38,6 +39,7 @@ import org.alfresco.service.namespace.QName;
 *
 * @author Gavin Cornwell
 */
+@AlfrescoPublicApi
 public final class RecordsManagementAuditQueryParameters
 {
    private int maxEntries = -1;
--- a/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/audit/RecordsManagementAuditService.java
+++ b/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/audit/RecordsManagementAuditService.java
@@ -33,6 +33,7 @@ import java.util.Date;
 import java.util.List;
 import java.util.Map;

+import org.alfresco.api.AlfrescoPublicApi;
 import org.alfresco.module.org_alfresco_module_rm.audit.event.AuditEvent;
 import org.alfresco.service.cmr.repository.NodeRef;
 import org.alfresco.service.namespace.QName;
@@ -42,6 +43,8 @@ import org.alfresco.service.namespace.QName;
 *
 * @author Gavin Cornwell
 */
+@AlfrescoPublicApi
+@SuppressWarnings("deprecation")
 public interface RecordsManagementAuditService extends RecordsManagementAuditServiceDeprecated
 {
    public enum ReportFormat { HTML, JSON }
--- a/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/audit/event/AuditEvent.java
+++ b/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/audit/event/AuditEvent.java
@@ -27,6 +27,7 @@

 package org.alfresco.module.org_alfresco_module_rm.audit.event;

+import org.alfresco.api.AlfrescoPublicApi;
 import org.alfresco.module.org_alfresco_module_rm.audit.RecordsManagementAuditService;
 import org.alfresco.module.org_alfresco_module_rm.model.RecordsManagementModel;
 import org.alfresco.util.ParameterCheck;
@@ -40,6 +41,7 @@ import org.springframework.extensions.surf.util.I18NUtil;
 * @author Roy Wetherall
 * @since 1.0
 */
+@AlfrescoPublicApi
 public class AuditEvent implements RecordsManagementModel, Comparable<AuditEvent>
 {
 	/** Name */
--- a/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/capability/Capability.java
+++ b/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/capability/Capability.java
@@ -27,6 +27,7 @@

 package org.alfresco.module.org_alfresco_module_rm.capability;

+import org.alfresco.api.AlfrescoPublicApi;
 import org.alfresco.service.cmr.repository.NodeRef;
 import org.alfresco.service.cmr.security.AccessStatus;

@@ -36,6 +37,7 @@ import org.alfresco.service.cmr.security.AccessStatus;
 * @author andyh
 * @author Roy Wetherall
 */
+@AlfrescoPublicApi
 public interface Capability
 {
    /**
--- a/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/capability/CapabilityService.java
+++ b/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/capability/CapabilityService.java
@@ -31,6 +31,7 @@ import java.util.List;
 import java.util.Map;
 import java.util.Set;

+import org.alfresco.api.AlfrescoPublicApi;
 import org.alfresco.service.cmr.repository.NodeRef;
 import org.alfresco.service.cmr.security.AccessStatus;

@@ -40,6 +41,7 @@ import org.alfresco.service.cmr.security.AccessStatus;
 * @author Roy Wetherall
 * @since 2.0
 */
+@AlfrescoPublicApi
 public interface CapabilityService
 {
   /**
--- a/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/capability/Group.java
+++ b/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/capability/Group.java
@@ -27,12 +27,15 @@

 package org.alfresco.module.org_alfresco_module_rm.capability;

+import org.alfresco.api.AlfrescoPublicApi;
+
 /**
 * Group interface
 *
 * @author Tuna Aksoy
 * @since 2.1
 */
+@AlfrescoPublicApi
 public interface Group
 {
    /**
--- a/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/disposition/DispositionActionDefinition.java
+++ b/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/disposition/DispositionActionDefinition.java
@@ -29,6 +29,7 @@ package org.alfresco.module.org_alfresco_module_rm.disposition;

 import java.util.List;

+import org.alfresco.api.AlfrescoPublicApi;
 import org.alfresco.module.org_alfresco_module_rm.event.RecordsManagementEvent;
 import org.alfresco.service.cmr.repository.NodeRef;
 import org.alfresco.service.cmr.repository.Period;
@@ -39,6 +40,7 @@ import org.alfresco.service.namespace.QName;
 *
 * @author Roy Wetherall
 */
+// Not @AlfrescoPublicApi because it depends on Period which is not part of the public API.
 public interface DispositionActionDefinition
 {
    /**
--- a/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/disposition/DispositionSchedule.java
+++ b/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/disposition/DispositionSchedule.java
@@ -36,6 +36,7 @@ import org.alfresco.service.cmr.repository.NodeRef;
 *
 * @author Roy Wetherall
 */
+// Not @AlfrescoPublicApi because it depends on DispositionActionDefinition which is not part of the public API.
 public interface DispositionSchedule
 {
    /**
--- a/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/disposition/DispositionService.java
+++ b/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/disposition/DispositionService.java
@@ -42,6 +42,7 @@ import org.alfresco.service.namespace.QName;
 * @author Roy Wetherall
 * @since 2.0
 */
+// Not @AlfrescoPublicApi because it depends on DispositionSchedule which is not part of the public API.
 public interface DispositionService
 {
    /** ========= Disposition Property Methods ========= */
--- a/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/event/RecordsManagementEvent.java
+++ b/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/event/RecordsManagementEvent.java
@@ -27,6 +27,7 @@

 package org.alfresco.module.org_alfresco_module_rm.event;

+import org.alfresco.api.AlfrescoPublicApi;
 import org.alfresco.util.ParameterCheck;

 /**
@@ -35,6 +36,7 @@ import org.alfresco.util.ParameterCheck;
 * @author Roy Wetherall
 * @since 1.0
 */
+@AlfrescoPublicApi
 public class RecordsManagementEvent
 {
    /** Records management event type */
--- a/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/event/RecordsManagementEventService.java
+++ b/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/event/RecordsManagementEventService.java
@@ -29,11 +29,14 @@ package org.alfresco.module.org_alfresco_module_rm.event;

 import java.util.List;

+import org.alfresco.api.AlfrescoPublicApi;
+
 /**
 * Records management event service interface
 *
 * @author Roy Wetherall
 */
+@AlfrescoPublicApi
 public interface RecordsManagementEventService
 {
    /**
--- a/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/event/RecordsManagementEventType.java
+++ b/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/event/RecordsManagementEventType.java
@@ -27,11 +27,14 @@

 package org.alfresco.module.org_alfresco_module_rm.event;

+import org.alfresco.api.AlfrescoPublicApi;
+
 /**
 * Records management event type interface
 *
 * @author Roy Wetherall
 */
+@AlfrescoPublicApi
 public interface RecordsManagementEventType
 {
    /**
--- a/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/fileplan/FilePlanComponentKind.java
+++ b/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/fileplan/FilePlanComponentKind.java
@@ -27,6 +27,8 @@

 package org.alfresco.module.org_alfresco_module_rm.fileplan;

+import org.alfresco.api.AlfrescoPublicApi;
+
 /**
 * File plan component kind enumeration class.
 * <br>
@@ -35,6 +37,7 @@ package org.alfresco.module.org_alfresco_module_rm.fileplan;
 *
 * @author Roy Wetherall
 */
+@AlfrescoPublicApi
 public enum FilePlanComponentKind
 {
    FILE_PLAN_COMPONENT,
--- a/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/fileplan/FilePlanService.java
+++ b/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/fileplan/FilePlanService.java
@@ -32,6 +32,7 @@ import java.util.List;
 import java.util.Map;
 import java.util.Set;

+import org.alfresco.api.AlfrescoPublicApi;
 import org.alfresco.service.cmr.repository.NodeRef;
 import org.alfresco.service.cmr.repository.StoreRef;
 import org.alfresco.service.namespace.QName;
@@ -42,6 +43,7 @@ import org.alfresco.service.namespace.QName;
 * @author Roy Wetherall
 * @since 2.1
 */
+@AlfrescoPublicApi
 public interface FilePlanService
 {
    /**
--- a/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/freeze/FreezeService.java
+++ b/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/freeze/FreezeService.java
@@ -30,6 +30,7 @@ package org.alfresco.module.org_alfresco_module_rm.freeze;
 import java.util.Date;
 import java.util.Set;

+import org.alfresco.api.AlfrescoPublicApi;
 import org.alfresco.module.org_alfresco_module_rm.hold.HoldService;
 import org.alfresco.service.cmr.repository.NodeRef;

@@ -41,6 +42,7 @@ import org.alfresco.service.cmr.repository.NodeRef;
 * @author Roy Wetherall
 * @since 2.0
 */
+@AlfrescoPublicApi
 public interface FreezeService
 {
    /**
--- a/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/hold/HoldService.java
+++ b/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/hold/HoldService.java
@@ -29,6 +29,7 @@ package org.alfresco.module.org_alfresco_module_rm.hold;

 import java.util.List;

+import org.alfresco.api.AlfrescoPublicApi;
 import org.alfresco.service.cmr.repository.NodeRef;

 /**
@@ -37,6 +38,7 @@ import org.alfresco.service.cmr.repository.NodeRef;
 * @author Tuna Aksoy
 * @since 2.2
 */
+@AlfrescoPublicApi
 public interface HoldService
 {
    /**
--- a/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/identifier/IdentifierGenerator.java
+++ b/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/identifier/IdentifierGenerator.java
@@ -30,6 +30,7 @@ package org.alfresco.module.org_alfresco_module_rm.identifier;
 import java.io.Serializable;
 import java.util.Map;

+import org.alfresco.api.AlfrescoPublicApi;
 import org.alfresco.service.namespace.QName;

 /**
@@ -37,6 +38,7 @@ import org.alfresco.service.namespace.QName;
 *
 * @author Roy Wetherall
 */
+@AlfrescoPublicApi
 public interface IdentifierGenerator
 {
    /**
--- a/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/identifier/IdentifierService.java
+++ b/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/identifier/IdentifierService.java
@@ -27,6 +27,7 @@

 package org.alfresco.module.org_alfresco_module_rm.identifier;

+import org.alfresco.api.AlfrescoPublicApi;
 import org.alfresco.service.cmr.repository.NodeRef;
 import org.alfresco.service.namespace.QName;

@@ -35,6 +36,7 @@ import org.alfresco.service.namespace.QName;
 *
 * @author Roy Wetherall
 */
+@AlfrescoPublicApi
 public interface IdentifierService
 {
    /** Context value names */
--- a/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/model/RecordsManagementCustomModel.java
+++ b/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/model/RecordsManagementCustomModel.java
@@ -27,6 +27,7 @@

 package org.alfresco.module.org_alfresco_module_rm.model;

+import org.alfresco.api.AlfrescoPublicApi;
 import org.alfresco.service.namespace.QName;

 /**
@@ -34,6 +35,7 @@ import org.alfresco.service.namespace.QName;
 *
 * @author Gavin Cornwell
 */
+@AlfrescoPublicApi
 public interface RecordsManagementCustomModel
 {
    // Namespace details
--- a/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/model/RecordsManagementModel.java
+++ b/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/model/RecordsManagementModel.java
@@ -27,6 +27,7 @@

 package org.alfresco.module.org_alfresco_module_rm.model;

+import org.alfresco.api.AlfrescoPublicApi;
 import org.alfresco.service.namespace.QName;

 /**
@@ -34,6 +35,7 @@ import org.alfresco.service.namespace.QName;
 *
 * @author Roy Wetherall
 */
+@AlfrescoPublicApi
 public interface RecordsManagementModel extends RecordsManagementCustomModel
 {
    // Namespace details
--- a/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/model/security/ModelSecurityService.java
+++ b/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/model/security/ModelSecurityService.java
@@ -29,6 +29,7 @@ package org.alfresco.module.org_alfresco_module_rm.model.security;

 import java.util.Set;

+import org.alfresco.api.AlfrescoPublicApi;
 import org.alfresco.service.cmr.repository.NodeRef;
 import org.alfresco.service.namespace.QName;

@@ -38,6 +39,7 @@ import org.alfresco.service.namespace.QName;
 * @author Roy Wetherall
 * @since 2.1
 */
+@AlfrescoPublicApi
 public interface ModelSecurityService
 {
    /**
--- a/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/model/security/ProtectedAspect.java
+++ b/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/model/security/ProtectedAspect.java
@@ -27,10 +27,13 @@

 package org.alfresco.module.org_alfresco_module_rm.model.security;

+import org.alfresco.api.AlfrescoPublicApi;
+
 /**
 * @author Roy Wetherall
 * @since 2.1
 */
+@AlfrescoPublicApi
 public class ProtectedAspect extends ProtectedModelArtifact
 {

--- a/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/model/security/ProtectedModelArtifact.java
+++ b/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/model/security/ProtectedModelArtifact.java
@@ -30,6 +30,7 @@ package org.alfresco.module.org_alfresco_module_rm.model.security;
 import java.util.HashSet;
 import java.util.Set;

+import org.alfresco.api.AlfrescoPublicApi;
 import org.alfresco.module.org_alfresco_module_rm.capability.Capability;
 import org.alfresco.service.namespace.NamespaceService;
 import org.alfresco.service.namespace.QName;
@@ -40,6 +41,7 @@ import org.alfresco.service.namespace.QName;
 * @author Roy Wetherall
 * @since 2.1
 */
+@AlfrescoPublicApi
 public abstract class ProtectedModelArtifact
 {
    /** Model security service */
--- a/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/model/security/ProtectedProperty.java
+++ b/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/model/security/ProtectedProperty.java
@@ -27,12 +27,15 @@

 package org.alfresco.module.org_alfresco_module_rm.model.security;

+import org.alfresco.api.AlfrescoPublicApi;
+
 /**
 * Protected property implementation
 *
 * @author Roy Wetherall
 * @since 2.1
 */
+@AlfrescoPublicApi
 public class ProtectedProperty extends ProtectedModelArtifact
 {
    /** always allow new indicator */
--- a/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/record/InplaceRecordService.java
+++ b/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/record/InplaceRecordService.java
@@ -27,6 +27,7 @@

 package org.alfresco.module.org_alfresco_module_rm.record;

+import org.alfresco.api.AlfrescoPublicApi;
 import org.alfresco.service.cmr.repository.NodeRef;

 /**
@@ -35,6 +36,7 @@ import org.alfresco.service.cmr.repository.NodeRef;
 * @author Tuna Aksoy
 * @since 2.3
 */
+@AlfrescoPublicApi
 public interface InplaceRecordService
 {
    /**
--- a/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/record/RecordService.java
+++ b/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/record/RecordService.java
@@ -32,6 +32,7 @@ import java.util.List;
 import java.util.Map;
 import java.util.Set;

+import org.alfresco.api.AlfrescoPublicApi;
 import org.alfresco.service.cmr.repository.ContentReader;
 import org.alfresco.service.cmr.repository.NodeRef;
 import org.alfresco.service.namespace.QName;
@@ -42,6 +43,7 @@ import org.alfresco.service.namespace.QName;
 * @author Roy Wetherall
 * @since 2.1
 */
+@AlfrescoPublicApi
 public interface RecordService
 {
    /**
--- a/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/recordableversion/RecordableVersionConfigService.java
+++ b/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/recordableversion/RecordableVersionConfigService.java
@@ -29,6 +29,7 @@ package org.alfresco.module.org_alfresco_module_rm.recordableversion;

 import java.util.List;

+import org.alfresco.api.AlfrescoPublicApi;
 import org.alfresco.module.org_alfresco_module_rm.script.slingshot.Version;
 import org.alfresco.service.cmr.repository.NodeRef;

@@ -38,6 +39,7 @@ import org.alfresco.service.cmr.repository.NodeRef;
 * @author Tuna Aksoy
 * @since 2.3
 */
+@AlfrescoPublicApi
 public interface RecordableVersionConfigService
 {
    /**
--- a/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/recordfolder/RecordFolderService.java
+++ b/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/recordfolder/RecordFolderService.java
@@ -31,6 +31,7 @@ import java.io.Serializable;
 import java.util.List;
 import java.util.Map;

+import org.alfresco.api.AlfrescoPublicApi;
 import org.alfresco.service.cmr.repository.NodeRef;
 import org.alfresco.service.namespace.QName;

@@ -40,6 +41,7 @@ import org.alfresco.service.namespace.QName;
 * @author Roy Wetherall
 * @since 2.1
 */
+@AlfrescoPublicApi
 public interface RecordFolderService
 {
    /**
--- a/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/relationship/Relationship.java
+++ b/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/relationship/Relationship.java
@@ -27,6 +27,7 @@

 package org.alfresco.module.org_alfresco_module_rm.relationship;

+import org.alfresco.api.AlfrescoPublicApi;
 import org.alfresco.service.cmr.repository.NodeRef;

 /**
@@ -35,6 +36,7 @@ import org.alfresco.service.cmr.repository.NodeRef;
 * @author Tuna Aksoy
 * @since 2.3
 */
+@AlfrescoPublicApi
 public interface Relationship
 {
    /**
--- a/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/relationship/RelationshipDefinition.java
+++ b/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/relationship/RelationshipDefinition.java
@@ -27,12 +27,15 @@

 package org.alfresco.module.org_alfresco_module_rm.relationship;

+import org.alfresco.api.AlfrescoPublicApi;
+
 /**
 * Interface representing the relationship definition
 *
 * @author Tuna Aksoy
 * @since 2.3
 */
+@AlfrescoPublicApi
 public interface RelationshipDefinition
 {
    /**
--- a/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/relationship/RelationshipDisplayName.java
+++ b/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/relationship/RelationshipDisplayName.java
@@ -29,12 +29,15 @@ package org.alfresco.module.org_alfresco_module_rm.relationship;

 import static org.alfresco.util.ParameterCheck.mandatoryString;

+import org.alfresco.api.AlfrescoPublicApi;
+
 /**
 * POJO representing the relationship display name
 *
 * @author Tuna Aksoy
 * @since 2.3
 */
+@AlfrescoPublicApi
 public class RelationshipDisplayName
 {
    /** The source text of the relationship */
--- a/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/relationship/RelationshipService.java
+++ b/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/relationship/RelationshipService.java
@@ -29,6 +29,7 @@ package org.alfresco.module.org_alfresco_module_rm.relationship;

 import java.util.Set;

+import org.alfresco.api.AlfrescoPublicApi;
 import org.alfresco.service.cmr.repository.NodeRef;

 /**
@@ -37,6 +38,7 @@ import org.alfresco.service.cmr.repository.NodeRef;
 * @author Tuna Aksoy
 * @since 2.3
 */
+@AlfrescoPublicApi
 public interface RelationshipService
 {
    /** System relationship names */
--- a/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/relationship/RelationshipType.java
+++ b/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/relationship/RelationshipType.java
@@ -27,12 +27,15 @@

 package org.alfresco.module.org_alfresco_module_rm.relationship;

+import org.alfresco.api.AlfrescoPublicApi;
+
 /**
 * Enum representing the relationship types
 *
 * @author Tuna Aksoy
 * @since 2.3
 */
+@AlfrescoPublicApi
 public enum RelationshipType
 {
    BIDIRECTIONAL,
--- a/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/report/Report.java
+++ b/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/report/Report.java
@@ -30,6 +30,7 @@ package org.alfresco.module.org_alfresco_module_rm.report;
 import java.io.Serializable;
 import java.util.Map;

+import org.alfresco.api.AlfrescoPublicApi;
 import org.alfresco.service.cmr.repository.ContentReader;
 import org.alfresco.service.namespace.QName;

@@ -39,6 +40,7 @@ import org.alfresco.service.namespace.QName;
 * @author Roy Wetherall
 * @since 2.1
 */
+@AlfrescoPublicApi
 public interface Report
 {
    /**
--- a/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/report/ReportGenerator.java
+++ b/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/report/ReportGenerator.java
@@ -27,6 +27,7 @@

 package org.alfresco.module.org_alfresco_module_rm.report;

+import org.alfresco.api.AlfrescoPublicApi;
 import org.alfresco.service.cmr.repository.NodeRef;
 import org.alfresco.service.namespace.QName;

@@ -36,6 +37,7 @@ import org.alfresco.service.namespace.QName;
 * @author Roy Wetherall
 * @since 2.1
 */
+@AlfrescoPublicApi
 public interface ReportGenerator
 {
    /**
--- a/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/report/ReportService.java
+++ b/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/report/ReportService.java
@@ -29,6 +29,7 @@ package org.alfresco.module.org_alfresco_module_rm.report;

 import java.util.Set;

+import org.alfresco.api.AlfrescoPublicApi;
 import org.alfresco.service.cmr.repository.NodeRef;
 import org.alfresco.service.namespace.QName;

@@ -38,6 +39,7 @@ import org.alfresco.service.namespace.QName;
 * @author Roy Wetherall
 * @since 2.1
 */
+@AlfrescoPublicApi
 public interface ReportService
 {
    /**
--- a/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/role/FilePlanRoleService.java
+++ b/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/role/FilePlanRoleService.java
@@ -31,6 +31,7 @@ import java.util.Arrays;
 import java.util.List;
 import java.util.Set;

+import org.alfresco.api.AlfrescoPublicApi;
 import org.alfresco.module.org_alfresco_module_rm.capability.Capability;
 import org.alfresco.service.cmr.repository.NodeRef;

@@ -40,6 +41,7 @@ import org.alfresco.service.cmr.repository.NodeRef;
 * @author Roy Wetherall
 * @since 2.1
 */
+@AlfrescoPublicApi
 public interface FilePlanRoleService
 {
    /** Default role names */
--- a/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/role/Role.java
+++ b/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/role/Role.java
@@ -29,6 +29,7 @@ package org.alfresco.module.org_alfresco_module_rm.role;

 import java.util.Set;

+import org.alfresco.api.AlfrescoPublicApi;
 import org.alfresco.module.org_alfresco_module_rm.capability.Capability;

 /**
@@ -36,6 +37,7 @@ import org.alfresco.module.org_alfresco_module_rm.capability.Capability;
 *
 * @author Roy Wetherall
 */
+@AlfrescoPublicApi
 public class Role
 {
    /** Role name */
--- a/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/script/slingshot/Version.java
+++ b/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/script/slingshot/Version.java
@@ -30,12 +30,15 @@ package org.alfresco.module.org_alfresco_module_rm.script.slingshot;
 import static org.alfresco.util.ParameterCheck.mandatory;
 import static org.alfresco.util.ParameterCheck.mandatoryString;

+import org.alfresco.api.AlfrescoPublicApi;
+
 /**
 * Recordable version class
 *
 * @author Tuna Aksoy
 * @since 2.3
 */
+@AlfrescoPublicApi
 public class Version
 {
    /** The version policy */
--- a/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/search/RecordsManagementSearchParameters.java
+++ b/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/search/RecordsManagementSearchParameters.java
@@ -33,6 +33,7 @@ import java.util.HashMap;
 import java.util.List;
 import java.util.Map;

+import org.alfresco.api.AlfrescoPublicApi;
 import org.alfresco.error.AlfrescoRuntimeException;
 import org.alfresco.model.ContentModel;
 import org.alfresco.service.cmr.repository.datatype.DefaultTypeConverter;
@@ -48,6 +49,7 @@ import org.json.JSONObject;
 /**
 * @author Roy Wetherall
 */
+@AlfrescoPublicApi
@SuppressWarnings("serial")
 public class RecordsManagementSearchParameters
 {
--- a/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/search/RecordsManagementSearchService.java
+++ b/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/search/RecordsManagementSearchService.java
@@ -37,6 +37,7 @@ import org.alfresco.util.Pair;
 *
 * @author Roy Wetherall
 */
+// Not @AlfrescoPublicApi at the moment as it requires SavedSearchDetails which is not public API.
 public interface RecordsManagementSearchService
 {
 	/**
--- a/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/search/ReportDetails.java
+++ b/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/search/ReportDetails.java
@@ -27,11 +27,14 @@

 package org.alfresco.module.org_alfresco_module_rm.search;

+import org.alfresco.api.AlfrescoPublicApi;
+
 /**
 * Report details.
 *
 * @author Roy Wetherall
 */
+@AlfrescoPublicApi
 public class ReportDetails
 {
    /** Name */
--- a/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/search/SavedSearchDetails.java
+++ b/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/search/SavedSearchDetails.java
@@ -83,6 +83,7 @@ import org.springframework.extensions.surf.util.I18NUtil;
 *
 * @author Roy Wetherall
 */
+// Not @AlfrescoPublicApi at the moment as it requires RecordsManagementSearchServiceImpl which is not public API.
 public class SavedSearchDetails extends ReportDetails
 {
    // JSON label values
--- a/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/search/SavedSearchDetailsCompatibility.java
+++ b/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/search/SavedSearchDetailsCompatibility.java
@@ -42,6 +42,7 @@ import org.alfresco.service.namespace.QName;
 * Used to bridge between the old style of saved search passed and required by the UI and the new actual saved search details.
 * Eventually will be factored out as web scripts are brought up to date.
 */
+// Not @AlfrescoPublicApi at the moment as it requires RecordsManagementSearchServiceImpl which is not public API.
 public class SavedSearchDetailsCompatibility implements RecordsManagementModel
 {
    /** Saved search details */
--- a/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/search/SortItem.java
+++ b/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/search/SortItem.java
@@ -27,8 +27,10 @@

 package org.alfresco.module.org_alfresco_module_rm.search;

+import org.alfresco.api.AlfrescoPublicApi;
 import org.alfresco.service.namespace.QName;

+@AlfrescoPublicApi
 /*package*/ class SortItem
 {
    public QName property = null;
--- a/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/security/ExtendedSecurityService.java
+++ b/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/security/ExtendedSecurityService.java
@@ -29,6 +29,7 @@ package org.alfresco.module.org_alfresco_module_rm.security;

 import java.util.Set;

+import org.alfresco.api.AlfrescoPublicApi;
 import org.alfresco.service.cmr.repository.NodeRef;

 /**
@@ -37,6 +38,7 @@ import org.alfresco.service.cmr.repository.NodeRef;
 * @author Roy Wetherall
 * @since 2.1
 */
+@AlfrescoPublicApi
 public interface ExtendedSecurityService
 {
 	/**
--- a/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/security/FilePlanAuthenticationService.java
+++ b/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/security/FilePlanAuthenticationService.java
@@ -35,6 +35,7 @@ import org.alfresco.repo.security.authentication.AuthenticationUtil.RunAsWork;
 *
 * @author Roy Wetherall
 * @since 2.1
+ * @deprecated as of 2.2, use {@link AuthenticationUtil}.
 */
 public interface FilePlanAuthenticationService
 {
--- a/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/security/FilePlanPermissionService.java
+++ b/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/security/FilePlanPermissionService.java
@@ -27,6 +27,7 @@

 package org.alfresco.module.org_alfresco_module_rm.security;

+import org.alfresco.api.AlfrescoPublicApi;
 import org.alfresco.service.cmr.repository.NodeRef;

 /**
@@ -35,6 +36,7 @@ import org.alfresco.service.cmr.repository.NodeRef;
 * @author Roy Wetherall
 * @since 2.1
 */
+@AlfrescoPublicApi
 public interface FilePlanPermissionService
 {
    /**
--- a/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/transfer/TransferService.java
+++ b/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/transfer/TransferService.java
@@ -27,6 +27,7 @@

 package org.alfresco.module.org_alfresco_module_rm.transfer;

+import org.alfresco.api.AlfrescoPublicApi;
 import org.alfresco.service.cmr.repository.NodeRef;

 /**
@@ -35,6 +36,7 @@ import org.alfresco.service.cmr.repository.NodeRef;
 * @author Tuna Aksoy
 * @since 2.2
 */
+@AlfrescoPublicApi
 public interface TransferService
 {
    /**
--- a/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/version/RecordableVersionService.java
+++ b/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/version/RecordableVersionService.java
@@ -27,6 +27,7 @@

 package org.alfresco.module.org_alfresco_module_rm.version;

+import org.alfresco.api.AlfrescoPublicApi;
 import org.alfresco.service.cmr.repository.NodeRef;
 import org.alfresco.service.cmr.version.Version;

@@ -36,6 +37,7 @@ import org.alfresco.service.cmr.version.Version;
 * @author Roy Wetherall
 * @since 2.3
 */
+@AlfrescoPublicApi
 public interface RecordableVersionService
 {
    /**
--- a/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/vital/VitalRecordService.java
+++ b/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/vital/VitalRecordService.java
@@ -36,6 +36,7 @@ import org.alfresco.service.cmr.repository.Period;
 * @author Roy Wetherall
 * @since 2.0
 */
+// Not @AlfrescoPublicApi due to e.g. Period.
 public interface VitalRecordService
 {
    /** Period 'none' */
--- a/rm-community/rm-community-repo/source/java/org/alfresco/util/SortDirection.java
+++ b/rm-community/rm-community-repo/source/java/org/alfresco/util/SortDirection.java
@@ -1,5 +1,7 @@
 package org.alfresco.util;

+import org.alfresco.api.AlfrescoPublicApi;
+
 /*
 * #%L
 * Alfresco Records Management Module
@@ -35,6 +37,7 @@ import org.alfresco.error.AlfrescoRuntimeException;
 * @author Tuna Aksoy
 * @since 2.5
 */
+@AlfrescoPublicApi
 public enum SortDirection
 {
    ASC ("asc"),