lumis.portal.page.webresource
Class AbstractPageWebResourceDataProvider

Package class diagram package AbstractPageWebResourceDataProvider
java.lang.Object
  extended by lumis.portal.page.webresource.AbstractPageWebResourceDataProvider
All Implemented Interfaces:
IPageWebResourceDataProvider
Direct Known Subclasses:
DefaultPageWebResourceDataProvider

@StableMinor(version="5.5",
             sinceVersion="5.0")
public abstract class AbstractPageWebResourceDataProvider
extends Object
implements IPageWebResourceDataProvider

An abstract implementation of IPageWebResourceDataProvider.

Since:
5.0.0

Field Summary
protected  PageWebResource pageWebResource
          The page web resource this provider is generating data for.
 
Constructor Summary
AbstractPageWebResourceDataProvider()
           
 
Method Summary
protected abstract  String getDescription()
          Returns the description for the page web resource.
protected abstract  List<String> getKeywords()
          Returns the keywords for the page web resource.
 PageWebResourceData getPageWebResourceData()
          Template method for filling up a page web resource data properties.
protected abstract  String getTitle()
          Returns the title for the page web resource.
 void init(PageWebResource pageWebResource)
          Sets pageWebResource attribute with the given pageWebResource object.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

pageWebResource

protected PageWebResource pageWebResource
The page web resource this provider is generating data for.

Since:
5.0.0
Constructor Detail

AbstractPageWebResourceDataProvider

public AbstractPageWebResourceDataProvider()
Method Detail

init

public void init(PageWebResource pageWebResource)
          throws PortalException
Sets pageWebResource attribute with the given pageWebResource object.

Specified by:
init in interface IPageWebResourceDataProvider
Parameters:
pageWebResource - the page web resource this provider will provide data for.
Throws:
PortalException
Since:
5.0.0

getPageWebResourceData

public PageWebResourceData getPageWebResourceData()
                                           throws PortalException
Template method for filling up a page web resource data properties. Calls getTitle(), getDescription() and getKeywords().

Specified by:
getPageWebResourceData in interface IPageWebResourceDataProvider
Returns:
the page web resource data.
Throws:
PortalException
Since:
5.0.0

getTitle

protected abstract String getTitle()
                            throws PortalException
Returns the title for the page web resource.

Returns:
the title. Must not be null.
Throws:
PortalException
Since:
5.0.0

getDescription

protected abstract String getDescription()
                                  throws PortalException
Returns the description for the page web resource.

Returns:
the description.
Throws:
PortalException
Since:
5.0.0

getKeywords

protected abstract List<String> getKeywords()
                                     throws PortalException
Returns the keywords for the page web resource.

Returns:
the keywords. Must not be null, but may be an empty list to indicate there are no keywords.
Throws:
PortalException
Since:
5.0.0


Lumisportal  5.5.0.091130 - Copyright © 2001-2007, Lumis. All Rights Reserved.