com.atlassian.confluence.internal.pages

Interface PageManagerInternal

All Superinterfaces:

ContentEntityManager, PageManager

All Known Implementing Classes:

DefaultPageManager

@ParametersAreNonnullByDefault
public interface PageManagerInternal
extends PageManager

Internal version of the PageManager interface; see the package-info.java for rationale.

Field Summary

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

ITERATE_ALL

Method Summary

Modifier and Type	Method and Description
AbstractPage	createDraft(String contentType, String spaceKey) This method creates a draft
AbstractPage	createDraft(String contentType, String spaceKey, long parentPageId) This method creates a draft.
AbstractPage	createOrFindDraftFor(AbstractPage abstractPage) Retrieves the draft for the given AbstractPage if exists.
List<ContentPermissionSummary>	findContentPermissionSummaryByIds(Collection<Long> ids) Get ContentPermissionSummary for bulk permission checking
PageResponse<AbstractPage>	getAbstractPages(org.joda.time.DateTime date, List<ContentStatus> statuses, LimitedRequest pageRequest, com.google.common.base.Predicate<? super AbstractPage>... filter) Returns pages and blog posts created on the specified date, that are in any of the given statuses, and also match the given predicate, limited to the page request.
PageResponse<AbstractPage>	getAbstractPages(List<ContentType> contentTypes, List<ContentStatus> statuses, LimitedRequest pageRequest, com.google.common.base.Predicate<? super AbstractPage>... filter) Returns all content in the instance within any of the specified statuses, limited to the specified content types and the pagination request.
PageResponse<AbstractPage>	getAbstractPages(Space space, List<ContentType> contentTypes, List<ContentStatus> statuses, LimitedRequest pageRequest, com.google.common.base.Predicate<? super AbstractPage>... filter) Returns all content in the space within any of the specified statuses and content types, limited to the pagination request.
PageResponse<AbstractPage>	getAbstractPages(Space space, String title, List<ContentStatus> statuses, LimitedRequest pageRequest, com.google.common.base.Predicate<? super AbstractPage>... filter) Returns pages and blog posts that belong to the space, exactly match the given title, are in any of the specified statuses, and match the given predicate, limited to the pagination request.
PageResponse<AbstractPage>	getAbstractPages(String title, List<ContentStatus> statuses, LimitedRequest pageRequest, com.google.common.base.Predicate<? super AbstractPage>... filter) Returns pages and blog posts that exactly match the given title, are in any of the specified statuses, and match the given predicate, limited to the pagination request.
PageResponse<AbstractPage>	getAbstractPagesByCreationDate(org.joda.time.DateTime date, LimitedRequest pageRequest, com.google.common.base.Predicate<? super AbstractPage>... filter) Returns the pages and blog posts created on the given date, that also match the given predicate, limited to the page request.
PageResponse<AbstractPage>	getAbstractPagesByTitle(String title, LimitedRequest pageRequest, com.google.common.base.Predicate<? super AbstractPage>... filter) Returns all current pages and blog posts that exactly match the given title, that also match the given predicate, limited to the pagination request.
PageResponse<BlogPost>	getBlogPosts(Space space, LimitedRequest pageRequest, com.google.common.base.Predicate<? super BlogPost>... filter) Returns all the current blog posts in the space, limited to the pagination request.
PageResponse<Page>	getChildren(Page page, LimitedRequest pageRequest, Depth depth) Returns the children of a page which have a status of CURRENT, limited to the pagination requested.
PageResponse<Page>	getPages(LimitedRequest pageRequest, com.google.common.base.Predicate<? super Page>... filter) Returns all the current pages in this instance of confluence, limited to the pagination request.
PageResponse<Page>	getPages(Space space, LimitedRequest pageRequest, com.google.common.base.Predicate<? super Page>... filter) Returns all the current pages in the space, limited to the pagination request.
PageResponse<Page>	getTopLevelPages(Space space, LimitedRequest pageRequest) Returns the current top-level pages in a space, limited to the pagination requested.

Methods inherited from interface com.atlassian.confluence.pages.PageManager

