com.plumtree.remote.prc.collaboration.wiki
Interface IWikiManager

public interface IWikiManager

Contains methods for creating, retrieving, storing, and deleting wiki pages.

Method Summary

IWikiPage	createWikiPage(int projectID, java.lang.String pageName) Creates a wiki page.
IWikiPage[]	getAllWikiPages(int projectID) Returns all wiki pages for the specified projectID.
IWikiPage	getWikiPage(int projectID, int wikiPageID) Returns the wiki page matching the specified projectID and wikiPageID.
void	removeWikiPage(IWikiPage wikiPage) Removes a wiki page.

Method Detail

createWikiPage

public IWikiPage createWikiPage(int projectID,
                                java.lang.String pageName)
                         throws CollaborationException,
                                java.rmi.RemoteException

Creates a wiki page.

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.

pageName - display name of the new wiki page; cannot be null.

Returns:

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

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

getAllWikiPages

public IWikiPage[] getAllWikiPages(int projectID)
                            throws CollaborationException,
                                   java.rmi.RemoteException

Returns all wiki pages for the specified projectID.

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:

an array of IWikiPage that represent wiki pages within the specified project, or a 0-length array if there are no wiki pages in the specified project

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

getWikiPage

public IWikiPage getWikiPage(int projectID,
                             int wikiPageID)
                      throws CollaborationException,
                             java.rmi.RemoteException

Returns the wiki page matching the specified projectID and wikiPageID.

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.

wikiPageID - the ID of the wiki page; must be positive. The ID of an object can be obtained using the getID method in the object class.

Returns:

the wiki page matching the specified projectID and wikiPageID, or null if the page does not exist or the user does not have permission to view the page

Throws:

CollaborationException - if the method call resulted in an error

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

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

removeWikiPage

public void removeWikiPage(IWikiPage wikiPage)
                    throws CollaborationException,
                           java.rmi.RemoteException

Removes a wiki page.

Parameters:

wikiPage - the wikiPage 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