org.apache.wicket.pageStore
Interface IPageStore

All Known Implementing Classes:
DefaultPageStore

public interface IPageStore

Persist (read & write) Page data

See Also:
IDataStore

Method Summary
 IManageablePage convertToPage(Object page)
           
 void destroy()
          Destroy the store.
 IManageablePage getPage(String sessionId, int id)
          Restores a page from the persistent layer.
 Serializable prepareForSerialization(String sessionId, Object page)
          Process the page before the it gets serialized.
 void removePage(String sessionId, int id)
          Removes a page from the persistent layer.
 Object restoreAfterSerialization(Serializable serializable)
          This method should restore the serialized page to intermediate object that can be converted to real page instance using convertToPage(Object).
 void storePage(String sessionId, IManageablePage page)
          Stores the page to a persistent layer.
 void unbind(String sessionId)
          The pagestore should cleanup all the pages for that sessionid.
 

Method Detail

destroy

void destroy()
Destroy the store.


getPage

IManageablePage getPage(String sessionId,
                        int id)
Restores a page from the persistent layer.

Parameters:
sessionId -
id -
Returns:
The page

removePage

void removePage(String sessionId,
                int id)
Removes a page from the persistent layer.

Parameters:
sessionId - The session of the page that must be removed
id - The id of the page.

storePage

void storePage(String sessionId,
               IManageablePage page)
Stores the page to a persistent layer. The page should be stored under the id and the version number.

Parameters:
sessionId -
page -

unbind

void unbind(String sessionId)
The pagestore should cleanup all the pages for that sessionid.

Parameters:
sessionId -

prepareForSerialization

Serializable prepareForSerialization(String sessionId,
                                     Object page)
Process the page before the it gets serialized. The page can be either real page instance or object returned by restoreAfterSerialization(Serializable).

Parameters:
sessionId -
page -
Returns:
The Page itself or a SerializedContainer for that page

restoreAfterSerialization

Object restoreAfterSerialization(Serializable serializable)
This method should restore the serialized page to intermediate object that can be converted to real page instance using convertToPage(Object).

Parameters:
sessionId -
serializable -
Returns:
Page

convertToPage

IManageablePage convertToPage(Object page)
Parameters:
page -
Returns:
page


Copyright © 2004-2011 Apache Software Foundation. All Rights Reserved.