|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface Event
A recorded event that occurred at some point in the wiki.
Events are identified by:
identifier
unique for each eventgroup identifier
used for all the events caused during the same actionexact date and time
when the event occurredimportance
which allows to order events in the same group, or in the same streamEvents contain:
title
body
parameters
Events are categorized into:
the application
that created them, like blog, user statuses, or the general wikieventual sub-stream
inside the application, for example a space for wiki events, or a
certain group for user statusesparticular type
of event, like adding a comment, updating an attachment, setting a new
user statusEvents target:
wiki
,space
,document
affected by the event,entity
inside the document, for example an individual attachment for
attachment events, or an individual object for comment events.Events can store some more information about the context in which they occur:
user
that caused the eventversion
of the target document at the time that the event occurreddisplay title
of the target document at the time that the event occurredrequested URL
that caused the event
Nested Class Summary | |
---|---|
static class |
Event.Importance
The importance of an event. |
Method Summary | |
---|---|
String |
getApplication()
Events can be triggered by different applications, not only the main wiki update events: user statuses, blog pingbacks, new extension added... |
String |
getBody()
A larger section of text where the event can store some data. |
Date |
getDate()
An event happens at a precise date. |
DocumentReference |
getDocument()
Document-related events target a certain document. |
String |
getDocumentTitle()
The document title is usually more important than the document name. |
String |
getDocumentVersion()
For events related to documents, this field records the version of the document at the time when the event occurred. |
String |
getGroupId()
Multiple events can correspond to the same activity, so events can be grouped under the same GroupID. |
String |
getId()
Each event has a unique ID. |
Event.Importance |
getImportance()
Different events can have a different importance. |
Map<String,String> |
getParameters()
|
EntityReference |
getRelatedEntity()
Some events may be related to a more specific entity in the target document, like an attachment or an object, or may relate to another document besides the main related document . |
SpaceReference |
getSpace()
Document-related events target a certain document, and documents belong to a space; this is the space of the target document. |
String |
getStream()
Events can happen in different contexts; for example, wiki activity events happen in different spaces, user statuses are targeted to different groups. |
String |
getTitle()
A name for the event. |
String |
getType()
Events have different types: adding a comment, updating an attachment, importing an application, etc. |
URL |
getUrl()
If an event happens in an URL-accessible location (a document), or if the event itself can be seen at a given URL, this field stores that URL. |
DocumentReference |
getUser()
Event usually occur as the result of a registered user activity. |
WikiReference |
getWiki()
In a wiki farm, each event happens in one of the wikis. |
void |
setApplication(String application)
|
void |
setBody(String body)
|
void |
setDate(Date date)
|
void |
setDocument(DocumentReference document)
|
void |
setDocumentTitle(String title)
|
void |
setDocumentVersion(String version)
|
void |
setGroupId(String id)
|
void |
setId(String id)
|
void |
setImportance(Event.Importance importance)
|
void |
setParameters(Map<String,String> parameters)
|
void |
setRelatedEntity(EntityReference entity)
|
void |
setSpace(SpaceReference space)
|
void |
setStream(String stream)
|
void |
setTitle(String title)
|
void |
setType(String type)
|
void |
setUrl(URL url)
|
void |
setUser(DocumentReference user)
|
void |
setWiki(WikiReference wiki)
|
Method Detail |
---|
String getId()
void setId(String id)
id
- the unique ID of the event to setgetId()
String getGroupId()
void setGroupId(String id)
id
- the event group IDgetGroupId()
Date getDate()
void setDate(Date date)
date
- the event dategetDate()
Event.Importance getImportance()
void setImportance(Event.Importance importance)
importance
- the importance of the eventgetImportance()
String getTitle()
void setTitle(String title)
title
- the title of the eventgetTitle()
String getBody()
void setBody(String body)
body
- the body of the eventgetBody()
String getApplication()
void setApplication(String application)
application
- the application NamegetApplication()
String getStream()
void setStream(String stream)
stream
- the stream NamegetStream()
String getType()
void setType(String type)
type
- The type of the eventgetType()
WikiReference getWiki()
void setWiki(WikiReference wiki)
wiki
- the wiki name in which the event was createdgetWiki()
SpaceReference getSpace()
void setSpace(SpaceReference space)
space
- the space in which the event was createdgetSpace()
DocumentReference getDocument()
void setDocument(DocumentReference document)
document
- the document related to the eventgetDocument()
String getDocumentVersion()
void setDocumentVersion(String version)
version
- the document version when the event occurredgetDocumentVersion()
EntityReference getRelatedEntity()
main related document
. The result of this
method depends on the actual event type.
null
void setRelatedEntity(EntityReference entity)
entity
- the eventual entity related to the eventgetRelatedEntity()
DocumentReference getUser()
void setUser(DocumentReference user)
user
- the user creating the eventgetUser()
URL getUrl()
void setUrl(URL url)
url
- the URL related to the eventgetUrl()
String getDocumentTitle()
void setDocumentTitle(String title)
title
- the title of the related document when the event occurred.getDocumentTitle()
Map<String,String> getParameters()
void setParameters(Map<String,String> parameters)
parameters
- the parameters to associate to the event.getParameters()
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |