From 519cec79651bf50e7ed1dcc660538acbcb6dd240 Mon Sep 17 00:00:00 2001
From: Jan Vonka <jan.vonka@alfresco.com>
Date: Mon, 17 Sep 2007 10:37:39 +0000
Subject: [PATCH] JavaDoc update

git-svn-id: https://svn.alfresco.com/repos/alfresco-enterprise/alfresco/HEAD/root@6797 c4b6b30b-aa2e-2d43-bbcb-ca4b014f7261
---
 .../service/cmr/admin/RepoAdminService.java   | 35 +++++++------------
 1 file changed, 12 insertions(+), 23 deletions(-)

diff --git a/source/java/org/alfresco/service/cmr/admin/RepoAdminService.java b/source/java/org/alfresco/service/cmr/admin/RepoAdminService.java
index 921ad2fd4e..eec54bf902 100755
--- a/source/java/org/alfresco/service/cmr/admin/RepoAdminService.java
+++ b/source/java/org/alfresco/service/cmr/admin/RepoAdminService.java
@@ -47,44 +47,35 @@ public interface RepoAdminService
     //
 
     /**
-     * Get list of deployed custom models 
-     * 
-     * - those that are runtime/repo managed only
+     * Get list of deployed custom model.
      */  
     @Auditable
     public List<RepoModelDefinition> getModels();
 
     /**
-     * Deploy custom model
-     * 
-     * - allows creation of new models
-     * - allows update of existing models (*)
-     * 
-     * (*) TODO - currently no validation (or locking) so can break existing usages
+     * Deploy custom model (to the 'Models' space). 
+     * Allows creation of new models and incremental update of existing models.
      * 
      */
     @Auditable(parameters = {"modelStream, modelFileName"})
     public void deployModel(InputStream modelStream, String modelFileName);
 
     /**
-     * Undeploy custom model
-     * 
-     * - allows delete of existing models (*)
-     * - permanently removes definition from repository (all versions)
-     * 
-     * (*) TODO - currently no validation (or locking) so can break existing usages
+     * Undeploy custom model (from the 'Models' space). 
+     * Allows delete of existing models, if not used. 
+     * Permanently removes the model definition from the repository (all versions).
      */
     @Auditable(parameters = {"modelFileName"})
     public QName undeployModel(String modelFileName);
 
     /**
-     * Activate custom model
+     * Activate custom model.
      */
     @Auditable(parameters = {"modelFileName"})
     public QName activateModel(String modelFileName);
     
     /**
-     * Deactivate custom model
+     * Deactivate custom model.
      */
     @Auditable(parameters = {"modelFileName"})
     public QName deactivateModel(String modelFileName);
@@ -94,28 +85,26 @@ public interface RepoAdminService
     //
 
     /**
-     * Get deployed custom messages resource bundles
-     * 
-     * - those that are runtime/repo managed only
+     * Get deployed custom messages resource bundles.
      */
     @Auditable
     public List<String> getMessageBundles();
 
     /**
-     * Deploy custom message resource bundle
+     * Deploy custom message resource bundle (to the 'Messages' space).
      * 
      */
     @Auditable(parameters = {"resourceClasspath"})
     public String deployMessageBundle(String resourceClasspath);
 
     /**
-     * Undeploy custom message resource bundle
+     * Undeploy custom message resource bundle (from the 'Messages' space).
      */
     @Auditable(parameters = {"bundleBaseName"})
     public void undeployMessageBundle(String bundleBaseName);
  
     /**
-     * Reload custom message resource bundle
+     * Reload custom message resource bundle.
      */
     @Auditable(parameters = {"bundleBaseName"})
     public void reloadMessageBundle(String bundleBaseName);