A C D E G H I M O P S T W

A

AbstractActionExecutionEvent - Class in org.xwiki.bridge.event
Base class for all action execution related events.
AbstractActionExecutionEvent() - Constructor for class org.xwiki.bridge.event.AbstractActionExecutionEvent
Match any ActionExecutedEvent.
AbstractActionExecutionEvent(String) - Constructor for class org.xwiki.bridge.event.AbstractActionExecutionEvent
Constructor initializing the action name of the event.
AbstractDocumentEvent - Class in org.xwiki.bridge.event
Base class for all document related Event.
AbstractDocumentEvent() - Constructor for class org.xwiki.bridge.event.AbstractDocumentEvent
This event will match any other document event of the same type.
AbstractDocumentEvent(DocumentReference) - Constructor for class org.xwiki.bridge.event.AbstractDocumentEvent
This event will match only events of the same type affecting the same document.
AbstractDocumentEvent(EventFilter) - Constructor for class org.xwiki.bridge.event.AbstractDocumentEvent
Constructor using a custom EventFilter.
AbstractWikiEvent - Class in org.xwiki.bridge.event
Base class for all wiki related Event.
AbstractWikiEvent() - Constructor for class org.xwiki.bridge.event.AbstractWikiEvent
This event will match any other document event of the same type.
AbstractWikiEvent(String) - Constructor for class org.xwiki.bridge.event.AbstractWikiEvent
This event will match only events of the same type affecting the same document.
AbstractWikiEvent(EventFilter) - Constructor for class org.xwiki.bridge.event.AbstractWikiEvent
Constructor using a custom EventFilter.
ActionExecutedEvent - Class in org.xwiki.bridge.event
An event triggered whenever a client request (action) is processed, like /upload/ or /view/.
ActionExecutedEvent() - Constructor for class org.xwiki.bridge.event.ActionExecutedEvent
Match any ActionExecutedEvent.
ActionExecutedEvent(String) - Constructor for class org.xwiki.bridge.event.ActionExecutedEvent
Constructor initializing the action name of the event.
ActionExecutingEvent - Class in org.xwiki.bridge.event
An event triggered whenever a client request (action) is processed, like /upload/ or /view/.
ActionExecutingEvent() - Constructor for class org.xwiki.bridge.event.ActionExecutingEvent
Match any ActionExecutingEvent.
ActionExecutingEvent(String) - Constructor for class org.xwiki.bridge.event.ActionExecutingEvent
Constructor initializing the action name of the event.
ActionExecutionEvent - Interface in org.xwiki.bridge.event
An event triggered whenever a client request (action) is processed, like /upload/ or /view/.
ApplicationReadyEvent - Class in org.xwiki.bridge.event
An event triggered when the XWiki application is ready to service requests.
ApplicationReadyEvent() - Constructor for class org.xwiki.bridge.event.ApplicationReadyEvent
 

C

cancel() - Method in class org.xwiki.bridge.event.ActionExecutingEvent
 
cancel(String) - Method in class org.xwiki.bridge.event.ActionExecutingEvent
 

D

