From fab3f867f836f7a1bddeb01f1a0ddb9d172347a0 Mon Sep 17 00:00:00 2001 From: Kevin Roast Date: Wed, 28 Mar 2007 09:14:19 +0000 Subject: [PATCH] JavaDoc updates for recent Template/script class changes and additions git-svn-id: https://svn.alfresco.com/repos/alfresco-enterprise/alfresco/HEAD/root@5428 c4b6b30b-aa2e-2d43-bbcb-ca4b014f7261 --- source/java/org/alfresco/repo/jscript/RhinoScriptService.java | 2 +- source/java/org/alfresco/repo/template/BaseContentNode.java | 2 ++ .../java/org/alfresco/repo/template/BasePermissionsNode.java | 2 ++ source/java/org/alfresco/repo/template/TemplateContent.java | 2 ++ source/java/org/alfresco/repo/template/TemplateNode.java | 2 ++ source/java/org/alfresco/repo/template/TemplateNodeRef.java | 3 +++ .../java/org/alfresco/repo/template/TemplatePermissions.java | 2 ++ source/java/org/alfresco/repo/template/TemplateProperties.java | 2 ++ 8 files changed, 16 insertions(+), 1 deletion(-) diff --git a/source/java/org/alfresco/repo/jscript/RhinoScriptService.java b/source/java/org/alfresco/repo/jscript/RhinoScriptService.java index 052edc251c..50fb7ccfc1 100644 --- a/source/java/org/alfresco/repo/jscript/RhinoScriptService.java +++ b/source/java/org/alfresco/repo/jscript/RhinoScriptService.java @@ -453,7 +453,7 @@ public class RhinoScriptService implements ScriptService if (resource.startsWith("/")) { // resolve from default SpacesStore as cm:name based path - // TODO: remove this once FFS correctly allows name path resolving from store root! + // we have to assume "/Company Home" as the root for now NodeRef rootNodeRef = this.services.getNodeService().getRootNode(this.storeRef); List nodes = this.services.getSearchService().selectNodes( rootNodeRef, this.storePath, null, this.services.getNamespaceService(), false); diff --git a/source/java/org/alfresco/repo/template/BaseContentNode.java b/source/java/org/alfresco/repo/template/BaseContentNode.java index 4e072b0cd5..b85b28444b 100644 --- a/source/java/org/alfresco/repo/template/BaseContentNode.java +++ b/source/java/org/alfresco/repo/template/BaseContentNode.java @@ -42,6 +42,8 @@ import org.alfresco.service.namespace.QName; import org.springframework.util.StringUtils; /** + * Base class for Template API objects that supply content functionality. + * * @author Kevin Roast */ public abstract class BaseContentNode implements TemplateContent diff --git a/source/java/org/alfresco/repo/template/BasePermissionsNode.java b/source/java/org/alfresco/repo/template/BasePermissionsNode.java index 515234f8dc..1ac5f5ea93 100644 --- a/source/java/org/alfresco/repo/template/BasePermissionsNode.java +++ b/source/java/org/alfresco/repo/template/BasePermissionsNode.java @@ -32,6 +32,8 @@ import org.alfresco.service.cmr.security.AccessPermission; import org.alfresco.service.cmr.security.AccessStatus; /** + * Base class for Template API objects that support permissions. + * * @author Kevin Roast */ public abstract class BasePermissionsNode extends BaseContentNode implements TemplatePermissions diff --git a/source/java/org/alfresco/repo/template/TemplateContent.java b/source/java/org/alfresco/repo/template/TemplateContent.java index 967993b1d0..780a4f5faa 100644 --- a/source/java/org/alfresco/repo/template/TemplateContent.java +++ b/source/java/org/alfresco/repo/template/TemplateContent.java @@ -26,6 +26,8 @@ package org.alfresco.repo.template; /** + * Contract for Template API objects that support content on the 'cm:content' default property. + * * @author Kevin Roast */ public interface TemplateContent extends TemplateProperties diff --git a/source/java/org/alfresco/repo/template/TemplateNode.java b/source/java/org/alfresco/repo/template/TemplateNode.java index f7366a3342..fe86b7b956 100644 --- a/source/java/org/alfresco/repo/template/TemplateNode.java +++ b/source/java/org/alfresco/repo/template/TemplateNode.java @@ -63,6 +63,8 @@ import freemarker.ext.dom.NodeModel; *

* Various helper methods are provided to access common and useful node variables such * as the content url and type information. + *

+ * See {@link http://wiki.alfresco.com/wiki/Template_Guide} * * @author Kevin Roast */ diff --git a/source/java/org/alfresco/repo/template/TemplateNodeRef.java b/source/java/org/alfresco/repo/template/TemplateNodeRef.java index 05f68f7c96..b42c30556d 100644 --- a/source/java/org/alfresco/repo/template/TemplateNodeRef.java +++ b/source/java/org/alfresco/repo/template/TemplateNodeRef.java @@ -30,6 +30,9 @@ import org.alfresco.service.cmr.repository.NodeRef; import org.alfresco.service.namespace.QName; /** + * Contract supported by Template API objects that represent a repository object via a NodeRef + * and associated minimum properties such as as Type and Name. + * * @author Kevin Roast */ public interface TemplateNodeRef extends Serializable diff --git a/source/java/org/alfresco/repo/template/TemplatePermissions.java b/source/java/org/alfresco/repo/template/TemplatePermissions.java index fd6a9dd063..dcab44725f 100644 --- a/source/java/org/alfresco/repo/template/TemplatePermissions.java +++ b/source/java/org/alfresco/repo/template/TemplatePermissions.java @@ -27,6 +27,8 @@ package org.alfresco.repo.template; import java.util.List; /** + * Contract for Template API objects that support permissions. + * * @author Kevin Roast */ public interface TemplatePermissions extends TemplateNodeRef diff --git a/source/java/org/alfresco/repo/template/TemplateProperties.java b/source/java/org/alfresco/repo/template/TemplateProperties.java index 848ced91d3..deb29b4f6a 100644 --- a/source/java/org/alfresco/repo/template/TemplateProperties.java +++ b/source/java/org/alfresco/repo/template/TemplateProperties.java @@ -32,6 +32,8 @@ import java.util.Set; import org.alfresco.service.namespace.QName; /** + * Contract for Template API objects that have properties, aspects and children. + * * @author Kevin Roast */ public interface TemplateProperties extends TemplateNodeRef