Jive Forums API (5.5.20.2-oracle) Developer Javadocs

com.jivesoftware.forum.proxy
Class PrivateMessageFolderProxy

java.lang.Object
  extended by com.jivesoftware.forum.proxy.PrivateMessageFolderProxy
All Implemented Interfaces:
PrivateMessageFolder

public class PrivateMessageFolderProxy
extends java.lang.Object
implements PrivateMessageFolder

Proxy class for PrivateMessageFolder objects.


Field Summary
 
Fields inherited from interface com.jivesoftware.forum.PrivateMessageFolder
FOLDER_DRAFTS, FOLDER_INBOX, FOLDER_SENT, FOLDER_TRASH, SORT_DATE, SORT_SENDER, SORT_SUBJECT
 
Constructor Summary
PrivateMessageFolderProxy(PrivateMessageFolder folder, AuthToken authToken)
          Creates a new PrivateMessageFolderProxy to protect the supplied message with the specified permissions.
 
Method Summary
 void deleteMessage(PrivateMessage privateMessage)
          Deletes a private message from the folder by moving it to the trash folder.
 int getID()
          Returns the ID of the folder.
 int getMessageCount()
          Returns the number of messages in the folder.
 java.util.Iterator getMessages()
          Returns all the messages in the folder sorted by date descending.
 java.util.Iterator getMessages(int startIndex, int count, int sortField, boolean sortDescending)
          Returns messages in the folder based on the params.
 java.lang.String getName()
          Returns the name of the folder.
 User getOwner()
          Returns the owner of the private message folder.
 int getUnreadMessageCount()
          Returns the number of unread messages in the folder.
 void moveMessage(PrivateMessage privateMessage, PrivateMessageFolder destinationFolder)
          Moves a private message to another folder.
 void setName(java.lang.String name)
          Sets the name of the folder.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

PrivateMessageFolderProxy

public PrivateMessageFolderProxy(PrivateMessageFolder folder,
                                 AuthToken authToken)
Creates a new PrivateMessageFolderProxy to protect the supplied message with the specified permissions.

Method Detail

getID

public int getID()
Description copied from interface: PrivateMessageFolder
Returns the ID of the folder. The folder ID may be one of the standard folders or a custom folder.

Specified by:
getID in interface PrivateMessageFolder
Returns:
the ID of the folder.

getOwner

public User getOwner()
Description copied from interface: PrivateMessageFolder
Returns the owner of the private message folder.

Specified by:
getOwner in interface PrivateMessageFolder
Returns:
the owner of the private message folder.

getName

public java.lang.String getName()
Description copied from interface: PrivateMessageFolder
Returns the name of the folder.

Specified by:
getName in interface PrivateMessageFolder
Returns:
the name of the folder.

setName

public void setName(java.lang.String name)
Description copied from interface: PrivateMessageFolder
Sets the name of the folder. This method does nothing if the folder is one of the standard folders.

Specified by:
setName in interface PrivateMessageFolder
Parameters:
name - the new name for the folder.

getMessages

public java.util.Iterator getMessages()
Description copied from interface: PrivateMessageFolder
Returns all the messages in the folder sorted by date descending.

Specified by:
getMessages in interface PrivateMessageFolder
Returns:
all messages in the folder.

getMessages

public java.util.Iterator getMessages(int startIndex,
                                      int count,
                                      int sortField,
                                      boolean sortDescending)
Description copied from interface: PrivateMessageFolder
Returns messages in the folder based on the params. Valid fields to sort on are:

getMessageCount

public int getMessageCount()
Description copied from interface: PrivateMessageFolder
Returns the number of messages in the folder.

Specified by:
getMessageCount in interface PrivateMessageFolder
Returns:
the total number of messages.

getUnreadMessageCount

public int getUnreadMessageCount()
Description copied from interface: PrivateMessageFolder
Returns the number of unread messages in the folder.

Specified by:
getUnreadMessageCount in interface PrivateMessageFolder
Returns:
the number of unread messages.

deleteMessage

public void deleteMessage(PrivateMessage privateMessage)
Description copied from interface: PrivateMessageFolder
Deletes a private message from the folder by moving it to the trash folder. Messages in the Trash folder will be routinely automatically deleted. If this is the Trash folder, this method will do nothing.

Specified by:
deleteMessage in interface PrivateMessageFolder
Parameters:
privateMessage - the private message to delete.

moveMessage

public void moveMessage(PrivateMessage privateMessage,
                        PrivateMessageFolder destinationFolder)
Description copied from interface: PrivateMessageFolder
Moves a private message to another folder.

Specified by:
moveMessage in interface PrivateMessageFolder
Parameters:
privateMessage - the message to move.
destinationFolder - the folder to move the message to.

Jive Forums Project Page

Copyright © 1999-2006 Jive Software.