DocumentAccessBridge - Interface in org.xwiki.bridge
Exposes methods for accessing Document data.
DocumentCreatedEvent - Class in org.xwiki.bridge.event
An event triggered after a document is created.
DocumentCreatedEvent() - Constructor for class org.xwiki.bridge.event.DocumentCreatedEvent
Constructor initializing the event filter with an AlwaysMatchingEventFilter, meaning that this event will match any other document delete event.
DocumentCreatedEvent(DocumentReference) - Constructor for class org.xwiki.bridge.event.DocumentCreatedEvent
Constructor initializing the event filter with a FixedNameEventFilter, meaning that this event will match only delete events affecting the same document.
DocumentCreatedEvent(EventFilter) - Constructor for class org.xwiki.bridge.event.DocumentCreatedEvent
Constructor using a custom EventFilter.
DocumentCreatingEvent - Class in org.xwiki.bridge.event
An event triggered before a document is created.
DocumentCreatingEvent() - Constructor for class org.xwiki.bridge.event.DocumentCreatingEvent
Constructor initializing the event filter with an AlwaysMatchingEventFilter, meaning that this event will match any other document delete event.
DocumentCreatingEvent(DocumentReference) - Constructor for class org.xwiki.bridge.event.DocumentCreatingEvent
Constructor initializing the event filter with a FixedNameEventFilter, meaning that this event will match only delete events affecting the same document.
DocumentCreatingEvent(EventFilter) - Constructor for class org.xwiki.bridge.event.DocumentCreatingEvent
Constructor using a custom EventFilter.
DocumentDeletedEvent - Class in org.xwiki.bridge.event
An event triggered after a document is deleted.
DocumentDeletedEvent() - Constructor for class org.xwiki.bridge.event.DocumentDeletedEvent
Constructor initializing the event filter with an AlwaysMatchingEventFilter, meaning that this event will match any other document delete event.
DocumentDeletedEvent(DocumentReference) - Constructor for class org.xwiki.bridge.event.DocumentDeletedEvent
Constructor initializing the event filter with a FixedNameEventFilter, meaning that this event will match only delete events affecting the same document.
DocumentDeletedEvent(EventFilter) - Constructor for class org.xwiki.bridge.event.DocumentDeletedEvent
Constructor using a custom EventFilter.
DocumentDeletingEvent - Class in org.xwiki.bridge.event
An event triggered before a document is deleted.
DocumentDeletingEvent() - Constructor for class org.xwiki.bridge.event.DocumentDeletingEvent
Constructor initializing the event filter with an AlwaysMatchingEventFilter, meaning that this event will match any other document delete event.
DocumentDeletingEvent(DocumentReference) - Constructor for class org.xwiki.bridge.event.DocumentDeletingEvent
Constructor initializing the event filter with a FixedNameEventFilter, meaning that this event will match only delete events affecting the same document.
DocumentDeletingEvent(EventFilter) - Constructor for class org.xwiki.bridge.event.DocumentDeletingEvent
Constructor using a custom EventFilter.
DocumentModelBridge - Interface in org.xwiki.bridge
Exposes methods for accessing Documents.
DocumentUpdatedEvent - Class in org.xwiki.bridge.event
An event triggered after a document is updated.
DocumentUpdatedEvent() - Constructor for class org.xwiki.bridge.event.DocumentUpdatedEvent
Constructor initializing the event filter with an AlwaysMatchingEventFilter, meaning that this event will match any other document delete event.
DocumentUpdatedEvent(DocumentReference) - Constructor for class org.xwiki.bridge.event.DocumentUpdatedEvent
Constructor initializing the event filter with a FixedNameEventFilter, meaning that this event will match only delete events affecting the same document.
DocumentUpdatedEvent(EventFilter) - Constructor for class org.xwiki.bridge.event.DocumentUpdatedEvent
Constructor using a custom EventFilter.
DocumentUpdatingEvent - Class in org.xwiki.bridge.event
An event triggered before a document is updated.
DocumentUpdatingEvent() - Constructor for class org.xwiki.bridge.event.DocumentUpdatingEvent
Constructor initializing the event filter with an AlwaysMatchingEventFilter, meaning that this event will match any other document delete event.
DocumentUpdatingEvent(DocumentReference) - Constructor for class org.xwiki.bridge.event.DocumentUpdatingEvent
Constructor initializing the event filter with a FixedNameEventFilter, meaning that this event will match only delete events affecting the same document.
DocumentUpdatingEvent(EventFilter) - Constructor for class org.xwiki.bridge.event.DocumentUpdatingEvent
Constructor using a custom EventFilter.

E

equals(Object) - Method in class org.xwiki.bridge.event.AbstractActionExecutionEvent
 
exists(DocumentReference) - Method in interface org.xwiki.bridge.DocumentAccessBridge
Check if a document exists or not in the wiki.
exists(String) - Method in interface org.xwiki.bridge.DocumentAccessBridge
Deprecated. replaced by DocumentAccessBridge.exists(DocumentReference) since 2.2.1

G

getActionName() - Method in class org.xwiki.bridge.event.AbstractActionExecutionEvent
 
