com.atlassian.confluence.pages

Interface PageManager

All Superinterfaces:

ContentEntityManager

All Known Subinterfaces:

PageManagerInternal

All Known Implementing Classes:

DefaultPageManager

@ParametersAreNonnullByDefault
public interface PageManager
extends ContentEntityManager

Manages the retrieval and manipulation both pages and blog entries. (Really this class manages "AbstractPage", but calling it AbstractPageManager would be just as confusing).

Field Summary

Fields inherited from interface com.atlassian.confluence.core.ContentEntityManager

ITERATE_ALL

Method Summary

Modifier and Type	Method and Description
int	countBlogsWithUnpublishedChanges() Counts the number of published blog posts that have unpublished changes.
int	countCurrentBlogs() Counts the total number of current blog posts across all spaces
int	countCurrentPages() Counts the total number of current pages across all spaces
int	countDraftBlogs() Counts the number of blog posts that are drafts.
int	countDraftPages() Counts the number of pages that are drafts.
int	countPagesInSubtree(Page page) Get number of descendant page including the input page
int	countPagesWithUnpublishedChanges() Counts the number of published pages that have unpublished changes.
void	deepCopyPage(PageCopyOptions option, Page originalPage, Page destinationPage) Copy child page of originalPage to destinationPage
void	deepDeletePage(PageDeleteOptions options, Page targetPage) Deletes a page hierarchy
BlogPost	findNextBlogPost(BlogPost post)
BlogPost	findNextBlogPost(String key, Date time)
BlogPost	findPreviousBlogPost(BlogPost post)
BlogPost	findPreviousBlogPost(String key, Date time)
AbstractPage	getAbstractPage(long id) Retrieve the AbstractPage subclass with the given content ID.
List<AbstractPage>	getAbstractPages(Iterable<Long> ids) Retrieve a collection of the AbstractPage subclass with the given content IDs.
AttachmentManager	getAttachmentManager() Deprecated. since 5.8 do not use. Implementation detail mistakenly added to manager interface.
int	getAuthoredPagesCountByUser(String username) Get the number of pages that have been created by a particular user
BlogPost	getBlogPost(long id) Retrieve the blog post with the given content ID.
BlogPost	getBlogPost(String spaceKey, String pageTitle, Calendar day) Retrieve the latest version of a blog post by its space key, title, and the day on which it was published.
BlogPost	getBlogPost(String spaceKey, String pageTitle, Calendar day, boolean eagerLoadComments) Retrieve the latest version of a blog post by its space key, title, and the day on which it was published.
long	getBlogPostCount(String key, Calendar postingDay, int period) Get total number of blogPost.
List<BlogPost>	getBlogPosts(Space space, boolean currentOnly)
List	getBlogPosts(String spaceKey, Calendar postingDate, int period) Get list of blogPost by Date.
List	getBlogPosts(String spaceKey, Calendar postingDate, int period, int startIndex, int maxResultCount) Get list of blogPost by Date.
List<BlogPost>	getBlogPostsInTrash(String spaceKey, String title) Gets a blog post that is in the trash for a given space that matches the given title.
int	getCommentCountOnPage(long pageId) Counts the number of comments on the page specified by the given id.
int	getCountOfLatestXhtmlContent(long endContentId) Count the number of AbstractPages that have an ID lower than the specified ID, excluding older versions.
Collection<Long>	getDescendantIds(Page page) Finds the ids of a page's descendants
List<Page>	getDescendants(Page page) Finds all descendant pages of the given page
List<String>	getDescendantTitles(Page page) Finds all descendant titles of the given page
Collection	getDescendentIds(Page page) Deprecated. since 5.5 use getDescendantIds(Page)
List	getDescendents(Page page) Deprecated. since 5.5.1. Use getDescendants(Page)
PageResponse<Page>	getDraftChildren(Page page, LimitedRequest pageRequest, Depth depth) Returns the children of a page which have a status of DRAFT, limited to the pagination requested.
long	getHighestCeoId() Get the highest content ID in the database, excluding older versions of content.
Set<Date>	getMonthsWithBlogPosts(String spaceKey, Calendar year) Returns the set of months in the specified year (represented as a Calendar with the year and month fields populated) for which blog posts exist in the specified space.
BlogPost	getNewestBlogPost(String spaceKey) Retrieves the most recently created blog post in the given space.
NotificationManager	getNotificationManager() Deprecated. since 5.8 do not use. Implementation detail mistakenly added to manager interface.
List<ContentEntityObject>	getOrderedXhtmlContentFromContentId(long startContentId, long endContentId, int maxRows) Gets the latest versions of AbstractPages between the given IDs limited by the specified number of rows.
List	getOrphanedPages(String spaceKey) Retrieve a list of pages in a given space that are not linked to.
Page	getPage(long id) Retrieve the page with the given content ID.
Page	getPage(String spaceKey, String pageTitle) Retrieve the latest version of a page by its space key and title.
Page	getPage(String spaceKey, String pageTitle, boolean eagerLoadComments) Deprecated. since 3.0, use getPageWithComments(String, String) instead.
AbstractPage	getPageByVersion(AbstractPage mostRecentPage, int version) returns the historical version of a page
long	getPageCount(String spaceKey) Get total number of current pages in a space
Collection<Long>	getPageIds(Space space) Get the ids of all pages (current and historical) in the given space.
List	getPageInTrash(String spaceKey, String title)
List<Page>	getPages(Iterable<Long> ids) Retrieve a collection of pages with the given content IDs.
List<Page>	getPages(Space space, boolean currentOnly)
List	getPagesCreatedOrUpdatedSinceDate(Date date) Get the list of all pages created or updated since a particular date.
List	getPagesStartingWith(Space space, String s)
List<Page>	getPagesWithPermissions(Space space) Get all current pages in a space and eagerly fetch permissions at the same time.
Page	getPageWithComments(String spaceKey, String pageTitle) Retrieve the latest version of a page by its space key and title.
List	getPermissionPages(Space space) Retrieve all pages within a particular space that have page level permissions applied to them.
List<AbstractPage>	getPossibleBlogRedirectsInSpace(Space space, String blogTitle, int maxResultCount) Searches for blogs in the space specified, looking for those that have the given title in a previous version.
List<AbstractPage>	getPossibleBlogRedirectsNotInSpace(Space space, String blogTitle, int maxResultCount) Searches for pages in all spaces except the one specified, looking for those that have the given title in a previous version.
List	getPossibleRedirects(String pageTitle) Deprecated. Since 3.1. Use getPossibleRedirectsInSpace(Space, String, int) or getPossibleRedirectsNotInSpace(Space, String, int)
List	getPossibleRedirectsForSpace(Space space, String pageTitle) Deprecated. Since 3.1. Use getPossibleRedirectsInSpace(Space, String, int) or getPossibleRedirectsNotInSpace(Space, String, int)
List<AbstractPage>	getPossibleRedirectsInSpace(Space space, String pageTitle, int maxResultCount) Searches for pages in the space specified, looking for those that have the given title in a previous version.
List<AbstractPage>	getPossibleRedirectsNotInSpace(Space space, String pageTitle, int maxResultCount) Searches for pages in all spaces except the one specified, looking for those that have the given title in a previous version.
List<ContentEntityObject>	getPreviousVersionsOfPageWithTaskId(long pageId, long taskId, int maxRows) Get previous versions of a CEO that contain the given task ID sorted by versions in descending order.
List	getRecentlyAddedBlogPosts(int maxPosts, Date timeSince, String spaceKey)
List	getRecentlyAddedBlogPosts(int maxCount, String spaceKey) Retrieve the most recently created blog posts in a given space.
List	getRecentlyAddedPages(int maxCount, String spaceKey) Retrieve the most recently created pages in a given space.
List	getRecentlyUpdatedPages(int maxCount, String spaceKey) Retrieve the most recently modified pages in a given space.
List	getTopLevelPages(Space space) Get all the pages in a space that do not have a parent page.
ListBuilder<Page>	getTopLevelPagesBuilder(Space space) Get the pages in a space that do not have a parent page.
List<OutgoingLink>	getUndefinedLinks(String spaceKey) Retrieve a list of link destinations in a given space that do not have pages.
List	getUndefinedPages(String spaceKey) Deprecated. since 6.6.0, use getUndefinedLinks(String)
Set<Date>	getYearsWithBlogPosts(String spaceKey) Returns the set of years (represented as a Date with the year field populated) for which blog posts exist in the specified space.
boolean	isPageRecentlyUpdatedForUser(Page page, com.atlassian.user.User user) Returns true if the page has been created or modified since the user last logged in.
void	moveBlogPostToTopLevel(BlogPost blogPost, Space space) Move a blog post to the top level of targetSpace.
void	moveChildrenToNewParent(Page oldParent, Page newParent) Moves all the children from one page to another The new parent should NOT be the child of the old parent, this method will return with no operation in that case
void	movePageAfter(Page page, Page refPage) Move the provided page (first argument) after the reference page (second argument).
void	movePageAsChild(Page page, Page refPage) Move the provided page (first argument) as a child of the reference page (second argument).
void	movePageBefore(Page page, Page refPage) Move the provided page (first argument) before the reference page (second argument).
void	movePageToTopLevel(Page page, Space space) Move a page to the top level of targetSpace.
void	refreshPage(ContentEntityObject page) Refresh the page object in the hibernate session.
void	removeAllBlogPosts(Space space)
void	removeAllPages(Space space) Removes all pages in the space.
void	removeAllPages(Space space, com.atlassian.core.util.ProgressMeter progress) Removes all pages in the space.
void	removePageFromAncestorCollections(Page page) Removes the page and its ancestors from the ancestor collection of all descendants.
int	removeStaleSharedDrafts() Removes any stale shared drafts.
void	renamePage(AbstractPage page, String newPageTitle) Call this function if you want to rename the page only.
void	renamePageWithoutNotifications(AbstractPage page, String newPageTitle) Call this function if you want to rename the page only, and don't want notifications generated.
void	restorePage(AbstractPage page) Restores a trashed page, effectively moving it out of the trash and promoting it back to being normal page.
void	revertChildPageOrder(Page parentPage) Removes manual ordering of child pages.
void	setAttachmentManager(AttachmentManager attachmentManager) Deprecated. since 5.8 do not use. Implementation detail mistakenly added to manager interface.
void	setChildPageOrder(Page parentPage, List<Long> childIds) Sets ordering of child pages for a supplied page, based on a map of child ids to positions.
void	setNotificationManager(NotificationManager notificationManager) Deprecated. since 5.8 do not use. Implementation detail mistakenly added to manager interface.
boolean	spaceHasBlogPosts(String spaceKey)
void	trashPage(AbstractPage page) Deprecated. since 6.0 Use trashPage(AbstractPage, DeleteContext)
void	trashPage(AbstractPage page, DeleteContext deleteContext)
void	updatePageInAncestorCollections(Page page, Page parentPage) Updates the ancestors of a page and all it's descendant pages with the new parent page and its ancestors.

