com.atlassian.confluence.spaces.persistence.dao
Interface SpaceDao

All Superinterfaces:
ObjectDao
All Known Implementing Classes:
HibernateSpaceDao

public interface SpaceDao
extends ObjectDao


Method Summary
 java.util.List<Space> findAllGlobalSpaces()
           
 java.util.List<Space> findAllSpacesSorted(java.lang.String sortBy, SpaceType type)
          Find all uncategorised spaces and sort results by named property.
 int findPageTotal(Space space)
          Fast way to count pages in a space without loading them.
 Space getById(long id)
           
 int getNumberOfBlogPosts(Space space)
          Fast way to count blog posts in a space without loading them.
 int getNumberOfMail(Space space)
          Fast way to count pages in a space without loading them.
 java.util.List<Space> getPermittedSpacesForUser(com.atlassian.user.User user, java.util.List<com.atlassian.user.Group> groups, java.lang.String permission)
          Find all spaces on which the given user with the given groups has the given permission
 java.util.List<Space> getPermittedSpacesForUser(com.atlassian.user.User user, java.lang.String permission)
          Deprecated. since 3.0, use getPermittedSpacesForUser(User, List, String)
 java.util.List<Space> getPermittedSpacesForUserByType(com.atlassian.user.User user, java.util.List<com.atlassian.user.Group> groups, java.lang.String permission, SpaceType type)
          Find all spaces of a certain type on which the given user with the given groups has the given permission
 java.util.List<Space> getPermittedSpacesForUserByType(com.atlassian.user.User user, java.lang.String permission, SpaceType type)
          Deprecated. since 3.0, use getPermittedSpacesForUserByType(User, List, String, SpaceType)
 java.util.List<Space> getPermittedSpacesForUserInSpaceGroup(com.atlassian.user.User user, java.util.List<com.atlassian.user.Group> groups, java.lang.String permission, SpaceGroup spaceGroup)
          Find all spaces within a spaceGroup to which the given user with the given groups has the given permission
 java.util.List<Space> getPermittedSpacesForUserInSpaceGroup(com.atlassian.user.User user, java.lang.String permission, SpaceGroup spaceGroup)
          Deprecated. since 3.0, use getPermittedSpacesForUserInSpaceGroup(User, List, String, SpaceGroup)
 Space getSpace(java.lang.String spaceKey)
          Find a space by its space key.
 java.util.List<Space> getSpacesContainingCommentsByUser(java.lang.String username)
          Find all spaces containing comments by a particular user.
 java.util.List<Space> getSpacesContainingPagesEditedByUser(java.lang.String username)
          Find all spaces containing pages that were edited by a particular user.
 java.util.List<Space> getSpacesCreatedAfter(java.util.Date creationDate)
           
 java.util.List<Space> getSpacesCreatedByUser(java.lang.String username)
          Find all the spaces created by a given user.
 java.util.List<Space> getSpacesCreatedOrUpdatedSinceDate(java.util.Date previousLoginDate)
           
 java.util.List<Space> getSpacesInSpaceGroup(SpaceGroup spaceGroup)
          Find all spaces within a given spaceGroup
 
Methods inherited from interface bucket.core.persistence.ObjectDao
findAll, findAllSorted, getPersistentClass, refresh, remove, replicate, save, saveRaw
 

Method Detail

getById

Space getById(long id)

getSpace

Space getSpace(java.lang.String spaceKey)
Find a space by its space key.


getSpacesInSpaceGroup

java.util.List<Space> getSpacesInSpaceGroup(SpaceGroup spaceGroup)
Find all spaces within a given spaceGroup

Parameters:
spaceGroup -
Returns:
List of spaces

getSpacesCreatedByUser

java.util.List<Space> getSpacesCreatedByUser(java.lang.String username)
Find all the spaces created by a given user.


getSpacesContainingPagesEditedByUser

java.util.List<Space> getSpacesContainingPagesEditedByUser(java.lang.String username)
Find all spaces containing pages that were edited by a particular user. This is for tracking down whether a user can be safely deleted or not.