getActionName() - Method in interface org.xwiki.bridge.event.ActionExecutionEvent
Gets the name of the action causing this event.
getAttachmentContent(String, String) - Method in interface org.xwiki.bridge.DocumentAccessBridge
Deprecated. use DocumentAccessBridge.getAttachmentContent(org.xwiki.model.reference.AttachmentReference) instead
getAttachmentContent(AttachmentReference) - Method in interface org.xwiki.bridge.DocumentAccessBridge
Returns the content of a document attachment.
getAttachmentReferences(DocumentReference) - Method in interface org.xwiki.bridge.DocumentAccessBridge
Retrieves all attachments in the passed document.
getAttachmentURL(String, String) - Method in interface org.xwiki.bridge.DocumentAccessBridge
Deprecated. use DocumentAccessBridge.getAttachmentURL(org.xwiki.model.reference.AttachmentReference , boolean) instead
getAttachmentURL(AttachmentReference, boolean) - Method in interface org.xwiki.bridge.DocumentAccessBridge
Retrieves the URL (either relative ie the path without the hostname and port, or the full URL) that can be used to access an attachment.
getAttachmentURL(AttachmentReference, String, boolean) - Method in interface org.xwiki.bridge.DocumentAccessBridge
Retrieves the URL (either relative ie the path without the hostname and port, or the full URL) that can be used to access an attachment.
getAttachmentURLs(DocumentReference, boolean) - Method in interface org.xwiki.bridge.DocumentAccessBridge
Deprecated. use DocumentAccessBridge.getAttachmentReferences(org.xwiki.model.reference.DocumentReference) instead
getAttachmentVersion(AttachmentReference) - Method in interface org.xwiki.bridge.DocumentAccessBridge
Returns the current version of a document attachment.
getContent() - Method in interface org.xwiki.bridge.DocumentModelBridge
Retrieves the textual content of the document.
getCurrentDocumentReference() - Method in interface org.xwiki.bridge.DocumentAccessBridge
Get the reference to the current document (found in the Context).
getCurrentUser() - Method in interface org.xwiki.bridge.DocumentAccessBridge
Deprecated. replaced by DocumentAccessBridge.getCurrentUserReference() since 4.0RC1
getCurrentUserReference() - Method in interface org.xwiki.bridge.DocumentAccessBridge
Utility method to retrieve the current user document reference.
getCurrentWiki() - Method in interface org.xwiki.bridge.DocumentAccessBridge
Deprecated. replaced by ModelContext.getCurrentEntityReference() since 2.2M1
getDefaultEncoding() - Method in interface org.xwiki.bridge.DocumentAccessBridge
 
getDocument(String) - Method in interface org.xwiki.bridge.DocumentAccessBridge
Deprecated. use DocumentAccessBridge.getDocument(org.xwiki.model.reference.DocumentReference) instead
getDocument(DocumentReference) - Method in interface org.xwiki.bridge.DocumentAccessBridge
Get the document object associated with the passed document name.
getDocumentContent(String) - Method in interface org.xwiki.bridge.DocumentAccessBridge
Deprecated. replaced by DocumentAccessBridge.getDocument(DocumentReference) and getContent() since 2.2.1
getDocumentContent(DocumentReference, String) - Method in interface org.xwiki.bridge.DocumentAccessBridge
Retrieves the textual content of the document, in the given language.
getDocumentContent(String, String) - Method in interface org.xwiki.bridge.DocumentAccessBridge
Deprecated. replaced by DocumentAccessBridge.getDocumentContent(DocumentReference, String) since 2.2.1
getDocumentContentForDefaultLanguage(DocumentReference) - Method in interface org.xwiki.bridge.DocumentAccessBridge
Retrieves the textual content of the document, in the document's default language.
getDocumentContentForDefaultLanguage(String) - Method in interface org.xwiki.bridge.DocumentAccessBridge
Deprecated. replaced by DocumentAccessBridge.getDocumentContentForDefaultLanguage(DocumentReference) since 2.2.1
getDocumentReference() - Method in interface org.xwiki.bridge.DocumentModelBridge
 
