com.atlassian.confluence.pages.persistence.dao
Interface PageDao

All Superinterfaces:
ContentEntityObjectDao, ObjectDao, VersionedObjectDao
All Known Implementing Classes:
CachingPageDao, HibernatePageDao

public interface PageDao
extends ContentEntityObjectDao


Method Summary
 java.util.List findPagesWithHistoricalTitle(java.lang.String pageTitle)
           
 int getAuthoredPagesCountByUser(java.lang.String username)
           
 java.util.List getDescendentIds(Page page)
           
 java.util.List<Page> getDescendents(Page page)
           
 java.util.List getOrphanedPages(java.lang.String spaceKey)
           
 Page getPage(Space space, java.lang.String pageTitle)
          Get the page by space and title.
 Page getPage(java.lang.String spaceKey, java.lang.String pageTitle)
          Deprecated. since 3.0, use getPage(Space, String)
 Page getPage(java.lang.String spaceKey, java.lang.String pageTitle, boolean eagerLoadComments)
          Deprecated. since 3.0, use getPageWithComments(Space, String)
 Page getPageById(long id)
          Get the page with the given id.
 Page getPageByIdWithComments(long id)
          Get the page with the given id, and perform an eager load of the comments and their children.
 java.util.List getPageInTrash(java.lang.String spaceKey, java.lang.String title)
           
 java.util.List getPages(Space space, boolean currentOnly)
          Return an iterator for the specified space.
 java.util.List getPagesCreatedOrUpdatedSinceDate(java.util.Date previousLoginDate)
           
 java.util.List getPagesStartingWith(Space space, java.lang.String s)
           
 Page getPageWithComments(Space space, java.lang.String pageTitle)
          Get the page by space and title, and perform an eager load of the comments and their children.
 java.util.List getPermissionPages(Space space)
           
 java.util.List getRecentlyAddedPages(int maxCount, java.lang.String spaceKey)
           
 java.util.List getRecentlyAuthoredPagesByUser(java.lang.String username, int maxCount)
           
 java.util.List getRecentlyUpdatedPages(int maxCount, java.lang.String spaceKey)
           
 java.util.List<Page> getTopLevelPages(Space space)
           
 java.util.List getUndefinedPages(java.lang.String spaceKey)
           
 void removeFromPageKeyCache(java.lang.String spaceKey, java.lang.String pageTitle)
          Deprecated. 
 
Methods inherited from interface com.atlassian.confluence.core.persistence.ContentEntityObjectDao
findPreviousVersions, getAllCurrentEntities, getById, getContentAuthoredByUser, getFirstVersionAfter, getFirstVersionBefore, getLastEditedVersionsOf, getLockedContentBySpace, getObjectType, getRecentlyAddedEntities, getRecentlyModifiedEntities, getRecentlyModifiedEntities, getRecentlyModifiedEntitiesByType, getRecentlyModifiedEntitiesForUser, getRecentlyModifiedForChangeDigest, getTrashedContent, getVersion, getVersionHistorySummary
 
Methods inherited from interface com.atlassian.confluence.core.persistence.VersionedObjectDao
findLatestVersionsCount, findLatestVersionsIterator, save
 
Methods inherited from interface bucket.core.persistence.ObjectDao
findAll, findAllSorted, getPersistentClass, refresh, remove, replicate, save, saveRaw
 

Method Detail

getPageById

Page getPageById(long id)
Get the page with the given id.

Parameters:
id - of the page to load
Returns:
the page with the given id, or null if no such page exists

getPageByIdWithComments

Page getPageByIdWithComments(long id)
Get the page with the given id, and perform an eager load of the comments and their children. This can be used as a performance optimisation when it is known that all comments will be displayed.

Parameters:
id - of the page to load
Returns:
the page with the given id, or null if no such page exists

getPage

@Deprecated
Page getPage(java.lang.String spaceKey,
                        java.lang.String pageTitle)
Deprecated. since 3.0, use getPage(Space, String)


getPage

@Deprecated
Page getPage(java.lang.String spaceKey,
                        java.lang.String pageTitle,
                        boolean eagerLoadComments)
Deprecated. since 3.0, use getPageWithComments(Space, String)

Get the page by space key and title, and perform an eager load of the comments and their children. This can be used as a performance optimisation when it is known that all comments will be displayed.

Parameters:
spaceKey - to match with
pageTitle - to match with
eagerLoadComments - true if comments should be loaded eagerly
Returns:
the page

getPage

Page getPage(Space space,
             java.lang.String pageTitle)
Get the page by space and title.

Parameters:
space - The space the page belongs to
pageTitle - The title of the page
Returns:
the page with the given title in the given space, or null if no such page exists

getPageWithComments

Page getPageWithComments(Space space,
                         java.lang.String pageTitle)
Get the page by space and title, and perform an eager load of the comments and their children. This can be used as a performance optimisation when it is known that all comments will be displayed.

Parameters:
space - The space the page belongs to
pageTitle - The title of the page
Returns:
the page with the given title in the given space, or null if no such page exists

getPages

java.util.List getPages(Space space,
                        boolean currentOnly)
Return an iterator for the specified space. This is an efficient alternative to space.getPages

Parameters:
space -
Returns:

getPagesStartingWith

java.util.List getPagesStartingWith(Space space,
                                    java.lang.String s)

getRecentlyAddedPages

java.util.List getRecentlyAddedPages(int maxCount,
                                     java.lang.String spaceKey)

getRecentlyUpdatedPages

java.util.List getRecentlyUpdatedPages(int maxCount,
                                       java.lang.String spaceKey)

getOrphanedPages

java.util.List getOrphanedPages(java.lang.String spaceKey)

getUndefinedPages

java.util.List getUndefinedPages(java.lang.String spaceKey)

getPermissionPages

java.util.List getPermissionPages(Space space)

getAuthoredPagesCountByUser

int getAuthoredPagesCountByUser(java.lang.String username)

getRecentlyAuthoredPagesByUser

java.util.List getRecentlyAuthoredPagesByUser(java.lang.String username,
                                              int maxCount)

getPagesCreatedOrUpdatedSinceDate

java.util.List getPagesCreatedOrUpdatedSinceDate(java.util.Date previousLoginDate)

removeFromPageKeyCache

@Deprecated
void removeFromPageKeyCache(java.lang.String spaceKey,
                                       java.lang.String pageTitle)
Deprecated. 


findPagesWithHistoricalTitle

java.util.List findPagesWithHistoricalTitle(java.lang.String pageTitle)

getPageInTrash

java.util.List getPageInTrash(java.lang.String spaceKey,
                              java.lang.String title)

getDescendents

java.util.List<Page> getDescendents(Page page)

getDescendentIds

java.util.List getDescendentIds(Page page)

getTopLevelPages

java.util.List<Page> getTopLevelPages(Space space)


Copyright © 2003-2009 Atlassian Pty Ltd. All Rights Reserved.