org.apache.jetspeed.services.persistence
Interface PortalPersistenceService

All Superinterfaces:

org.apache.turbine.services.Initable, org.apache.turbine.services.Service

All Known Implementing Classes:

JetspeedPortalPersistenceService

public interface PortalPersistenceService

extends org.apache.turbine.services.Service

Defines the interface to the Portal Persistence Service for storing and retrieving portlet instances.

Version:

$Id: PortalPersistenceService.java,v 1.3 2004/02/23 03:33:52 jford Exp $

Author:

Scott Weaver

Field Summary

static java.lang.String

SERVICE_NAME

Method Summary

PortletInstance	getInstance(Portlet portlet, Profile profile) Retrieves a PersistentPortlet instance for this portlet.
PortletInstance	getInstance(Portlet portlet, org.apache.turbine.util.RunData data) Retrieves a portlet instance from persistent storage for the given portlet.
java.util.List	getInstances(Profile profile) Retrieves a List of portlet instances for the given profile.
java.util.List	getInstances(org.apache.turbine.util.RunData data) Retrieves a List of portlet instances for the current profile.
void	store(PortletInstance instance) Store a portlet instance to permenant storage.

Methods inherited from interface org.apache.turbine.services.Service

getConfiguration, getName, getProperties, setName, setServiceBroker

Methods inherited from interface org.apache.turbine.services.Initable

getInit, init, init, setInitableBroker, shutdown

Field Detail

SERVICE_NAME

public static final java.lang.String SERVICE_NAME

See Also:

Constant Field Values

Method Detail

store

public void store(PortletInstance instance)
           throws PortalPersistenceException

Store a portlet instance to permenant storage.

Parameters:

instance - The portlet instance to be stored.

Throws:

PortalPersistenceException - if there were problems storing the PSMLDocument to persistent storage.

getInstance

public PortletInstance getInstance(Portlet portlet,
                                   org.apache.turbine.util.RunData data)

Retrieves a portlet instance from persistent storage for the given portlet.

Parameters:

portlet - The portlet to retrieve an instance for

data - Request rundata.

Returns:

PortletInstance The instance for the given portlet.

getInstance

public PortletInstance getInstance(Portlet portlet,
                                   Profile profile)

Retrieves a PersistentPortlet instance for this portlet.

Parameters:

portlet - The portlet to retrieve an instance for

profile - Retrieve instance from this profile.

Returns:

PortletInstance The instance for the given portlet.

getInstances

public java.util.List getInstances(org.apache.turbine.util.RunData data)
                            throws PortletException

Retrieves a List of portlet instances for the current profile.

Parameters:

data - Request rundata.

Returns:

List The list of all instances in current profile.

Throws:

PortletException

getInstances

public java.util.List getInstances(Profile profile)
                            throws PortletException

Retrieves a List of portlet instances for the given profile.

Parameters:

profile - Retrieve instances from this profile.

Returns:

List The list of all instances in current profile.

Throws:

PortletException