ACE-4598: ServiceRegistry exposes services that are not part of the p…

…ublic API

Updated the deprecated message wording to make it clearer it's just the method on ServiceRegistry that's deprecated and not the service/object being returned.

git-svn-id: https://svn.alfresco.com/repos/alfresco-enterprise/alfresco/HEAD/root@118420 c4b6b30b-aa2e-2d43-bbcb-ca4b014f7261

source/java/org/alfresco/service/ServiceRegistry.java

@@ -187,14 +187,16 @@ public interface ServiceRegistry
 
     /**
      * @return the descriptor service
-     * @deprecated This method returns a service that is not part of the public Java API.
+     * @deprecated This method has been deprecated as it would return a service that is not part of the public API. 
+     * The service itself is not deprecated, but access to it via the ServiceRegistry will be removed in the future.
      */
     @NotAuditable
     DescriptorService getDescriptorService();
 
     /**
      * @return the transaction service
-     * @deprecated This method returns a service that is not part of the public Java API.
+     * @deprecated This method has been deprecated as it would return a service that is not part of the public API. 
+     * The service itself is not deprecated, but access to it via the ServiceRegistry will be removed in the future.
      */
     @NotAuditable
     TransactionService getTransactionService();
@@ -237,7 +239,8 @@ public interface ServiceRegistry
 
     /**
      * @return the content filter languages service (or null, if one is not provided)
-     * @deprecated This method returns a service that is not part of the public Java API.
+     * @deprecated This method has been deprecated as it would return a service that is not part of the public API. 
+     * The service itself is not deprecated, but access to it via the ServiceRegistry will be removed in the future.
      */
     @NotAuditable
     ContentFilterLanguagesService getContentFilterLanguagesService();
@@ -292,21 +295,24 @@ public interface ServiceRegistry
 
     /**
      * @return the importer service or null if not present
-     * @deprecated This method returns a service that is not part of the public Java API.
+     * @deprecated This method has been deprecated as it would return a service that is not part of the public API. 
+     * The service itself is not deprecated, but access to it via the ServiceRegistry will be removed in the future.
      */
     @NotAuditable
     ImporterService getImporterService();
 
     /**
      * @return the exporter service or null if not present
-     * @deprecated This method returns a service that is not part of the public Java API.
+     * @deprecated This method has been deprecated as it would return a service that is not part of the public API. 
+     * The service itself is not deprecated, but access to it via the ServiceRegistry will be removed in the future.
      */
     @NotAuditable
     ExporterService getExporterService();
 
     /**
      * @return the rule service (or null, if one is not provided)
-     * @deprecated This method returns a service that is not part of the public Java API.
+     * @deprecated This method has been deprecated as it would return a service that is not part of the public API. 
+     * The service itself is not deprecated, but access to it via the ServiceRegistry will be removed in the future.
      */
     @NotAuditable
     RuleService getRuleService();
@@ -343,7 +349,8 @@ public interface ServiceRegistry
 
     /**
      * @return the script execution service (or null if one is not provided)
-     * @deprecated This method returns a service that is not part of the public Java API.
+     * @deprecated This method has been deprecated as it would return a service that is not part of the public API. 
+     * The service itself is not deprecated, but access to it via the ServiceRegistry will be removed in the future.
      */
     @NotAuditable
     ScriptService getScriptService();
