A C D E G H I O R S U V W X

A

addDocument(String) - Method in class com.xpn.xwiki.plugin.watchlist.WatchListPluginApi

Add the specified document to the current user's WatchList.

addDocumentForUser(String, String) - Method in class com.xpn.xwiki.plugin.watchlist.WatchListPluginApi

Allows Administrators to add the specified document in the specified user's WatchList.

addEvent(WatchListEvent) - Method in class com.xpn.xwiki.plugin.watchlist.WatchListEvent

Add another event associated to this event.

addSpace(String) - Method in class com.xpn.xwiki.plugin.watchlist.WatchListPluginApi

Add the current space to the current user's WatchList.

addSpaceForUser(String, String) - Method in class com.xpn.xwiki.plugin.watchlist.WatchListPluginApi

Allows Administrators to add the specified space to the specified user's WatchList.

addUser(String) - Method in class com.xpn.xwiki.plugin.watchlist.WatchListPluginApi

Add the specified user to the current user's WatchList.

addUserForUser(String, String) - Method in class com.xpn.xwiki.plugin.watchlist.WatchListPluginApi

Allows Administrators to add the specified user in the specified user's WatchList.

addWatchedElement(String, String, WatchListStore.ElementType, XWikiContext) - Method in class com.xpn.xwiki.plugin.watchlist.WatchListStore

Add the specified element (document or space) to the corresponding list in the user's WatchList.

addWiki(String) - Method in class com.xpn.xwiki.plugin.watchlist.WatchListPluginApi

Add the current wiki to the current user's WatchList.

addWikiForUser(String, String) - Method in class com.xpn.xwiki.plugin.watchlist.WatchListPluginApi

Allows Administrators to add the specified wiki to the specified user's WatchList.

APP_RES_PREFIX - Static variable in class com.xpn.xwiki.plugin.watchlist.WatchListPlugin

Prefix used in ApplicationResources for this plugin.

C

cleanupComponents() - Method in class com.xpn.xwiki.plugin.watchlist.WatchListJob

Clean the container context.

com.xpn.xwiki.plugin.watchlist - package com.xpn.xwiki.plugin.watchlist

compareTo(WatchListEvent) - Method in class com.xpn.xwiki.plugin.watchlist.WatchListEvent

Perform a string comparison on the prefixed fullName of the source document.

CREATE - Static variable in interface com.xpn.xwiki.plugin.watchlist.WatchListEventType

Document creation event.

createWatchListObject(String, XWikiContext) - Method in class com.xpn.xwiki.plugin.watchlist.WatchListStore

Creates a WatchList XWiki Object in the user's profile's page.

D

DEFAULT_CLASS_PARENT - Static variable in class com.xpn.xwiki.plugin.watchlist.WatchListPlugin

Default parent to use for class pages.

DEFAULT_DOC_AUTHOR - Static variable in class com.xpn.xwiki.plugin.watchlist.WatchListPlugin

Default XWiki Administrator.

DEFAULT_EMAIL_TEMPLATE - Static variable in class com.xpn.xwiki.plugin.watchlist.WatchListJob

Wiki page which contains the default watchlist email template.

DEFAULT_EMAIL_TEMPLATE - Static variable in class com.xpn.xwiki.plugin.watchlist.WatchListNotifier

Wiki page which contains the default watchlist email template.

DELETE - Static variable in interface com.xpn.xwiki.plugin.watchlist.WatchListEventType

Document delete event.

E

equals(Object) - Method in class com.xpn.xwiki.plugin.watchlist.WatchListEvent

Overriding of the default equals method.

executeJob(JobExecutionContext) - Method in class com.xpn.xwiki.plugin.watchlist.WatchListJob

Method called from the scheduler.

G

getAuthor() - Method in class com.xpn.xwiki.plugin.watchlist.WatchListEvent

getAuthors() - Method in class com.xpn.xwiki.plugin.watchlist.WatchListEvent

getDate() - Method in class com.xpn.xwiki.plugin.watchlist.WatchListEvent

getDates() - Method in class com.xpn.xwiki.plugin.watchlist.WatchListEvent

getEventNumber() - Method in class com.xpn.xwiki.plugin.watchlist.WatchListEventMatcher

getEvents() - Method in class com.xpn.xwiki.plugin.watchlist.WatchListStore

getFeed(String, int, XWikiContext) - Method in class com.xpn.xwiki.plugin.watchlist.WatchListEventFeedManager

getFeed(int) - Method in class com.xpn.xwiki.plugin.watchlist.WatchListPluginApi