countBlogsWithUnpublishedChanges, countCurrentBlogs, countCurrentPages, countDraftBlogs, countDraftPages, countPagesInSubtree, countPagesWithUnpublishedChanges, deepCopyPage, deepDeletePage, findNextBlogPost, findNextBlogPost, findPreviousBlogPost, findPreviousBlogPost, getAbstractPage, getAbstractPages, getAttachmentManager, getAuthoredPagesCountByUser, getBlogPost, getBlogPost, getBlogPost, getBlogPostCount, getBlogPosts, getBlogPosts, getBlogPosts, getBlogPostsInTrash, getCommentCountOnPage, getCountOfLatestXhtmlContent, getDescendantIds, getDescendants, getDescendantTitles, getDescendentIds, getDescendents, getDraftChildren, getHighestCeoId, getMonthsWithBlogPosts, getNewestBlogPost, getNotificationManager, getOrderedXhtmlContentFromContentId, getOrphanedPages, getPage, getPage, getPage, getPageByVersion, getPageCount, getPageIds, getPageInTrash, getPages, getPages, getPagesCreatedOrUpdatedSinceDate, getPagesStartingWith, getPagesWithPermissions, getPageWithComments, getPermissionPages, getPossibleBlogRedirectsInSpace, getPossibleBlogRedirectsNotInSpace, getPossibleRedirects, getPossibleRedirectsForSpace, getPossibleRedirectsInSpace, getPossibleRedirectsNotInSpace, getPreviousVersionsOfPageWithTaskId, getRecentlyAddedBlogPosts, getRecentlyAddedBlogPosts, getRecentlyAddedPages, getRecentlyUpdatedPages, getTopLevelPages, getTopLevelPagesBuilder, getUndefinedLinks, getUndefinedPages, getYearsWithBlogPosts, isPageRecentlyUpdatedForUser, moveBlogPostToTopLevel, moveChildrenToNewParent, movePageAfter, movePageAsChild, movePageBefore, movePageToTopLevel, refreshPage, removeAllBlogPosts, removeAllPages, removeAllPages, removePageFromAncestorCollections, removeStaleSharedDrafts, renamePage, renamePageWithoutNotifications, restorePage, revertChildPageOrder, setAttachmentManager, setChildPageOrder, setNotificationManager, spaceHasBlogPosts, trashPage, trashPage, updatePageInAncestorCollections

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

createDraft

AbstractPage createDraft(String contentType,
                         String spaceKey)

This method creates a draft

Parameters:

contentType - - content type of the draft to create: page or blogpost

spaceKey - - space key of the space to create the draft into

Returns:

the obj created as draft

See Also:

ContentEntityObject.DRAFT

createDraft

AbstractPage createDraft(String contentType,
                         String spaceKey,
                         long parentPageId)

This method creates a draft. The draft is created as a child of the parentPage

Parameters:

contentType - - content type of the draft to create: page or blogpost

spaceKey - - space key of the space to create the draft into

parentPageId - - parent page ID of the newly created draft

Returns:

the obj created as draft

createOrFindDraftFor

AbstractPage createOrFindDraftFor(AbstractPage abstractPage)

Retrieves the draft for the given AbstractPage if exists.

Parameters:

abstractPage - the AbstractPage to retrieve the draft for

Returns:

the draft for the given AbstractPage if exists, null otherwise

See Also:

ContentEntityObject.DRAFT

getTopLevelPages

@Nonnull
PageResponse<Page> getTopLevelPages(Space space,
                                             LimitedRequest pageRequest)

Returns the current top-level pages in a space, limited to the pagination requested.

Parameters:

space - the space to locate pages in

pageRequest - the pagination requested

Returns:

the paginated response of Page entities

getPages

@Nonnull
PageResponse<Page> getPages(Space space,
                                     LimitedRequest pageRequest,
                                     com.google.common.base.Predicate<? super Page>... filter)

Returns all the current pages in the space, limited to the pagination request.

Parameters:

space - the space to locate pages in

pageRequest - the pagination requested

filter - a Predicate to apply to the results before returning

Returns:

the paginated response of Page entities in the given space

getPages

@Nonnull
PageResponse<Page> getPages(LimitedRequest pageRequest,
                                     com.google.common.base.Predicate<? super Page>... filter)

Returns all the current pages in this instance of confluence, limited to the pagination request.

Parameters:

pageRequest - the pagination requested

filter - a Predicate to apply to the results before returning

Returns:

the paginated response of Page entities

getBlogPosts

@Nonnull
PageResponse<BlogPost> getBlogPosts(Space space,
                                             LimitedRequest pageRequest,
                                             com.google.common.base.Predicate<? super BlogPost>... filter)

Returns all the current blog posts in the space, limited to the pagination request.

Parameters:

space - the space to locate blog posts in

pageRequest - the pagination requested

Returns:

the paginated response of BlogPost entities

getChildren

@Nonnull
PageResponse<Page> getChildren(Page page,
                                        LimitedRequest pageRequest,
                                        Depth depth)

Returns the children of a page which have a status of CURRENT, limited to the pagination requested.

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