getDocumentSyntaxId(String) - Method in interface org.xwiki.bridge.DocumentAccessBridge
Deprecated. replaced by DocumentAccessBridge.getDocument(DocumentReference) and getSyntaxId() since 2.2.1
getDocumentURL(DocumentReference, String, String, String) - Method in interface org.xwiki.bridge.DocumentAccessBridge
Retrieves the internal (without the hostname) URL that can be used to access a document, using a specific action.
getDocumentURL(DocumentReference, String, String, String, boolean) - Method in interface org.xwiki.bridge.DocumentAccessBridge
Retrieves the relitive (without the hostname) or absolute (with the hostname) URL that can be used to access a document, using a specific action.
getFullName() - Method in interface org.xwiki.bridge.DocumentModelBridge
Deprecated. use getDocumentReference() instead
getIconURL(String) - Method in interface org.xwiki.bridge.SkinAccessBridge
 
getObjectNumber(DocumentReference, DocumentReference, String, String) - Method in interface org.xwiki.bridge.DocumentAccessBridge
Get the number of the first object that has a property that match the expectation.
getOriginalDocument() - Method in interface org.xwiki.bridge.DocumentModelBridge
Retrieves a copy of the document before it was changed.
getPageName() - Method in interface org.xwiki.bridge.DocumentModelBridge
Deprecated. since 2.2M1 use getDocumentReference() instead
getProperties(String, String) - Method in interface org.xwiki.bridge.DocumentAccessBridge
 
getProperty(String, String, int, String) - Method in interface org.xwiki.bridge.DocumentAccessBridge
Retrieves the value for an object property.
getProperty(String, String, String) - Method in interface org.xwiki.bridge.DocumentAccessBridge
Deprecated. since 2.2M1 use DocumentAccessBridge.getProperty(DocumentReference, DocumentReference, String) instead
getProperty(ObjectReference, String) - Method in interface org.xwiki.bridge.DocumentAccessBridge
Retrieves the value for an object property.
getProperty(ObjectPropertyReference) - Method in interface org.xwiki.bridge.DocumentAccessBridge
Retrieves the value for an object property.
getProperty(DocumentReference, DocumentReference, String) - Method in interface org.xwiki.bridge.DocumentAccessBridge
Retrieves the value for an object property, from the first object of the given class.
getProperty(DocumentReference, DocumentReference, int, String) - Method in interface org.xwiki.bridge.DocumentAccessBridge
Retrieves the value for an object property, from the Nth object of the given class.
getProperty(String, String) - Method in interface org.xwiki.bridge.DocumentAccessBridge
Retrieves the value for an object property, from the first object of any class that has a property with that name.
getPropertyType(String, String) - Method in interface org.xwiki.bridge.DocumentAccessBridge
 
getRealLanguage() - Method in interface org.xwiki.bridge.DocumentModelBridge
Retrieve the actual language of the document variant.
getReason() - Method in class org.xwiki.bridge.event.ActionExecutingEvent
 
getSkinFile(String) - Method in interface org.xwiki.bridge.SkinAccessBridge
Gets a specific file from the current skin.
getSourceWikiId() - Method in class org.xwiki.bridge.event.WikiCopiedEvent
 
getSpaceName() - Method in interface org.xwiki.bridge.DocumentModelBridge
Deprecated. since 2.2M1 use getDocumentReference() instead
getSyntax() - Method in interface org.xwiki.bridge.DocumentModelBridge
 
getSyntaxId() - Method in interface org.xwiki.bridge.DocumentModelBridge
Deprecated. since 3.0M1 use getSyntax() instead
getTargetWikiId() - Method in class org.xwiki.bridge.event.WikiCopiedEvent
 
getTitle() - Method in interface org.xwiki.bridge.DocumentModelBridge
 
getURL(String, String, String, String) - Method in interface org.xwiki.bridge.DocumentAccessBridge
Deprecated. replaced by DocumentAccessBridge.getDocumentURL(DocumentReference, String, String, String) since 2.2.1
getVersion() - Method in interface org.xwiki.bridge.DocumentModelBridge
 
getWikiId() - Method in class org.xwiki.bridge.event.AbstractWikiEvent
 
getWikiId() - Method in interface org.xwiki.bridge.event.WikiEvent
 
getWikiName() - Method in interface org.xwiki.bridge.DocumentModelBridge
Deprecated. since 2.2M1 use getDocumentReference() instead
getXDOM() - Method in interface org.xwiki.bridge.DocumentModelBridge
 

H

hashCode() - Method in class org.xwiki.bridge.event.AbstractActionExecutionEvent
 
hasProgrammingRights() - Method in interface org.xwiki.bridge.DocumentAccessBridge
 

I

isCanceled() - Method in class org.xwiki.bridge.event.ActionExecutingEvent
 
isDocumentEditable(String) - Method in interface org.xwiki.bridge.DocumentAccessBridge
Deprecated. use DocumentAccessBridge.isDocumentEditable(org.xwiki.model.reference.DocumentReference) instead
isDocumentEditable(DocumentReference) - Method in interface org.xwiki.bridge.DocumentAccessBridge
 
isDocumentViewable(DocumentReference) - Method in interface org.xwiki.bridge.DocumentAccessBridge
 
isDocumentViewable(String) - Method in interface org.xwiki.bridge.DocumentAccessBridge
Deprecated. use DocumentAccessBridge.isDocumentViewable(org.xwiki.model.reference.DocumentReference) instead
isPropertyCustomMapped(String, String) - Method in interface org.xwiki.bridge.DocumentAccessBridge
 

M

matches(Object) - Method in class org.xwiki.bridge.event.AbstractActionExecutionEvent
 
matches(Object) - Method in class org.xwiki.bridge.event.ApplicationReadyEvent
 
matches(Object) - Method in class org.xwiki.bridge.event.WikiCopiedEvent
 

O

org.xwiki.bridge - package org.xwiki.bridge
 
org.xwiki.bridge.event - package org.xwiki.bridge.event
 

P

popDocumentFromContext(Map<String, Object>) - Method in interface org.xwiki.bridge.DocumentAccessBridge
Restore values saved in a backup object in the XWiki Context and restore the current document with the same value before DocumentAccessBridge.pushDocumentInContext(Map, String) was called.
pushDocumentInContext(Map<String, Object>, String) - Method in interface org.xwiki.bridge.DocumentAccessBridge
Deprecated. use DocumentAccessBridge.pushDocumentInContext(Map, DocumentReference) instead
pushDocumentInContext(Map<String, Object>, DocumentReference) - Method in interface org.xwiki.bridge.DocumentAccessBridge
Sets the passed document as the current document in the XWiki Context and saves current values related to the current document into a backup object.

S

setAttachmentContent(AttachmentReference, byte[]) - Method in interface org.xwiki.bridge.DocumentAccessBridge
Sets the content of a document attachment.
setAttachmentContent(String, String, byte[]) - Method in interface org.xwiki.bridge.DocumentAccessBridge
Deprecated. replaced by DocumentAccessBridge.getAttachmentContent(AttachmentReference) since 2.2.1
setCurrentUser(String) - Method in interface org.xwiki.bridge.DocumentAccessBridge
Utility method to set the current user.
setDocumentContent(DocumentReference, String, String, boolean) - Method in interface org.xwiki.bridge.DocumentAccessBridge
Updates the target document with the new content provided.
setDocumentContent(String, String, String, boolean) - Method in interface org.xwiki.bridge.DocumentAccessBridge
Deprecated. replaced by DocumentAccessBridge.setDocumentContent(DocumentReference, String, String, boolean) since 2.2.1
setDocumentParentReference(DocumentReference, DocumentReference) - Method in interface org.xwiki.bridge.DocumentAccessBridge
Sets the parent document name attribute for this document.
setDocumentSyntaxId(DocumentReference, String) - Method in interface org.xwiki.bridge.DocumentAccessBridge
Changes the syntax Id of the target document to the given syntaxId.
setDocumentSyntaxId(String, String) - Method in interface org.xwiki.bridge.DocumentAccessBridge
Deprecated. replaced by DocumentAccessBridge.setDocumentSyntaxId(DocumentReference, String) since 2.2.1
setDocumentTitle(DocumentReference, String) - Method in interface org.xwiki.bridge.DocumentAccessBridge
Sets the title of this document.
setProperty(String, String, String, Object) - Method in interface org.xwiki.bridge.DocumentAccessBridge
Deprecated. use {@link DocumentAccessBridge#setProperty(DocumentReference, DocumentReference, String, Object)
setProperty(DocumentReference, DocumentReference, String, Object) - Method in interface org.xwiki.bridge.DocumentAccessBridge
Sets the given property of the first object (of the given class) attached to the document.
SkinAccessBridge - Interface in org.xwiki.bridge
Exposes methods for accessing Skin data.

T

toString() - Method in class org.xwiki.bridge.event.AbstractActionExecutionEvent
 

W

WikiCopiedEvent - Class in org.xwiki.bridge.event
An event triggered after a wiki has been copied.
WikiCopiedEvent() - Constructor for class org.xwiki.bridge.event.WikiCopiedEvent
Matches all WikiCopiedEvent events.
WikiCopiedEvent(String, String) - Constructor for class org.xwiki.bridge.event.WikiCopiedEvent
Matches events affecting the same wikis.
WikiCreatedEvent - Class in org.xwiki.bridge.event
An event triggered after a wiki has been created.
WikiCreatedEvent() - Constructor for class org.xwiki.bridge.event.WikiCreatedEvent
Constructor initializing the event filter with an AlwaysMatchingEventFilter, meaning that this event will match any other document delete event.
WikiCreatedEvent(String) - Constructor for class org.xwiki.bridge.event.WikiCreatedEvent
Constructor initializing the event filter with a FixedNameEventFilter, meaning that this event will match only events affecting the same wiki.
WikiCreatedEvent(EventFilter) - Constructor for class org.xwiki.bridge.event.WikiCreatedEvent
Constructor using a custom EventFilter.
WikiCreateFailedEvent - Class in org.xwiki.bridge.event
An event triggered after trying to create a wiki if the creation failed.
WikiCreateFailedEvent() - Constructor for class org.xwiki.bridge.event.WikiCreateFailedEvent
Matches all WikiCreateFailedEvent events.
WikiCreateFailedEvent(String) - Constructor for class org.xwiki.bridge.event.WikiCreateFailedEvent
Constructor initializing the event filter with a FixedNameEventFilter, meaning that this event will match only events affecting the same wiki.
WikiCreateFailedEvent(EventFilter) - Constructor for class org.xwiki.bridge.event.WikiCreateFailedEvent
Constructor using a custom EventFilter.
WikiCreatingEvent - Class in org.xwiki.bridge.event
An event triggered just before a wiki is about to be created.
WikiCreatingEvent() - Constructor for class org.xwiki.bridge.event.WikiCreatingEvent
Matches all WikiCreatingEvent events.
WikiCreatingEvent(String) - Constructor for class org.xwiki.bridge.event.WikiCreatingEvent
Constructor initializing the event filter with a FixedNameEventFilter, meaning that this event will match only events affecting the same wiki.
WikiCreatingEvent(EventFilter) - Constructor for class org.xwiki.bridge.event.WikiCreatingEvent
Constructor using a custom EventFilter.
WikiDeletedEvent - Class in org.xwiki.bridge.event
An event triggered after a wiki is deleted.
WikiDeletedEvent() - Constructor for class org.xwiki.bridge.event.WikiDeletedEvent
Matches all WikiDeletedEvent events.
WikiDeletedEvent(String) - Constructor for class org.xwiki.bridge.event.WikiDeletedEvent
Constructor initializing the event filter with a FixedNameEventFilter, meaning that this event will match only events affecting the same wiki.
WikiDeletedEvent(EventFilter) - Constructor for class org.xwiki.bridge.event.WikiDeletedEvent
Constructor using a custom EventFilter.
WikiEvent - Interface in org.xwiki.bridge.event
COmmon interface for all wiki related events.
WikiReadyEvent - Class in org.xwiki.bridge.event
An event triggered when a (sub)wiki is ready to service requests.
WikiReadyEvent() - Constructor for class org.xwiki.bridge.event.WikiReadyEvent
Matches all WikiReadyEvent events.
WikiReadyEvent(String) - Constructor for class org.xwiki.bridge.event.WikiReadyEvent
Constructor initializing the event filter with a FixedNameEventFilter, meaning that this event will match only events affecting the same wiki.
WikiReadyEvent(EventFilter) - Constructor for class org.xwiki.bridge.event.WikiReadyEvent
Constructor using a custom EventFilter.

A C D E G H I M O P S T W

Copyright © 2004-2012 XWiki. All Rights Reserved.