Methods inherited from interface com.atlassian.confluence.core.ContentEntityManager

getById, getContributionStatusByUser, getNextVersion, getOtherVersion, getPageAndBlogPostsVersionsLastEditedByUser, getPageAndBlogPostsVersionsLastEditedByUserIncludingDrafts, getPreviousVersion, getRecentlyAddedEntities, getRecentlyModifiedEntities, getRecentlyModifiedEntitiesForUser, getRecentlyModifiedForChangeDigest, getVersionHistorySummaries, getVersionsLastEditedByUser, refreshContentEntity, removeContentEntity, removeHistoricalVersion, revertContentEntityBackToVersion, saveContentEntity, saveContentEntity, saveNewVersion, saveNewVersion, updateContentLinkingTo, updateOutgoingLinksInContent, updateSingleContentLinkinTo, updateSingleContentLinkinTo

Method Detail

getPage

@Nullable
Page getPage(long id)

Retrieve the page with the given content ID.

Parameters:

id - the database content ID for the page to return

Returns:

the page with that id, or null if the page could not be found (or the object with that id is not a page)

getPages

@Nonnull
List<Page> getPages(Iterable<Long> ids)

Retrieve a collection of pages with the given content IDs.

Parameters:

ids - an Iterable of content IDs for the pages to return

Returns:

pages found with those ids, or an empty list if no pages were found

getAbstractPage

@Nullable
AbstractPage getAbstractPage(long id)

Retrieve the AbstractPage subclass with the given content ID. This will return either a page or a blogpost, depending on the type of the database entity.

Parameters:

id - the database content ID for the page to return

Returns:

the abstractpage with that id, or null if there is no AbstractPage with that ID.

getAbstractPages

@Nonnull
List<AbstractPage> getAbstractPages(Iterable<Long> ids)

Retrieve a collection of the AbstractPage subclass with the given content IDs. This can contain both pages or a blogposts, depending on the type of the database entity.

Parameters:

ids - an Iterable of content IDs for the pages or blogposts to return

Returns:

pages and blogposts found with those ids, or an empty list if none was found.

getBlogPost

@Nullable
BlogPost getBlogPost(long id)

Retrieve the blog post with the given content ID.

Parameters:

id - the database content ID for the blog post to return

Returns:

the page with that id, or null if the post could not be found (or the object with that id is not a blog post)

getPage

@Nullable
Page getPage(String spaceKey,
                       String pageTitle)

Retrieve the latest version of a page by its space key and title. Pages that are not current (i.e. in the trash) will not be returned.

Both the space key and page title matches are case-insensitive.

Returns:

the page specified by the spaceKey and pageTitle, or null if the page cannot be found, or is in the trash.

getPageWithComments

@Nullable
Page getPageWithComments(String spaceKey,
                                   String pageTitle)

Retrieve the latest version of a page by its space key and title. Pages that are not current (i.e. in the trash) will not be returned. This method will eager load comments for the page.

Both the space key and page title matches are case-insensitive.

Returns:

the page specified by the spaceKey and pageTitle, or null if the page cannot be found, or is in the trash.

getCommentCountOnPage

int getCommentCountOnPage(long pageId)

Counts the number of comments on the page specified by the given id.

Parameters:

pageId - the id to check for comments on

Returns:

a count of the total number of comments on this page

getPage

@Deprecated
 @Nullable
Page getPage(String spaceKey,
                                    String pageTitle,
                                    boolean eagerLoadComments)

Deprecated. since 3.0, use getPageWithComments(String, String) instead.

Retrieve the latest version of a page by its space key and title. Pages that are not current (i.e. in the trash) will not be returned. Additionally, this method will eager load comments for the page if eagerLoadComments is true.

