Package com.atlassian.confluence.internal.pages

Interface PageManagerInternal

    • 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

        @Deprecated
default @NonNull PageResponse<Page> getPages​(Space space,
                                             LimitedRequest pageRequest,
                                             com.google.common.base.Predicate<? super Page>... filter)
        Deprecated.
        since 7.0.1. Use getFilteredPages(Space, LimitedRequest, Predicate[])
        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

      • getFilteredPages

        @NonNull PageResponse<Page> getFilteredPages​(Space space,
                                             LimitedRequest pageRequest,
                                             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
        Since:
        7.0.1

      • scanFilteredPages

        default @NonNull PageResponse<Page> scanFilteredPages​(Space space,
                                                      List<ContentStatus> statuses,
                                                      LimitedRequest pageRequest,
                                                      Predicate<? super Page>... filter)
        Returns all pages in the space which has specified content statuses, limited to the pagination request.
        Parameters:
        space - the space to locate pages in
        statuses - list of content status which we are interested to fetch
        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
        Since:
        7.18.0

      • getPages

        @Deprecated
default @NonNull PageResponse<Page> getPages​(LimitedRequest pageRequest,
                                             com.google.common.base.Predicate<? super Page>... filter)
        Deprecated.
        since 7.0.1. Use getFilteredPages(LimitedRequest, Predicate[])
        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

      • getFilteredPages

        @NonNull PageResponse<Page> getFilteredPages​(LimitedRequest pageRequest,
                                             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
        Since:
        7.0.1

      • scanFilteredPages

        default @NonNull PageResponse<Page> scanFilteredPages​(List<ContentStatus> statuses,
                                                      LimitedRequest pageRequest,
                                                      Predicate<? super Page>... filter)
        Returns all pages with specified content statuses, limited to the pagination request.
        Parameters:
        statuses - list of content status which we are interested to fetch
        pageRequest - the pagination requested
        filter - a Predicate to apply to the results before returning
        Returns:
        the paginated response of Page entities
        Since:
        7.18.0

      • getFilteredBlogPosts

        @NonNull PageResponse<BlogPost> getFilteredBlogPosts​(Space space,
                                                     LimitedRequest pageRequest,
                                                     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
        Since:
        7.0.1

      • 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

      • getAllChildren

        PageResponse<Page> getAllChildren​(Page page,
                                  LimitedRequest pageRequest,
                                  Depth depth)
        Returns all the children of a page (including drafts), 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
        Since:
        6.7.1

      • getAbstractPagesByTitle

        @Deprecated
default @NonNull PageResponse<AbstractPage> getAbstractPagesByTitle​(String title,
                                                                    LimitedRequest pageRequest,
                                                                    com.google.common.base.Predicate<? super AbstractPage>... filter)
        Deprecated.
        since 7.0.1. Use getFilteredAbstractPagesByTitle(String, LimitedRequest, Predicate[])
        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

      • getFilteredAbstractPagesByTitle

        @NonNull PageResponse<AbstractPage> getFilteredAbstractPagesByTitle​(String title,
                                                                    LimitedRequest pageRequest,
                                                                    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
        Since:
        7.0.1

      • getAbstractPages

        @Deprecated
default @NonNull PageResponse<AbstractPage> getAbstractPages​(List<ContentType> contentTypes,
                                                             List<ContentStatus> statuses,
                                                             LimitedRequest pageRequest,
                                                             com.google.common.base.Predicate<? super AbstractPage>... filter)
        Deprecated.
        since 7.0.1. Use getFilteredAbstractPages(List, List, LimitedRequest, Predicate[])
        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

      • getFilteredAbstractPages

        @NonNull PageResponse<AbstractPage> getFilteredAbstractPages​(List<ContentType> contentTypes,
                                                             List<ContentStatus> statuses,
                                                             LimitedRequest pageRequest,
                                                             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
        Since:
        7.0.1

      • getFilteredAbstractPages

        @NonNull PageResponse<AbstractPage> getFilteredAbstractPages​(Space space,
                                                             List<ContentType> contentTypes,
                                                             List<ContentStatus> statuses,
                                                             LimitedRequest pageRequest,
                                                             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
        Since:
        7.0.1

      • getAbstractPages

        @Deprecated
default @NonNull PageResponse<AbstractPage> getAbstractPages​(Space space,
                                                             String title,
                                                             List<ContentStatus> statuses,
                                                             LimitedRequest pageRequest,
                                                             com.google.common.base.Predicate<? super AbstractPage>... filter)
        Deprecated.
        since 7.0.1. Use getFilteredAbstractPages(Space, String, List, LimitedRequest, Predicate[])
        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

      • getFilteredAbstractPages

        @NonNull PageResponse<AbstractPage> getFilteredAbstractPages​(Space space,
                                                             String title,
                                                             List<ContentStatus> statuses,
                                                             LimitedRequest pageRequest,
                                                             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
        Since:
        7.0.1

      • getAbstractPages

        @Deprecated
default @NonNull PageResponse<AbstractPage> getAbstractPages​(String title,
                                                             List<ContentStatus> statuses,
                                                             LimitedRequest pageRequest,
                                                             com.google.common.base.Predicate<? super AbstractPage>... filter)
        Deprecated.
        since 7.0.1. Use getFilteredAbstractPages(String, List, LimitedRequest, Predicate[])
        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

      • getFilteredAbstractPages

        @NonNull PageResponse<AbstractPage> getFilteredAbstractPages​(String title,
                                                             List<ContentStatus> statuses,
                                                             LimitedRequest pageRequest,
                                                             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
        Since:
        7.0.1

      • findContentPermissionSummaryByIds

        List<ContentPermissionSummary> findContentPermissionSummaryByIds​(Collection<Long> ids)
        Get ContentPermissionSummary for bulk permission checking
        Parameters:
        ids - of Content
        Returns:
        List of ContentPermissionSummary
        Since:
        6.0

      • getPermissionPages

        Collection<Page> getPermissionPages​(Space space,
                                    LimitedRequest limitedRequest)
        Pagination permission pages for particular Space
        Parameters:
        space -
        limitedRequest -
        Returns:
        Collection of permission pages within the request range
        Since:
        7.5.0

      • getPermissionPagesCount

        long getPermissionPagesCount​(Space space)
        Get total number of permission pages for particular Space
        Parameters:
        space -
        Returns:
        the count
        Since:
        7.5.0