CategoryService (Alfresco 5.0.3 Public API)

org.alfresco.service.cmr.search

Interface CategoryService

public interface CategoryService

Category Service The service for querying and creating categories. All other management can be carried out using the node service. Classification - the groupings of categories. There is a one-to-one mapping with aspects. For example, Region. Root Category - the top level categories in a classification. For example, Northern Europe Category - any other category below a root category

Method Summary
NodeRef	createCategory(NodeRef parent, String name) Create a new category.
NodeRef	createClassification(StoreRef storeRef, QName aspectName, String attributeName) Create a new category.
NodeRef	createRootCategory(StoreRef storeRef, QName aspectName, String name) Create a new root category in the given classification
void	deleteCategory(NodeRef nodeRef) Delete a category
void	deleteClassification(StoreRef storeRef, QName aspectName) Delete a classification
Collection<ChildAssociationRef>	getCategories(StoreRef storeRef, QName aspectQName, org.alfresco.service.cmr.search.CategoryService.Depth depth) Get a list of all the categories appropriate for a given property.
ChildAssociationRef	getCategory(NodeRef parent, QName aspectName, String name) Looks up a category by name under its immediate parent.
Collection<ChildAssociationRef>	getChildren(NodeRef categoryRef, org.alfresco.service.cmr.search.CategoryService.Mode mode, org.alfresco.service.cmr.search.CategoryService.Depth depth) Get the children of a given category node
Collection<QName>	getClassificationAspects() Get all the types that represent categories
Collection<ChildAssociationRef>	getClassifications(StoreRef storeRef) Get all the classification entries
Collection<ChildAssociationRef>	getRootCategories(StoreRef storeRef, QName aspectName) Get the root categories for an aspect/classification
PagingResults<ChildAssociationRef>	getRootCategories(StoreRef storeRef, QName aspectName, PagingRequest pagingRequest, boolean sortByName) Get a paged list of the root categories for an aspect/classification
Collection<ChildAssociationRef>	getRootCategories(StoreRef storeRef, QName aspectName, String filter) Get the root categories for an aspect/classification with names that start with filter
Collection<ChildAssociationRef>	getRootCategories(StoreRef storeRef, QName aspectName, String name, boolean create) Gets root categories by name, optionally creating one if one does not exist.
List<Pair<NodeRef,Integer>>	getTopCategories(StoreRef storeRef, QName aspectName, int count) Get the most polular categories

@Auditable(parameters={
  "categoryRef",
  "mode",
  "depth"
})
Collection<ChildAssociationRef> getChildren(NodeRef categoryRef,
                                            org.alfresco.service.cmr.search.CategoryService.Mode mode,
                                            org.alfresco.service.cmr.search.CategoryService.Depth depth)

Get the children of a given category node

categoryRef - - the category node

mode - - the enumeration mode for what to recover

depth - - the enumeration depth for what level to recover

a collection of all the nodes found identified by their ChildAssocRef's

@Auditable(parameters={
  "storeRef",
  "aspectQName",
  "depth"
})
Collection<ChildAssociationRef> getCategories(StoreRef storeRef,
                                              QName aspectQName,
                                              org.alfresco.service.cmr.search.CategoryService.Depth depth)

Get a list of all the categories appropriate for a given property. The full list of categories that may be assigned for this aspect.

depth - - the enumeration depth for what level to recover

a collection of all the nodes found identified by their ChildAssocRef's

@Auditable(parameters="storeRef")
Collection<ChildAssociationRef> getClassifications(StoreRef storeRef)

Get all the classification entries

@Auditable(parameters={
  "storeRef",
  "aspectName"
})
Collection<ChildAssociationRef> getRootCategories(StoreRef storeRef,
                                                  QName aspectName)

Get the root categories for an aspect/classification

@Auditable(parameters={
  "storeRef",
  "aspectName",
  "pagingRequest",
  "sortByName"
})
PagingResults<ChildAssociationRef> getRootCategories(StoreRef storeRef,
                                                     QName aspectName,
                                                     PagingRequest pagingRequest,
                                                     boolean sortByName)

Get a paged list of the root categories for an aspect/classification

pagingRequest - PagingRequest

sortByName - boolean

@Auditable(parameters={
  "storeRef",
  "aspectName"
})
Collection<ChildAssociationRef> getRootCategories(StoreRef storeRef,
                                                  QName aspectName,
                                                  String filter)

Get the root categories for an aspect/classification with names that start with filter

@Auditable(parameters={
  "storeRef",
  "aspectName",
  "name"
})
ChildAssociationRef getCategory(NodeRef parent,
                                QName aspectName,
                                String name)

Looks up a category by name under its immediate parent. Index-independent so can be used for cluster-safe existence checks.

aspectName - the aspect name

name - the category name

the category child association reference

@Auditable(parameters={
  "storeRef",
  "aspectName",
  "name",
  "create"
})
Collection<ChildAssociationRef> getRootCategories(StoreRef storeRef,
                                                  QName aspectName,
                                                  String name,
                                                  boolean create)

Gets root categories by name, optionally creating one if one does not exist. Index-independent so can be used for cluster-safe existence checks.

storeRef - the store ref

aspectName - the aspect name

name - the aspect name

create - should a category node be created if one does not exist?

getClassificationAspects

@Auditable
Collection<QName> getClassificationAspects()

Get all the types that represent categories

createClassification

@Auditable(parameters={
  "storeRef",
  "aspectName",
  "attributeName"
})
NodeRef createClassification(StoreRef storeRef,
                             QName aspectName,
                             String attributeName)

Create a new category. This will extend the category types in the data dictionary All it needs is the type name and the attribute in which to store noderefs to categories.

attributeName - String

@Auditable(parameters={
  "storeRef",
  "aspectName",
  "name"
})
NodeRef createRootCategory(StoreRef storeRef,
                           QName aspectName,
                           String name)

Create a new root category in the given classification

@Auditable(parameters={
  "parent",
  "name"
})
NodeRef createCategory(NodeRef parent,
                       String name)

Create a new category.

deleteClassification

@Auditable(parameters={
  "storeRef",
  "aspectName"
})
void deleteClassification(StoreRef storeRef,
                          QName aspectName)

Delete a classification

@Auditable(parameters="nodeRef")
void deleteCategory(NodeRef nodeRef)

@Auditable(parameters={
  "storeRef",
  "aspectName",
  "count"
})
List<Pair<NodeRef,Integer>> getTopCategories(StoreRef storeRef,
                                             QName aspectName,
                                             int count)

Get the most polular categories

Java API documentation generated with DocFlex/Javadoc 1.6.1 using JavadocPro template set.