Both the space key and page title matches are case-insensitive.

Returns:

the page specified by the spaceKey and pageTitle, or null if the page cannot be found, or is in the trash.

getBlogPost

@Nullable
BlogPost getBlogPost(String spaceKey,
                               String pageTitle,
                               Calendar day)

Retrieve the latest version of a blog post by its space key, title, and the day on which it was published. Blog posts that are not current (i.e. in the trash) will not be returned.

Both the space key and page title matches are case-insensitive.

Returns:

the appropriate blog post, or null if none can be found, or the post is in the trash.

getBlogPost

@Nullable
BlogPost getBlogPost(String spaceKey,
                               String pageTitle,
                               Calendar day,
                               boolean eagerLoadComments)

Retrieve the latest version of a blog post by its space key, title, and the day on which it was published. Blog posts that are not current (i.e. in the trash) will not be returned. If eager load comments is true, the comments and their immediate children will also be eagerly loaded for this BlogPost.

Both the space key and page title matches are case-insensitive.

Returns:

the appropriate blog post, or null if none can be found, or the post is in the trash.

getNewestBlogPost

@Nullable
BlogPost getNewestBlogPost(@Nullable
                                     String spaceKey)

Retrieves the most recently created blog post in the given space. Only the latest version of the blog post is returned. blog posts that are not current (i.e. in the trash) are not considered.

Parameters:

spaceKey - the key of the space to retrieve the most recently created blog post for.

Returns:

the most recently created blog post in the given space, or null if the space contains no blog posts.

getRecentlyAddedBlogPosts

@Nonnull
List getRecentlyAddedBlogPosts(int maxCount,
                                        @Nullable
                                        String spaceKey)

Retrieve the most recently created blog posts in a given space. If no space key is supplied, the most recent blog posts from all spaces are returned. Only the latest version of each post is returned. Posts that are not current (i.e. in the trash) are not included.

For queries like this, you're probably much better off using the SearchManager

Parameters:

maxCount - the maximum number of blog posts to retrieve

spaceKey - the key of the space to retrieve the posts from, or null to retrieve posts from all spaces

Returns:

a list of the most recently created blog posts in the given space

getRecentlyAddedPages

@Nonnull
List getRecentlyAddedPages(int maxCount,
                                    @Nullable
                                    String spaceKey)

Retrieve the most recently created pages in a given space. If no space key is supplied, the most recent pages from all spaces are returned. Only the latest version of each page is returned. Pages that are not current (i.e. in the trash) are not included.

For queries like this, you're probably much better off using the SearchManager

Parameters:

maxCount - the maximum number of pages to retrieve

spaceKey - the key of the space to retrieve the pages from, or null to retrieve posts from all spaces

Returns:

a list of the most recently created pages in the given space

getRecentlyUpdatedPages

@Nonnull
List getRecentlyUpdatedPages(int maxCount,
                                      @Nullable
                                      String spaceKey)

Retrieve the most recently modified pages in a given space. If no space key is supplied, the most recent pages from all spaces are returned. Only the latest version of each page is returned. Pages that are not current (i.e. in the trash) are not included.

For queries like this, you're probably much better off using the SearchManager

Parameters:

maxCount - the maximum number of pages to retrieve

spaceKey - the key of the space to retrieve the pages from, or null to retrieve posts from all spaces

Returns:

a list of the most recently updated pages in the given space

getOrphanedPages

@Nonnull
List getOrphanedPages(@Nullable
                               String spaceKey)

Retrieve a list of pages in a given space that are not linked to. If no space key is supplied, the search is performed across all spaces. Only the latest version of each page is returned. Pages that are not current (i.e. in the trash) are not returned.

The orphaned pages search is not 100% accurate, as the algorithm used to track links doesn't account for all links. Hopefully this can be fixed with future versions of the wiki renderer that allow more accurate tracking of link destinations.

Parameters:

spaceKey - the key of the space to look for orphans in, or null to search all spaces

Returns:

the list of orphaned pages

getUndefinedPages

@Deprecated
 @Nonnull
List getUndefinedPages(@Nullable
                                             String spaceKey)

Deprecated. since 6.6.0, use getUndefinedLinks(String)

Retrieve a list of link destinations in a given space that do not have pages.

The undefined pages search is not 100% accurate, as the algorithm used to track links doesn't account for all links. Hopefully this can be fixed with future versions of the wiki renderer that allow more accurate tracking of link destinations.

Parameters:

spaceKey - the key of the space to look for undefined pages in, or null to search all spaces

Returns:

the list of undefined pages

getUndefinedLinks

List<OutgoingLink> getUndefinedLinks(@Nullable
                                     String spaceKey)

Retrieve a list of link destinations in a given space that do not have pages.

The undefined pages search is not 100% accurate, as the algorithm used to track links doesn't account for all links. Hopefully this can be fixed with future versions of the wiki renderer that allow more accurate tracking of link destinations.

