org.apache.cocoon.portal
Interface PortalService

All Known Implementing Classes:
PortalServiceImpl

public interface PortalService

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:
$Id: PortalService.java 321405 2005-10-15 18:15:44Z cziegeler $

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.
 Object removeAttribute(String key)
          Remove an attribute.
 Object 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 setTemporaryAttribute(String key, Object value)
          Set a temporary attribute.
 

Field Detail

ROLE

public static final String ROLE
The role to lookup this component.

Method Detail

getPortalName

public String getPortalName()
The name of the portal - as defined in the portal configuration.


getAttribute

public 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

public void setAttribute(String key,
                         Object value)
Set an attribute.

Parameters:
key - The key of the attribute
value - The new value

removeAttribute

public Object removeAttribute(String key)
Remove an attribute.

Parameters:
key - The key of the attribute

getAttributeNames

public Iterator getAttributeNames()
Return the names of all attributes.


getTemporaryAttribute

public 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

public void setTemporaryAttribute(String key,
                                  Object value)
Set a temporary attribute.

Parameters:
key - The key of the attribute
value - The new value

removeTemporaryAttribute

public Object removeTemporaryAttribute(String key)
Remove a temporary attribute.

Parameters:
key - The key of the attribute

getTemporaryAttributeNames

public Iterator getTemporaryAttributeNames()
Return the names of all temporary attributes.


getComponentManager

public PortalComponentManager getComponentManager()
Return the component manager for the current portal


setEntryLayout

public void setEntryLayout(String layoutKey,
                           Layout object)
FIXME this is for the full-screen function

Parameters:
layoutKey - TODO

getEntryLayout

public Layout getEntryLayout(String layoutKey)

setDefaultLayoutKey

public void setDefaultLayoutKey(String layoutKey)
Change the default layout key for most functions


getDefaultLayoutKey

public String getDefaultLayoutKey()
Get the default layout key


getSkinDescriptions

public List getSkinDescriptions()
Return all skins


getObjectModel

public Map getObjectModel()
Return the current object model.

Since:
2.1.8


Copyright ? 1999-2005 The Apache Software Foundation. All Rights Reserved.