org.apache.jetspeed.components.portletentity
Interface PortletEntityAccessComponent

public interface PortletEntityAccessComponent

PortletEntityAccessComponent

Version:

$Id: PortletEntityAccessComponent.java,v 1.8 2005/04/29 13:59:46 weaver Exp $

Author:

Scott T. Weaver

Method Summary

MutablePortletEntity	generateEntityFromFragment(ContentFragment fragment) generateEntityFromFragment
MutablePortletEntity	generateEntityFromFragment(ContentFragment fragment, String principal) generateEntityFromFragment
org.apache.pluto.om.common.ObjectID	generateEntityKey(Fragment fragment, String principal) generateEntityKey
Collection	getPortletEntities(org.apache.pluto.om.portlet.PortletDefinition portletDefinition) getPortletEntities
Collection	getPortletEntities(String portletUniqueName)
MutablePortletEntity	getPortletEntity(org.apache.pluto.om.common.ObjectID id) getPortletEntity
MutablePortletEntity	getPortletEntity(String id)
MutablePortletEntity	getPortletEntityForFragment(ContentFragment fragment) getPortletEntityForFragment
MutablePortletEntity	getPortletEntityForFragment(ContentFragment fragment, String principal) getPortletEntityForFragment
MutablePortletEntity	newPortletEntityInstance(org.apache.pluto.om.portlet.PortletDefinition portletDefinition) newPortletEntityInstance
MutablePortletEntity	newPortletEntityInstance(org.apache.pluto.om.portlet.PortletDefinition portletDefinition, String id)
void	removeFromCache(org.apache.pluto.om.entity.PortletEntity entity) removeFromCache
void	removePortletEntities(org.apache.pluto.om.portlet.PortletDefinition portletDefinition) removePortletEntities
void	removePortletEntity(org.apache.pluto.om.entity.PortletEntity portletEntity) removePortletEntity
void	storePortletEntity(org.apache.pluto.om.entity.PortletEntity portletEntity) storePortletEntity
void	storePreferenceSet(org.apache.pluto.om.common.PreferenceSet prefSet, org.apache.pluto.om.entity.PortletEntity entity)

Method Detail

getPortletEntity

public MutablePortletEntity getPortletEntity(org.apache.pluto.om.common.ObjectID id)

getPortletEntity

Parameters:

id -

Returns:

getPortletEntity

public MutablePortletEntity getPortletEntity(String id)

generateEntityFromFragment

public MutablePortletEntity generateEntityFromFragment(ContentFragment fragment,
                                                       String principal)
                                                throws PortletEntityNotGeneratedException

generateEntityFromFragment

Parameters:

fragment -

principal -

Returns:

Throws:

PortletEntityNotGeneratedException

generateEntityFromFragment

public MutablePortletEntity generateEntityFromFragment(ContentFragment fragment)
                                                throws PortletEntityNotGeneratedException

generateEntityFromFragment

Parameters:

fragment -

Returns:

Throws:

PortletEntityNotGeneratedException

generateEntityKey

public org.apache.pluto.om.common.ObjectID generateEntityKey(Fragment fragment,
                                                             String principal)

generateEntityKey

Parameters:

fragment -

principal -

Returns:

newPortletEntityInstance

public MutablePortletEntity newPortletEntityInstance(org.apache.pluto.om.portlet.PortletDefinition portletDefinition)

newPortletEntityInstance

Parameters:

portletDefinition -

Returns:

newPortletEntityInstance

public MutablePortletEntity newPortletEntityInstance(org.apache.pluto.om.portlet.PortletDefinition portletDefinition,
                                                     String id)

getPortletEntityForFragment

public MutablePortletEntity getPortletEntityForFragment(ContentFragment fragment,
                                                        String principal)
                                                 throws PortletEntityNotStoredException

getPortletEntityForFragment

Parameters:

fragment -

principal -

Returns:

Throws:

PortletEntityNotStoredException

getPortletEntityForFragment

public MutablePortletEntity getPortletEntityForFragment(ContentFragment fragment)
                                                 throws PortletEntityNotStoredException

getPortletEntityForFragment

Parameters:

fragment -

Returns:

Throws:

PortletEntityNotStoredException

removePortletEntity

public void removePortletEntity(org.apache.pluto.om.entity.PortletEntity portletEntity)
                         throws PortletEntityNotDeletedException

removePortletEntity

Parameters:

portletEntity -

Throws:

PortletEntityNotDeletedException

removeFromCache

public void removeFromCache(org.apache.pluto.om.entity.PortletEntity entity)

removeFromCache

Removes a PortletEntity from the cache.

Parameters:

entity -

storePortletEntity

public void storePortletEntity(org.apache.pluto.om.entity.PortletEntity portletEntity)
                        throws PortletEntityNotStoredException

storePortletEntity

Parameters:

portletEntity -

Throws:

PortletEntityNotStoredException

getPortletEntities

public Collection getPortletEntities(org.apache.pluto.om.portlet.PortletDefinition portletDefinition)

getPortletEntities

Parameters:

portletDefinition -

Returns:

getPortletEntities

public Collection getPortletEntities(String portletUniqueName)

removePortletEntities

public void removePortletEntities(org.apache.pluto.om.portlet.PortletDefinition portletDefinition)
                           throws PortletEntityNotDeletedException

removePortletEntities

Parameters:

portletDefinition -

Throws:

PortletEntityNotDeletedException

storePreferenceSet

public void storePreferenceSet(org.apache.pluto.om.common.PreferenceSet prefSet,
                               org.apache.pluto.om.entity.PortletEntity entity)
                        throws IOException

Throws:

IOException