|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface TargetPageConfig
Interface that allows specification of a page that should used to render the content the URL is generated for.
Method Summary | |
---|---|
java.lang.String |
getPageId()
Get the ID of the page. |
java.lang.String |
getPagePath()
Get the URL path that addresses the the page. |
java.lang.Boolean |
useCurrentPage()
Returns Boolean.TRUE if the current page should be used as target
page. |
Method Detail |
---|
java.lang.String getPagePath()
null
if the configuration does not
address a target page by path.
null
if the
configuration does not address a target page by path.java.lang.String getPageId()
ObjectID
or the
unique name of the page. This method returns null
if the
configuration does not address a target page using an ID. The
Identification
provider can be used to generate a
ObjectID
from a non-null return value of this method.
null
if the configuration
does not address a target page using an ID or unique name.java.lang.Boolean useCurrentPage()
Boolean.TRUE
if the current page should be used as target
page.
Boolean.TRUE
if the current page should be used as
target. A value of Boolean.FALSE
indicates that the
configuration parameter was set but the current page is not
targeted. A return value of null
indicates that the
configuration parameter was not set.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |