com.xpn.xwiki.plugin.activitystream.api
Interface ActivityEvent

All Known Implementing Classes:

ActivityEventImpl

public interface ActivityEvent

An Activity Event represents a event done by a user in a certain context.

Version:

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

Method Summary

java.lang.String	getApplication()
java.lang.String	getBody()
java.util.Date	getDate()
java.lang.String	getDisplayBody(com.xpn.xwiki.XWikiContext context)
java.lang.String	getDisplayDate(com.xpn.xwiki.XWikiContext context)
java.lang.String	getDisplayTitle(com.xpn.xwiki.XWikiContext context)
java.lang.String	getDisplayUser(com.xpn.xwiki.XWikiContext context)
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()
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	setApplication(java.lang.String application)
void	setBody(java.lang.String body)
void	setDate(java.util.Date date)
void	setEventId(java.lang.String id)
void	setPage(java.lang.String page)
void	setParam1(java.lang.String param1)
void	setParam2(java.lang.String param2)
void	setParam3(java.lang.String param3)
void	setParam4(java.lang.String param4)
void	setParam5(java.lang.String param5)
void	setParams(java.util.List<java.lang.String> params) Set all params at once.
void	setPriority(int priority)
void	setRequestId(java.lang.String id)
void	setSpace(java.lang.String space)
void	setStream(java.lang.String stream)
void	setTitle(java.lang.String title)
void	setType(java.lang.String type)
void	setUrl(java.lang.String url)
void	setUser(java.lang.String user)
void	setVersion(java.lang.String version)
void	setWiki(java.lang.String wiki)

Method Detail

getEventId

java.lang.String getEventId()

Returns:

The unique ID of the event

setEventId

void setEventId(java.lang.String id)

Parameters:

id - Unique ID of the event

See Also:

getEventId()

getRequestId

java.lang.String getRequestId()

Returns:

The request ID

setRequestId

void setRequestId(java.lang.String id)

Parameters:

id - The request ID of the event

See Also:

getRequestId()

getPriority

int getPriority()

Returns:

The priority of the event

setPriority

void setPriority(int priority)

Parameters:

priority - The priority of the event

See Also:

getPriority()

getType

java.lang.String getType()

Returns:

The type of the event

setType

void setType(java.lang.String type)

Parameters:

type - The type of the event

See Also:

getType()

getApplication

java.lang.String getApplication()

Returns:

The application name

setApplication

void setApplication(java.lang.String application)

Parameters:

application - The application Name

See Also:

getApplication()

getStream

java.lang.String getStream()

Returns:

The stream name

setStream

void setStream(java.lang.String stream)

Parameters:

stream - The stream Name

See Also:

getStream()

getDate

java.util.Date getDate()

Returns:

The stream name

setDate

void setDate(java.util.Date date)

Parameters:

date - The event date

See Also:

getDate()

getUser

java.lang.String getUser()

Returns:

The wiki name of the user creating the event

setUser

void setUser(java.lang.String user)

Parameters:

user - The wiki name of the user creating the event

See Also:

getUser()

getWiki

java.lang.String getWiki()

Returns:

The wiki name in which the event was created

setWiki

void setWiki(java.lang.String wiki)

Parameters:

wiki - The wiki name in which the event was created

See Also:

getWiki()

getSpace

java.lang.String getSpace()

Returns:

The space name in which the event was created

setSpace

void setSpace(java.lang.String space)

Parameters:

space - The space name in which the event was created

See Also:

getSpace()

getPage

java.lang.String getPage()

Returns:

The page of the event

setPage

void setPage(java.lang.String page)

Parameters:

page - The page of the event

See Also:

getPage()

getUrl

java.lang.String getUrl()

Returns:

The target url

setUrl

void setUrl(java.lang.String url)

Parameters:

url - The url of the event

See Also:

getUrl()

getTitle

java.lang.String getTitle()

Returns:

The title of the event

setTitle

void setTitle(java.lang.String title)

Parameters:

title - The title of the event

See Also:

getTitle()

getBody

java.lang.String getBody()

Returns:

The Body of the event

setBody

void setBody(java.lang.String body)

Parameters:

body - The body of the event

See Also:

getBody()

getVersion

java.lang.String getVersion()

Returns:

The document version on the event

setVersion

void setVersion(java.lang.String version)

Parameters:

version - Version on this event

See Also:

getVersion()

getParam1

java.lang.String getParam1()

Returns:

The first param of the event

setParam1

void setParam1(java.lang.String param1)

Parameters:

param1 - The first param of the event

See Also:

getParam1()

getParam2

java.lang.String getParam2()

Returns:

The second param of the event

setParam2

void setParam2(java.lang.String param2)

Parameters:

param2 - The second param of the event

See Also:

getParam2()

getParam3

java.lang.String getParam3()

Returns:

The third param of the event

setParam3

void setParam3(java.lang.String param3)

Parameters:

param3 - The third param of the event

See Also:

getParam3()

getParam4

java.lang.String getParam4()

Returns:

The fourth param of the event

setParam4

void setParam4(java.lang.String param4)

Parameters:

param4 - The fourth param of the event

See Also:

getParam4()

getParam5

java.lang.String getParam5()

Returns:

The fifth param of the event

setParam5

void setParam5(java.lang.String param5)

Parameters:

param5 - The fifth param of the event

See Also:

getParam5()

getDisplayTitle

java.lang.String getDisplayTitle(com.xpn.xwiki.XWikiContext context)

Parameters:

context - the XWiki context

Returns:

the event title in a human readable format

getDisplayBody

java.lang.String getDisplayBody(com.xpn.xwiki.XWikiContext context)

Parameters:

context - the XWiki context

Returns:

the event body in a human readable format

getDisplayDate

java.lang.String getDisplayDate(com.xpn.xwiki.XWikiContext context)

Parameters:

context - the XWiki context

Returns:

the event date in a human readable format

getDisplayUser

java.lang.String getDisplayUser(com.xpn.xwiki.XWikiContext context)

Parameters:

context - the XWiki context

Returns:

the event user in a human readable format (example: Administrator instead of XWiki.Admin)

setParams

void setParams(java.util.List<java.lang.String> params)

Set all params at once.

Parameters:

params - parameters to set