com.endeca.soleng.urlformatter

Interface UrlParam

All Superinterfaces:

Cloneable

All Known Subinterfaces:

AggrERecUrlParam, ERecUrlParam, NavStateUrlParam

public interface UrlParam
extends Cloneable

An interface used internally by an UrlState to store a single URL parameter. This is an internal interface used by an UrlState. You shouldn't need to use this interface unless you are implementing a custom UrlFormatter.

See Also:

UrlFormatter.createUrlParam(UrlState,String,String)

Method Summary

Methods

Modifier and Type	Method and Description
Object	clone() Creates a cloned instance of the parameter.
String	getEncodedKey() The encoded key.
String	getEncodedValue() The encoded string value.
String	getKey() The parameter key.
String	getValue() The parameter string value.

Method Detail

getKey

String getKey()

The parameter key.

Returns:

the parameter key.

getValue

String getValue()

The parameter string value.

Returns:

the parameter value.

getEncodedKey

String getEncodedKey()
                     throws UrlFormatException

The encoded key.

Returns:

the encoded key.

Throws:

UrlFormatException - if the key cannot be encoded.

getEncodedValue

String getEncodedValue()
                       throws UrlFormatException

The encoded string value.

Returns:

the encoded value.

Throws:

UrlFormatException - if the value cannot be encoded.

clone

Object clone()

Creates a cloned instance of the parameter.

Returns:

a cloned URL parameter.