org.sakaiproject.news.api

Interface NewsItemEnclosure

public interface NewsItemEnclosure

NewsItemEnclosure is the Interface for a Sakai News message enclsoure.

The news message enclsure has header fields (type, size) and a url of the actual enclosed file. All fields are read only.

Author:

Joshua Ryan joshua.ryan@asu.edu alt^i

Method Summary

Methods

Modifier and Type	Method and Description
long	getLength() Access the length in Bytes of the enclosed item.
String	getType() Access the type of the enclosure.
String	getUrl() Access the Url of the enclosed item.
void	setLength(long length) Set the length in Bytes of the enclosed item.
void	setType(String type) Set the type of the enclosure.
void	setUrl(String url) Set the url of the enclosure.

Method Detail

getUrl

String getUrl()

Access the Url of the enclosed item.

Returns:

The url of the enclosure.

getType

String getType()

Access the type of the enclosure.

Returns:

The type of the enclosed item.

getLength

long getLength()

Access the length in Bytes of the enclosed item.

Returns:

The length in Bytes of the enclosed item.

setUrl

void setUrl(String url)

Set the url of the enclosure.

Parameters:

url - The url of the enclosure.

setType

void setType(String type)

Set the type of the enclosure.

Parameters:

type - The type of the enclosure.

setLength

void setLength(long length)

Set the length in Bytes of the enclosed item.

Parameters:

length - The length in Bytes of the enclosed item.