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
This commit is contained in:
Kevin Roast
2007-03-28 09:14:19 +00:00
parent f48caf423e
commit fab3f867f8
8 changed files with 16 additions and 1 deletions

View File

@@ -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<NodeRef> nodes = this.services.getSearchService().selectNodes(
rootNodeRef, this.storePath, null, this.services.getNamespaceService(), false);

View File

@@ -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

View File

@@ -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

View File

@@ -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

View File

@@ -63,6 +63,8 @@ import freemarker.ext.dom.NodeModel;
* <p>
* Various helper methods are provided to access common and useful node variables such
* as the content url and type information.
* <p>
* See {@link http://wiki.alfresco.com/wiki/Template_Guide}
*
* @author Kevin Roast
*/

View File

@@ -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

View File

@@ -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

View File

@@ -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