org.apache.jetspeed.aggregator
Interface PortletContent

public interface PortletContent

PortletContent

Version:

$Id: PortletContent.java 554756 2007-07-09 20:33:26Z ate $

Author:

Scott T. Weaver, David S. Taylor

Method Summary

void	complete() Notify that this content is completed.
void	completeWithError() Notify that this content is complete with error
ContentCacheKey	getCacheKey() Get the cache key used to cache this content
String	getContent() Retrieve the actual content of a portlet as a string
int	getExpiration() Get the expiration setting for this content if it is cached.
String	getTitle() Get the title of the portlet, used during caching
PrintWriter	getWriter() Get a writer to the content to stream content into this object
boolean	isComplete() Has the renderer completed rendering the content?
void	setExpiration(int expiration)
void	setTitle(String title) Set the title of this portlet, used during caching

Method Detail

getContent

String getContent()

Retrieve the actual content of a portlet as a string

Returns:

isComplete

boolean isComplete()

Has the renderer completed rendering the content?

Returns:

complete

void complete()

Notify that this content is completed.

completeWithError

void completeWithError()

Notify that this content is complete with error

getWriter

PrintWriter getWriter()

Get a writer to the content to stream content into this object

Returns:

getExpiration

int getExpiration()

Get the expiration setting for this content if it is cached.

Returns:

setExpiration

void setExpiration(int expiration)

getCacheKey

ContentCacheKey getCacheKey()

Get the cache key used to cache this content

Returns:

Since:

2.1.2

getTitle

String getTitle()

Get the title of the portlet, used during caching

Returns:

setTitle

void setTitle(String title)

Set the title of this portlet, used during caching

Parameters:

title -