RM-2812 Mark public API methods with @AlfrescoPublicAPI.

This commit is contained in:
Tom Page
2016-04-19 16:24:46 +01:00
parent 715d4f81a9
commit 0659402f13
70 changed files with 442 additions and 289 deletions

View File

@@ -39,6 +39,7 @@ import org.alfresco.service.cmr.repository.NodeRef;
* *
* @author Roy Wetherall * @author Roy Wetherall
* @since 2.1 * @since 2.1
* @deprecated as of 2.1, see {@link RecordsManagementAuditService}.
*/ */
public interface RecordsManagementAuditServiceDeprecated public interface RecordsManagementAuditServiceDeprecated
{ {

View File

@@ -33,9 +33,11 @@ import java.util.List;
import java.util.Map; import java.util.Map;
import java.util.Set; import java.util.Set;
import org.alfresco.api.AlfrescoPublicApi;
import org.alfresco.error.AlfrescoRuntimeException; import org.alfresco.error.AlfrescoRuntimeException;
import org.alfresco.service.cmr.repository.NodeRef; import org.alfresco.service.cmr.repository.NodeRef;
@AlfrescoPublicApi
public interface RMCaveatConfigService public interface RMCaveatConfigService
{ {
void init(); void init();

View File

@@ -29,6 +29,9 @@ package org.alfresco.module.org_alfresco_module_rm.caveat;
import java.util.Arrays; import java.util.Arrays;
import org.alfresco.api.AlfrescoPublicApi;
@AlfrescoPublicApi
public class RMConstraintInfo public class RMConstraintInfo
{ {
private String name; private String name;

View File

@@ -33,6 +33,7 @@ import java.util.HashMap;
import java.util.List; import java.util.List;
import java.util.Map; import java.util.Map;
import org.alfresco.api.AlfrescoPublicApi;
import org.alfresco.repo.dictionary.constraint.ListOfValuesConstraint; import org.alfresco.repo.dictionary.constraint.ListOfValuesConstraint;
import org.alfresco.repo.security.authentication.AuthenticationUtil; import org.alfresco.repo.security.authentication.AuthenticationUtil;
import org.alfresco.service.cmr.dictionary.ConstraintException; import org.alfresco.service.cmr.dictionary.ConstraintException;
@@ -59,6 +60,7 @@ public class RMListOfValuesConstraint extends ListOfValuesConstraint
// defined match logic used by caveat matching (default = "AND") // defined match logic used by caveat matching (default = "AND")
private MatchLogic matchLogic = MatchLogic.AND; private MatchLogic matchLogic = MatchLogic.AND;
@AlfrescoPublicApi
public enum MatchLogic public enum MatchLogic
{ {
// closed marking - all values must match // closed marking - all values must match

View File

@@ -30,6 +30,7 @@ package org.alfresco.module.org_alfresco_module_rm.action;
import java.io.Serializable; import java.io.Serializable;
import java.util.Map; import java.util.Map;
import org.alfresco.api.AlfrescoPublicApi;
import org.alfresco.service.cmr.repository.NodeRef; import org.alfresco.service.cmr.repository.NodeRef;
/** /**
@@ -37,6 +38,7 @@ import org.alfresco.service.cmr.repository.NodeRef;
* *
* @author Roy Wetherall * @author Roy Wetherall
*/ */
@AlfrescoPublicApi
public interface RecordsManagementAction public interface RecordsManagementAction
{ {
/** /**

View File

@@ -27,12 +27,15 @@
package org.alfresco.module.org_alfresco_module_rm.action; package org.alfresco.module.org_alfresco_module_rm.action;
import org.alfresco.api.AlfrescoPublicApi;
/** /**
* Record Management Action Condition * Record Management Action Condition
* *
* @author Roy Wetherall * @author Roy Wetherall
* @since 2.1 * @since 2.1
*/ */
@AlfrescoPublicApi
public interface RecordsManagementActionCondition public interface RecordsManagementActionCondition
{ {
/** /**

View File

@@ -27,6 +27,7 @@
package org.alfresco.module.org_alfresco_module_rm.action; package org.alfresco.module.org_alfresco_module_rm.action;
import org.alfresco.api.AlfrescoPublicApi;
import org.alfresco.service.cmr.action.ActionConditionDefinition; import org.alfresco.service.cmr.action.ActionConditionDefinition;
/** /**
@@ -37,6 +38,7 @@ import org.alfresco.service.cmr.action.ActionConditionDefinition;
* @author Roy Wetherall * @author Roy Wetherall
* @since 2.1 * @since 2.1
*/ */
@AlfrescoPublicApi
public interface RecordsManagementActionConditionDefinition extends ActionConditionDefinition public interface RecordsManagementActionConditionDefinition extends ActionConditionDefinition
{ {
} }

View File

@@ -29,6 +29,7 @@ package org.alfresco.module.org_alfresco_module_rm.action;
import java.util.Set; import java.util.Set;
import org.alfresco.api.AlfrescoPublicApi;
import org.alfresco.module.org_alfresco_module_rm.fileplan.FilePlanComponentKind; import org.alfresco.module.org_alfresco_module_rm.fileplan.FilePlanComponentKind;
import org.alfresco.service.cmr.action.ActionDefinition; import org.alfresco.service.cmr.action.ActionDefinition;
@@ -38,6 +39,7 @@ import org.alfresco.service.cmr.action.ActionDefinition;
* @author Roy Wetherall * @author Roy Wetherall
* @since 2.1 * @since 2.1
*/ */
@AlfrescoPublicApi
public interface RecordsManagementActionDefinition extends ActionDefinition public interface RecordsManagementActionDefinition extends ActionDefinition
{ {
/** /**

View File

@@ -27,11 +27,14 @@
package org.alfresco.module.org_alfresco_module_rm.action; package org.alfresco.module.org_alfresco_module_rm.action;
import org.alfresco.api.AlfrescoPublicApi;
/** /**
* Records management action result. * Records management action result.
* *
* @author Roy Wetherall * @author Roy Wetherall
*/ */
@AlfrescoPublicApi
public class RecordsManagementActionResult public class RecordsManagementActionResult
{ {
/** Result value */ /** Result value */

View File

@@ -31,6 +31,7 @@ import java.io.Serializable;
import java.util.List; import java.util.List;
import java.util.Map; import java.util.Map;
import org.alfresco.api.AlfrescoPublicApi;
import org.alfresco.service.cmr.repository.NodeRef; import org.alfresco.service.cmr.repository.NodeRef;
@@ -39,6 +40,7 @@ import org.alfresco.service.cmr.repository.NodeRef;
* *
* @author Roy Wetherall * @author Roy Wetherall
*/ */
@AlfrescoPublicApi
public interface RecordsManagementActionService public interface RecordsManagementActionService
{ {
/** /**

View File

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

View File

@@ -27,6 +27,7 @@
package org.alfresco.module.org_alfresco_module_rm.admin; package org.alfresco.module.org_alfresco_module_rm.admin;
import org.alfresco.api.AlfrescoPublicApi;
import org.springframework.extensions.surf.util.I18NUtil; import org.springframework.extensions.surf.util.I18NUtil;
/** /**
@@ -36,6 +37,7 @@ import org.springframework.extensions.surf.util.I18NUtil;
* @since 2.1 * @since 2.1
* @see org.alfresco.module.org_alfresco_module_rm.PropertyAlreadyExistsMetadataException * @see org.alfresco.module.org_alfresco_module_rm.PropertyAlreadyExistsMetadataException
*/ */
@AlfrescoPublicApi
public class PropertyAlreadyExistsMetadataException extends CustomMetadataException public class PropertyAlreadyExistsMetadataException extends CustomMetadataException
{ {
private static final long serialVersionUID = -6194867814140009959L; private static final long serialVersionUID = -6194867814140009959L;

View File

@@ -31,6 +31,7 @@ import java.util.List;
import java.util.Map; import java.util.Map;
import java.util.Set; import java.util.Set;
import org.alfresco.api.AlfrescoPublicApi;
import org.alfresco.error.AlfrescoRuntimeException; import org.alfresco.error.AlfrescoRuntimeException;
import org.alfresco.module.org_alfresco_module_rm.caveat.RMListOfValuesConstraint.MatchLogic; import org.alfresco.module.org_alfresco_module_rm.caveat.RMListOfValuesConstraint.MatchLogic;
import org.alfresco.module.org_alfresco_module_rm.relationship.RelationshipService; import org.alfresco.module.org_alfresco_module_rm.relationship.RelationshipService;
@@ -52,6 +53,7 @@ import org.alfresco.service.namespace.RegexQNamePattern;
* @since 2.1 * @since 2.1
* @see org.alfresco.module.org_alfresco_module_rm.RecordsManagementAdminService * @see org.alfresco.module.org_alfresco_module_rm.RecordsManagementAdminService
*/ */
@AlfrescoPublicApi
public interface RecordsManagementAdminService public interface RecordsManagementAdminService
{ {
/** /**

View File

@@ -42,6 +42,8 @@ import org.alfresco.service.namespace.QName;
* *
* @author Gavin Cornwell * @author Gavin Cornwell
*/ */
// Not @AlfrescoPublicApi as extends the deprecated class RecordsManagementAuditServiceDeprecated.
@SuppressWarnings("deprecation")
public interface RecordsManagementAuditService extends RecordsManagementAuditServiceDeprecated public interface RecordsManagementAuditService extends RecordsManagementAuditServiceDeprecated
{ {
public enum ReportFormat { HTML, JSON } public enum ReportFormat { HTML, JSON }

View File

@@ -27,6 +27,7 @@
package org.alfresco.module.org_alfresco_module_rm.capability; 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.repository.NodeRef;
import org.alfresco.service.cmr.security.AccessStatus; import org.alfresco.service.cmr.security.AccessStatus;
@@ -36,6 +37,7 @@ import org.alfresco.service.cmr.security.AccessStatus;
* @author andyh * @author andyh
* @author Roy Wetherall * @author Roy Wetherall
*/ */
@AlfrescoPublicApi
public interface Capability public interface Capability
{ {
/** /**

View File

@@ -31,6 +31,7 @@ import java.util.List;
import java.util.Map; import java.util.Map;
import java.util.Set; import java.util.Set;
import org.alfresco.api.AlfrescoPublicApi;
import org.alfresco.service.cmr.repository.NodeRef; import org.alfresco.service.cmr.repository.NodeRef;
import org.alfresco.service.cmr.security.AccessStatus; import org.alfresco.service.cmr.security.AccessStatus;
@@ -40,6 +41,7 @@ import org.alfresco.service.cmr.security.AccessStatus;
* @author Roy Wetherall * @author Roy Wetherall
* @since 2.0 * @since 2.0
*/ */
@AlfrescoPublicApi
public interface CapabilityService public interface CapabilityService
{ {
/** /**

View File

@@ -27,12 +27,15 @@
package org.alfresco.module.org_alfresco_module_rm.capability; package org.alfresco.module.org_alfresco_module_rm.capability;
import org.alfresco.api.AlfrescoPublicApi;
/** /**
* Group interface * Group interface
* *
* @author Tuna Aksoy * @author Tuna Aksoy
* @since 2.1 * @since 2.1
*/ */
@AlfrescoPublicApi
public interface Group public interface Group
{ {
/** /**

View File

@@ -27,6 +27,9 @@
package org.alfresco.module.org_alfresco_module_rm.dataset; package org.alfresco.module.org_alfresco_module_rm.dataset;
import org.alfresco.api.AlfrescoPublicApi;
@AlfrescoPublicApi
public interface DataSet public interface DataSet
{ {

View File

@@ -29,8 +29,10 @@ package org.alfresco.module.org_alfresco_module_rm.dataset;
import java.util.Map; import java.util.Map;
import org.alfresco.api.AlfrescoPublicApi;
import org.alfresco.service.cmr.repository.NodeRef; import org.alfresco.service.cmr.repository.NodeRef;
@AlfrescoPublicApi
public interface DataSetService public interface DataSetService
{ {

View File

@@ -29,6 +29,7 @@ package org.alfresco.module.org_alfresco_module_rm.disposition;
import java.util.List; import java.util.List;
import org.alfresco.api.AlfrescoPublicApi;
import org.alfresco.module.org_alfresco_module_rm.event.RecordsManagementEvent; import org.alfresco.module.org_alfresco_module_rm.event.RecordsManagementEvent;
import org.alfresco.service.cmr.repository.NodeRef; import org.alfresco.service.cmr.repository.NodeRef;
import org.alfresco.service.cmr.repository.Period; import org.alfresco.service.cmr.repository.Period;
@@ -39,6 +40,7 @@ import org.alfresco.service.namespace.QName;
* *
* @author Roy Wetherall * @author Roy Wetherall
*/ */
// Not @AlfrescoPublicApi because it depends on Period which is not part of the public API.
public interface DispositionActionDefinition public interface DispositionActionDefinition
{ {
/** /**

View File

@@ -36,6 +36,7 @@ import org.alfresco.service.cmr.repository.NodeRef;
* *
* @author Roy Wetherall * @author Roy Wetherall
*/ */
// Not @AlfrescoPublicApi because it depends on DispositionActionDefinition which is not part of the public API.
public interface DispositionSchedule public interface DispositionSchedule
{ {
/** /**

View File

@@ -42,6 +42,7 @@ import org.alfresco.service.namespace.QName;
* @author Roy Wetherall * @author Roy Wetherall
* @since 2.0 * @since 2.0
*/ */
// Not @AlfrescoPublicApi because it depends on DispositionSchedule which is not part of the public API.
public interface DispositionService public interface DispositionService
{ {
/** ========= Disposition Property Methods ========= */ /** ========= Disposition Property Methods ========= */

View File

@@ -32,6 +32,7 @@ import java.util.Date;
import java.util.Map; import java.util.Map;
import java.util.Set; import java.util.Set;
import org.alfresco.api.AlfrescoPublicApi;
import org.alfresco.error.AlfrescoRuntimeException; import org.alfresco.error.AlfrescoRuntimeException;
import org.alfresco.module.org_alfresco_module_rm.disposition.DispositionAction; import org.alfresco.module.org_alfresco_module_rm.disposition.DispositionAction;
import org.alfresco.module.org_alfresco_module_rm.disposition.DispositionActionDefinition; import org.alfresco.module.org_alfresco_module_rm.disposition.DispositionActionDefinition;
@@ -55,6 +56,7 @@ import org.alfresco.service.namespace.QName;
* *
* @author Roy Wetherall * @author Roy Wetherall
*/ */
@AlfrescoPublicApi
@BehaviourBean @BehaviourBean
public class DispositionProperty extends BaseBehaviourBean public class DispositionProperty extends BaseBehaviourBean
implements NodeServicePolicies.OnUpdatePropertiesPolicy implements NodeServicePolicies.OnUpdatePropertiesPolicy

View File

@@ -30,9 +30,12 @@ package org.alfresco.module.org_alfresco_module_rm.email;
import java.util.List; import java.util.List;
import java.util.Set; import java.util.Set;
import org.alfresco.api.AlfrescoPublicApi;
/** /**
* Custom EMail Mapping Service * Custom EMail Mapping Service
*/ */
@AlfrescoPublicApi
public interface CustomEmailMappingService public interface CustomEmailMappingService
{ {
/** /**

View File

@@ -27,9 +27,12 @@
package org.alfresco.module.org_alfresco_module_rm.email; package org.alfresco.module.org_alfresco_module_rm.email;
import org.alfresco.api.AlfrescoPublicApi;
/** /**
* Custom EMail Mapping * Custom EMail Mapping
*/ */
@AlfrescoPublicApi
public class CustomMapping public class CustomMapping
{ {
private String from; private String from;

View File

@@ -27,6 +27,7 @@
package org.alfresco.module.org_alfresco_module_rm.event; package org.alfresco.module.org_alfresco_module_rm.event;
import org.alfresco.api.AlfrescoPublicApi;
import org.alfresco.util.ParameterCheck; import org.alfresco.util.ParameterCheck;
/** /**
@@ -35,6 +36,7 @@ import org.alfresco.util.ParameterCheck;
* @author Roy Wetherall * @author Roy Wetherall
* @since 1.0 * @since 1.0
*/ */
@AlfrescoPublicApi
public class RecordsManagementEvent public class RecordsManagementEvent
{ {
/** Records management event type */ /** Records management event type */

View File

@@ -29,11 +29,14 @@ package org.alfresco.module.org_alfresco_module_rm.event;
import java.util.List; import java.util.List;
import org.alfresco.api.AlfrescoPublicApi;
/** /**
* Records management event service interface * Records management event service interface
* *
* @author Roy Wetherall * @author Roy Wetherall
*/ */
@AlfrescoPublicApi
public interface RecordsManagementEventService public interface RecordsManagementEventService
{ {
/** /**

View File

@@ -27,11 +27,14 @@
package org.alfresco.module.org_alfresco_module_rm.event; package org.alfresco.module.org_alfresco_module_rm.event;
import org.alfresco.api.AlfrescoPublicApi;
/** /**
* Records management event type interface * Records management event type interface
* *
* @author Roy Wetherall * @author Roy Wetherall
*/ */
@AlfrescoPublicApi
public interface RecordsManagementEventType public interface RecordsManagementEventType
{ {
/** /**

View File

@@ -27,6 +27,8 @@
package org.alfresco.module.org_alfresco_module_rm.fileplan; package org.alfresco.module.org_alfresco_module_rm.fileplan;
import org.alfresco.api.AlfrescoPublicApi;
/** /**
* File plan component kind enumeration class. * File plan component kind enumeration class.
* <br> * <br>
@@ -35,6 +37,7 @@ package org.alfresco.module.org_alfresco_module_rm.fileplan;
* *
* @author Roy Wetherall * @author Roy Wetherall
*/ */
@AlfrescoPublicApi
public enum FilePlanComponentKind public enum FilePlanComponentKind
{ {
FILE_PLAN_COMPONENT, FILE_PLAN_COMPONENT,

View File

@@ -32,6 +32,7 @@ import java.util.List;
import java.util.Map; import java.util.Map;
import java.util.Set; import java.util.Set;
import org.alfresco.api.AlfrescoPublicApi;
import org.alfresco.service.cmr.repository.NodeRef; import org.alfresco.service.cmr.repository.NodeRef;
import org.alfresco.service.cmr.repository.StoreRef; import org.alfresco.service.cmr.repository.StoreRef;
import org.alfresco.service.namespace.QName; import org.alfresco.service.namespace.QName;
@@ -42,6 +43,7 @@ import org.alfresco.service.namespace.QName;
* @author Roy Wetherall * @author Roy Wetherall
* @since 2.1 * @since 2.1
*/ */
@AlfrescoPublicApi
public interface FilePlanService public interface FilePlanService
{ {
/** /**

View File

@@ -30,6 +30,7 @@ package org.alfresco.module.org_alfresco_module_rm.freeze;
import java.util.Date; import java.util.Date;
import java.util.Set; import java.util.Set;
import org.alfresco.api.AlfrescoPublicApi;
import org.alfresco.module.org_alfresco_module_rm.hold.HoldService; import org.alfresco.module.org_alfresco_module_rm.hold.HoldService;
import org.alfresco.service.cmr.repository.NodeRef; import org.alfresco.service.cmr.repository.NodeRef;
@@ -41,6 +42,7 @@ import org.alfresco.service.cmr.repository.NodeRef;
* @author Roy Wetherall * @author Roy Wetherall
* @since 2.0 * @since 2.0
*/ */
@AlfrescoPublicApi
public interface FreezeService public interface FreezeService
{ {
/** /**

View File

@@ -29,6 +29,7 @@ package org.alfresco.module.org_alfresco_module_rm.hold;
import java.util.List; import java.util.List;
import org.alfresco.api.AlfrescoPublicApi;
import org.alfresco.service.cmr.repository.NodeRef; import org.alfresco.service.cmr.repository.NodeRef;
/** /**
@@ -37,6 +38,7 @@ import org.alfresco.service.cmr.repository.NodeRef;
* @author Tuna Aksoy * @author Tuna Aksoy
* @since 2.2 * @since 2.2
*/ */
@AlfrescoPublicApi
public interface HoldService public interface HoldService
{ {
/** /**

View File

@@ -30,6 +30,7 @@ package org.alfresco.module.org_alfresco_module_rm.identifier;
import java.io.Serializable; import java.io.Serializable;
import java.util.Map; import java.util.Map;
import org.alfresco.api.AlfrescoPublicApi;
import org.alfresco.service.namespace.QName; import org.alfresco.service.namespace.QName;
/** /**
@@ -37,6 +38,7 @@ import org.alfresco.service.namespace.QName;
* *
* @author Roy Wetherall * @author Roy Wetherall
*/ */
@AlfrescoPublicApi
public interface IdentifierGenerator public interface IdentifierGenerator
{ {
/** /**

View File

@@ -27,6 +27,7 @@
package org.alfresco.module.org_alfresco_module_rm.identifier; 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.cmr.repository.NodeRef;
import org.alfresco.service.namespace.QName; import org.alfresco.service.namespace.QName;
@@ -35,6 +36,7 @@ import org.alfresco.service.namespace.QName;
* *
* @author Roy Wetherall * @author Roy Wetherall
*/ */
@AlfrescoPublicApi
public interface IdentifierService public interface IdentifierService
{ {
/** Context value names */ /** Context value names */

View File

@@ -30,6 +30,7 @@ package org.alfresco.module.org_alfresco_module_rm.model;
import java.util.HashMap; import java.util.HashMap;
import java.util.Map; import java.util.Map;
import org.alfresco.api.AlfrescoPublicApi;
import org.alfresco.error.AlfrescoRuntimeException; import org.alfresco.error.AlfrescoRuntimeException;
import org.alfresco.module.org_alfresco_module_rm.util.ServiceBaseImpl; import org.alfresco.module.org_alfresco_module_rm.util.ServiceBaseImpl;
import org.alfresco.repo.policy.BehaviourFilter; import org.alfresco.repo.policy.BehaviourFilter;
@@ -43,6 +44,7 @@ import org.apache.commons.logging.LogFactory;
* @author Roy Wetherall * @author Roy Wetherall
* @since 2.2 * @since 2.2
*/ */
@AlfrescoPublicApi
public abstract class BaseBehaviourBean extends ServiceBaseImpl public abstract class BaseBehaviourBean extends ServiceBaseImpl
implements RecordsManagementModel, implements RecordsManagementModel,
BehaviourRegistry BehaviourRegistry

View File

@@ -27,6 +27,7 @@
package org.alfresco.module.org_alfresco_module_rm.model; package org.alfresco.module.org_alfresco_module_rm.model;
import org.alfresco.api.AlfrescoPublicApi;
import org.alfresco.service.namespace.QName; import org.alfresco.service.namespace.QName;
/** /**
@@ -34,6 +35,7 @@ import org.alfresco.service.namespace.QName;
* *
* @author Gavin Cornwell * @author Gavin Cornwell
*/ */
@AlfrescoPublicApi
public interface RecordsManagementCustomModel public interface RecordsManagementCustomModel
{ {
// Namespace details // Namespace details

View File

@@ -27,6 +27,7 @@
package org.alfresco.module.org_alfresco_module_rm.model; package org.alfresco.module.org_alfresco_module_rm.model;
import org.alfresco.api.AlfrescoPublicApi;
import org.alfresco.service.namespace.QName; import org.alfresco.service.namespace.QName;
/** /**
@@ -34,6 +35,7 @@ import org.alfresco.service.namespace.QName;
* *
* @author Roy Wetherall * @author Roy Wetherall
*/ */
@AlfrescoPublicApi
public interface RecordsManagementModel extends RecordsManagementCustomModel public interface RecordsManagementModel extends RecordsManagementCustomModel
{ {
// Namespace details // Namespace details

View File

@@ -29,6 +29,7 @@ package org.alfresco.module.org_alfresco_module_rm.model.security;
import java.util.Set; import java.util.Set;
import org.alfresco.api.AlfrescoPublicApi;
import org.alfresco.service.cmr.repository.NodeRef; import org.alfresco.service.cmr.repository.NodeRef;
import org.alfresco.service.namespace.QName; import org.alfresco.service.namespace.QName;
@@ -38,6 +39,7 @@ import org.alfresco.service.namespace.QName;
* @author Roy Wetherall * @author Roy Wetherall
* @since 2.1 * @since 2.1
*/ */
@AlfrescoPublicApi
public interface ModelSecurityService public interface ModelSecurityService
{ {
/** /**

View File

@@ -27,10 +27,13 @@
package org.alfresco.module.org_alfresco_module_rm.model.security; package org.alfresco.module.org_alfresco_module_rm.model.security;
import org.alfresco.api.AlfrescoPublicApi;
/** /**
* @author Roy Wetherall * @author Roy Wetherall
* @since 2.1 * @since 2.1
*/ */
@AlfrescoPublicApi
public class ProtectedAspect extends ProtectedModelArtifact public class ProtectedAspect extends ProtectedModelArtifact
{ {

View File

@@ -30,6 +30,7 @@ package org.alfresco.module.org_alfresco_module_rm.model.security;
import java.util.HashSet; import java.util.HashSet;
import java.util.Set; import java.util.Set;
import org.alfresco.api.AlfrescoPublicApi;
import org.alfresco.module.org_alfresco_module_rm.capability.Capability; import org.alfresco.module.org_alfresco_module_rm.capability.Capability;
import org.alfresco.service.namespace.NamespaceService; import org.alfresco.service.namespace.NamespaceService;
import org.alfresco.service.namespace.QName; import org.alfresco.service.namespace.QName;
@@ -40,6 +41,7 @@ import org.alfresco.service.namespace.QName;
* @author Roy Wetherall * @author Roy Wetherall
* @since 2.1 * @since 2.1
*/ */
@AlfrescoPublicApi
public abstract class ProtectedModelArtifact public abstract class ProtectedModelArtifact
{ {
/** Model security service */ /** Model security service */

View File

@@ -27,12 +27,15 @@
package org.alfresco.module.org_alfresco_module_rm.model.security; package org.alfresco.module.org_alfresco_module_rm.model.security;
import org.alfresco.api.AlfrescoPublicApi;
/** /**
* Protected property implementation * Protected property implementation
* *
* @author Roy Wetherall * @author Roy Wetherall
* @since 2.1 * @since 2.1
*/ */
@AlfrescoPublicApi
public class ProtectedProperty extends ProtectedModelArtifact public class ProtectedProperty extends ProtectedModelArtifact
{ {
/** always allow new indicator */ /** always allow new indicator */

View File

@@ -27,6 +27,7 @@
package org.alfresco.module.org_alfresco_module_rm.record; package org.alfresco.module.org_alfresco_module_rm.record;
import org.alfresco.api.AlfrescoPublicApi;
import org.alfresco.service.cmr.repository.NodeRef; import org.alfresco.service.cmr.repository.NodeRef;
/** /**
@@ -35,6 +36,7 @@ import org.alfresco.service.cmr.repository.NodeRef;
* @author Tuna Aksoy * @author Tuna Aksoy
* @since 2.3 * @since 2.3
*/ */
@AlfrescoPublicApi
public interface InplaceRecordService public interface InplaceRecordService
{ {
/** /**

View File

@@ -32,6 +32,7 @@ import java.util.List;
import java.util.Map; import java.util.Map;
import java.util.Set; import java.util.Set;
import org.alfresco.api.AlfrescoPublicApi;
import org.alfresco.service.cmr.repository.ContentReader; import org.alfresco.service.cmr.repository.ContentReader;
import org.alfresco.service.cmr.repository.NodeRef; import org.alfresco.service.cmr.repository.NodeRef;
import org.alfresco.service.namespace.QName; import org.alfresco.service.namespace.QName;
@@ -42,6 +43,7 @@ import org.alfresco.service.namespace.QName;
* @author Roy Wetherall * @author Roy Wetherall
* @since 2.1 * @since 2.1
*/ */
@AlfrescoPublicApi
public interface RecordService public interface RecordService
{ {
/** /**

View File

@@ -29,6 +29,7 @@ package org.alfresco.module.org_alfresco_module_rm.recordableversion;
import java.util.List; import java.util.List;
import org.alfresco.api.AlfrescoPublicApi;
import org.alfresco.module.org_alfresco_module_rm.script.slingshot.Version; import org.alfresco.module.org_alfresco_module_rm.script.slingshot.Version;
import org.alfresco.service.cmr.repository.NodeRef; import org.alfresco.service.cmr.repository.NodeRef;
@@ -38,6 +39,7 @@ import org.alfresco.service.cmr.repository.NodeRef;
* @author Tuna Aksoy * @author Tuna Aksoy
* @since 2.3 * @since 2.3
*/ */
@AlfrescoPublicApi
public interface RecordableVersionConfigService public interface RecordableVersionConfigService
{ {
/** /**

View File

@@ -31,6 +31,7 @@ import java.io.Serializable;
import java.util.List; import java.util.List;
import java.util.Map; import java.util.Map;
import org.alfresco.api.AlfrescoPublicApi;
import org.alfresco.service.cmr.repository.NodeRef; import org.alfresco.service.cmr.repository.NodeRef;
import org.alfresco.service.namespace.QName; import org.alfresco.service.namespace.QName;
@@ -40,6 +41,7 @@ import org.alfresco.service.namespace.QName;
* @author Roy Wetherall * @author Roy Wetherall
* @since 2.1 * @since 2.1
*/ */
@AlfrescoPublicApi
public interface RecordFolderService public interface RecordFolderService
{ {
/** /**

View File

@@ -27,6 +27,7 @@
package org.alfresco.module.org_alfresco_module_rm.relationship; package org.alfresco.module.org_alfresco_module_rm.relationship;
import org.alfresco.api.AlfrescoPublicApi;
import org.alfresco.service.cmr.repository.NodeRef; import org.alfresco.service.cmr.repository.NodeRef;
/** /**
@@ -35,6 +36,7 @@ import org.alfresco.service.cmr.repository.NodeRef;
* @author Tuna Aksoy * @author Tuna Aksoy
* @since 2.3 * @since 2.3
*/ */
@AlfrescoPublicApi
public interface Relationship public interface Relationship
{ {
/** /**

View File

@@ -27,12 +27,15 @@
package org.alfresco.module.org_alfresco_module_rm.relationship; package org.alfresco.module.org_alfresco_module_rm.relationship;
import org.alfresco.api.AlfrescoPublicApi;
/** /**
* Interface representing the relationship definition * Interface representing the relationship definition
* *
* @author Tuna Aksoy * @author Tuna Aksoy
* @since 2.3 * @since 2.3
*/ */
@AlfrescoPublicApi
public interface RelationshipDefinition public interface RelationshipDefinition
{ {
/** /**

View File

@@ -29,12 +29,15 @@ package org.alfresco.module.org_alfresco_module_rm.relationship;
import static org.alfresco.util.ParameterCheck.mandatoryString; import static org.alfresco.util.ParameterCheck.mandatoryString;
import org.alfresco.api.AlfrescoPublicApi;
/** /**
* POJO representing the relationship display name * POJO representing the relationship display name
* *
* @author Tuna Aksoy * @author Tuna Aksoy
* @since 2.3 * @since 2.3
*/ */
@AlfrescoPublicApi
public class RelationshipDisplayName public class RelationshipDisplayName
{ {
/** The source text of the relationship */ /** The source text of the relationship */

View File

@@ -29,6 +29,7 @@ package org.alfresco.module.org_alfresco_module_rm.relationship;
import java.util.Set; import java.util.Set;
import org.alfresco.api.AlfrescoPublicApi;
import org.alfresco.service.cmr.repository.NodeRef; import org.alfresco.service.cmr.repository.NodeRef;
/** /**
@@ -37,6 +38,7 @@ import org.alfresco.service.cmr.repository.NodeRef;
* @author Tuna Aksoy * @author Tuna Aksoy
* @since 2.3 * @since 2.3
*/ */
@AlfrescoPublicApi
public interface RelationshipService public interface RelationshipService
{ {
/** System relationship names */ /** System relationship names */

View File

@@ -27,12 +27,15 @@
package org.alfresco.module.org_alfresco_module_rm.relationship; package org.alfresco.module.org_alfresco_module_rm.relationship;
import org.alfresco.api.AlfrescoPublicApi;
/** /**
* Enum representing the relationship types * Enum representing the relationship types
* *
* @author Tuna Aksoy * @author Tuna Aksoy
* @since 2.3 * @since 2.3
*/ */
@AlfrescoPublicApi
public enum RelationshipType public enum RelationshipType
{ {
BIDIRECTIONAL, BIDIRECTIONAL,

View File

@@ -30,6 +30,7 @@ package org.alfresco.module.org_alfresco_module_rm.report;
import java.io.Serializable; import java.io.Serializable;
import java.util.Map; import java.util.Map;
import org.alfresco.api.AlfrescoPublicApi;
import org.alfresco.service.cmr.repository.ContentReader; import org.alfresco.service.cmr.repository.ContentReader;
import org.alfresco.service.namespace.QName; import org.alfresco.service.namespace.QName;
@@ -39,6 +40,7 @@ import org.alfresco.service.namespace.QName;
* @author Roy Wetherall * @author Roy Wetherall
* @since 2.1 * @since 2.1
*/ */
@AlfrescoPublicApi
public interface Report public interface Report
{ {
/** /**

View File

@@ -27,6 +27,7 @@
package org.alfresco.module.org_alfresco_module_rm.report; 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.cmr.repository.NodeRef;
import org.alfresco.service.namespace.QName; import org.alfresco.service.namespace.QName;
@@ -36,6 +37,7 @@ import org.alfresco.service.namespace.QName;
* @author Roy Wetherall * @author Roy Wetherall
* @since 2.1 * @since 2.1
*/ */
@AlfrescoPublicApi
public interface ReportGenerator public interface ReportGenerator
{ {
/** /**

View File

@@ -29,6 +29,7 @@ package org.alfresco.module.org_alfresco_module_rm.report;
import java.util.Set; import java.util.Set;
import org.alfresco.api.AlfrescoPublicApi;
import org.alfresco.service.cmr.repository.NodeRef; import org.alfresco.service.cmr.repository.NodeRef;
import org.alfresco.service.namespace.QName; import org.alfresco.service.namespace.QName;
@@ -38,6 +39,7 @@ import org.alfresco.service.namespace.QName;
* @author Roy Wetherall * @author Roy Wetherall
* @since 2.1 * @since 2.1
*/ */
@AlfrescoPublicApi
public interface ReportService public interface ReportService
{ {
/** /**

View File

@@ -31,6 +31,7 @@ import java.util.Arrays;
import java.util.List; import java.util.List;
import java.util.Set; import java.util.Set;
import org.alfresco.api.AlfrescoPublicApi;
import org.alfresco.module.org_alfresco_module_rm.capability.Capability; import org.alfresco.module.org_alfresco_module_rm.capability.Capability;
import org.alfresco.service.cmr.repository.NodeRef; import org.alfresco.service.cmr.repository.NodeRef;
@@ -40,6 +41,7 @@ import org.alfresco.service.cmr.repository.NodeRef;
* @author Roy Wetherall * @author Roy Wetherall
* @since 2.1 * @since 2.1
*/ */
@AlfrescoPublicApi
public interface FilePlanRoleService public interface FilePlanRoleService
{ {
/** Default role names */ /** Default role names */

View File

@@ -29,6 +29,7 @@ package org.alfresco.module.org_alfresco_module_rm.role;
import java.util.Set; import java.util.Set;
import org.alfresco.api.AlfrescoPublicApi;
import org.alfresco.module.org_alfresco_module_rm.capability.Capability; 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 * @author Roy Wetherall
*/ */
@AlfrescoPublicApi
public class Role public class Role
{ {
/** Role name */ /** Role name */

View File

@@ -33,6 +33,7 @@ import java.util.HashMap;
import java.util.List; import java.util.List;
import java.util.Map; import java.util.Map;
import org.alfresco.api.AlfrescoPublicApi;
import org.alfresco.error.AlfrescoRuntimeException; import org.alfresco.error.AlfrescoRuntimeException;
import org.alfresco.model.ContentModel; import org.alfresco.model.ContentModel;
import org.alfresco.service.cmr.repository.datatype.DefaultTypeConverter; import org.alfresco.service.cmr.repository.datatype.DefaultTypeConverter;
@@ -48,6 +49,7 @@ import org.json.JSONObject;
/** /**
* @author Roy Wetherall * @author Roy Wetherall
*/ */
@AlfrescoPublicApi
@SuppressWarnings("serial") @SuppressWarnings("serial")
public class RecordsManagementSearchParameters public class RecordsManagementSearchParameters
{ {

View File

@@ -29,6 +29,7 @@ package org.alfresco.module.org_alfresco_module_rm.search;
import java.util.List; import java.util.List;
import org.alfresco.api.AlfrescoPublicApi;
import org.alfresco.service.cmr.repository.NodeRef; import org.alfresco.service.cmr.repository.NodeRef;
import org.alfresco.util.Pair; import org.alfresco.util.Pair;
@@ -37,6 +38,7 @@ import org.alfresco.util.Pair;
* *
* @author Roy Wetherall * @author Roy Wetherall
*/ */
@AlfrescoPublicApi
public interface RecordsManagementSearchService public interface RecordsManagementSearchService
{ {
/** /**

View File

@@ -31,6 +31,7 @@ import java.util.ArrayList;
import java.util.List; import java.util.List;
import java.util.Map.Entry; import java.util.Map.Entry;
import org.alfresco.api.AlfrescoPublicApi;
import org.alfresco.error.AlfrescoRuntimeException; import org.alfresco.error.AlfrescoRuntimeException;
import org.alfresco.model.ContentModel; import org.alfresco.model.ContentModel;
import org.alfresco.module.org_alfresco_module_rm.model.RecordsManagementModel; import org.alfresco.module.org_alfresco_module_rm.model.RecordsManagementModel;
@@ -63,6 +64,7 @@ import org.springframework.extensions.surf.util.I18NUtil;
* *
* @author Roy Wetherall * @author Roy Wetherall
*/ */
@AlfrescoPublicApi
public class RecordsManagementSearchServiceImpl implements RecordsManagementSearchService public class RecordsManagementSearchServiceImpl implements RecordsManagementSearchService
{ {
private static final String SITES_SPACE_QNAME_PATH = "/app:company_home/st:sites/"; private static final String SITES_SPACE_QNAME_PATH = "/app:company_home/st:sites/";

View File

@@ -27,6 +27,7 @@
package org.alfresco.module.org_alfresco_module_rm.search; package org.alfresco.module.org_alfresco_module_rm.search;
import org.alfresco.api.AlfrescoPublicApi;
import org.alfresco.error.AlfrescoRuntimeException; import org.alfresco.error.AlfrescoRuntimeException;
import org.alfresco.service.cmr.repository.NodeRef; import org.alfresco.service.cmr.repository.NodeRef;
import org.alfresco.service.namespace.NamespaceService; import org.alfresco.service.namespace.NamespaceService;
@@ -83,6 +84,7 @@ import org.springframework.extensions.surf.util.I18NUtil;
* *
* @author Roy Wetherall * @author Roy Wetherall
*/ */
@AlfrescoPublicApi
public class SavedSearchDetails extends ReportDetails public class SavedSearchDetails extends ReportDetails
{ {
// JSON label values // JSON label values

View File

@@ -32,6 +32,7 @@ import java.net.URLDecoder;
import java.util.ArrayList; import java.util.ArrayList;
import java.util.List; import java.util.List;
import org.alfresco.api.AlfrescoPublicApi;
import org.alfresco.module.org_alfresco_module_rm.model.RecordsManagementModel; import org.alfresco.module.org_alfresco_module_rm.model.RecordsManagementModel;
import org.alfresco.service.namespace.NamespaceService; import org.alfresco.service.namespace.NamespaceService;
import org.alfresco.service.namespace.QName; import org.alfresco.service.namespace.QName;
@@ -42,6 +43,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. * 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. * Eventually will be factored out as web scripts are brought up to date.
*/ */
@AlfrescoPublicApi
public class SavedSearchDetailsCompatibility implements RecordsManagementModel public class SavedSearchDetailsCompatibility implements RecordsManagementModel
{ {
/** Saved search details */ /** Saved search details */

View File

@@ -29,6 +29,7 @@ package org.alfresco.module.org_alfresco_module_rm.security;
import java.util.Set; import java.util.Set;
import org.alfresco.api.AlfrescoPublicApi;
import org.alfresco.service.cmr.repository.NodeRef; import org.alfresco.service.cmr.repository.NodeRef;
/** /**
@@ -37,6 +38,7 @@ import org.alfresco.service.cmr.repository.NodeRef;
* @author Roy Wetherall * @author Roy Wetherall
* @since 2.1 * @since 2.1
*/ */
@AlfrescoPublicApi
public interface ExtendedSecurityService public interface ExtendedSecurityService
{ {
/** /**

View File

@@ -35,6 +35,7 @@ import org.alfresco.repo.security.authentication.AuthenticationUtil.RunAsWork;
* *
* @author Roy Wetherall * @author Roy Wetherall
* @since 2.1 * @since 2.1
* @deprecated as of 2.2, use {@link AuthenticationUtil}.
*/ */
public interface FilePlanAuthenticationService public interface FilePlanAuthenticationService
{ {

View File

@@ -27,6 +27,7 @@
package org.alfresco.module.org_alfresco_module_rm.security; package org.alfresco.module.org_alfresco_module_rm.security;
import org.alfresco.api.AlfrescoPublicApi;
import org.alfresco.service.cmr.repository.NodeRef; import org.alfresco.service.cmr.repository.NodeRef;
/** /**
@@ -35,6 +36,7 @@ import org.alfresco.service.cmr.repository.NodeRef;
* @author Roy Wetherall * @author Roy Wetherall
* @since 2.1 * @since 2.1
*/ */
@AlfrescoPublicApi
public interface FilePlanPermissionService public interface FilePlanPermissionService
{ {
/** /**

View File

@@ -27,6 +27,7 @@
package org.alfresco.module.org_alfresco_module_rm.transfer; package org.alfresco.module.org_alfresco_module_rm.transfer;
import org.alfresco.api.AlfrescoPublicApi;
import org.alfresco.service.cmr.repository.NodeRef; import org.alfresco.service.cmr.repository.NodeRef;
/** /**
@@ -35,6 +36,7 @@ import org.alfresco.service.cmr.repository.NodeRef;
* @author Tuna Aksoy * @author Tuna Aksoy
* @since 2.2 * @since 2.2
*/ */
@AlfrescoPublicApi
public interface TransferService public interface TransferService
{ {
/** /**

View File

@@ -27,6 +27,7 @@
package org.alfresco.module.org_alfresco_module_rm.util; package org.alfresco.module.org_alfresco_module_rm.util;
import org.alfresco.api.AlfrescoPublicApi;
import org.alfresco.repo.security.authentication.AuthenticationException; import org.alfresco.repo.security.authentication.AuthenticationException;
import org.alfresco.repo.security.authentication.AuthenticationUtil.RunAsWork; import org.alfresco.repo.security.authentication.AuthenticationUtil.RunAsWork;
@@ -38,6 +39,7 @@ import org.alfresco.repo.security.authentication.AuthenticationUtil.RunAsWork;
* @author Roy Wetherall * @author Roy Wetherall
* @since 2.3 * @since 2.3
*/ */
@AlfrescoPublicApi
public class AuthenticationUtil public class AuthenticationUtil
{ {
/** /**

View File

@@ -31,6 +31,7 @@ import java.util.Map;
import java.util.Set; import java.util.Set;
import java.util.WeakHashMap; import java.util.WeakHashMap;
import org.alfresco.api.AlfrescoPublicApi;
import org.alfresco.module.org_alfresco_module_rm.fileplan.FilePlanComponentKind; import org.alfresco.module.org_alfresco_module_rm.fileplan.FilePlanComponentKind;
import org.alfresco.module.org_alfresco_module_rm.fileplan.FilePlanService; import org.alfresco.module.org_alfresco_module_rm.fileplan.FilePlanService;
import org.alfresco.module.org_alfresco_module_rm.hold.HoldService; import org.alfresco.module.org_alfresco_module_rm.hold.HoldService;
@@ -52,6 +53,7 @@ import org.springframework.context.ApplicationContextAware;
* @author Roy Wetherall * @author Roy Wetherall
* @since 2.1 * @since 2.1
*/ */
@AlfrescoPublicApi
public class ServiceBaseImpl implements RecordsManagementModel, ApplicationContextAware public class ServiceBaseImpl implements RecordsManagementModel, ApplicationContextAware
{ {
/** Node service */ /** Node service */

View File

@@ -32,6 +32,8 @@ import java.util.Map;
import java.util.Set; import java.util.Set;
import java.util.TreeSet; import java.util.TreeSet;
import org.alfresco.api.AlfrescoPublicApi;
/** /**
* Delegate spring bean for TransactionResourceHelper * Delegate spring bean for TransactionResourceHelper
* *
@@ -39,6 +41,7 @@ import java.util.TreeSet;
* @since 2.3 * @since 2.3
* @see org.alfresco.repo.transaction.TransactionalResourceHelper * @see org.alfresco.repo.transaction.TransactionalResourceHelper
*/ */
@AlfrescoPublicApi
public class TransactionalResourceHelper public class TransactionalResourceHelper
{ {
/** /**

View File

@@ -27,6 +27,7 @@
package org.alfresco.module.org_alfresco_module_rm.version; 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.repository.NodeRef;
import org.alfresco.service.cmr.version.Version; import org.alfresco.service.cmr.version.Version;
@@ -36,6 +37,7 @@ import org.alfresco.service.cmr.version.Version;
* @author Roy Wetherall * @author Roy Wetherall
* @since 2.3 * @since 2.3
*/ */
@AlfrescoPublicApi
public interface RecordableVersionService public interface RecordableVersionService
{ {
/** /**

View File

@@ -36,6 +36,7 @@ import org.alfresco.service.cmr.repository.Period;
* @author Roy Wetherall * @author Roy Wetherall
* @since 2.0 * @since 2.0
*/ */
// Not @AlfrescoPublicApi due to e.g. Period.
public interface VitalRecordService public interface VitalRecordService
{ {
/** Period 'none' */ /** Period 'none' */

View File

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