@@ -356,22 +363,25 @@ public interface ServiceRegistry
 
     /**
      * @return the notification service (or null if on is not provided)
-     * @deprecated This method returns a service that is not part of the public Java API.
+     * @deprecated This method has been deprecated as it would return a service that is not part of the public API. 
+     * The service itself is not deprecated, but access to it via the ServiceRegistry will be removed in the future.
      */
     @NotAuditable
     NotificationService getNotificationService();
 
     /**
      * @return the audit service (or null if one is not provided)
-     * @deprecated This method returns a service that is not part of the public Java API.
+     * @deprecated This method has been deprecated as it would return a service that is not part of the public API. 
+     * The service itself is not deprecated, but access to it via the ServiceRegistry will be removed in the future.
      */
     @NotAuditable
     AuditService getAuditService();
 
     /**
      * Get the ownable service (or null if one is not provided)
      * @return OwnableService
-     * @deprecated This method returns a service that is not part of the public Java API.
+     * @deprecated This method has been deprecated as it would return a service that is not part of the public API. 
+     * The service itself is not deprecated, but access to it via the ServiceRegistry will be removed in the future.
      */
     @NotAuditable
     OwnableService getOwnableService();
@@ -396,21 +406,24 @@ public interface ServiceRegistry
 
     /**
      * Get the Multilingual Content Service
-     * @deprecated This method returns a service that is not part of the public Java API.
+     * @deprecated This method has been deprecated as it would return a service that is not part of the public API. 
+     * The service itself is not deprecated, but access to it via the ServiceRegistry will be removed in the future.
      */
     @NotAuditable
     MultilingualContentService getMultilingualContentService();
 
     /**
      * Get the Edition Service
-     * @deprecated This method returns a service that is not part of the public Java API.
+     * @deprecated This method has been deprecated as it would return a service that is not part of the public API. 
+     * The service itself is not deprecated, but access to it via the ServiceRegistry will be removed in the future.
      */
     @NotAuditable
     EditionService getEditionService();
 
     /**
      * Get the Thumbnail Service
-     * @deprecated This method returns a service that is not part of the public Java API.
+     * @deprecated This method has been deprecated as it would return a service that is not part of the public API. 
+     * The service itself is not deprecated, but access to it via the ServiceRegistry will be removed in the future.
      */
     @NotAuditable
     ThumbnailService getThumbnailService();
@@ -423,7 +436,8 @@ public interface ServiceRegistry
 
     /**
      * Get the form service (or null if one is not provided)
-     * @deprecated This method returns a service that is not part of the public Java API.
+     * @deprecated This method has been deprecated as it would return a service that is not part of the public API. 
+     * The service itself is not deprecated, but access to it via the ServiceRegistry will be removed in the future.
      */
     @NotAuditable
     FormService getFormService();
@@ -450,7 +464,8 @@ public interface ServiceRegistry
      * Get the blog service (or null if one is not provided)
      * 
      * @since 4.0
-     * @deprecated This method returns a service that is not part of the public Java API.
+     * @deprecated This method has been deprecated as it would return a service that is not part of the public API. 
+     * The service itself is not deprecated, but access to it via the ServiceRegistry will be removed in the future.
      */
     @NotAuditable
     BlogService getBlogService();
@@ -459,71 +474,80 @@ public interface ServiceRegistry
      * Get the calendar service (or null if one is not provided)
      * 
      * @since 4.0
