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

PortletEntity	generateEntityFromFragment(ContentFragment fragment) generateEntityFromFragment
java.lang.String	generateEntityKey(ContentFragment fragment) generateEntityKey
java.util.Collection	getPortletEntities(PortletDefinition portletDefinition) getPortletEntities
java.util.Collection	getPortletEntities(java.lang.String portletUniqueName)
PortletEntity	getPortletEntity(java.lang.String id) getPortletEntity
PortletEntity	getPortletEntityForFragment(ContentFragment fragment) getPortletEntityForFragment
boolean	isMergeSharedPreferences() All preferences were shared.
PortletEntity	newPortletEntityInstance(PortletDefinition portletDefinition) newPortletEntityInstance
PortletEntity	newPortletEntityInstance(PortletDefinition portletDefinition, java.lang.String id)
void	removeFromCache(PortletEntity entity) removeFromCache
void	removePortletEntities(PortletDefinition portletDefinition) removePortletEntities
void	removePortletEntity(PortletEntity portletEntity) removePortletEntity
void	storePortletEntity(PortletEntity portletEntity) storePortletEntity
void	updatePortletEntity(PortletEntity portletEntity, ContentFragment fragment) updatePortletEntity

Method Detail

getPortletEntity

PortletEntity getPortletEntity(java.lang.String id)

getPortletEntity

Parameters:

id -

Returns:

generateEntityFromFragment

PortletEntity generateEntityFromFragment(ContentFragment fragment)
                                         throws PortletEntityNotGeneratedException

generateEntityFromFragment

Parameters:

fragment -

Returns:

Throws:

PortletEntityNotGeneratedException

generateEntityKey

java.lang.String generateEntityKey(ContentFragment fragment)

generateEntityKey

Parameters:

fragment -

Returns:

newPortletEntityInstance

PortletEntity newPortletEntityInstance(PortletDefinition portletDefinition)

newPortletEntityInstance

Parameters:

portletDefinition -

Returns:

newPortletEntityInstance

PortletEntity newPortletEntityInstance(PortletDefinition portletDefinition,
                                       java.lang.String id)

getPortletEntityForFragment

PortletEntity getPortletEntityForFragment(ContentFragment fragment)
                                          throws PortletEntityNotStoredException

getPortletEntityForFragment

Parameters:

fragment -

Returns:

Throws:

PortletEntityNotStoredException

removePortletEntity

void removePortletEntity(PortletEntity portletEntity)
                         throws PortletEntityNotDeletedException

removePortletEntity

Parameters:

portletEntity -

Throws:

PortletEntityNotDeletedException

removeFromCache

void removeFromCache(PortletEntity entity)

removeFromCache

Removes a PortletEntity from the cache.

Parameters:

entity -

updatePortletEntity

void updatePortletEntity(PortletEntity portletEntity,
                         ContentFragment fragment)
                         throws PortletEntityNotStoredException

updatePortletEntity

Updates portlet definition associated with the portlet entity to match the fragment configuration

Parameters:

portletEntity -

fragment -

Throws:

PortletEntityNotStoredException

storePortletEntity

void storePortletEntity(PortletEntity portletEntity)
                        throws PortletEntityNotStoredException

storePortletEntity

Parameters:

portletEntity -

Throws:

PortletEntityNotStoredException

getPortletEntities

java.util.Collection getPortletEntities(PortletDefinition portletDefinition)

getPortletEntities

Parameters:

portletDefinition -

Returns:

getPortletEntities

java.util.Collection getPortletEntities(java.lang.String portletUniqueName)

removePortletEntities

void removePortletEntities(PortletDefinition portletDefinition)
                           throws PortletEntityNotDeletedException

removePortletEntities

Parameters:

portletDefinition -

Throws:

PortletEntityNotDeletedException

isMergeSharedPreferences

boolean isMergeSharedPreferences()

All preferences were shared. With JS2-449, preferences are now stored 'per user'. The username is stored in the preferences FULL_PATH To turn on mergeSharedPreferences configure this property to true in your Spring configuration. This will NOT turn off per user prefs, but instead merge with them, where user prefs override.