public interface SolrFacetService
Modifier and Type | Interface and Description |
---|---|
static class |
SolrFacetService.SyntheticPropertyDefinition
This class represents a special case of a property, examples being file size and MIME type, which
are not modelled as Alfresco content model properties, but are instead stored as components
within properties of type
cm:content . |
Modifier and Type | Method and Description |
---|---|
org.alfresco.service.cmr.repository.NodeRef |
createFacetNode(SolrFacetProperties facetProperties)
Creates a new facet.
|
void |
deleteFacet(String filterID)
Deletes the specified facet permanently
|
SolrFacetProperties |
getFacet(String filterID)
Gets the facet by filter Id.
|
List<org.alfresco.service.cmr.dictionary.PropertyDefinition> |
getFacetableProperties()
This method offers a convenient access point for getting all Facetable
content properties defined in the repository.
|
List<org.alfresco.service.cmr.dictionary.PropertyDefinition> |
getFacetableProperties(org.alfresco.service.namespace.QName contentClass)
This method offers a convenient access point for getting all Facetable
content properties defined on the specified content class (type or aspect) or any of its inherited properties.
|
List<SolrFacetService.SyntheticPropertyDefinition> |
getFacetableSyntheticProperties()
This method gets all synthetic, facetable properties across all content models in the repository.
|
List<SolrFacetService.SyntheticPropertyDefinition> |
getFacetableSyntheticProperties(org.alfresco.service.namespace.QName contentClass)
This method gets all synthetic, facetable properties defined on the specified content class (type or aspect) or any of its inherited properties.
|
org.alfresco.service.cmr.repository.NodeRef |
getFacetNodeRef(String filterID)
Gets the facet's
NodeRef by filter Id. |
List<SolrFacetProperties> |
getFacets()
Gets all the available facets.
|
boolean |
isSearchAdmin(String userName)
Indicates whether the specified user is a search-administrator or not.
|
void |
reorderFacets(List<String> filterIds)
Reorders existing facets to the provided order.
|
void |
updateFacet(SolrFacetProperties facetProperties)
Updates the existing facet.
|
List<SolrFacetProperties> getFacets()
SolrFacetProperties
or an empty list if none existsSolrFacetProperties getFacet(String filterID)
filterID
- the filter IdSolrFacetProperties
object or null if there is no facet with the specified Idorg.alfresco.service.cmr.repository.NodeRef getFacetNodeRef(String filterID)
NodeRef
by filter Id.filterID
- the filter IdNodeRef
or null if there is no facet with the specified Idboolean isSearchAdmin(String userName)
Note: The super/repo admin is considered to be a search-administrator too.
userName
- The user nameorg.alfresco.service.cmr.repository.NodeRef createFacetNode(SolrFacetProperties facetProperties)
facetProperties
- the facet's propertiesNodeRef
void updateFacet(SolrFacetProperties facetProperties)
facetProperties
- the facet's propertiesvoid deleteFacet(String filterID)
filterID
- the filter Idvoid reorderFacets(List<String> filterIds)
filterIds
- an ordered sequence of filter IDs.NullPointerException
- if filterIds is null
.Exceptions.MissingFacetId
- if the list is empty.Exceptions.DuplicateFacetId
- if there is a duplicate filter ID in the list.List<org.alfresco.service.cmr.dictionary.PropertyDefinition> getFacetableProperties()
PropertyDefinition
s.Facetable
List<org.alfresco.service.cmr.dictionary.PropertyDefinition> getFacetableProperties(org.alfresco.service.namespace.QName contentClass)
contentClass
- the QName of an aspect or type, whose facetable properties are sought.PropertyDefinition
s.Facetable
List<SolrFacetService.SyntheticPropertyDefinition> getFacetableSyntheticProperties()
List<SolrFacetService.SyntheticPropertyDefinition> getFacetableSyntheticProperties(org.alfresco.service.namespace.QName contentClass)
contentClass
- the QName of an aspect or type, whose synthetic, facetable properties are sought.Copyright © 2005–2017 Alfresco Software. All rights reserved.