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


public interface IWikiPage

Contains for retrieving wiki page properties, annotations, and object references.


Method Summary
 java.lang.String getAuthor()
          Returns the wiki page author.
 IProject getContainingProject()
          Returns the project that this object belongs to.
 java.lang.String getContent()
          Returns the wiki page content.
 java.util.Date getCreatedDate()
          Returns the wiki page created date.
 java.lang.String getDisplayName()
          Returns the wiki page display name.
 int getID()
          Returns the wiki page id.
 java.util.Date getLastModified()
          Returns the wiki page last modified date.
 java.lang.String getLastModifiedBy()
          Returns the name of the person who last modified this wiki page.
 int getNumberViews()
          Returns the number of views for this wiki page.
 IObjectReference[] getObjectReferences()
          Returns the object references for this wiki page.
 int getRevision()
          Returns the wiki page revision number.
 void setContent(java.lang.String content)
          Sets the wiki page content.
 void setDisplayName(java.lang.String displayName)
          Sets the wiki page display name.
 void store()
          Stores this wiki page.
 

Method Detail

getAuthor

public java.lang.String getAuthor()
Returns the wiki page author.

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

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:
CollaborationException - if the method call resulted in an error
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 wiki page content.

Returns:
the content
Throws:
java.lang.IllegalStateException - if the object has already been removed

getCreatedDate

public java.util.Date getCreatedDate()
Returns the wiki page created date.

Returns:
the created date
Throws:
java.lang.IllegalStateException - if the object has not yet been stored or has already been removed

getDisplayName

public java.lang.String getDisplayName()
Returns the wiki page display name.

Returns:
the name
Throws:
java.lang.IllegalStateException - if the object has has already been removed

getID

public int getID()
Returns the wiki page 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 wiki page 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 wiki page.

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

getNumberViews

public int getNumberViews()
Returns the number of views for this wiki page.

Returns:
the number of times this wiki page has been viewed
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 wiki page. Object references for blog entries can be attached documents or discussions.

Returns:
the object references for this wiki page, 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

getRevision

public int getRevision()
Returns the wiki page revision number.

Returns:
the revision number
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 wiki page content.

Parameters:
content - content to set for this wiki page; cannot be null
Throws:
java.lang.IllegalStateException - if the object has already been removed

setDisplayName

public void setDisplayName(java.lang.String displayName)
Sets the wiki page display name.

Parameters:
displayName - display name to set for this wiki page; casnnot be null
Throws:
java.lang.IllegalStateException - if the object has already been removed

store

public void store()
           throws CollaborationException,
                  java.rmi.RemoteException
Stores this wiki page. Changes to display name and content will not be persisted until this method is called.

Throws:
CollaborationException - if the method call resulted in an error, or if the display name is not unique
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


For additional information on the Oracle® WebCenter Interaction Development Kit, including tutorials, blogs, code samples and more, see the Oracle Technology Network (http://www.oracle.com/technology/index.html).

Copyright ©2010 Oracle® Corporation. All Rights Reserved.