@AlfrescoPublicApi
public interface CategoryService
Modifier and Type | Interface and Description |
---|---|
static class |
CategoryService.Depth
Depth from which to get nodes.
|
static class |
CategoryService.Mode
Enumeration for navigation control.
|
Modifier and Type | Method and Description |
---|---|
org.alfresco.service.cmr.repository.NodeRef |
createCategory(org.alfresco.service.cmr.repository.NodeRef parent,
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,
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,
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
|
Collection<org.alfresco.service.cmr.repository.ChildAssociationRef> |
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.
|
org.alfresco.service.cmr.repository.ChildAssociationRef |
getCategory(org.alfresco.service.cmr.repository.NodeRef parent,
org.alfresco.service.namespace.QName aspectName,
String name)
Looks up a category by name under its immediate parent.
|
Collection<org.alfresco.service.cmr.repository.ChildAssociationRef> |
getChildren(org.alfresco.service.cmr.repository.NodeRef categoryRef,
CategoryService.Mode mode,
CategoryService.Depth depth)
Get the children of a given category node
|
Collection<org.alfresco.service.namespace.QName> |
getClassificationAspects()
Get all the types that represent categories
|
Collection<org.alfresco.service.cmr.repository.ChildAssociationRef> |
getClassifications(org.alfresco.service.cmr.repository.StoreRef storeRef)
Get all the classification entries
|
Collection<org.alfresco.service.cmr.repository.ChildAssociationRef> |
getRootCategories(org.alfresco.service.cmr.repository.StoreRef storeRef,
org.alfresco.service.namespace.QName aspectName)
Get the root categories for an aspect/classification
|
org.alfresco.query.PagingResults<org.alfresco.service.cmr.repository.ChildAssociationRef> |
getRootCategories(org.alfresco.service.cmr.repository.StoreRef storeRef,
org.alfresco.service.namespace.QName aspectName,
org.alfresco.query.PagingRequest pagingRequest,
boolean sortByName)
Get a paged list of the root categories for an aspect/classification
|
org.alfresco.query.PagingResults<org.alfresco.service.cmr.repository.ChildAssociationRef> |
getRootCategories(org.alfresco.service.cmr.repository.StoreRef storeRef,
org.alfresco.service.namespace.QName aspectName,
org.alfresco.query.PagingRequest pagingRequest,
boolean sortByName,
String filter)
Get a paged list of the root categories for an aspect/classification
|
Collection<org.alfresco.service.cmr.repository.ChildAssociationRef> |
getRootCategories(org.alfresco.service.cmr.repository.StoreRef storeRef,
org.alfresco.service.namespace.QName aspectName,
String filter)
Get the root categories for an aspect/classification with names that start with filter
|
Collection<org.alfresco.service.cmr.repository.ChildAssociationRef> |
getRootCategories(org.alfresco.service.cmr.repository.StoreRef storeRef,
org.alfresco.service.namespace.QName aspectName,
String name,
boolean create)
Gets root categories by name, optionally creating one if one does not exist.
|
List<org.alfresco.util.Pair<org.alfresco.service.cmr.repository.NodeRef,Integer>> |
getTopCategories(org.alfresco.service.cmr.repository.StoreRef storeRef,
org.alfresco.service.namespace.QName aspectName,
int count)
Get the most polular categories
|
@Auditable(parameters={"categoryRef","mode","depth"}) Collection<org.alfresco.service.cmr.repository.ChildAssociationRef> 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"}) Collection<org.alfresco.service.cmr.repository.ChildAssociationRef> getCategories(org.alfresco.service.cmr.repository.StoreRef storeRef, org.alfresco.service.namespace.QName aspectQName, CategoryService.Depth depth)
storeRef
- StoreRefaspectQName
- QNamedepth
- - the enumeration depth for what level to recover@Auditable(parameters="storeRef") Collection<org.alfresco.service.cmr.repository.ChildAssociationRef> getClassifications(org.alfresco.service.cmr.repository.StoreRef storeRef)
@Auditable(parameters={"storeRef","aspectName"}) Collection<org.alfresco.service.cmr.repository.ChildAssociationRef> getRootCategories(org.alfresco.service.cmr.repository.StoreRef storeRef, org.alfresco.service.namespace.QName aspectName)
storeRef
- StoreRefaspectName
- QName@Auditable(parameters={"storeRef","aspectName","pagingRequest","sortByName"}) org.alfresco.query.PagingResults<org.alfresco.service.cmr.repository.ChildAssociationRef> getRootCategories(org.alfresco.service.cmr.repository.StoreRef storeRef, org.alfresco.service.namespace.QName aspectName, org.alfresco.query.PagingRequest pagingRequest, boolean sortByName)
storeRef
- StoreRefaspectName
- QNamepagingRequest
- PagingRequestsortByName
- boolean@Auditable(parameters={"storeRef","aspectName","pagingRequest","sortByName","filter"}) org.alfresco.query.PagingResults<org.alfresco.service.cmr.repository.ChildAssociationRef> getRootCategories(org.alfresco.service.cmr.repository.StoreRef storeRef, org.alfresco.service.namespace.QName aspectName, org.alfresco.query.PagingRequest pagingRequest, boolean sortByName, String filter)
storeRef
- aspectName
- pagingRequest
- sortByName
- filter
- @Auditable(parameters={"storeRef","aspectName"}) Collection<org.alfresco.service.cmr.repository.ChildAssociationRef> getRootCategories(org.alfresco.service.cmr.repository.StoreRef storeRef, org.alfresco.service.namespace.QName aspectName, String filter)
storeRef
- StoreRefaspectName
- QNamefilter
- String@Auditable(parameters={"storeRef","aspectName","name"}) org.alfresco.service.cmr.repository.ChildAssociationRef getCategory(org.alfresco.service.cmr.repository.NodeRef parent, org.alfresco.service.namespace.QName aspectName, String name)
parent
- the parentaspectName
- the aspect namename
- the category name@Auditable(parameters={"storeRef","aspectName","name","create"}) Collection<org.alfresco.service.cmr.repository.ChildAssociationRef> getRootCategories(org.alfresco.service.cmr.repository.StoreRef storeRef, org.alfresco.service.namespace.QName aspectName, String name, boolean create)
storeRef
- the store refaspectName
- the aspect namename
- the aspect namecreate
- should a category node be created if one does not exist?@Auditable Collection<org.alfresco.service.namespace.QName> 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, String attributeName)
storeRef
- StoreRefaspectName
- QNameattributeName
- String@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, String name)
storeRef
- StoreRefaspectName
- QNamename
- String@Auditable(parameters={"parent","name"}) org.alfresco.service.cmr.repository.NodeRef createCategory(org.alfresco.service.cmr.repository.NodeRef parent, String name)
parent
- NodeRefname
- String@Auditable(parameters={"storeRef","aspectName"}) void deleteClassification(org.alfresco.service.cmr.repository.StoreRef storeRef, org.alfresco.service.namespace.QName aspectName)
storeRef
- StoreRefaspectName
- QName@Auditable(parameters="nodeRef") void deleteCategory(org.alfresco.service.cmr.repository.NodeRef nodeRef)
nodeRef
- NodeRef@Auditable(parameters={"storeRef","aspectName","count"}) List<org.alfresco.util.Pair<org.alfresco.service.cmr.repository.NodeRef,Integer>> getTopCategories(org.alfresco.service.cmr.repository.StoreRef storeRef, org.alfresco.service.namespace.QName aspectName, int count)
storeRef
- StoreRefaspectName
- QNamecount
- intCopyright © 2005–2017 Alfresco Software. All rights reserved.