|
|||||||||
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 | |
---|---|
NodeRef |
createCategory(NodeRef parent,
java.lang.String name)
Create a new category. |
NodeRef |
createClassification(StoreRef storeRef,
QName aspectName,
java.lang.String attributeName)
Create a new category. |
NodeRef |
createRootCategory(StoreRef storeRef,
QName aspectName,
java.lang.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 |
java.util.Collection |
getCategories(StoreRef storeRef,
QName aspectQName,
CategoryService.Depth depth)
Get a list of all the categories appropriate for a given property. |
java.util.Collection |
getChildren(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(StoreRef storeRef)
Get all the classification entries |
java.util.Collection |
getRootCategories(StoreRef storeRef,
QName aspectName)
Get the root categories for an aspect/classification |
java.util.List |
getTopCategories(StoreRef storeRef,
QName aspectName,
int count)
Get the most polular categories |
Method Detail |
---|
@Auditable(key=ARG_0, parameters={"categoryRef", "mode", "depth"}) java.util.Collection getChildren(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(key=ARG_0, parameters={"storeRef", "aspectQName", "depth"}) java.util.Collection getCategories(StoreRef storeRef, QName aspectQName, CategoryService.Depth depth)
aspectQName
- depth
- - the enumeration depth for what level to recover
@Auditable(key=ARG_0, parameters="storeRef") java.util.Collection getClassifications(StoreRef storeRef)
@Auditable(key=ARG_0, parameters={"storeRef", "aspectName"}) java.util.Collection getRootCategories(StoreRef storeRef, QName aspectName)
storeRef
- aspectName
-
@Auditable java.util.Collection getClassificationAspects()
@Auditable(key=ARG_0, parameters={"storeRef", "aspectName", "attributeName"}) NodeRef createClassification(StoreRef storeRef, QName aspectName, java.lang.String attributeName)
aspectName
- attributeName
- @Auditable(key=ARG_0, parameters={"storeRef", "aspectName", "name"}) NodeRef createRootCategory(StoreRef storeRef, QName aspectName, java.lang.String name)
storeRef
- aspectName
- name
-
@Auditable(key=ARG_0, parameters={"parent", "name"}) NodeRef createCategory(NodeRef parent, java.lang.String name)
parent
- name
-
@Auditable(key=ARG_0, parameters={"storeRef", "aspectName"}) void deleteClassification(StoreRef storeRef, QName aspectName)
storeRef
- aspectName
- @Auditable(key=ARG_0, parameters="nodeRef") void deleteCategory(NodeRef nodeRef)
nodeRef
- java.util.List getTopCategories(StoreRef storeRef, QName aspectName, int count)
storeRef
- aspectName
- count
-
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |