com.xpn.xwiki.plugin.activitystream.plugin
Class ActivityEvent

java.lang.Object
  com.xpn.xwiki.api.Api
      com.xpn.xwiki.plugin.activitystream.plugin.ActivityEvent

public class ActivityEvent
extends com.xpn.xwiki.api.Api

Api wrapper for a ActivityEvent to be exposed from velocity.

Version:

$Id: ActivityEvent.java 24078 2009-09-27 02:37:41Z sdumitriu $

Field Summary

protected ActivityEvent

event Wrapped event.

Fields inherited from class com.xpn.xwiki.api.Api

context

Constructor Summary

ActivityEvent(ActivityEvent event, com.xpn.xwiki.XWikiContext context)
Constructor.

Method Summary

java.lang.String	getApplication()
java.lang.String	getBody()
java.util.Date	getDate()
java.lang.String	getDisplayBody()
java.lang.String	getDisplayDate()
java.lang.String	getDisplayTitle()
java.lang.String	getDisplayUser()
protected ActivityEvent	getEvent()
java.lang.String	getEventId()
java.lang.String	getPage()
java.lang.String	getParam1()
java.lang.String	getParam2()
java.lang.String	getParam3()
java.lang.String	getParam4()
java.lang.String	getParam5()
int	getPriority()
ActivityEvent	getProtectedEvent()
java.lang.String	getRequestId()
java.lang.String	getSpace()
java.lang.String	getStream()
java.lang.String	getTitle()
java.lang.String	getType()
java.lang.String	getUrl()
java.lang.String	getUser()
java.lang.String	getVersion()
java.lang.String	getWiki()
void	setBody(java.lang.String body) Allows to modify the body of an event This might be useful to control the display or RSS feeds.
void	setTitle(java.lang.String title) Allows to modify the title of an event This might be useful to control the display or RSS feeds.

Methods inherited from class com.xpn.xwiki.api.Api

checkProgrammingRights, convert, convert, getXWikiContext, hasAccessLevel, hasAdminRights, hasProgrammingRights

Methods inherited from class java.lang.Object

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

Field Detail

event

protected ActivityEvent event

Wrapped event.

Constructor Detail

ActivityEvent

public ActivityEvent(ActivityEvent event,
                     com.xpn.xwiki.XWikiContext context)

Constructor.

Parameters:

event - event to wrap

context - the XWiki context

Method Detail

getEventId

public java.lang.String getEventId()

Returns:

The unique ID of the event

getRequestId

public java.lang.String getRequestId()

Returns:

The request ID

getPriority

public int getPriority()

Returns:

The priority of the event

getType

public java.lang.String getType()

Returns:

The type of the event

getApplication

public java.lang.String getApplication()

Returns:

The application name

getStream

public java.lang.String getStream()

Returns:

The stream name

getDate

public java.util.Date getDate()

Returns:

The stream name

getUser

public java.lang.String getUser()

Returns:

The wiki name of the user creating the event

getWiki

public java.lang.String getWiki()

Returns:

The wiki name in which the event was created

getSpace

public java.lang.String getSpace()

Returns:

The space name in which the event was created

getPage

public java.lang.String getPage()

Returns:

The page of the event

getUrl

public java.lang.String getUrl()

Returns:

The target url

getTitle

public java.lang.String getTitle()

Returns:

The title of the event

getBody

public java.lang.String getBody()

Returns:

The Body of the event

setTitle

public void setTitle(java.lang.String title)

Allows to modify the title of an event This might be useful to control the display or RSS feeds.

Parameters:

title - title to set

setBody

public void setBody(java.lang.String body)

Allows to modify the body of an event This might be useful to control the display or RSS feeds.

Parameters:

body - body to set

getVersion

public java.lang.String getVersion()

Returns:

The document version on the event

getParam1

public java.lang.String getParam1()

Returns:

The first param of the event

getParam2

public java.lang.String getParam2()

Returns:

The second param of the event

getParam3

public java.lang.String getParam3()

Returns:

The third param of the event

getParam4

public java.lang.String getParam4()

Returns:

The fourth param of the event

getParam5

public java.lang.String getParam5()

Returns:

The fifth param of the event

getDisplayTitle

public java.lang.String getDisplayTitle()

Returns:

the event in displayable format.

getDisplayBody

public java.lang.String getDisplayBody()

Returns:

the event body in displayable format

getDisplayDate

public java.lang.String getDisplayDate()

Returns:

the event date in displayable format

getDisplayUser

public java.lang.String getDisplayUser()

Returns:

the event user in displayable format

getProtectedEvent

public ActivityEvent getProtectedEvent()

Returns:

the wrapped event

getEvent

protected ActivityEvent getEvent()

Returns:

the wrapped event