org.moremotion.page
Class CurrentPage

java.lang.Object
  org.moremotion.page.CurrentPage

public class CurrentPage

extends java.lang.Object

Version:

$Id: CurrentPage.java 119 2008-04-10 16:42:27Z erkan $

Constructor Summary

CurrentPage(MoreMotionRequest request, java.lang.String pageName)

Method Summary

void	flushNextPages() Saves "Pages-To-Be-Displayed-Next" list into the "nextpage" ADOM
CommandDefinition	getCommandDefinition(java.lang.String command) Returns the CommandDefinition object associated with the specified command
java.lang.String	getContextRelativeURL() Returns the Part of the current URL relative to the Context URL.
CommandDefinition	getCurrentCommandDefinition() Returns the Current CommandDefinition object associated with the specified command
java.lang.String	getEncoding() Returns the encoding of the current page
java.lang.String	getHostRelativeURL() Returns the Part of the current URL relative to the Context URL.
java.lang.String	getNextPages()
PageInfo	getPageInfo() Returns the PageInfo object attached to the current page
java.lang.String	getPageName()
java.lang.String	getPageName(boolean withVariant)
java.lang.String	getVariant() Returns the name of the variant if current page is a variant page, null otherwise.
boolean	hasCommandDefinitions() Returns true if current page has andy command definition, false otherwise.
void	insertNextPage(java.lang.String pageName) Inserts the given page name into the "Pages-To-Be-Displayed-Next" list
void	pushSelfName() Inserts this page into the "Pages-To-Be-Displayed-Next" list

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CurrentPage

public CurrentPage(MoreMotionRequest request,
                   java.lang.String pageName)
            throws PageGenerationException

Method Detail

getEncoding

public java.lang.String getEncoding()
                             throws ConfigParameterException

Returns the encoding of the current page

Throws:

ConfigParameterException

getPageName

public java.lang.String getPageName()

getPageName

public java.lang.String getPageName(boolean withVariant)
                             throws PageGenerationException

Throws:

PageGenerationException

getNextPages

public java.lang.String getNextPages()

getCurrentCommandDefinition

public CommandDefinition getCurrentCommandDefinition()
                                              throws PageGenerationException

Returns the Current CommandDefinition object associated with the specified command

Throws:

PageGenerationException

getCommandDefinition

public CommandDefinition getCommandDefinition(java.lang.String command)
                                       throws PageGenerationException

Returns the CommandDefinition object associated with the specified command

Parameters:

command - The name of the command

Throws:

PageGenerationException

hasCommandDefinitions

public boolean hasCommandDefinitions()
                              throws PageGenerationException

Returns true if current page has andy command definition, false otherwise.

Throws:

PageGenerationException

getVariant

public java.lang.String getVariant()

Returns the name of the variant if current page is a variant page, null otherwise.

getContextRelativeURL

public java.lang.String getContextRelativeURL()

Returns the Part of the current URL relative to the Context URL. i.e. if the URL is http://www.xyz.com/contextA/showlist.doms?id=12 then
showlist.doms?id=12 is returned

getHostRelativeURL

public java.lang.String getHostRelativeURL()

Returns the Part of the current URL relative to the Context URL. i.e. if the URL is http://www.xyz.com/contextA/showlist.doms?id=12 then
contextA/showlist.doms?id=12 is returned

insertNextPage

public void insertNextPage(java.lang.String pageName)

Inserts the given page name into the "Pages-To-Be-Displayed-Next" list

pushSelfName

public void pushSelfName()

Inserts this page into the "Pages-To-Be-Displayed-Next" list

flushNextPages

public void flushNextPages()

Saves "Pages-To-Be-Displayed-Next" list into the "nextpage" ADOM

getPageInfo

public PageInfo getPageInfo()
                     throws PageGenerationException

Returns the PageInfo object attached to the current page

Throws:

PageGenerationException