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

public interface IBlogEntry

Contains method to return blog entry properties, annotations, and object references.

Method Summary

void	addAnnotation(java.lang.String content) Adds an annotation.
IAnnotation[]	getAnnotations() Gets the annotations for this blog entry.
java.lang.String	getAuthor() Returns the blog entry author.
IBlog	getContainingBlog() Returns the blog that this object belongs to.
IProject	getContainingProject() Returns the project that this object belongs to.
java.lang.String	getContent() Returns the blog entry content.
java.util.Date	getCreatedDate() Returns the blog entry created date.
int	getID() Returns the blog entry id.
java.util.Date	getLastModified() Returns the blog entry last modified date.
java.lang.String	getLastModifiedBy() Returns the name of the person who last modified this blog entry.
IObjectReference[]	getObjectReferences() Returns the object references for this blog entry.
java.lang.String	getTitle() Returns the blog entry title.
void	setContent(java.lang.String content) Sets the blog entry content.
void	setTitle(java.lang.String title) Sets the blog entry title.
void	store() Stores this blog entry.

Method Detail

addAnnotation

public void addAnnotation(java.lang.String content)
                   throws CollaborationException,
                          java.rmi.RemoteException

Adds an annotation.

Parameters:

content - annotation content; cannot be null

Throws:

CollaborationException - if the method call resulted in an error

java.lang.IllegalStateException - if the object has not yet been stored or has already been removed

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

getAnnotations

public IAnnotation[] getAnnotations()
                             throws CollaborationException,
                                    java.rmi.RemoteException

Gets the annotations for this blog entry.

Returns:

the annotations for this blog entry, or an empty array if there are no annotations

Throws:

CollaborationException - if the method call resulted in an error

java.lang.IllegalStateException - if the object has not yet been stored or has already been removed

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

getAuthor

public java.lang.String getAuthor()

Returns the blog entry author.

Returns:

the author

Throws:

java.lang.IllegalStateException - if the object has not yet been stored or has already been removed

getContainingBlog

public IBlog getContainingBlog()
                        throws CollaborationException,
                               java.rmi.RemoteException

Returns the blog that this object belongs to.

Returns:

the blog that this object belongs to

Throws:

java.lang.IllegalStateException - if the object has already been removed

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

getContainingProject

public IProject getContainingProject()
                              throws CollaborationException,
                                     java.rmi.RemoteException

Returns the project that this object belongs to.

Returns:

the project that this object belongs to

Throws:

java.lang.IllegalStateException - if the object has already been removed

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

getContent

public java.lang.String getContent()

Returns the blog entry content.

Returns:

the content

Throws:

java.lang.IllegalStateException - if the object has not yet been stored or has already been removed

getCreatedDate

public java.util.Date getCreatedDate()

Returns the blog entry created date.

Returns:

the created date

Throws:

java.lang.IllegalStateException - if the object has not yet been stored or has already been removed

getID

public int getID()

Returns the blog entry id.

Returns:

the ID

Throws:

java.lang.IllegalStateException - if the object has not yet been stored or has already been removed

getLastModified

public java.util.Date getLastModified()

Returns the blog entry last modified date.

Returns:

the last modified date, or null if this blog entry has never been modified

Throws:

java.lang.IllegalStateException - if the object has not yet been stored or has already been removed

getLastModifiedBy

public java.lang.String getLastModifiedBy()

Returns the name of the person who last modified this blog entry.

Returns:

the name of the person who last modified the blog entry, or null if this blog entry has never been modified

Throws:

java.lang.IllegalStateException - if the object has not yet been stored or has already been removed

getObjectReferences

public IObjectReference[] getObjectReferences()
                                       throws CollaborationException,
                                              java.rmi.RemoteException

Returns the object references for this blog entry. Object references for blog entries are attached documents.

Returns:

the object references for this blog entry, or an empty array if there are no object references

Throws:

CollaborationException - if the method call resulted in an error

java.lang.IllegalStateException - if the object has not yet been stored or has already been removed

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

getTitle

public java.lang.String getTitle()

Returns the blog entry title.

Returns:

the title

Throws:

java.lang.IllegalStateException - if the object has not yet been stored or has already been removed

setContent

public void setContent(java.lang.String content)

Sets the blog entry content.

Parameters:

content - content to set for this blog entry; cannot be null

Throws:

java.lang.IllegalStateException - if the object has already been removed

setTitle

public void setTitle(java.lang.String title)

Sets the blog entry title.

Parameters:

title - title to set; cannot be null

Throws:

java.lang.IllegalStateException - if the object has already been removed

store

public void store()
           throws CollaborationException,
                  java.rmi.RemoteException

Stores this blog entry. Changes to title and content will not be persisted until this method is called.

Throws:

CollaborationException - if the method call resulted in an error

java.lang.IllegalStateException - if the object has already been removed

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