org.alfresco.repo.jscript
Class CategoryNode

java.lang.Object
  extended by org.alfresco.repo.jscript.ScriptNode
      extended by org.alfresco.repo.jscript.CategoryNode
All Implemented Interfaces:
java.io.Serializable, Scopeable, org.alfresco.service.namespace.NamespacePrefixResolverProvider

public class CategoryNode
extends ScriptNode

Category Nodes from the classification helper have special support.

See Also:
Serialized Form

Nested Class Summary
 
Nested classes/interfaces inherited from class org.alfresco.repo.jscript.ScriptNode
ScriptNode.NodeValueConverter, ScriptNode.ScriptContentData
 
Field Summary
 
Fields inherited from class org.alfresco.repo.jscript.ScriptNode
aspects, converter, id, imageResolver, nodeRef, parent, scope, services, siteName, siteNameResolved
 
Constructor Summary
CategoryNode(org.alfresco.service.cmr.repository.NodeRef nodeRef, ServiceRegistry services)
          Constructor
CategoryNode(org.alfresco.service.cmr.repository.NodeRef nodeRef, ServiceRegistry services, org.mozilla.javascript.Scriptable scope)
          Constructor
 
Method Summary
 CategoryNode createSubCategory(java.lang.String name)
          Create a new subcategory
 ScriptNode[] getCategoryMembers()
           
 ScriptNode[] getImmediateCategoryMembers()
           
 ScriptNode[] getImmediateMembersAndSubCategories()
           
 CategoryNode[] getImmediateSubCategories()
           
 boolean getIsCategory()
          Indicates whether this is a category or not.
 ScriptNode[] getMembersAndSubCategories()
           
 CategoryNode[] getSubCategories()
           
 void removeCategory()
          Remove this category
 void rename(java.lang.String name)
          Renames the category.
 
Methods inherited from class org.alfresco.repo.jscript.ScriptNode
addAspect, addAspect, addNode, addTag, addTags, cancelCheckout, checkin, checkin, checkin, checkout, checkout, checkoutForUpload, childByNamePath, childFileFolders, childFileFolders, childFileFolders, childFileFolders, childFileFolders, childrenByTags, childrenByXPath, clearTags, copy, copy, createAssociation, createFile, createFile, createFolder, createFolder, createNode, createNode, createNode, createNode, createNode, createQName, createThumbnail, createThumbnail, createValueConverter, createVersion, ensureVersioningEnabled, equals, exists, getActiveWorkflows, getAspects, getAspectsSet, getAssociations, getAssocs, getChildAssociations, getChildAssocs, getChildAssocsByType, getChildren, getContent, getCrossRepositoryCopyHelper, getDirectPermissions, getDisplayPath, getDownloadUrl, getFullPermissions, getHasChildren, getIcon16, getIcon32, getId, getIsContainer, getIsDocument, getIsLinkToContainer, getIsLinkToDocument, getIsLocked, getIsTagScope, getIsVersioned, getMimetype, getName, getNamespacePrefixResolver, getNodeRef, getOwner, getParent, getParentAssociations, getParentAssocs, getParents, getPermissions, getPrimaryParentAssoc, getProperties, getPropertyNames, getQnamePath, getQNameType, getSettablePermissions, getShortQName, getSiteShortName, getSize, getSourceAssociations, getSourceAssocs, getStoreId, getStoreType, getTags, getTagScope, getThumbnail, getThumbnailDefintions, getThumbnails, getType, getTypePropertyNames, getTypePropertyNames, getTypeShort, getUrl, getValueConverter, getVersion, getVersionHistory, getWebdavUrl, hasAspect, hashCode, hasPermission, inheritsPermissions, isScriptContent, isSubType, jsGet_downloadUrl, move, move, newInstance, newInstance, processTemplate, processTemplate, processTemplate, processTemplate, remove, removeAspect, removeAssociation, removeNode, removePermission, removePermission, removeTag, removeTags, reset, retrieveAllSetPermissions, revert, revert, save, setContent, setInheritsPermissions, setIsTagScope, setMimetype, setName, setOwner, setPermission, setPermission, setScope, setTags, specializeType, takeOwnership, toJSON, toJSON, toString, transformDocument, transformDocument, transformImage, transformImage, transformImage, transformImage
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

CategoryNode

public CategoryNode(org.alfresco.service.cmr.repository.NodeRef nodeRef,
                    ServiceRegistry services)
Constructor

Parameters:
nodeRef - node reference
services - service registry

CategoryNode

public CategoryNode(org.alfresco.service.cmr.repository.NodeRef nodeRef,
                    ServiceRegistry services,
                    org.mozilla.javascript.Scriptable scope)
Constructor

Parameters:
nodeRef - node reference
services - service registry
scope - scriptable scope
Method Detail

getCategoryMembers

public ScriptNode[] getCategoryMembers()
Returns:
all the members of a category

getSubCategories

public CategoryNode[] getSubCategories()
Returns:
all the subcategories of a category

getMembersAndSubCategories

public ScriptNode[] getMembersAndSubCategories()
Returns:
members and subcategories of a category

getImmediateCategoryMembers

public ScriptNode[] getImmediateCategoryMembers()
Returns:
all the immediate member of a category

getImmediateSubCategories

public CategoryNode[] getImmediateSubCategories()
Returns:
all the immediate subcategories of a category

getImmediateMembersAndSubCategories

public ScriptNode[] getImmediateMembersAndSubCategories()
Returns:
immediate members and subcategories of a category

createSubCategory

public CategoryNode createSubCategory(java.lang.String name)
Create a new subcategory

Parameters:
name - Of the category to create
Returns:
CategoryNode

rename

public void rename(java.lang.String name)
Renames the category.

Parameters:
name - new cateogory name

removeCategory

public void removeCategory()
Remove this category


getIsCategory

public boolean getIsCategory()
Indicates whether this is a category or not.

Overrides:
getIsCategory in class ScriptNode
Returns:
boolean true if category, false otherwise


Copyright © 2005 - 2010 Alfresco Software, Inc. All Rights Reserved.