org.sakaiproject.news.api

Interface NewsItem

public interface NewsItem

NewsItem is the Interface for a Sakai News message.

The news message has header fields (from, date) and a body (text). Each message also has an id, unique within the channel. All fields are read only.

Method Summary

Methods

Modifier and Type	Method and Description
String	getDescription() Access the description (or body) of the NewsItem.
String	getLink() Access the URL where the complete story can be found.
String	getPubdate() Access the time when the NewsItem was updated.
Date	getPubdateInDateFormat()
String	getTitle() Access the title of the NewsItem.
void	setDescription(String description) Set the description of the NewsItem.
void	setLink(String link) Set the URL where the complete story can be found.
void	setPubdate(String pubdate) Set the time when the NewsItem was updated.
void	setTitle(String title) Set the title of the NewsItem.

Method Detail

getTitle

String getTitle()

Access the title of the NewsItem.

Returns:

The title of the NewsItem.

getDescription

String getDescription()

Access the description (or body) of the NewsItem.

Returns:

The description of the NewsItem.

getPubdate

String getPubdate()

Access the time when the NewsItem was updated.

Returns:

The time when the NewsItem was updated.

getPubdateInDateFormat

Date getPubdateInDateFormat()

getLink

String getLink()

Access the URL where the complete story can be found.

Returns:

The URL where the complete story can be found.

setTitle

void setTitle(String title)

Set the title of the NewsItem.

Parameters:

title - The title of the NewsItem.

setDescription

void setDescription(String description)

Set the description of the NewsItem.

Parameters:

description - The description of the NewsItem.

setPubdate

void setPubdate(String pubdate)

Set the time when the NewsItem was updated.

Parameters:

pubdate - The time when the NewsItem was updated.

setLink

void setLink(String link)

Set the URL where the complete story can be found.