getFeed(String, int) - Method in class com.xpn.xwiki.plugin.watchlist.WatchListPluginApi

getFeedManager() - Method in class com.xpn.xwiki.plugin.watchlist.WatchListPlugin

getFullName() - Method in class com.xpn.xwiki.plugin.watchlist.WatchListEvent

getHTMLDiff() - Method in class com.xpn.xwiki.plugin.watchlist.WatchListEvent

getId() - Method in class com.xpn.xwiki.plugin.watchlist.WatchListJob

getJobDocumentNames() - Method in class com.xpn.xwiki.plugin.watchlist.WatchListStore

getJobManager() - Method in class com.xpn.xwiki.plugin.watchlist.WatchListPlugin

getMatchingEvents(List<String>, List<String>, List<String>, List<String>, String, XWikiContext) - Method in class com.xpn.xwiki.plugin.watchlist.WatchListEventMatcher

Get the events matching criteria.

getName() - Method in class com.xpn.xwiki.plugin.watchlist.WatchListPlugin

getName() - Method in class com.xpn.xwiki.plugin.watchlist.WatchListStore

getNotifier() - Method in class com.xpn.xwiki.plugin.watchlist.WatchListPlugin

getPluginApi(XWikiPluginInterface, XWikiContext) - Method in class com.xpn.xwiki.plugin.watchlist.WatchListPlugin

getPrefixedFullName() - Method in class com.xpn.xwiki.plugin.watchlist.WatchListEvent

getPrefixedSpace() - Method in class com.xpn.xwiki.plugin.watchlist.WatchListEvent

getPreviousVersion() - Method in class com.xpn.xwiki.plugin.watchlist.WatchListEvent

getSpace() - Method in class com.xpn.xwiki.plugin.watchlist.WatchListEvent

getStore() - Method in class com.xpn.xwiki.plugin.watchlist.WatchListPlugin

getSubscribersForJob(String) - Method in class com.xpn.xwiki.plugin.watchlist.WatchListStore

getType() - Method in class com.xpn.xwiki.plugin.watchlist.WatchListEvent

getUrl() - Method in class com.xpn.xwiki.plugin.watchlist.WatchListEvent

getVersion() - Method in class com.xpn.xwiki.plugin.watchlist.WatchListEvent

getVersions() - Method in class com.xpn.xwiki.plugin.watchlist.WatchListEvent

getWatchedDocuments() - Method in class com.xpn.xwiki.plugin.watchlist.WatchListPluginApi

Get the documents watched by the current user.

getWatchedElements() - Method in class com.xpn.xwiki.plugin.watchlist.WatchListPluginApi

Get the elements (wikis + spaces + documents + users) watched by the current user.

getWatchedElements(String, WatchListStore.ElementType, XWikiContext) - Method in class com.xpn.xwiki.plugin.watchlist.WatchListStore

Get watched elements for the given element type and user.

getWatchedSpaces() - Method in class com.xpn.xwiki.plugin.watchlist.WatchListPluginApi

Get the spaces watched by the current user.

getWatchedUsers() - Method in class com.xpn.xwiki.plugin.watchlist.WatchListPluginApi

Get the list of users watched by the current user.

getWatchedWikis() - Method in class com.xpn.xwiki.plugin.watchlist.WatchListPluginApi

Get the list of wikis watched by the current user.

getWatchListObject(String, XWikiContext) - Method in class com.xpn.xwiki.plugin.watchlist.WatchListStore

Gets the WatchList XWiki Object from user's profile's page.

getWiki() - Method in class com.xpn.xwiki.plugin.watchlist.WatchListEvent

globalSearchDocuments(String, int, int, List<Object>, XWikiContext) - Method in class com.xpn.xwiki.plugin.watchlist.WatchListStore

Search documents on all the wikis by passing HQL where clause values as parameters.

H

hashCode() - Method in class com.xpn.xwiki.plugin.watchlist.WatchListEvent

I

ID - Static variable in class com.xpn.xwiki.plugin.watchlist.WatchListPlugin

Plugin name.

init(JobExecutionContext) - Method in class com.xpn.xwiki.plugin.watchlist.WatchListJob

Sets objects required by the Job : XWiki, XWikiContext, WatchListPlugin, etc.

init(XWikiContext) - Method in class com.xpn.xwiki.plugin.watchlist.WatchListJobManager

Create default WatchList jobs in the wiki.

init(XWikiContext) - Method in class com.xpn.xwiki.plugin.watchlist.WatchListPlugin

