org.xwiki.xmlrpc.model
Class XWikiExtendedId

java.lang.Object
  org.xwiki.xmlrpc.model.XWikiExtendedId

public class XWikiExtendedId
extends java.lang.Object

An extended id is a string in the form of Space.Page[?param=value&...] that is used to request some kind of objects. Typically an extended id is used for requesting a given page in a particular translation or version.

Examples:

• Main.WebHome
• Main.WebHome?language=fr
• Main.WebHome?version=3
• Main.WebHome?language=it&version=2

Version:

$Id$

Field Summary

static java.lang.String	COMMENT_ID_PARAMETER
static java.lang.String	LANGUAGE_PARAMETER
static java.lang.String	MINOR_VERSION_PARAMETER
static java.lang.String	VERSION_PARAMETER

Constructor Summary

XWikiExtendedId(java.lang.String string)

Method Summary

java.lang.String	getBasePageId()
java.lang.String	getParameter(java.lang.String key)
java.util.Set<java.lang.String>	getParameters()
void	setParameter(java.lang.String key, java.lang.String value)
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

VERSION_PARAMETER

public static final java.lang.String VERSION_PARAMETER

See Also:

Constant Field Values

MINOR_VERSION_PARAMETER

public static final java.lang.String MINOR_VERSION_PARAMETER

See Also:

Constant Field Values

LANGUAGE_PARAMETER

public static final java.lang.String LANGUAGE_PARAMETER

See Also:

Constant Field Values

COMMENT_ID_PARAMETER

public static final java.lang.String COMMENT_ID_PARAMETER

See Also:

Constant Field Values

Constructor Detail

XWikiExtendedId

public XWikiExtendedId(java.lang.String string)

Method Detail

getBasePageId

public java.lang.String getBasePageId()

getParameters

public java.util.Set<java.lang.String> getParameters()

getParameter

public java.lang.String getParameter(java.lang.String key)

setParameter

public void setParameter(java.lang.String key,
                         java.lang.String value)

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object