de.innovationgate.webgate.api

Interface WGPortletItemStorage

public interface WGPortletItemStorage

A service to store items for WGTransientPortlets

Method Summary

Methods

Modifier and Type	Method and Description
java.util.List<java.lang.String>	getItemNames(WGTransientPortlet portlet) Returns all names of items stored for this portlet
java.lang.Object	getItemValue(WGTransientPortlet portlet, java.lang.String name) Returns the value of a stored item for this portlet
boolean	hasItem(WGTransientPortlet portlet, java.lang.String name) Returns if an item of the given name is stored for this portlet
void	prepareNewProfile(WGUserProfile profile) Callback after a new user profile is created
void	preSaveProfile(WGUserProfile profile) Callback before the user profile is saved
void	pushData(WGPortletItemStorage targetStorage) Pushes all persistent item storage data from all portlets to the given target storage
void	receiveData(PortletItemStorageData p) Receives the item storage data for a single portlet and stores it to its own storage
void	removeItem(WGTransientPortlet portlet, java.lang.String name) Removes a stored item from this portlet
void	setItemValue(WGTransientPortlet portlet, java.lang.String name, java.lang.Object value) Sets stored item for this portlet

Method Detail

preSaveProfile

void preSaveProfile(WGUserProfile profile)
                    throws WGAPIException

Callback before the user profile is saved

Parameters:

profile -

Throws:

WGAPIException

getItemNames

java.util.List<java.lang.String> getItemNames(WGTransientPortlet portlet)
                                              throws WGAPIException

Returns all names of items stored for this portlet

Parameters:

portlet -

Throws:

WGAPIException

hasItem

boolean hasItem(WGTransientPortlet portlet,
              java.lang.String name)
                throws WGAPIException

Returns if an item of the given name is stored for this portlet

Parameters:

portlet -

name -

Throws:

WGAPIException

getItemValue

java.lang.Object getItemValue(WGTransientPortlet portlet,
                            java.lang.String name)
                              throws WGAPIException

Returns the value of a stored item for this portlet

Parameters:

portlet -

name -

Throws:

WGAPIException

setItemValue

void setItemValue(WGTransientPortlet portlet,
                java.lang.String name,
                java.lang.Object value)
                  throws WGAPIException

Sets stored item for this portlet

Parameters:

portlet -

name -

value -

Throws:

WGAPIException

removeItem

void removeItem(WGTransientPortlet portlet,
              java.lang.String name)
                throws WGAPIException

Removes a stored item from this portlet

Parameters:

portlet -

name -

Throws:

WGAPIException

prepareNewProfile

void prepareNewProfile(WGUserProfile profile)
                       throws WGAPIException

Callback after a new user profile is created

Parameters:

profile -

Throws:

WGAPIException

pushData

void pushData(WGPortletItemStorage targetStorage)
              throws WGAPIException

Pushes all persistent item storage data from all portlets to the given target storage

Parameters:

targetStorage -

Throws:

WGAPIException

receiveData

void receiveData(PortletItemStorageData p)
                 throws WGAPIException

Receives the item storage data for a single portlet and stores it to its own storage

Parameters:

p -

Throws:

WGAPIException