init(XWikiContext) - Method in class com.xpn.xwiki.plugin.watchlist.WatchListStore

Init watchlist store.

initializeComponents(XWikiContext) - Method in class com.xpn.xwiki.plugin.watchlist.WatchListJob

Initialize container context.

isComposite() - Method in class com.xpn.xwiki.plugin.watchlist.WatchListEvent

isDocInWatchedSpaces() - Method in class com.xpn.xwiki.plugin.watchlist.WatchListPluginApi

Is current document within a space watched by the current user.

isDocumentWatched() - Method in class com.xpn.xwiki.plugin.watchlist.WatchListPluginApi

Is current document watched by the current user.

isSpaceWatched() - Method in class com.xpn.xwiki.plugin.watchlist.WatchListPluginApi

Is the current space watched by the current user.

isUserWatched(String) - Method in class com.xpn.xwiki.plugin.watchlist.WatchListPluginApi

Is the given user watched by the current user.

isWatched(String, String, WatchListStore.ElementType, XWikiContext) - Method in class com.xpn.xwiki.plugin.watchlist.WatchListStore

Is the element watched by the given user.

isWikiWatched() - Method in class com.xpn.xwiki.plugin.watchlist.WatchListPluginApi

Is the current wiki watched by the current user.

O

onEvent(Event, Object, Object) - Method in class com.xpn.xwiki.plugin.watchlist.WatchListStore

R

removeDocument(String) - Method in class com.xpn.xwiki.plugin.watchlist.WatchListPluginApi

Removed the specified document from the current user's WatchList.

removeDocumentForUser(String, String) - Method in class com.xpn.xwiki.plugin.watchlist.WatchListPluginApi

Allows Adminstrators to remove the specified document from the specified user's WatchList.

removeSpace(String) - Method in class com.xpn.xwiki.plugin.watchlist.WatchListPluginApi

Remove the specified space from the current user's WatchList.

removeSpaceForUser(String, String) - Method in class com.xpn.xwiki.plugin.watchlist.WatchListPluginApi

Allows Administrators to remove the specified space from the specified user's WatchList.

removeUser(String) - Method in class com.xpn.xwiki.plugin.watchlist.WatchListPluginApi

Removed the specified user from the current user's WatchList.

removeUserForUser(String, String) - Method in class com.xpn.xwiki.plugin.watchlist.WatchListPluginApi

Allows Administrators to remove the specified user from the specified user's WatchList.

removeWatchedElement(String, String, WatchListStore.ElementType, XWikiContext) - Method in class com.xpn.xwiki.plugin.watchlist.WatchListStore

Remove the specified element (document or space) from the corresponding list in the user's WatchList.

removeWiki(String) - Method in class com.xpn.xwiki.plugin.watchlist.WatchListPluginApi

Remove the specified wiki from the current user's WatchList.

removeWikiForUser(String, String) - Method in class com.xpn.xwiki.plugin.watchlist.WatchListPluginApi

Allows Administrators to remove the specified wiki from the specified user's WatchList.

S

SCHEDULER_SPACE - Static variable in class com.xpn.xwiki.plugin.watchlist.WatchListStore

Space of the scheduler application.

sendEmailNotification(String, List<WatchListEvent>, String, Date, XWikiContext) - Method in class com.xpn.xwiki.plugin.watchlist.WatchListNotifier

Sends the email notifying the subscriber that the updatedDocuments have been changed.

SPACE_PAGE_SEP - Static variable in class com.xpn.xwiki.plugin.watchlist.WatchListStore

Character used to separated space and page in XWiki model.

U

UPDATE - Static variable in interface com.xpn.xwiki.plugin.watchlist.WatchListEventType

Document update event.

V

valueOf(String) - Static method in enum com.xpn.xwiki.plugin.watchlist.WatchListStore.ElementType

Returns the enum constant of this type with the specified name.

values() - Static method in enum com.xpn.xwiki.plugin.watchlist.WatchListStore.ElementType

Returns an array containing the constants of this enum type, in the order they're declared.

virtualInit(XWikiContext) - Method in class com.xpn.xwiki.plugin.watchlist.WatchListPlugin

virtualInit(XWikiContext) - Method in class com.xpn.xwiki.plugin.watchlist.WatchListStore

Virtual init for watchlist store.

W

WATCHLIST_ELEMENT_SEP - Static variable in class com.xpn.xwiki.plugin.watchlist.WatchListStore

