|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface IPageProvider
Represents object capable of providing a page instance. In some cases the implementation class
might now page class and page parameters without having the actual page instance. Thus it's
recommended to call getPageParameters()
instead of calling getPageInstance()
.getPageParameters(). Same goes for page class.
Method Summary | |
---|---|
void |
detach()
Detaches the page if it has been loaded. |
Class<? extends IRequestablePage> |
getPageClass()
Returns class of the page. |
Integer |
getPageId()
Returns the page id. |
IRequestablePage |
getPageInstance()
Returns page instance specified by the constructor. |
PageParameters |
getPageParameters()
Returns PageParameters of the page. |
Integer |
getRenderCount()
Returns the number of times this page has been rendered. |
boolean |
isNewPageInstance()
Returns whether calling getPageInstance() will result in creating new page instance or whether it will be an existing instance (even though it might be pulled from page store). |
Method Detail |
---|
IRequestablePage getPageInstance()
StalePageException
- if render count has been specified in constructor and the render count of page
does not match the value
{@link
- PageExpiredException} if the specified page could not have been found and the
constructor used did not provide enough information to create new page instancePageParameters getPageParameters()
PageParameters
of the page.
boolean isNewPageInstance()
true
if calling getPageInstance()
will create new page
instance, false
otherwise.Class<? extends IRequestablePage> getPageClass()
Integer getPageId()
Integer getRenderCount()
void detach()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |