diff --git a/source/java/org/alfresco/wcm/sandbox/SandboxService.java b/source/java/org/alfresco/wcm/sandbox/SandboxService.java index d3824a2f76..be6910ac67 100644 --- a/source/java/org/alfresco/wcm/sandbox/SandboxService.java +++ b/source/java/org/alfresco/wcm/sandbox/SandboxService.java @@ -28,7 +28,6 @@ import java.util.Date; import java.util.List; import java.util.Map; -import org.alfresco.service.cmr.avm.VersionDescriptor; import org.alfresco.service.namespace.QName; import org.alfresco.wcm.asset.AssetInfo; @@ -154,7 +153,7 @@ public interface SandboxService * * @param sbStoreId sandbox store id * @param includeDeleted if true, include deleted assets as well as new/modified assets - * @return List list of all changed assets + * @return List list of all changed assets */ public List listChangedAll(String sbStoreId, boolean includeDeleted); @@ -166,7 +165,7 @@ public interface SandboxService * @param sbStoreId sandbox store id * @param webApp web app to filter by * @param includeDeleted if true, include deleted assets as well as new/modified assets - * @return List list of changed assets + * @return List list of changed assets */ public List listChangedWebApp(String sbStoreId, String webApp, boolean includeDeleted); @@ -178,7 +177,7 @@ public interface SandboxService * @param sbStoreId sandbox store id * @param relativePath relative path to filter by (eg. /www/avm_webapps/ROOT/MyFolderToList) * @param includeDeleted if true, include deleted assets as well as new/modified assets - * @return List list of changed assets + * @return List list of changed assets */ public List listChanged(String sbStoreId, String relativePath, boolean includeDeleted); @@ -190,7 +189,7 @@ public interface SandboxService * @param dstSandboxStoreId destination sandbox store id * @param dstRelativePath destination relative path to filter by (eg. /www/avm_webapps/ROOT/MyFolderToList) * @param includeDeleted if true, include deleted assets as well as new/modified assets - * @return List list of changed assets + * @return List list of changed assets */ public List listChanged(String srcSandboxStoreId, String srcRelativePath, String dstSandboxStoreId, String dstRelativePath, boolean includeDeleted); @@ -199,67 +198,81 @@ public interface SandboxService *

* Note: This will submit all new/modified/deleted assets from the sandbox root directory (eg. /www/avm_webapps) - ie. across all web apps *