Parameters:

spaceKey - the key of the space to look for undefined pages in, or null to search all spaces

Returns:

the list of link destinations

Since:

6.6.0

getPermissionPages

@Nonnull
List getPermissionPages(Space space)

Retrieve all pages within a particular space that have page level permissions applied to them. Only the latest version of each page is returned. Pages that are not current (i.e. in the trash) are not returned.

Parameters:

space - the space to search

Returns:

the list of all pages in that space with page-level permissions

getAuthoredPagesCountByUser

int getAuthoredPagesCountByUser(String username)

Get the number of pages that have been created by a particular user

Parameters:

username - the username of the user to search for

Returns:

the number of pages that have been created by that user.

isPageRecentlyUpdatedForUser

boolean isPageRecentlyUpdatedForUser(Page page,
                                     @Nullable
                                     com.atlassian.user.User user)

Returns true if the page has been created or modified since the user last logged in. If the user has no last login time, returns false. For an anonymous user returns false.

Parameters:

page - the page in question

user - the user or null if it is the anonymous user

Returns:

true if the page has been created or modified since the user's last login, false otherwise

getPagesCreatedOrUpdatedSinceDate

@Nonnull
List getPagesCreatedOrUpdatedSinceDate(Date date)

Get the list of all pages created or updated since a particular date.

Parameters:

date - the date the pages must have been created or edited after

Returns:

all pages created or edited since that date

getBlogPosts

@Nonnull
List getBlogPosts(String spaceKey,
                           Calendar postingDate,
                           int period)

Get list of blogPost by Date.

Parameters:

spaceKey - the space to look for posts in

postingDate - a calendar object representing the date range we are looking for. Any part of the calendar more specific than the supplied period will be ignored.

period - one of the Calendar constants specifying the granularity of the search. currently, only Calendar.MONTH and Calendar.DATE are supported

Returns:

a list of blogPost

getBlogPosts

@Nonnull
List getBlogPosts(String spaceKey,
                           Calendar postingDate,
                           int period,
                           int startIndex,
                           int maxResultCount)

Get list of blogPost by Date.

Parameters:

spaceKey - the space to look for posts in

postingDate - a calendar object representing the date range we are looking for. Any part of the calendar more specific than the supplied period will be ignored.

period - one of the Calendar constants specifying the granularity of the search. currently, only Calendar.MONTH and Calendar.DATE are supported

startIndex - start number of posts

maxResultCount - Maximum number of posts to return

Returns:

a list of blogPost

getBlogPosts

@Nonnull
List<BlogPost> getBlogPosts(Space space,
                                     boolean currentOnly)

getYearsWithBlogPosts

@Nonnull
Set<Date> getYearsWithBlogPosts(String spaceKey)

Returns the set of years (represented as a Date with the year field populated) for which blog posts exist in the specified space.

Parameters:

spaceKey - the key of the space to look for blog posts in.

Returns:

the set of years for which blog posts exist.

getMonthsWithBlogPosts

@Nonnull
Set<Date> getMonthsWithBlogPosts(String spaceKey,
                                          Calendar year)

Returns the set of months in the specified year (represented as a Calendar with the year and month fields populated) for which blog posts exist in the specified space.

Parameters:

spaceKey - the key of the space to look for blog posts in.

year - the year to examine blog posts for, represented as a Calendar with the year field specified.

Returns:

the set of months for which blog posts exist.

getPages

@Nonnull
List<Page> getPages(Space space,
                             boolean currentOnly)

getPagesWithPermissions

List<Page> getPagesWithPermissions(@Nonnull
                                   Space space)

Get all current pages in a space and eagerly fetch permissions at the same time. This is an optimisation for when you known that permissions will need to be fetched for all or most of the pages later.

Parameters:

space -

Returns:

a list of all the current pages in a space

Since:

6.1.3

getPageIds

@Nonnull
Collection<Long> getPageIds(Space space)

Get the ids of all pages (current and historical) in the given space.

Parameters:

space - space to retrieve page ids from, can not be null.

Returns:

a Collection of ids for pages.

Since:

4.2

getPagesStartingWith

@Nonnull
List getPagesStartingWith(Space space,
                                   String s)

findNextBlogPost

@Nullable
BlogPost findNextBlogPost(BlogPost post)

findPreviousBlogPost

@Nullable
BlogPost findPreviousBlogPost(BlogPost post)

getNotificationManager

@Deprecated
NotificationManager getNotificationManager()

Deprecated. since 5.8 do not use. Implementation detail mistakenly added to manager interface.

setNotificationManager

@Deprecated
void setNotificationManager(NotificationManager notificationManager)

Deprecated. since 5.8 do not use. Implementation detail mistakenly added to manager interface.

getAttachmentManager

@Deprecated
AttachmentManager getAttachmentManager()

Deprecated. since 5.8 do not use. Implementation detail mistakenly added to manager interface.

