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

All Superinterfaces:
ObjectDao, VersionedObjectDao
All Known Implementing Classes:
HibernateBlogPostDao

public interface BlogPostDao
extends VersionedObjectDao


Method Summary
 BlogPost getBlogPost(String spaceKey, String title, Calendar day)
          Get the blog post by name and date.
 BlogPost getBlogPost(String spaceKey, String title, Calendar day, boolean eagerLoadComments)
          Get the blog post by name and date.
 BlogPost getBlogPostByTitle(String spaceKey, String title)
          Get a blog post by name.
 List getBlogPosts(Space space, boolean currentOnly)
          Return an iterator for the specified space.
 List getBlogPosts(String spaceKey, Calendar date, int period)
          Get the blog posts in a space for a particular period.
 BlogPost getById(long id)
          Get a blog post by id.
 BlogPost getFirstPostAfter(BlogPost post)
          Used for finding the "previous" post to an existing post.
 BlogPost getFirstPostAfter(String spaceKey, Date creationDate)
          Used for finding the "previous" post to an existing post
 BlogPost getFirstPostBefore(BlogPost post)
          Used for finding the "previous" post to an existing post.
 BlogPost getFirstPostBefore(String spaceKey, Date creationDate)
          Used for finding the "previous" post to an existing post
 BlogPost getMostRecentBlogPost(String spaceKey)
           
 List getRecentlyAddedBlogPosts(int maxPosts, Date timeSince, String spaceKey)
           
 List getRecentlyAddedBlogPosts(int maxCount, String spaceKey)
          Get list of recently created blog posts.
 
Methods inherited from interface com.atlassian.confluence.core.persistence.VersionedObjectDao
findLatestVersionsCount, findLatestVersionsIterator, save
 
Methods inherited from interface bucket.core.persistence.ObjectDao
findAll, findAllSorted, findAllSorted, getPersistentClass, refresh, remove, replicate, save, saveRaw
 

Method Detail

getById

BlogPost getById(long id)
Get a blog post by id. Will return null if the post does not exist


getBlogPostByTitle

BlogPost getBlogPostByTitle(String spaceKey,
                            String title)
Get a blog post by name. If there is no blog post by that name, or if the name is ambiguous (there are multiple blog posts by that name on different dates), the method will return null

Parameters:
spaceKey - the space
title - the title
Returns:
the blog post in that key with that title, or null if there is no such post, or the title does not unambiguously refer to a single blog entry.

getBlogPost

BlogPost getBlogPost(String spaceKey,
                     String title,
                     Calendar day)
Get the blog post by name and date. If there is no blog post by that name on that date, the method will return null

Parameters:
spaceKey - the space to look for the post in
title - the title of the post we are looking for
day - the DAY the post was created on. Any part of the calendar more specific than a day will be ignored

getBlogPost

BlogPost getBlogPost(String spaceKey,
                     String title,
                     Calendar day,
                     boolean eagerLoadComments)
Get the blog post by name and date. If there is no blog post by that name on that date, the method will return null

Parameters:
spaceKey - the space to look for the post in
title - the title of the post we are looking for
day - the DAY the post was created on. Any part of the calendar more specific than a day will be ignored

getBlogPosts

List getBlogPosts(String spaceKey,
                  Calendar date,
                  int period)
Get the blog posts in a space for a particular period.

TODO: add Calendar.WEEK range support.

Parameters:
spaceKey - the space to look for posts in
date - 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 blog posts in that time-range. The list may be empty but will never be null

getBlogPosts

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


getRecentlyAddedBlogPosts

List getRecentlyAddedBlogPosts(int maxCount,
                               String spaceKey)
Get list of recently created blog posts.

Parameters:
maxCount - Maximum number of posts to return
spaceKey - the spaceKey to look for the posts in. If this key is null, we look acrosns all spaces
Returns:
a list of the most recently added blog posts. The list can be empty but will never be null.

getFirstPostBefore

BlogPost getFirstPostBefore(String spaceKey,
                            Date creationDate)
Used for finding the "previous" post to an existing post

Parameters:
spaceKey - the space to look in
creationDate - the date the post must be before
Returns:
the first post created before that date, or null if there are none.

getFirstPostAfter

BlogPost getFirstPostAfter(String spaceKey,
                           Date creationDate)
Used for finding the "previous" post to an existing post

Parameters:
spaceKey - the space to look in
creationDate - the date the post must be after
Returns:
the first post created after that date, or null if there are none

getFirstPostBefore

BlogPost getFirstPostBefore(BlogPost post)
Used for finding the "previous" post to an existing post. If you are comparing blog posts, you should always prefer this over the method that takes a date, because this method will avoid date comparison bugs that can sneak in with certain databases. (*cough* Oracle)

Parameters:
post - the blog post that this must preceed
Returns:
the first post created before the given blog post, or null if there are none.

getFirstPostAfter

BlogPost getFirstPostAfter(BlogPost post)
Used for finding the "previous" post to an existing post. If you are comparing blog posts, you should always prefer this over the method that takes a date, because this method will avoid date comparison bugs that can sneak in with certain databases. (*cough* Oracle)

Parameters:
post - the blog post that this must be after
Returns:
the first post created after the given blog post, or null if there are none.

getRecentlyAddedBlogPosts

List getRecentlyAddedBlogPosts(int maxPosts,
                               Date timeSince,
                               String spaceKey)

getMostRecentBlogPost

BlogPost getMostRecentBlogPost(String spaceKey)


Copyright © 2003-2011 Atlassian. All Rights Reserved.