|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
@PublicService 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
| Nested Class Summary | |
|---|---|
static class |
CategoryService.Depth
Depth from which to get nodes. |
static class |
CategoryService.Mode
Enumeration for navigation control. |
| Method Summary | |
|---|---|
org.alfresco.service.cmr.repository.NodeRef |
createCategory(org.alfresco.service.cmr.repository.NodeRef parent,
java.lang.String name)
Create a new category. |
org.alfresco.service.cmr.repository.NodeRef |
createClassification(org.alfresco.service.cmr.repository.StoreRef storeRef,
org.alfresco.service.namespace.QName aspectName,
java.lang.String attributeName)
Create a new category. |
org.alfresco.service.cmr.repository.NodeRef |
createRootCategory(org.alfresco.service.cmr.repository.StoreRef storeRef,
org.alfresco.service.namespace.QName aspectName,
java.lang.String name)
Create a new root category in the given classification |
void |
deleteCategory(org.alfresco.service.cmr.repository.NodeRef nodeRef)
Delete a category |
void |
deleteClassification(org.alfresco.service.cmr.repository.StoreRef storeRef,
org.alfresco.service.namespace.QName aspectName)
Delete a classification |
java.util.Collection |
getCategories(org.alfresco.service.cmr.repository.StoreRef storeRef,
org.alfresco.service.namespace.QName aspectQName,
CategoryService.Depth depth)
Get a list of all the categories appropriate for a given property. |
java.util.Collection |
getChildren(org.alfresco.service.cmr.repository.NodeRef categoryRef,
CategoryService.Mode mode,
CategoryService.Depth depth)
Get the children of a given category node |
java.util.Collection |
getClassificationAspects()
Get all the types that represent categories |
java.util.Collection |
getClassifications(org.alfresco.service.cmr.repository.StoreRef storeRef)
Get all the classification entries |
java.util.Collection |
getRootCategories(org.alfresco.service.cmr.repository.StoreRef storeRef,
org.alfresco.service.namespace.QName aspectName)
Get the root categories for an aspect/classification |
java.util.List |
getTopCategories(org.alfresco.service.cmr.repository.StoreRef storeRef,
org.alfresco.service.namespace.QName aspectName,
int count)
Get the most polular categories |
| Method Detail |
|---|
@Auditable(parameters={"categoryRef", "mode", "depth"})
java.util.Collection getChildren(org.alfresco.service.cmr.repository.NodeRef categoryRef,
CategoryService.Mode mode,
CategoryService.Depth depth)
categoryRef - - the category nodemode - - the enumeration mode for what to recoverdepth - - the enumeration depth for what level to recover
@Auditable(parameters={"storeRef", "aspectQName", "depth"})
java.util.Collection getCategories(org.alfresco.service.cmr.repository.StoreRef storeRef,
org.alfresco.service.namespace.QName aspectQName,
CategoryService.Depth depth)
aspectQName - depth - - the enumeration depth for what level to recover
@Auditable(parameters="storeRef") java.util.Collection getClassifications(org.alfresco.service.cmr.repository.StoreRef storeRef)
@Auditable(parameters={"storeRef", "aspectName"})
java.util.Collection getRootCategories(org.alfresco.service.cmr.repository.StoreRef storeRef,
org.alfresco.service.namespace.QName aspectName)
storeRef - aspectName -
@Auditable java.util.Collection getClassificationAspects()
@Auditable(parameters={"storeRef", "aspectName", "attributeName"})
org.alfresco.service.cmr.repository.NodeRef createClassification(org.alfresco.service.cmr.repository.StoreRef storeRef,
org.alfresco.service.namespace.QName aspectName,
java.lang.String attributeName)
aspectName - attributeName -
@Auditable(parameters={"storeRef", "aspectName", "name"})
org.alfresco.service.cmr.repository.NodeRef createRootCategory(org.alfresco.service.cmr.repository.StoreRef storeRef,
org.alfresco.service.namespace.QName aspectName,
java.lang.String name)
storeRef - aspectName - name -
@Auditable(parameters={"parent", "name"})
org.alfresco.service.cmr.repository.NodeRef createCategory(org.alfresco.service.cmr.repository.NodeRef parent,
java.lang.String name)
parent - name -
@Auditable(parameters={"storeRef", "aspectName"})
void deleteClassification(org.alfresco.service.cmr.repository.StoreRef storeRef,
org.alfresco.service.namespace.QName aspectName)
storeRef - aspectName - @Auditable(parameters="nodeRef") void deleteCategory(org.alfresco.service.cmr.repository.NodeRef nodeRef)
nodeRef -
java.util.List getTopCategories(org.alfresco.service.cmr.repository.StoreRef storeRef,
org.alfresco.service.namespace.QName aspectName,
int count)
storeRef - aspectName - count -
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||