setAttachmentManager

@Deprecated
void setAttachmentManager(AttachmentManager attachmentManager)

Deprecated. since 5.8 do not use. Implementation detail mistakenly added to manager interface.

renamePage

void renamePage(AbstractPage page,
                String newPageTitle)

Call this function if you want to rename the page only. If you want to update not only the title, but the content and other attributes, modify the entity and call save instead.

Parameters:

page - to rename

newPageTitle - new title for page

renamePageWithoutNotifications

void renamePageWithoutNotifications(AbstractPage page,
                                    String newPageTitle)

Call this function if you want to rename the page only, and don't want notifications generated. If you want to update not only the title, but the content and other attributes, modify the entity and call save instead.

Parameters:

page - to rename

newPageTitle - new title for page

getPossibleRedirectsForSpace

@Deprecated
 @Nonnull
List getPossibleRedirectsForSpace(Space space,
                                                        String pageTitle)

Deprecated. Since 3.1. Use getPossibleRedirectsInSpace(Space, String, int) or getPossibleRedirectsNotInSpace(Space, String, int)

getPossibleRedirectsNotInSpace

@Nonnull
List<AbstractPage> getPossibleRedirectsNotInSpace(Space space,
                                                           String pageTitle,
                                                           int maxResultCount)

Searches for pages in all spaces except the one specified, looking for those that have the given title in a previous version.

Parameters:

space - Space to exclude from search. If null, all spaces are searched.

pageTitle - title of a page in a previous version.

maxResultCount - maximum pages to return

getPossibleRedirectsInSpace

@Nonnull
List<AbstractPage> getPossibleRedirectsInSpace(Space space,
                                                        String pageTitle,
                                                        int maxResultCount)

Searches for pages in the space specified, looking for those that have the given title in a previous version.

Parameters:

space - Space to search. Must not be null.

pageTitle - title of a page in a previous version.

maxResultCount - maximum pages to return

getPossibleBlogRedirectsInSpace

@Nonnull
List<AbstractPage> getPossibleBlogRedirectsInSpace(Space space,
                                                            String blogTitle,
                                                            int maxResultCount)

Searches for blogs in the space specified, looking for those that have the given title in a previous version.

Parameters:

space - Space to search. Must not be null.

blogTitle - title of a blog in a previous version.

maxResultCount - maximum blogs to return

getPossibleBlogRedirectsNotInSpace

@Nonnull
List<AbstractPage> getPossibleBlogRedirectsNotInSpace(Space space,
                                                               String blogTitle,
                                                               int maxResultCount)

Searches for pages in all spaces except the one specified, looking for those that have the given title in a previous version.

Parameters:

space - Space to exclude from search. If null, all spaces are searched.

blogTitle - title of a blog post to locate

maxResultCount - maximum blog posts to return

Since:

5.6.2

getPossibleRedirects

@Deprecated
 @Nonnull
List getPossibleRedirects(String pageTitle)

Deprecated. Since 3.1. Use getPossibleRedirectsInSpace(Space, String, int) or getPossibleRedirectsNotInSpace(Space, String, int)

getRecentlyAddedBlogPosts

@Nonnull
List getRecentlyAddedBlogPosts(int maxPosts,
                                        @Nullable
                                        Date timeSince,
                                        String spaceKey)

getPageInTrash

@Nonnull
List getPageInTrash(String spaceKey,
                             String title)

getBlogPostsInTrash

@Nonnull
List<BlogPost> getBlogPostsInTrash(String spaceKey,
                                            String title)

Gets a blog post that is in the trash for a given space that matches the given title.

Parameters:

spaceKey - The space key (case-insensitive) in which to look for the blog

title - The title (case-insensitive) of the blog to look for

Returns:

a list of blog posts in the trash that have the given title and space key.

Since:

6.2

spaceHasBlogPosts

boolean spaceHasBlogPosts(String spaceKey)

getDescendents

@Deprecated
 @Nonnull
List getDescendents(Page page)

Deprecated. since 5.5.1. Use getDescendants(Page)

getDescendants

@Nonnull
List<Page> getDescendants(Page page)

Finds all descendant pages of the given page

Parameters:

page -

Returns:

a List of descendant pages

getDescendantTitles

@Nonnull
List<String> getDescendantTitles(Page page)

Finds all descendant titles of the given page

Parameters:

page -

Returns:

a List of descendant titles

getDraftChildren

PageResponse<Page> getDraftChildren(Page page,
                                    LimitedRequest pageRequest,
                                    Depth depth)

Returns the children of a page which have a status of DRAFT, limited to the pagination requested. Will fetch drafts all drafts regardless of whether the current authenticated user has permission to view the drafts

Parameters:

page - the page to find children for

pageRequest - the pagination requested

depth - the depth to return children to

Returns:

the paginated response of Page entities

removeStaleSharedDrafts

int removeStaleSharedDrafts()