getAbstractPagesByTitle

@Nonnull
PageResponse<AbstractPage> getAbstractPagesByTitle(String title,
                                                            LimitedRequest pageRequest,
                                                            com.google.common.base.Predicate<? super AbstractPage>... filter)

Returns all current pages and blog posts that exactly match the given title, that also match the given predicate, limited to the pagination request.

Parameters:

title - the title of the page or blog post to match

pageRequest - the pagination requested

filter - a predicate to apply to the results before returning

Returns:

the paginated list of AbstractPages by title

getAbstractPagesByCreationDate

@Nonnull
PageResponse<AbstractPage> getAbstractPagesByCreationDate(org.joda.time.DateTime date,
                                                                   LimitedRequest pageRequest,
                                                                   com.google.common.base.Predicate<? super AbstractPage>... filter)

Returns the pages and blog posts created on the given date, that also match the given predicate, limited to the page request.

Parameters:

date - the creation date of the page or blog post

pageRequest - the pagination request

filter - a predicate to apply to the results before returning

Returns:

the paginated list of AbstractPages created on the given date

getAbstractPages

@Nonnull
PageResponse<AbstractPage> getAbstractPages(List<ContentType> contentTypes,
                                                     List<ContentStatus> statuses,
                                                     LimitedRequest pageRequest,
                                                     com.google.common.base.Predicate<? super AbstractPage>... filter)

Returns all content in the instance within any of the specified statuses, limited to the specified content types and the pagination request.

Parameters:

contentTypes - types of the content to fetch, pages and or blog posts

statuses - list of statuses the content can be in

pageRequest - the pagination requested

filter - a Predicate to apply to the results before returning

Returns:

the paginated response of Page entities in the given space

getAbstractPages

@Nonnull
PageResponse<AbstractPage> getAbstractPages(Space space,
                                                     List<ContentType> contentTypes,
                                                     List<ContentStatus> statuses,
                                                     LimitedRequest pageRequest,
                                                     com.google.common.base.Predicate<? super AbstractPage>... filter)

Returns all content in the space within any of the specified statuses and content types, limited to the pagination request.

Parameters:

space - the space to locate pages in

contentTypes - types of the content to fetch, pages and or blog posts

statuses - list of statuses the content can be in

pageRequest - the pagination requested

filter - a Predicate to apply to the results before returning

Returns:

the paginated response of Page entities in the given space

getAbstractPages

@Nonnull
PageResponse<AbstractPage> getAbstractPages(org.joda.time.DateTime date,
                                                     List<ContentStatus> statuses,
                                                     LimitedRequest pageRequest,
                                                     com.google.common.base.Predicate<? super AbstractPage>... filter)

Returns pages and blog posts created on the specified date, that are in any of the given statuses, and also match the given predicate, limited to the page request.

Parameters:

date - the creation date to match

statuses - list of statuses the content can be in

pageRequest - the pagination request

filter - a predicate to apply to the results before returning

Returns:

the paginated list of AbstractPages created on the given date

getAbstractPages

@Nonnull
PageResponse<AbstractPage> getAbstractPages(Space space,
                                                     String title,
                                                     List<ContentStatus> statuses,
                                                     LimitedRequest pageRequest,
                                                     com.google.common.base.Predicate<? super AbstractPage>... filter)

Returns pages and blog posts that belong to the space, exactly match the given title, are in any of the specified statuses, and match the given predicate, limited to the pagination request.

Parameters:

space - space the content belongs to

title - the title of the page to match

statuses - list of statuses the content can be in

pageRequest - the pagination requested

filter - a Predicate to apply to the results before returning

Returns:

the paginated list of AbstractPages that have a title, are in the specified statuses, and belong to the given space

getAbstractPages

@Nonnull
PageResponse<AbstractPage> getAbstractPages(String title,
                                                     List<ContentStatus> statuses,
                                                     LimitedRequest pageRequest,
                                                     com.google.common.base.Predicate<? super AbstractPage>... filter)

Returns pages and blog posts that exactly match the given title, are in any of the specified statuses, and match the given predicate, limited to the pagination request.

Parameters:

title - the title of the page to match

statuses - list of statuses the content can be in

pageRequest - the pagination requested

filter - a predicate to apply to the results before returning

Returns:

the paginated list of AbstractPages by title

findContentPermissionSummaryByIds

List<ContentPermissionSummary> findContentPermissionSummaryByIds(Collection<Long> ids)

Get ContentPermissionSummary for bulk permission checking

Parameters:

ids - of Content

Returns:

List of ContentPermissionSummary

Since:

6.0