org.xwiki.resource

Class EntityResource

java.lang.Object

org.xwiki.resource.AbstractResource

org.xwiki.resource.EntityResource

All Implemented Interfaces:

Resource

@Unstable
public class EntityResource
extends AbstractResource

Represents an XWiki Resource pointing to an Entity (Document, Space, Wiki, Object, etc).

Since:

5.3M1

Version:

$Id: 84f208663c17d29b92582a8330e878efab2f7892 $

Constructor Summary

Constructors

Constructor and Description
EntityResource(EntityReference entityReference, ActionId actionId)

Method Summary

Methods

Modifier and Type	Method and Description
EntityReference	getEntityReference()
Locale	getLocale()
String	getRevision()
void	setEntityReference(EntityReference entityReference)
void	setLocale(Locale locale)
void	setRevision(String revision)

Methods inherited from class org.xwiki.resource.AbstractResource

addParameter, getActionId, getParameters, getParameterValue, getParameterValues, getType, setActionId, setType

Methods inherited from class java.lang.Object

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

Constructor Detail

EntityResource

public EntityResource(EntityReference entityReference,
              ActionId actionId)

Parameters:

entityReference - the entity reference being wrapped

actionId - the instance representing the technical Action id (e.g. View, Download, etc)

Method Detail

getEntityReference

public EntityReference getEntityReference()

Returns:

the wrapped entity reference

setEntityReference

public void setEntityReference(EntityReference entityReference)

Parameters:

entityReference - see getEntityReference()

setLocale

public void setLocale(Locale locale)

Parameters:

locale - see getLocale()

getLocale

public Locale getLocale()

Returns:

the locale of the entity

setRevision

public void setRevision(String revision)

Parameters:

revision - see getRevision()

getRevision

public String getRevision()

Returns:

the version of the resource (eg "2.1", etc)