-     * @deprecated This method returns a service that is not part of the public Java API.
+     * @deprecated This method has been deprecated as it would return a service that is not part of the public API. 
+     * The service itself is not deprecated, but access to it via the ServiceRegistry will be removed in the future.
      */
     @NotAuditable
     CalendarService getCalendarService();
 
     /**
      * Get the invitation service (or null if one is not provided)
      * @return the invitation service
-     * @deprecated This method returns a service that is not part of the public Java API.
+     * @deprecated This method has been deprecated as it would return a service that is not part of the public API. 
+     * The service itself is not deprecated, but access to it via the ServiceRegistry will be removed in the future.
      */
     @NotAuditable
     InvitationService getInvitationService();
 
     /**
      * Get the CMIS Dictionary service (or null if one is not provided)
      * @return the CMIS Dictionary service
-     * @deprecated This method returns a service that is not part of the public Java API.
+     * @deprecated This method has been deprecated as it would return a service that is not part of the public API. 
+     * The service itself is not deprecated, but access to it via the ServiceRegistry will be removed in the future.
      */
     @NotAuditable
     CMISDictionaryService getCMISDictionaryService();
 
     /**
      * Get the CMIS Query service (or null if one is not provided)
      * @return the CMIS Query service
-     * @deprecated This method returns a service that is not part of the public Java API.
+     * @deprecated This method has been deprecated as it would return a service that is not part of the public API. 
+     * The service itself is not deprecated, but access to it via the ServiceRegistry will be removed in the future.
      */
     @NotAuditable
     CMISQueryService getCMISQueryService();
 
     /**
      * Get the IMAP service (or null if one is not provided)
      * @return the IMAP service
-     * @deprecated This method returns a service that is not part of the public Java API.
+     * @deprecated This method has been deprecated as it would return a service that is not part of the public API. 
+     * The service itself is not deprecated, but access to it via the ServiceRegistry will be removed in the future.
      */
     @NotAuditable
     ImapService getImapService();
 
     /**
      * Get the Public Service Access service (or null if one is not provided)
      * @return the Public Service Access service
-     * @deprecated This method returns a service that is not part of the public Java API.
+     * @deprecated This method has been deprecated as it would return a service that is not part of the public API. 
+     * The service itself is not deprecated, but access to it via the ServiceRegistry will be removed in the future.
      */
     @NotAuditable
     PublicServiceAccessService getPublicServiceAccessService();
 
     /**
      * Get the repo admin service (or null if one is not provided)
      * @return the repo admin service
-     * @deprecated This method returns a service that is not part of the public Java API.
+     * @deprecated This method has been deprecated as it would return a service that is not part of the public API. 
+     * The service itself is not deprecated, but access to it via the ServiceRegistry will be removed in the future.
      */
     @NotAuditable
     RepoAdminService getRepoAdminService();
 
     /**
      * Get the sys admin params helper bean.
      * @return the sys admin params bean.
-     * @deprecated This method returns a service that is not part of the public Java API.
+     * @deprecated This method has been deprecated as it would return an object that is not part of the public API. 
+     * The object itself is not deprecated, but access to it via the ServiceRegistry will be removed in the future.
      */
     @NotAuditable
     SysAdminParams getSysAdminParams();
 
     /**
      * Get the webdav service / helper bean.
      * @return the webdav service / helper bean
-     * @deprecated This method returns a service that is not part of the public Java API.
+     * @deprecated This method has been deprecated as it would return a service that is not part of the public API. 
+     * The service itself is not deprecated, but access to it via the ServiceRegistry will be removed in the future.
      */
     @NotAuditable
     WebDavService getWebDavService();
@@ -538,15 +562,17 @@ public interface ServiceRegistry
     /**
      * Get the Solr facet helper bean
      * @return the Solr facet helper bean
-     * @deprecated This method returns a service that is not part of the public Java API.
+     * @deprecated This method has been deprecated as it would return an object that is not part of the public API. 
+     * The object itself is not deprecated, but access to it via the ServiceRegistry will be removed in the future.
      */
     @NotAuditable
     SolrFacetHelper getSolrFacetHelper();
 
     /**
      * Get the facet label display handler registry bean
      * @return the Facet label display handler registry bean
-     * @deprecated This method returns a service that is not part of the public Java API.
+     * @deprecated This method has been deprecated as it would return an object that is not part of the public API. 
+     * The object itself is not deprecated, but access to it via the ServiceRegistry will be removed in the future.
      */
     @NotAuditable
     FacetLabelDisplayHandlerRegistry getFacetLabelDisplayHandlerRegistry();
@@ -561,7 +587,8 @@ public interface ServiceRegistry
     /**
      * Get the document link service
      * @return the document link service
-     * @deprecated This method returns a service that is not part of the public Java API.
+     * @deprecated This method has been deprecated as it would return a service that is not part of the public API. 
+     * The service itself is not deprecated, but access to it via the ServiceRegistry will be removed in the future.
      */
     @NotAuditable
     DocumentLinkService getDocumentLinkService();