Character used to separated elements in Watchlist lists (pages, spaces, etc).

WATCHLIST_JOB_CLASS - Static variable in class com.xpn.xwiki.plugin.watchlist.WatchListJobManager

WatchList Job class.

WATCHLIST_JOB_EMAIL_PROP - Static variable in class com.xpn.xwiki.plugin.watchlist.WatchListJobManager

WatchList Job email template property name.

WATCHLIST_JOB_LAST_FIRE_TIME_PROP - Static variable in class com.xpn.xwiki.plugin.watchlist.WatchListJobManager

WatchList Job last fire time property name.

WatchListEvent - Class in com.xpn.xwiki.plugin.watchlist

The class representing an event in the WatchList.

WatchListEvent(ActivityEvent, XWikiContext) - Constructor for class com.xpn.xwiki.plugin.watchlist.WatchListEvent

Constructor.

WatchListEventFeedManager - Class in com.xpn.xwiki.plugin.watchlist

Manager for watchlist events RSS feeds.

WatchListEventFeedManager(WatchListPlugin) - Constructor for class com.xpn.xwiki.plugin.watchlist.WatchListEventFeedManager

Constructor.

WatchListEventMatcher - Class in com.xpn.xwiki.plugin.watchlist

Matcher for WatchList events.

WatchListEventMatcher(Date, XWikiContext) - Constructor for class com.xpn.xwiki.plugin.watchlist.WatchListEventMatcher

Constructor.

WatchListEventType - Interface in com.xpn.xwiki.plugin.watchlist

Type of WatchList events.

WatchListJob - Class in com.xpn.xwiki.plugin.watchlist

WatchList abstract implementation of Quartz's Job.

WatchListJob() - Constructor for class com.xpn.xwiki.plugin.watchlist.WatchListJob

WatchListJobManager - Class in com.xpn.xwiki.plugin.watchlist

Manager for WatchList jobs.

WatchListJobManager() - Constructor for class com.xpn.xwiki.plugin.watchlist.WatchListJobManager

WatchListNotifier - Class in com.xpn.xwiki.plugin.watchlist

Utility class used by the watchlist plugin to send notifications to users.

WatchListNotifier() - Constructor for class com.xpn.xwiki.plugin.watchlist.WatchListNotifier

WatchListPlugin - Class in com.xpn.xwiki.plugin.watchlist

Plugin that offers WatchList features to XWiki.

WatchListPlugin(String, String, XWikiContext) - Constructor for class com.xpn.xwiki.plugin.watchlist.WatchListPlugin

WatchListPluginApi - Class in com.xpn.xwiki.plugin.watchlist

Plugin that offers WatchList features to XWiki.

WatchListPluginApi(WatchListPlugin, XWikiContext) - Constructor for class com.xpn.xwiki.plugin.watchlist.WatchListPluginApi

API constructor.

WatchListStore - Class in com.xpn.xwiki.plugin.watchlist

WatchList store class.

WatchListStore() - Constructor for class com.xpn.xwiki.plugin.watchlist.WatchListStore

WatchListStore.ElementType - Enum in com.xpn.xwiki.plugin.watchlist

List of elements that can be watched.

WIKI_SPACE_SEP - Static variable in class com.xpn.xwiki.plugin.watchlist.WatchListStore

Character used to separated wiki and space in XWiki model.

X

XWIKI_RIGHTS_CLASS_ALLOW_PROPERTY - Static variable in class com.xpn.xwiki.plugin.watchlist.WatchListJobManager

Name of the allow property in the XWiki rights class.

XWIKI_RIGHTS_CLASS_GROUPS_PROPERTY - Static variable in class com.xpn.xwiki.plugin.watchlist.WatchListJobManager

Name of the groups property in the XWiki rights class.

XWIKI_RIGHTS_CLASS_LEVELS_PROPERTY - Static variable in class com.xpn.xwiki.plugin.watchlist.WatchListJobManager

Name of the levels property in the XWiki rights class.

XWIKI_USER_CLASS - Static variable in class com.xpn.xwiki.plugin.watchlist.WatchListNotifier

XWiki User Class.

XWIKI_USER_CLASS_FIRST_NAME_PROP - Static variable in class com.xpn.xwiki.plugin.watchlist.WatchListNotifier

XWiki User Class first name property name.

XWIKI_USER_CLASS_LAST_NAME_PROP - Static variable in class com.xpn.xwiki.plugin.watchlist.WatchListNotifier

XWiki User Class last name property name.

A C D E G H I O R S U V W X