Parameters:
username - the name of the user to track down
Returns:
a list of the spaces containing pages that were edited by this user, or the empty list if no such spaces exist.

getSpacesContainingCommentsByUser

java.util.List<Space> getSpacesContainingCommentsByUser(java.lang.String username)
Find all spaces containing comments by a particular user. This is for tracking down whether a user can be safely deleted or not. Does currently not include personal spaces, but probably should.

Parameters:
username - the name of the user to track down
Returns:
a list of the spaces containing comments by this user, or the empty list if no such spaces exist.

getSpacesCreatedOrUpdatedSinceDate

java.util.List<Space> getSpacesCreatedOrUpdatedSinceDate(java.util.Date previousLoginDate)

findPageTotal

int findPageTotal(Space space)
Fast way to count pages in a space without loading them. Counts all pages, not just the current versions.

Returns:
returns the number of all versions of all pages in a space

getNumberOfBlogPosts

int getNumberOfBlogPosts(Space space)
Fast way to count blog posts in a space without loading them. Counts all blog posts, not just the current versions.

Returns:
returns the number of all versions of all blog posts in a space

getNumberOfMail

int getNumberOfMail(Space space)
Fast way to count pages in a space without loading them. Counts all mail, not just the current versions.

Returns:
returns the number of all versions of all mail in a space

getSpacesCreatedAfter

java.util.List<Space> getSpacesCreatedAfter(java.util.Date creationDate)

getPermittedSpacesForUser

@Deprecated
java.util.List<Space> getPermittedSpacesForUser(com.atlassian.user.User user,
                                                           java.lang.String permission)
Deprecated. since 3.0, use getPermittedSpacesForUser(User, List, String)

Find all spaces on which the given user has the given permission


getPermittedSpacesForUserByType

@Deprecated
java.util.List<Space> getPermittedSpacesForUserByType(com.atlassian.user.User user,
                                                                 java.lang.String permission,
                                                                 SpaceType type)
Deprecated. since 3.0, use getPermittedSpacesForUserByType(User, List, String, SpaceType)

Find all spaces of a certain type on which the given user has the given permission


getPermittedSpacesForUserInSpaceGroup

@Deprecated
java.util.List<Space> getPermittedSpacesForUserInSpaceGroup(com.atlassian.user.User user,
                                                                       java.lang.String permission,
                                                                       SpaceGroup spaceGroup)
Deprecated. since 3.0, use getPermittedSpacesForUserInSpaceGroup(User, List, String, SpaceGroup)

Find all spaces within a spaceGroup to which the given user has the given permission


getPermittedSpacesForUser

java.util.List<Space> getPermittedSpacesForUser(com.atlassian.user.User user,
                                                java.util.List<com.atlassian.user.Group> groups,
                                                java.lang.String permission)
Find all spaces on which the given user with the given groups has the given permission


getPermittedSpacesForUserByType

java.util.List<Space> getPermittedSpacesForUserByType(com.atlassian.user.User user,
                                                      java.util.List<com.atlassian.user.Group> groups,
                                                      java.lang.String permission,
                                                      SpaceType type)
Find all spaces of a certain type on which the given user with the given groups has the given permission


getPermittedSpacesForUserInSpaceGroup

java.util.List<Space> getPermittedSpacesForUserInSpaceGroup(com.atlassian.user.User user,
                                                            java.util.List<com.atlassian.user.Group> groups,
                                                            java.lang.String permission,
                                                            SpaceGroup spaceGroup)
Find all spaces within a spaceGroup to which the given user with the given groups has the given permission


findAllSpacesSorted

java.util.List<Space> findAllSpacesSorted(java.lang.String sortBy,
                                          SpaceType type)
Find all uncategorised spaces and sort results by named property.

Parameters:
sortBy -
Returns:
sorted List of spaces

findAllGlobalSpaces

java.util.List<Space> findAllGlobalSpaces()


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