com.plumtree.remote.prc.collaboration.blog
Interface IBlogManager

public interface IBlogManager

Contains methods for getting blogs and manipulating blog entries.

A blog contains zero or more blog entries, which contain zero or more annotations and object references.

Method Summary

IBlogEntry	createBlogEntry(int projectID, int blogID) Creates a blog entry.
IBlog	getBlog(int projectID, int blogID) Returns the IBlog matching the specified projectID and blogID.
IBlogEntry[]	getBlogEntries(int projectID, int blogID) Gets all blog entries matching the specified projectID and blogID.
IBlogEntry[]	getBlogEntries(int projectID, int blogID, java.util.Date startDate, java.util.Date endDate) Gets all blog entries matching the specified projectID and blogID, startDate and endDate.
IBlogEntry	getBlogEntry(int projectID, int blogID, int blogEntryID) Returns a blog entry matching the specified projectID, blogID, and blogEntryID.
IBlog	getBlogFromProject(int projectID) Returns the default blog from the project.
void	removeBlogEntry(IBlogEntry blogEntry) Removes the blog entry.

Method Detail

createBlogEntry

public IBlogEntry createBlogEntry(int projectID,
                                  int blogID)
                           throws CollaborationException,
                                  java.rmi.RemoteException

Creates a blog entry.

Parameters:

projectID - the ID of the project; must be positive. The ID of an object can be obtained using the getID method in the object class.

blogID - the ID of the blog; must be positive. The ID of an object can be obtained using the getID method in the object class.

Returns:

a blog entry that has not been persisted yet (you must call store to save the new blog entry)

Throws:

CollaborationException - if the method call resulted in an error

java.lang.IllegalArgumentException - if the projectID or blogID is not > 0

java.rmi.RemoteException - if there was a communication problem during the execution of the remote method call

getBlog

public IBlog getBlog(int projectID,
                     int blogID)
              throws CollaborationException,
                     java.rmi.RemoteException

Returns the IBlog matching the specified projectID and blogID.

Parameters:

projectID - the ID of the project; must be positive. The ID of an object can be obtained using the getID method in the object class.

blogID - the ID of the blog; must be positive. The ID of an object can be obtained using the getID method in the object class.

Returns:

the blog or null if the blog does not exist, or the user does not have the rights to see the blog

Throws:

CollaborationException - if the method call resulted in an error

java.lang.IllegalArgumentException - if the projectID or blogID is not > 0

java.rmi.RemoteException - if there was a communication problem during the execution of the remote method call

getBlogEntries

public IBlogEntry[] getBlogEntries(int projectID,
                                   int blogID)
                            throws CollaborationException,
                                   java.rmi.RemoteException

Gets all blog entries matching the specified projectID and blogID.

Parameters:

projectID - the ID of the project; must be positive. The ID of an object can be obtained using the getID method in the object class.

blogID - the ID of the blog; must be positive. The ID of an object can be obtained using the getID method in the object class.

Returns:

an array of IBlogEntry that represent blog entries within the specified project and blog, or a 0-length array if there are no blog entries in the specified project

Throws:

CollaborationException - if the method call resulted in an error

java.lang.IllegalArgumentException - if the projectID or blogID is not > 0

java.rmi.RemoteException - if there was a communication problem during the execution of the remote method call

getBlogEntries

public IBlogEntry[] getBlogEntries(int projectID,
                                   int blogID,
                                   java.util.Date startDate,
                                   java.util.Date endDate)
                            throws CollaborationException,
                                   java.rmi.RemoteException

Gets all blog entries matching the specified projectID and blogID, startDate and endDate.

Parameters:

projectID - the ID of the project; must be positive. The ID of an object can be obtained using the getID method in the object class.

blogID - the ID of the blog; must be positive. The ID of an object can be obtained using the getID method in the object class.

startDate - the start date of the blog entries to fetch; cannot be null

endDate - the end date of the blog entries to fetch; cannot be null and must be later than the start date

Returns:

an array of IBlogEntry that represent blog entries within the specified project and blog, or a 0-length array if there are no blog entries in the specified project

Throws:

CollaborationException - if the method call resulted in an error

java.lang.IllegalArgumentException - if the projectID or blogID is not > 0, or if the end date is not later than the start date

java.rmi.RemoteException - if there was a communication problem during the execution of the remote method call

getBlogEntry

public IBlogEntry getBlogEntry(int projectID,
                               int blogID,
                               int blogEntryID)
                        throws CollaborationException,
                               java.rmi.RemoteException

Returns a blog entry matching the specified projectID, blogID, and blogEntryID.

Parameters:

projectID - the ID of the project; must be positive. The ID of an object can be obtained using the getID method in the object class.

blogID - the ID of the blog; must be positive. The ID of an object can be obtained using the getID method in the object class.

blogEntryID - the ID of the blog entry; must be positive. The ID of an object can be obtained using the getID method in the object class.

Returns:

the blog entry matching the specified IDs

Throws:

CollaborationException - if the method call resulted in an error

java.lang.IllegalArgumentException - if the projectID, blogID, or blogEntryID is not > 0

java.rmi.RemoteException - if there was a communication problem during the execution of the remote method call

getBlogFromProject

public IBlog getBlogFromProject(int projectID)
                         throws CollaborationException,
                                java.rmi.RemoteException

Returns the default blog from the project.

Parameters:

projectID - the ID of the project; must be positive. The ID of an object can be obtained using the getID method in the object class.

Returns:

the blog or null if the user does not have the rights to see the blog

Throws:

CollaborationException - if the method call resulted in an error

java.lang.IllegalArgumentException - if the projectID is not > 0

java.rmi.RemoteException - if there was a communication problem during the execution of the remote method call

removeBlogEntry

public void removeBlogEntry(IBlogEntry blogEntry)
                     throws CollaborationException,
                            java.rmi.RemoteException

Removes the blog entry.

Parameters:

blogEntry - the blogEntry to be removed; cannot be null

Throws:

CollaborationException - if the method call resulted in an error

java.rmi.RemoteException - if there was a communication problem during the execution of the remote method call