| org.apache.cocoon.portal.PortalService
All known Subclasses: org.apache.cocoon.portal.impl.PortalServiceImpl,
| PortalService | | public interface PortalService extends Component(Code) | | 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.
author:
Carsten Ziegeler
author:
Volker Schmitt
version:
CVS $Id: PortalService.java 433543 2006-08-22 06:22:54Z crossley $ |
| Field Summary | |
| String | ROLE
The role to lookup this component. |
| getAttribute | | Object getAttribute(String key)(Code) | | Return the value of an attribute
Parameters:
key - The key of the attribute The value of the attribute or null. |
| getAttributeNames | | Iterator getAttributeNames()(Code) | | Return the names of all attributes
|
| getDefaultLayoutKey | | String getDefaultLayoutKey()(Code) | | Get the default layout key
|
| getObjectModel | | Map getObjectModel()(Code) | | Return the current object model.
since:
2.1.8 |
| getPortalName | | String getPortalName()(Code) | | The name of the portal - as defined in the portal configuration.
|
| getSkinDescriptions | | List getSkinDescriptions()(Code) | | Return all skins
|
| getTemporaryAttribute | | Object getTemporaryAttribute(String key)(Code) | | Return the value of a temporary attribute
Parameters:
key - The key of the attribute The value of the attribute or null. |
| getTemporaryAttributeNames | | Iterator getTemporaryAttributeNames()(Code) | | Return the names of all temporary attributes
|
| isRenderable | | Boolean isRenderable()(Code) | | Returns true if all aspects should render, false if only "static" aspects should
render.
|
| removeAttribute | | void removeAttribute(String key)(Code) | | Remove an attribute
Parameters:
key - The key of the attribute |
| removeTemporaryAttribute | | void removeTemporaryAttribute(String key)(Code) | | Remove a temporary attribute
Parameters:
key - The key of the attribute |
| setAttribute | | void setAttribute(String key, Object value)(Code) | | Set an attribute
Parameters:
key - The key of the attribute
Parameters:
value - The new value |
| setDefaultLayoutKey | | void setDefaultLayoutKey(String layoutKey)(Code) | | Change the default layout key for most functions
|
| setEntryLayout | | void setEntryLayout(String layoutKey, Layout object)(Code) | | FIXME this is for the full-screen function
Parameters:
layoutKey - TODO |
| setRenderable | | void setRenderable(Boolean renderable)(Code) | | Indicates whether aspects which are sensitive to rendering state should render
Parameters:
renderable - true if all aspects should render |
| setTemporaryAttribute | | void setTemporaryAttribute(String key, Object value)(Code) | | Set a temporary attribute
Parameters:
key - The key of the attribute
Parameters:
value - The new value |
|
|