org.apache.jetspeed.aggregator
Interface PortletContent

All Known Implementing Classes:
PortletContentImpl, PortletContentImpl

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
 java.lang.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.
 java.lang.String getTitle()
          Get the title of the portlet, used during caching
 java.io.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(java.lang.String title)
          Set the title of this portlet, used during caching
 

Method Detail

getContent

java.lang.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

java.io.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

java.lang.String getTitle()
Get the title of the portlet, used during caching

Returns:

setTitle

void setTitle(java.lang.String title)
Set the title of this portlet, used during caching

Parameters:
title -


Copyright © 1999-2009 Apache Software Foundation. All Rights Reserved.