org.apache.cocoon.components.flow.apples
Interface AppleRequest

All Known Implementing Classes:

DefaultAppleRequest

public interface AppleRequest

AppleRequest defines the services an AppleController can collect from the current request.

Method Summary

Request	getCocoonRequest()
String	getSitemapParameter(String key) Finds a named parameter in the request.
String	getSitemapParameter(String key, String defaultValue) Finds a named parameter in the request using the overloaded method getSitemapParameter(String) but lets the returned value default to the second argument in case the delegation resulted into null
Set	getSitemapParameterNames()

Method Detail

getCocoonRequest

Request getCocoonRequest()

Returns:

the wrapped cocoon environment Request

getSitemapParameterNames

Set getSitemapParameterNames()

Returns:

Set of String's listing all available sitemap-parameters passed.

getSitemapParameter

String getSitemapParameter(String key)

Finds a named parameter in the request.

Parameters:

key - of parameter to lookup

Returns:

the parameter-value

getSitemapParameter

String getSitemapParameter(String key,
                           String defaultValue)

Finds a named parameter in the request using the overloaded method getSitemapParameter(String) but lets the returned value default to the second argument in case the delegation resulted into null

Parameters:

key - of parameter to lookup

defaultValue - return-value in case the lookup returned null

Returns:

the parameter-value or if that was null: the defaultValue passed.