Removes any stale shared drafts. Stale shared drafts are pages with a content_status 'draft' and which have a last modified date that is earlier than or equal to the last modified date on the published page.

Returns:

The number of pages removed

Since:

6.0.2

updatePageInAncestorCollections

void updatePageInAncestorCollections(Page page,
                                     Page parentPage)

Updates the ancestors of a page and all it's descendant pages with the new parent page and its ancestors.

Parameters:

page - the page being updated with new ancestors

parentPage - the new parent page of the page being updated

removePageFromAncestorCollections

void removePageFromAncestorCollections(Page page)

Removes the page and its ancestors from the ancestor collection of all descendants.

getDescendentIds

@Deprecated
 @Nonnull
Collection getDescendentIds(Page page)

Deprecated. since 5.5 use getDescendantIds(Page)

getDescendantIds

@Nonnull
Collection<Long> getDescendantIds(Page page)

Finds the ids of a page's descendants

Parameters:

page -

Returns:

a collection of page ids

getTopLevelPages

@Nonnull
List getTopLevelPages(Space space)

Get all the pages in a space that do not have a parent page. Since there can be an arbitrary number of such pages it is NOT RECOMMENDED to call this method. Use the builder method instead.

getPageByVersion

@Nullable
AbstractPage getPageByVersion(AbstractPage mostRecentPage,
                                        int version)

returns the historical version of a page

Parameters:

mostRecentPage - - must specify the most recent recent version of the page (page must be associated with a space)

version - - historical version to retrieve

Returns:

the specified version of the page

removeAllPages

void removeAllPages(Space space)

Removes all pages in the space.

This can be a lengthy operation and should be performed in a long running task. Current Hibernate session will be cleared as part of this method.

Parameters:

space - the space to remove pages from.

removeAllPages

void removeAllPages(Space space,
                    com.atlassian.core.util.ProgressMeter progress)

Removes all pages in the space.

This can be a lengthy operation and should be performed in a long running task. Current Hibernate session will be cleared as part of this method.

Parameters:

space - the space to remove pages from.

progress - progress meter to report progress on, can not be null.

Since:

4.2

removeAllBlogPosts

void removeAllBlogPosts(Space space)

findPreviousBlogPost

@Nullable
BlogPost findPreviousBlogPost(String key,
                                        Date time)

findNextBlogPost

@Nullable
BlogPost findNextBlogPost(String key,
                                    Date time)

trashPage

@Deprecated
void trashPage(AbstractPage page)

Deprecated. since 6.0 Use trashPage(AbstractPage, DeleteContext)

trashPage

void trashPage(AbstractPage page,
               @Nonnull
               DeleteContext deleteContext)

Parameters:

page - page to be trashed

deleteContext - context a DeleteContext holding additional parameters for the manager to use when trashing the page.

Since:

6.0

getTopLevelPagesBuilder

@Nonnull
ListBuilder<Page> getTopLevelPagesBuilder(Space space)

Get the pages in a space that do not have a parent page. This method returns a list builder that can be used to paginate the results efficiently.

This method will return only pages the current user can view.

Parameters:

space - the space in which to look for pages

Returns:

a builder to paginate the result

restorePage

void restorePage(AbstractPage page)

Restores a trashed page, effectively moving it out of the trash and promoting it back to being normal page.

Parameters:

page - a trashed page

movePageAfter

void movePageAfter(Page page,
                   Page refPage)

Move the provided page (first argument) after the reference page (second argument). This may also mean moving the target page to another space, if the reference page is in another space.

Parameters:

page - the page to move

refPage - the page which the first page will be placed after

movePageBefore

void movePageBefore(Page page,
                    Page refPage)

Move the provided page (first argument) before the reference page (second argument). This may also mean moving the target page to another space, if the reference page is in another space.

Parameters:

page - the page to move

refPage - the page which the first page will be placed before

movePageAsChild

void movePageAsChild(Page page,
                     Page refPage)

Move the provided page (first argument) as a child of the reference page (second argument). This may also mean moving the target page to another space, if the reference page is in another space.

The location of the page in the reference page's children is dependent on their existing order. If they are not explicitly ordered, the page will have a default location in the list. If the children have an existing order, the page will be added as the last child of the reference page.

Parameters:

page - the page to move

refPage - the page which the first page will be made a child of

moveChildrenToNewParent

void moveChildrenToNewParent(Page oldParent,
                             Page newParent)

Moves all the children from one page to another The new parent should NOT be the child of the old parent, this method will return with no operation in that case

The location of the children under their new parent is dependent on the new parent's existing order. If they are not explicitly ordered, the children will be in their default location in the list. If the new parent have an existing order, the children will be ordered under the new parent.

Parameters:

oldParent - the page whose children you want to move

newParent - the page whose the children will now belong to

movePageToTopLevel

void movePageToTopLevel(Page page,
                        Space space)

Move a page to the top level of targetSpace. If the top-level pages are manually ordered, the page will be added to the end of the child pages.

Parameters:

page - the page to move

space - the space to move the page to

moveBlogPostToTopLevel

void moveBlogPostToTopLevel(BlogPost blogPost,
                            Space space)

Move a blog post to the top level of targetSpace.

Parameters:

blogPost - the blogPost to move

space - the space to move the page to

setChildPageOrder

void setChildPageOrder(Page parentPage,
                       List<Long> childIds)

Sets ordering of child pages for a supplied page, based on a map of child ids to positions.

Parameters:

parentPage - the page for which children should be ordered.

childIds - children page IDs in the new order

revertChildPageOrder

void revertChildPageOrder(Page parentPage)

Removes manual ordering of child pages.

Parameters:

parentPage - the page for which children should be unordered.

getOrderedXhtmlContentFromContentId

@Nonnull
List<ContentEntityObject> getOrderedXhtmlContentFromContentId(long startContentId,
                                                                       long endContentId,
                                                                       int maxRows)

Gets the latest versions of AbstractPages between the given IDs limited by the specified number of rows. Sorted by IDs in ascending order.

Parameters:

startContentId - The minimum ID

endContentId - The maximum ID

maxRows - The maximum number of rows to return

Returns:

A list of CEOs that match the criteria.

countPagesInSubtree

int countPagesInSubtree(Page page)

Get number of descendant page including the input page

Parameters:

page -

Returns:

total descendant page

getCountOfLatestXhtmlContent

int getCountOfLatestXhtmlContent(long endContentId)

Count the number of AbstractPages that have an ID lower than the specified ID, excluding older versions.

Parameters:

endContentId - The maximum ID

Returns:

The number of AbstractPages that have IDs lower than the specified ID

getHighestCeoId

long getHighestCeoId()

Get the highest content ID in the database, excluding older versions of content.

Returns:

The highest content ID

getPreviousVersionsOfPageWithTaskId

@Nonnull
List<ContentEntityObject> getPreviousVersionsOfPageWithTaskId(long pageId,
                                                                       long taskId,
                                                                       int maxRows)

Get previous versions of a CEO that contain the given task ID sorted by versions in descending order.

Parameters:

pageId - The ID of the latest version of the page

taskId - The task ID to look for in previous versions

maxRows - The maximum number of previous versions to return

Returns:

A maximum of maxRows previous versions of the page that contain the given taskId

getBlogPostCount

long getBlogPostCount(String key,
                      @Nullable
                      Calendar postingDay,
                      int period)

Get total number of blogPost.

Parameters:

key - the space to look for posts in

postingDay - a calendar object representing the date range we are looking for. Any part of the calendar more specific than the supplied period will be ignored.

period - one of the Calendar constants specifying the granularity of the search. currently, only Calendar.MONTH and Calendar.DATE are supported

Returns:

a count number of blogPosts

getPageCount

long getPageCount(@Nonnull
                  String spaceKey)

Get total number of current pages in a space

Parameters:

spaceKey - the space to look for posts in

Returns:

a count number of pages

Since:

6.1.3

countCurrentPages

int countCurrentPages()

Counts the total number of current pages across all spaces

Returns:

the number of current pages

Since:

6.3.1

countDraftPages

int countDraftPages()

Counts the number of pages that are drafts. This does not include drafts of pages that have already been published (i.e. pages with unpublished changes).

Returns:

the number of draft pages

Since:

6.3.1

countPagesWithUnpublishedChanges

int countPagesWithUnpublishedChanges()

Counts the number of published pages that have unpublished changes.

Returns:

the number of pages with unpublished changes.

Since:

6.3.1

countCurrentBlogs

int countCurrentBlogs()

Counts the total number of current blog posts across all spaces

Returns:

the number of current blog posts

Since:

6.3.1

countDraftBlogs

int countDraftBlogs()

Counts the number of blog posts that are drafts. This does not include drafts of blog posts that have already been published (i.e. blog posts with unpublished changes).

Returns:

the number of draft blog posts

Since:

6.3.1

countBlogsWithUnpublishedChanges

int countBlogsWithUnpublishedChanges()

Counts the number of published blog posts that have unpublished changes.

Returns:

the number of blog posts with unpublished changes.

Since:

6.3.1

refreshPage

@Nonnull
void refreshPage(ContentEntityObject page)

Refresh the page object in the hibernate session. This might be necessary if the page object has become stale.

Parameters:

page - the page to refresh

deepCopyPage

void deepCopyPage(PageCopyOptions option,
                  Page originalPage,
                  Page destinationPage)

Copy child page of originalPage to destinationPage

Parameters:

option - hint for us how we should copy page. Need to have READ permission on this page and all his child pages

originalPage - source page. Need to have CREATE permission on it

destinationPage - destination page

Since:

5.10

deepDeletePage

void deepDeletePage(PageDeleteOptions options,
                    Page targetPage)

Deletes a page hierarchy

Parameters:

options - options for bulk delete pages

targetPage - target page hierarchy to be deleted