wicket.request
Class RequestParameters

java.lang.Object
  wicket.request.RequestParameters

All Implemented Interfaces:

java.io.Serializable

public class RequestParameters
extends java.lang.Object
implements java.io.Serializable

Object that abstracts common request parameters. It consists of possible optional parameters that can be translated from e.g. servlet request parameters and serves of a strongly typed variant of these that is to be created by the IRequestCycleProcessor's IRequestCodingStrategy.

Though this object can be extended and hence more parameter options can be used, anything other than in this implementation must be supported by specific IRequestCycleProcessor implementations and thus are not supported by default implementations.

Author:

Eelco Hillenius

See Also:

Serialized Form

Constructor Summary

RequestParameters()
Construct.

Method Summary

java.lang.String	getBehaviorId() Gets the component registration id of any behavior.
java.lang.String	getBookmarkablePageClass() Gets any bookmarkable page class.
java.lang.String	getComponentId() Gets any id of a non-page target component.
java.lang.String	getComponentPath() Gets the full path to a component (might be just the page)..
RequestListenerInterface	getInterface()
java.lang.String	getInterfaceName() Gets any callable interface name (e.g.
java.lang.String	getPageMapName() Gets any name of the page map.
java.util.Map	getParameters() Gets free-to-use map of non-reserved parameters.
java.lang.String	getPath() Gets path info.
java.lang.String	getResourceKey() Gets any resource key.
int	getVersionNumber() Gets any version information string.
boolean	isOnlyProcessIfPathActive() Gets the only-process-if-path-active flag
void	setBehaviorId(java.lang.String behaviorId) Sets the component registration id of any behavior.
void	setBookmarkablePageClass(java.lang.String bookmarkablePageClass) Sets any bookmarkable page class.
void	setComponentId(java.lang.String componentId) Sets any id of a non-page target component.
void	setComponentPath(java.lang.String componentPath) Sets the full path to a component (might be just the page)..
void	setInterfaceName(java.lang.String interfaceName) Sets any callable interface name (e.g.
void	setOnlyProcessIfPathActive(boolean onlyProcessIfPathActive) Sets the only-process-if-path-active flag
void	setPageMapName(java.lang.String pageMapName) Sets any name of the page map.
void	setParameters(java.util.Map parameters) Sets free-to-use map of non-reserved parameters.
void	setPath(java.lang.String pathInfo) Sets path info.
void	setResourceKey(java.lang.String resourceKey) Sets any resource key.
void	setVersionNumber(int versionNumber) Sets any version information string.
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

RequestParameters

public RequestParameters()

Construct.

Method Detail

getBookmarkablePageClass

public java.lang.String getBookmarkablePageClass()

Gets any bookmarkable page class.

Returns:

any bookmarkable page class

setBookmarkablePageClass

public void setBookmarkablePageClass(java.lang.String bookmarkablePageClass)

Sets any bookmarkable page class.

Parameters:

bookmarkablePageClass - any bookmarkable page class

getComponentId

public java.lang.String getComponentId()

Gets any id of a non-page target component.

Returns:

any id of a non-page target component

setComponentId

public void setComponentId(java.lang.String componentId)

Sets any id of a non-page target component.

Parameters:

componentId - any id of a non-page target component

getComponentPath

public java.lang.String getComponentPath()

Gets the full path to a component (might be just the page)..

Returns:

the full path to a component (might be just the page).

setComponentPath

public void setComponentPath(java.lang.String componentPath)

Sets the full path to a component (might be just the page)..

Parameters:

componentPath - the full path to a component (might be just the page).

getInterface

public RequestListenerInterface getInterface()

Returns:

The interface named by these request parameters

getInterfaceName

public java.lang.String getInterfaceName()

Gets any callable interface name (e.g. ILinkListener).

Returns:

any callable interface name (e.g. ILinkListener)

setInterfaceName

public void setInterfaceName(java.lang.String interfaceName)

Sets any callable interface name (e.g. ILinkListener).

Parameters:

interfaceName - any callable interface name (e.g. ILinkListener)

getPageMapName

public java.lang.String getPageMapName()

Gets any name of the page map.

Returns:

any name of the page map

setPageMapName

public void setPageMapName(java.lang.String pageMapName)

Sets any name of the page map.

Parameters:

pageMapName - any name of the page map

getParameters

public java.util.Map getParameters()

Gets free-to-use map of non-reserved parameters.

Returns:

free-to-use map of non-reserved parameters

setParameters

public void setParameters(java.util.Map parameters)

Sets free-to-use map of non-reserved parameters.

Parameters:

parameters - free-to-use map of non-reserved parameters

getResourceKey

public java.lang.String getResourceKey()

Gets any resource key.

Returns:

any resource key

setResourceKey

public void setResourceKey(java.lang.String resourceKey)

Sets any resource key.

Parameters:

resourceKey - any resource key

getVersionNumber

public int getVersionNumber()

Gets any version information string.

Returns:

any version information string

setVersionNumber

public void setVersionNumber(int versionNumber)

Sets any version information string.

Parameters:

versionNumber - any version information string

getPath

public java.lang.String getPath()

Gets path info.

Returns:

path info

setPath

public void setPath(java.lang.String pathInfo)

Sets path info.

Parameters:

pathInfo - path info

getBehaviorId

public java.lang.String getBehaviorId()

Gets the component registration id of any behavior.

Returns:

behaviorId the id

setBehaviorId

public void setBehaviorId(java.lang.String behaviorId)

Sets the component registration id of any behavior.

Parameters:

behaviorId - the id

isOnlyProcessIfPathActive

public boolean isOnlyProcessIfPathActive()

Gets the only-process-if-path-active flag

Returns:

the only-process-if-path-active flag

See Also:

onlyProcessIfPathActive

setOnlyProcessIfPathActive

public void setOnlyProcessIfPathActive(boolean onlyProcessIfPathActive)

Sets the only-process-if-path-active flag

Parameters:

onlyProcessIfPathActive -

See Also:

onlyProcessIfPathActive

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

See Also:

Object.toString()