org.apache.cocoon.portal
Interface PortalService

All Superinterfaces:

Component

All Known Implementing Classes:

PortalServiceImpl

public interface PortalService
extends Component

This is the central component in the portal. It holds the configuration of the portal, the current name etc. The main use of this component is to get the PortalComponentManager to get all the other portal components. This component is a singleton.

Version:

CVS $Id: PortalService.html 1304258 2012-03-23 10:09:27Z ilgrosso $

Author:

Carsten Ziegeler, Volker Schmitt

Field Summary

static String

ROLE The role to lookup this component.

Method Summary

Object	getAttribute(String key) Return the value of an attribute
Iterator	getAttributeNames() Return the names of all attributes
PortalComponentManager	getComponentManager() Return the component manager for the current portal
String	getDefaultLayoutKey() Get the default layout key
Layout	getEntryLayout(String layoutKey)
Map	getObjectModel() Return the current object model.
String	getPortalName() The name of the portal - as defined in the portal configuration.
List	getSkinDescriptions() Return all skins
Object	getTemporaryAttribute(String key) Return the value of a temporary attribute
Iterator	getTemporaryAttributeNames() Return the names of all temporary attributes
Boolean	isRenderable() Returns true if all aspects should render, false if only "static" aspects should render.
void	removeAttribute(String key) Remove an attribute
void	removeTemporaryAttribute(String key) Remove a temporary attribute
void	setAttribute(String key, Object value) Set an attribute
void	setDefaultLayoutKey(String layoutKey) Change the default layout key for most functions
void	setEntryLayout(String layoutKey, Layout object) FIXME this is for the full-screen function
void	setPortalName(String value)
void	setRenderable(Boolean renderable) Indicates whether aspects which are sensitive to rendering state should render
void	setTemporaryAttribute(String key, Object value) Set a temporary attribute

Field Detail

ROLE

static final String ROLE

The role to lookup this component.

Method Detail

getPortalName

String getPortalName()

The name of the portal - as defined in the portal configuration.

setPortalName

void setPortalName(String value)

getAttribute

Object getAttribute(String key)

Return the value of an attribute

Parameters:

key - The key of the attribute

Returns:

The value of the attribute or null.

setAttribute

void setAttribute(String key,
                  Object value)

Set an attribute

Parameters:

key - The key of the attribute

value - The new value

removeAttribute

void removeAttribute(String key)

Remove an attribute

Parameters:

key - The key of the attribute

getAttributeNames

Iterator getAttributeNames()

Return the names of all attributes

getTemporaryAttribute

Object getTemporaryAttribute(String key)

Return the value of a temporary attribute

Parameters:

key - The key of the attribute

Returns:

The value of the attribute or null.

setTemporaryAttribute

void setTemporaryAttribute(String key,
                           Object value)

Set a temporary attribute

Parameters:

key - The key of the attribute

value - The new value

removeTemporaryAttribute

void removeTemporaryAttribute(String key)

Remove a temporary attribute

Parameters:

key - The key of the attribute

getTemporaryAttributeNames

Iterator getTemporaryAttributeNames()

Return the names of all temporary attributes

getComponentManager

PortalComponentManager getComponentManager()

Return the component manager for the current portal

setEntryLayout

void setEntryLayout(String layoutKey,
                    Layout object)

FIXME this is for the full-screen function

Parameters:

layoutKey - TODO

getEntryLayout

Layout getEntryLayout(String layoutKey)

setDefaultLayoutKey

void setDefaultLayoutKey(String layoutKey)

Change the default layout key for most functions

getDefaultLayoutKey

String getDefaultLayoutKey()

Get the default layout key

getSkinDescriptions

List getSkinDescriptions()

Return all skins

getObjectModel

Map getObjectModel()

Return the current object model.

Since:

2.1.8

setRenderable

void setRenderable(Boolean renderable)

Indicates whether aspects which are sensitive to rendering state should render

Parameters:

renderable - true if all aspects should render

isRenderable

Boolean isRenderable()

Returns true if all aspects should render, false if only "static" aspects should render.