org.wso2.carbon.registry.social.api.message
Interface MessageCollection


public interface MessageCollection

This interface represents Message Collection


Nested Class Summary
static class MessageCollection.Field
          An enumeration of field names in a message.
 
Field Summary
static String ALL
           
static String OUTBOX
           
 
Method Summary
 String getId()
          Gets the unique ID of the message collection.
 String getTitle()
          Gets the title of the message collection.
 Integer getTotal()
          Gets the total number of messages for this collection.
 Integer getUnread()
          Gets the total number of unread messages.
 Date getUpdated()
          Returns the last time this message collection was modified.
 List<Url> getUrls()
          Get the URLs related to the message collection.
 void setId(String id)
          Sets the unique ID of the message collection.
 void setTitle(String newTitle)
          Sets the title of the message message collection.
 void setTotal(Integer total)
          Sets the total number of messages for this collection
 void setUnread(Integer unread)
          Sets the total number of unread messages.
 void setUpdated(Date updated)
          Sets the updated time for this message collection.
 void setUrls(List<Url> urls)
          Set the URLs related to the message collection
 

Field Detail

OUTBOX

static final String OUTBOX
See Also:
Constant Field Values

ALL

static final String ALL
See Also:
Constant Field Values
Method Detail

getId

String getId()
Gets the unique ID of the message collection.

Returns:
the ID of the message

setId

void setId(String id)
Sets the unique ID of the message collection.

Parameters:
id - the ID value to set

getTitle

String getTitle()
Gets the title of the message collection.

Returns:
the title of the message

setTitle

void setTitle(String newTitle)
Sets the title of the message message collection.

Parameters:
newTitle - the title of the message

getTotal

Integer getTotal()
Gets the total number of messages for this collection.

Returns:
the total number of messages

setTotal

void setTotal(Integer total)
Sets the total number of messages for this collection

Parameters:
total - the total number of messages

getUnread

Integer getUnread()
Gets the total number of unread messages.

Returns:
the total number of unread messages

setUnread

void setUnread(Integer unread)
Sets the total number of unread messages.

Parameters:
unread - the number of unread messages

getUpdated

Date getUpdated()
Returns the last time this message collection was modified.

Returns:
the updated time

setUpdated

void setUpdated(Date updated)
Sets the updated time for this message collection.

Parameters:
updated -

getUrls

List<Url> getUrls()
Get the URLs related to the message collection.

Returns:
the URLs related to the message collection

setUrls

void setUrls(List<Url> urls)
Set the URLs related to the message collection

Parameters:
urls - the URLs related to the message collection


Copyright © 2012 WSO2 Inc. All Rights Reserved.