- * @param sbStoreId sandbox store id - * @param submitLabel label for submitted snapshot - * @param submitComment comment for submitted snapshot + * @param sbStoreId sandbox store id + * @param submitLabel label for submitted snapshot + * @param submitDescription description for submitted snapshot */ - public void submitAll(String sbStoreId, String submitLabel, String submitComment); + public void submitAll(String sbStoreId, String submitLabel, String submitDescription); /** * Submit changed assets for given sandbox and web app (eg. in user sandbox) *

* Note: This will submit new/modified/deleted assets for the given web app * - * @param sbStoreId sandbox store id - * @param webApp web app to filter by - * @param submitLabel label for submitted snapshot - * @param submitComment comment for submitted snapshot + * @param sbStoreId sandbox store id + * @param webApp web app to filter by + * @param submitLabel label for submitted snapshot + * @param submitDescription description for submitted snapshot */ - public void submitWebApp(String sbStoreId, String webApp, String submitLabel, String submitComment); + public void submitWebApp(String sbStoreId, String webApp, String submitLabel, String submitDescription); /** * Submit changed asset(s) for given sandbox path (eg. in user sandbox) *

* Note: This will submit new/modified/deleted asset(s) for given path (either file or directory and below) * - * @param sbStoreId sandbox store id - * @param relativePath relative path to filter by (eg. /www/avm_webapps or /www/avm_webapps/ROOT/MyFolderToSubmit) - * @param submitLabel label for submitted snapshot - * @param submitComment comment for submitted snapshot + * @param sbStoreId sandbox store id + * @param relativePath relative path to filter by (eg. /www/avm_webapps or /www/avm_webapps/ROOT/MyFolderToSubmit) + * @param submitLabel label for submitted snapshot + * @param submitDescription description for submitted snapshot */ - public void submit(String sbStoreId, String relativePath, String submitLabel, String submitComment); + public void submit(String sbStoreId, String relativePath, String submitLabel, String submitDescription); /** * Submit list of changed assets for given sandbox (eg. in user sandbox) * - * @param sbStoreId sandbox store id - * @param assetPaths list of assets, as relative paths (eg. /www/avm_webapps/ROOT/MyFolderToSubmit) - * @param submitLabel label for submitted snapshot - * @param submitComment comment for submitted snapshot + * @param sbStoreId sandbox store id + * @param assetPaths list of assets, as relative paths (eg. /www/avm_webapps/ROOT/MyFolderToSubmit) + * @param submitLabel label for submitted snapshot + * @param submitDescription description for submitted snapshot */ - public void submitList(String sbStoreId, List relativePaths, String submitLabel, String submitComment); - - public void submitList(String sbStoreId, List relativePaths, Map expirationDates, String submitLabel, String submitComment); - /** - * Submit list of changed assets for given sandbox (eg. from user sandbox to staging sandbox) - * - * @param sbStoreId sandbox store id - * @param assetNodes list of assets, as AVM node descriptors - * @param submitLabel label for submitted snapshot - * @param submitComment comment for submitted snapshot - */ - public void submitListAssets(String sbStoreId, List assets, String submitLabel, String submitComment); + public void submitList(String sbStoreId, List relativePaths, String submitLabel, String submitDescription); /** * Submit list of changed assets for given sandbox (eg. from user sandbox to staging sandbox) * - * @param sbStoreId sandbox store id - * @param assets list of assets, as AVM node descriptors - * @param expirationDates map of for those assets set with an expiration date, or can be null (if no expiration dates) - * @param submitLabel label for submitted snapshot - * @param submitComment comment for submitted snapshot + * NOTE: for backwards compatibility - subject to change - hence deprecated for now + * + * @param sbStoreId sandbox store id + * @param assetPaths list of assets, as relative paths (eg. /www/avm_webapps/ROOT/MyFolderToSubmit) + * @param expirationDates map of AVM src paths to expiration dates + * @param submitLabel label for submitted snapshot + * @param submitDescription description for submitted snapshot + * + * @deprecated */ - public void submitListAssets(String sbStoreId, List assets, Map expirationDates, String submitLabel, String submitComment); + public void submitList(String sbStoreId, List relativePaths, Map expirationDates, String submitLabel, String submitDescription); + + /** + * Submit list of changed assets for given sandbox (eg. from user sandbox to staging sandbox) + * + * @param sbStoreId sandbox store id + * @param assetNodes list of assets + * @param submitLabel label for submitted snapshot + * @param submitDescription description for submitted snapshot + */ + public void submitListAssets(String sbStoreId, List assets, String submitLabel, String submitDescription); + + /** + * Submit list of changed assets for given sandbox (eg. from user sandbox to staging sandbox) + * + * @param sbStoreId sandbox store id + * @param assets list of assets + * @param expirationDates map of for those assets set with an expiration date, or can be null (if no expiration dates) + * @param submitLabel label for submitted snapshot + * @param submitDescription description for submitted snapshot + */ + public void submitListAssets(String sbStoreId, List assets, Map expirationDates, String submitLabel, String submitDescription); /** * Revert all changed assets for given sandbox (eg. in user sandbox) @@ -294,14 +307,14 @@ public interface SandboxService * Revert list of changed assets for given sandbox (eg. in user sandbox) * * @param sbStoreId sandbox store id - * @param assetPaths list of assets, as relative paths (eg. /www/avm_webapps/ROOT/MyFolderToRevert) + * @param assetPaths list of assets, as relative paths (eg. /www/avm_webapps/ROOT/MyFolderToRevert) */ public void revertList(String sbStoreId, List relativePaths); /** * Revert list of changed assets for given sandbox (eg. in user sandbox) * - * @param assets list of AVM node descriptors + * @param assets list of assets */ public void revertListNodes(String sbStoreId, List assets); diff --git a/source/java/org/alfresco/wcm/sandbox/SandboxServiceImpl.java b/source/java/org/alfresco/wcm/sandbox/SandboxServiceImpl.java index c0ae51a72d..624e7bb781 100644 --- a/source/java/org/alfresco/wcm/sandbox/SandboxServiceImpl.java +++ b/source/java/org/alfresco/wcm/sandbox/SandboxServiceImpl.java @@ -491,6 +491,9 @@ public class SandboxServiceImpl implements SandboxService submitList(sbStoreId, relativePaths, null, submitLabel, submitComment); } + /* (non-Javadoc) + * @see org.alfresco.wcm.sandbox.SandboxService#submitList(java.lang.String, java.util.List, java.util.Map, java.lang.String, java.lang.String) + */ public void submitList(String sbStoreId, List relativePaths, Map expirationDates, String submitLabel, String submitComment) { ParameterCheck.mandatoryString("sbStoreId", sbStoreId); diff --git a/source/java/org/alfresco/wcm/sandbox/SandboxVersion.java b/source/java/org/alfresco/wcm/sandbox/SandboxVersion.java index b796e606b1..dfc35cf6b0 100644 --- a/source/java/org/alfresco/wcm/sandbox/SandboxVersion.java +++ b/source/java/org/alfresco/wcm/sandbox/SandboxVersion.java @@ -60,16 +60,16 @@ public interface SandboxVersion public Date getCreatedDate(); /** - * Get the short description + * Get the submitted (short) label / tag * - * @return The short description + * @return The label */ - public String getTag(); + public String getLabel(); /** - * Get the long description + * Get the submitted (long) description * - * @return The long description + * @return The description */ public String getDescription(); diff --git a/source/java/org/alfresco/wcm/sandbox/SandboxVersionImpl.java b/source/java/org/alfresco/wcm/sandbox/SandboxVersionImpl.java index bb961cee53..a940db68a8 100644 --- a/source/java/org/alfresco/wcm/sandbox/SandboxVersionImpl.java +++ b/source/java/org/alfresco/wcm/sandbox/SandboxVersionImpl.java @@ -73,9 +73,9 @@ public class SandboxVersionImpl implements SandboxVersion } /* (non-Javadoc) - * @see org.alfresco.wcm.sandbox.SandboxVersion#getTag() + * @see org.alfresco.wcm.sandbox.SandboxVersion#getLabel() */ - public String getTag() + public String getLabel() { return vDesc.getTag(); }