com.atlassian.confluence.labels.persistence.dao.LabelDao |
Known Indirect Subclasses |
Constants | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
int | UNLIMITED | Specify no limit on the number of results returned by the dao. |
Public Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Find all labels based on the details passed in.
| |||||||||||
Find all labels for a specific space, based on the details passed in.
| |||||||||||
Find all labels for a specific space, based on the details passed in.
| |||||||||||
Find the label by its id.
| |||||||||||
Find the labels that are a single degree of separation away from the specified content.
| |||||||||||
Find the labels that are a single degree of separation away from the specified label.
| |||||||||||
Find the labels used to label the content with the specified space.
| |||||||||||
Retrieve all ContentEntityObjects which are labelled with ALL provided labels.
| |||||||||||
Returns current content with the specified label and spaceKey.
| |||||||||||
Find the most popular labels.
| |||||||||||
Find the most popular labels in the specified space.
| |||||||||||
[Expand]
Inherited Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
From interface
bucket.core.persistence.ObjectDao
|
Specify no limit on the number of results returned by the dao.
Find all labels based on the details passed in. If a parameter is null, it will not be considered in the search.
The list of labels returned will be ordered by name.
name | Label name (can be null) |
---|---|
namespace | Namespace of the label (can be null) |
owner | Owner of the label (can be null) |
Find all labels for a specific space, based on the details passed in. If a parameter is null, it will not be considered in the search.
The list of labels returned will be ordered by name.
name | Label name (can be null) |
---|---|
namespace | Namespace of the label (can be null) |
owner | Owner of the label (can be null) |
spaceKey | Key of the space whose content must have the returned labels (can be null) |
Find all labels for a specific space, based on the details passed in. If a parameter is null, it will not be considered in the search.
The list of labels returned will be ordered by name.
name | Label name (can be null) |
---|---|
namespace | Namespace of the label (can be null) |
owner | Owner of the label (can be null) |
spaces | Collection of spaces whose content must have the returned labels (can be null) |
Find the label by its id.
id | ID of the label |
---|
Find the labels that are a single degree of separation away from the specified content. This query will retrieve the labels on the given content object and find any content with those labels. The labels that are used on the second "level" of content will be returned. e.g. Page H is passed in as the content object, which is labelled with A and B. All pages labelled with A and B are retrieved (J, K, L, M), and the labels on those four pages are returned in order of frequency.
content | the content object used to search for related labels |
---|---|
maxResults | specifies the number of labels to be returned. |
Find the labels that are a single degree of separation away from the specified label. This query will return the labels located on the same pages with the given label, in order of frequency e.g. Page A has labels ABCX, Page B has labels ABX. A query for X will return A (2 uses) then B (1 use)
label | the label to look for on pages |
---|---|
maxResults | the maximum number of results to return |
Find the labels used to label the content with the specified space.
spaceKey | Key of the space whose content must have the returned labels (can be null) |
---|---|
namespace | Namespace of the label (can be null) |
Retrieve all ContentEntityObjects which are labelled with ALL provided labels.
labels | labels which must appear on ContentEntityObjects |
---|---|
maxResults | the maximum number of results to return |
offset | the offset into the results |
Returns current content with the specified label and spaceKey. If no spaceKey is specified, a search will be performed against the label only.
label | search for content with this label |
---|---|
spaceKey | (optional) search for content belonging to the space with this spaceKey |
Find the most popular labels. Label popularity is defined by the number of times a label has been used / applied to content.
maxResults | Maximum size of list to return |
---|
Find the most popular labels in the specified space. You can restrict the number of results returned by this query by setting the maxResults parameter.
key | of the space whose content must have the returned labels |
---|---|
maxResults | allows you to specify the maximum number of results returned by this method. Leaving max results at zero will return all of the results. |