|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface CustomContentManager
Nested Class Summary | |
---|---|
static class |
CustomContentManager.SortField
|
static class |
CustomContentManager.SortOrder
|
Field Summary |
---|
Fields inherited from interface com.atlassian.confluence.core.ContentEntityManager |
---|
ITERATE_ALL |
Method Summary | ||
---|---|---|
long |
countChildrenOfType(CustomContentEntityObject content,
java.lang.String contentModuleKey)
Get the total number of children of a piece of content with the given type |
|
java.util.Iterator<CustomContentEntityObject> |
findAllChildren(CustomContentEntityObject content)
Get an iterator of all children of a piece of content. |
|
java.util.Collection<CustomContentEntityObject> |
findAllInSpace(Space space)
Deprecated. Since 4.2. No replacement. |
|
|
findByQuery(ContentQuery<T> query,
int offset,
int maxResults)
Get the results of a query for PluginContentEntityObjects |
|
java.util.Iterator<CustomContentEntityObject> |
findChildrenOfType(CustomContentEntityObject content,
java.lang.String contentModuleKey,
int offset,
int maxResults,
CustomContentManager.SortField sortField,
CustomContentManager.SortOrder sortOrder)
Get an iterator of children of a piece of content with a given type. |
|
java.util.Iterator<CustomContentEntityObject> |
findCurrentInSpace(Space space,
java.lang.String contentModuleKey,
int offset,
int maxResults,
CustomContentManager.SortField sortField,
CustomContentManager.SortOrder sortOrder)
Get an iterator of all the current, non-deleted content of the given type in the given space. |
|
|
findFirstObjectByQuery(ContentQuery<T> query)
Find the first result of a query for PluginContentEntityObjects. |
|
int |
findTotalInSpace(Space space,
java.lang.String contentModuleKey)
Get the total count of current, non-deleted content of the given type in the given space. |
|
CustomContentEntityObject |
getById(long id)
Find a single CustomContentEntityObject by its id |
|
CustomContentEntityObject |
newPluginContentEntityObject(java.lang.String contentModuleKey)
Create a new CustomContentEntityObject for the given module. |
|
void |
removeAllInSpace(java.lang.String contentModuleKey,
Space space)
Remove all plugin content of a particular type from a given space. |
|
void |
removeAllPluginContent(java.lang.String contentModuleKey)
Remove all plugin content of a particular type |
|
void |
removeAllPluginContentInSpace(Space space)
Remove all plugin content (of all types) from a given space. |
|
CustomContentEntityObject |
updatePluginModuleKey(CustomContentEntityObject content,
java.lang.String pluginModuleKey)
Update the type of an existing CustomContentEntityObject with the specified module key. |
Method Detail |
---|
CustomContentEntityObject newPluginContentEntityObject(java.lang.String contentModuleKey)
contentModuleKey
- the module complete key of the content's ContentAdapter module
CustomContentEntityObject updatePluginModuleKey(CustomContentEntityObject content, java.lang.String pluginModuleKey)
pluginModuleKey
- the module complete key of the content's ContentAdapter module
CustomContentEntityObject getById(long id)
getById
in interface ContentEntityManager
id
- the ID of the entity to retrieve
<T> java.util.Iterator<T> findByQuery(ContentQuery<T> query, int offset, int maxResults)
query
- the query to performoffset
- the first result to returnmaxResults
- the maximum number of results to return
<T> T findFirstObjectByQuery(ContentQuery<T> query)
query
- the query to perform
int findTotalInSpace(Space space, java.lang.String contentModuleKey)
space
- the space to count content incontentModuleKey
- the plugin module complete key of the content to be searched for
java.util.Iterator<CustomContentEntityObject> findCurrentInSpace(Space space, java.lang.String contentModuleKey, int offset, int maxResults, CustomContentManager.SortField sortField, CustomContentManager.SortOrder sortOrder)
space
- the space to retrieve content fromcontentModuleKey
- the plugin module complete key of the content to be searched forsortField
- what field to sort the content onsortOrder
- which direction to sort the content in
long countChildrenOfType(CustomContentEntityObject content, java.lang.String contentModuleKey)
content
- the content to look for children ofcontentModuleKey
- the module key for the type of child to look for
java.util.Iterator<CustomContentEntityObject> findChildrenOfType(CustomContentEntityObject content, java.lang.String contentModuleKey, int offset, int maxResults, CustomContentManager.SortField sortField, CustomContentManager.SortOrder sortOrder)
content
- the content to look for children ofcontentModuleKey
- the module key of the type of child to look foroffset
- the offset of the first resultmaxResults
- the maximum total results to returnsortField
- what field to sort the content onsortOrder
- which direction to sort the content injava.util.Iterator<CustomContentEntityObject> findAllChildren(CustomContentEntityObject content)
content
- the content to look for children ofvoid removeAllInSpace(java.lang.String contentModuleKey, Space space)
contentModuleKey
- the plugin module complete key of the content to be searched forspace
- the space from which to delete all content of that typevoid removeAllPluginContentInSpace(Space space)
space
- void removeAllPluginContent(java.lang.String contentModuleKey)
contentModuleKey
- the plugin module complete key of the content to be searched for@Deprecated java.util.Collection<CustomContentEntityObject> findAllInSpace(Space space)
space
- a space
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |