Index (XWiki Platform - Bridge 14.10.7 API)

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

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.
AbstractDocumentRestoreEvent - Class in org.xwiki.bridge.event: Base class for event related to the restoration of a deleted document.
AbstractDocumentRestoreEvent() - Constructor for class org.xwiki.bridge.event.AbstractDocumentRestoreEvent
AbstractDocumentRestoreEvent(DocumentReference) - Constructor for class org.xwiki.bridge.event.AbstractDocumentRestoreEvent
AbstractDocumentRestoreEvent(DocumentReference, long) - Constructor for class org.xwiki.bridge.event.AbstractDocumentRestoreEvent
AbstractDocumentRestoreEvent(EventFilter) - Constructor for class org.xwiki.bridge.event.AbstractDocumentRestoreEvent: 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
copyAuthors(DocumentAuthors) - Method in interface org.xwiki.model.document.DocumentAuthors: Copy all authors from the given document authors.

D

deleteId - Variable in class org.xwiki.bridge.event.AbstractDocumentRestoreEvent
DocumentAccessBridge - Interface in org.xwiki.bridge: Exposes methods for accessing Document data.
DocumentAuthors - Interface in org.xwiki.model.document: Define the different authors information that are related to an XWikiDocument.
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.
DocumentRestoredEvent - Class in org.xwiki.bridge.event: An event triggered after a deleted document is restored.
DocumentRestoredEvent() - Constructor for class org.xwiki.bridge.event.DocumentRestoredEvent: Constructor initializing the event filter with an AlwaysMatchingEventFilter, meaning that this event will match any other document delete event.
DocumentRestoredEvent(DocumentReference) - Constructor for class org.xwiki.bridge.event.DocumentRestoredEvent: Constructor initializing the event filter with a FixedNameEventFilter, meaning that this event will match only delete events affecting the same document.
DocumentRestoredEvent(DocumentReference, long) - Constructor for class org.xwiki.bridge.event.DocumentRestoredEvent
DocumentRestoredEvent(EventFilter) - Constructor for class org.xwiki.bridge.event.DocumentRestoredEvent: Constructor using a custom EventFilter.
DocumentRestoringEvent - Class in org.xwiki.bridge.event: An event triggered before a deleted document is restored.
DocumentRestoringEvent() - Constructor for class org.xwiki.bridge.event.DocumentRestoringEvent: Constructor initializing the event filter with an AlwaysMatchingEventFilter, meaning that this event will match any other document delete event.
DocumentRestoringEvent(DocumentReference) - Constructor for class org.xwiki.bridge.event.DocumentRestoringEvent: Constructor initializing the event filter with a FixedNameEventFilter, meaning that this event will match only delete events affecting the same document.
DocumentRestoringEvent(DocumentReference, long) - Constructor for class org.xwiki.bridge.event.DocumentRestoringEvent
DocumentRestoringEvent(EventFilter) - Constructor for class org.xwiki.bridge.event.DocumentRestoringEvent: Constructor using a custom EventFilter.
DocumentRolledBackEvent - Class in org.xwiki.bridge.event: An event triggered after a document is rolled back to a previous revision.
DocumentRolledBackEvent() - Constructor for class org.xwiki.bridge.event.DocumentRolledBackEvent: Matches all DocumentRolledBackEvent events.
DocumentRolledBackEvent(DocumentReference) - Constructor for class org.xwiki.bridge.event.DocumentRolledBackEvent: Matches DocumentRolledBackEvent events that target the specified document.
DocumentRolledBackEvent(DocumentReference, String) - Constructor for class org.xwiki.bridge.event.DocumentRolledBackEvent: Matches DocumentRolledBackEvent events that target the specified document and revision.
DocumentRolledBackEvent(EventFilter) - Constructor for class org.xwiki.bridge.event.DocumentRolledBackEvent: Constructor using a custom EventFilter.
DocumentRollingBackEvent - Class in org.xwiki.bridge.event: An event triggered before a document is rolled back to a previous revision.
DocumentRollingBackEvent() - Constructor for class org.xwiki.bridge.event.DocumentRollingBackEvent: Matches all DocumentRollingBackEvent events.
DocumentRollingBackEvent(DocumentReference) - Constructor for class org.xwiki.bridge.event.DocumentRollingBackEvent: Matches DocumentRollingBackEvent events that target the specified document.
DocumentRollingBackEvent(DocumentReference, String) - Constructor for class org.xwiki.bridge.event.DocumentRollingBackEvent: Matches DocumentRollingBackEvent events that target the specified document and revision.
DocumentRollingBackEvent(EventFilter) - Constructor for class org.xwiki.bridge.event.DocumentRollingBackEvent: Constructor using a custom EventFilter.
DocumentsDeletingEvent - Class in org.xwiki.bridge.event: An event triggered before a list of documents is deleted.
DocumentsDeletingEvent() - Constructor for class org.xwiki.bridge.event.DocumentsDeletingEvent
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.
DocumentVersionRangeDeletedEvent - Class in org.xwiki.bridge.event: An event triggered after one or several versions of a document history have been deleted.
DocumentVersionRangeDeletedEvent() - Constructor for class org.xwiki.bridge.event.DocumentVersionRangeDeletedEvent: Matches all DocumentVersionRangeDeletedEvent events.
DocumentVersionRangeDeletedEvent(DocumentReference, String, String) - Constructor for class org.xwiki.bridge.event.DocumentVersionRangeDeletedEvent
DocumentVersionRangeDeletedEvent(EventFilter) - Constructor for class org.xwiki.bridge.event.DocumentVersionRangeDeletedEvent: Constructor using a custom EventFilter to match the document reference.
DocumentVersionRangeDeletingEvent - Class in org.xwiki.bridge.event: An event triggered before one or several versions of a document history have been deleted.
DocumentVersionRangeDeletingEvent() - Constructor for class org.xwiki.bridge.event.DocumentVersionRangeDeletingEvent: Matches all DocumentVersionRangeDeletingEvent events.
DocumentVersionRangeDeletingEvent(DocumentReference, String, String) - Constructor for class org.xwiki.bridge.event.DocumentVersionRangeDeletingEvent
DocumentVersionRangeDeletingEvent(EventFilter) - Constructor for class org.xwiki.bridge.event.DocumentVersionRangeDeletingEvent: Constructor using a custom EventFilter to match the document reference.

E

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

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: Deprecated.
use DocumentAccessBridge.getAttachmentContent(EntityReference) instead
getAttachmentContent(EntityReference) - 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.
getAuthors() - Method in interface org.xwiki.bridge.DocumentModelBridge
getContent() - Method in interface org.xwiki.bridge.DocumentModelBridge: Retrieves the textual content of the document.
getContentAuthor() - Method in interface org.xwiki.model.document.DocumentAuthors: The last user that has changed the document's content (ie not object, attachments).
getContentAuthorReference() - Method in interface org.xwiki.bridge.DocumentModelBridge: Deprecated.
since 14.0RC1 rely on DocumentModelBridge.getAuthors().
getCreationDate() - Method in interface org.xwiki.bridge.DocumentModelBridge
getCreator() - Method in interface org.xwiki.model.document.DocumentAuthors: The creator of the document is the first author of the document when it has been created.
getCurrentAuthorReference() - Method in interface org.xwiki.bridge.DocumentAccessBridge
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
getDate() - Method in interface org.xwiki.bridge.DocumentModelBridge
getDefaultEncoding() - Method in interface org.xwiki.bridge.DocumentAccessBridge
getDeleteId() - Method in class org.xwiki.bridge.event.AbstractDocumentRestoreEvent
getDocument(String) - Method in interface org.xwiki.bridge.DocumentAccessBridge: Deprecated.
use DocumentAccessBridge.getTranslatedDocumentInstance(DocumentReference) instead
getDocument(DocumentReference) - Method in interface org.xwiki.bridge.DocumentAccessBridge: Deprecated.
deprecated since 10.2RC1, use DocumentAccessBridge.getTranslatedDocumentInstance(DocumentReference) instead
getDocumentContent(String) - Method in interface org.xwiki.bridge.DocumentAccessBridge: Deprecated.
replaced by DocumentAccessBridge.getDocument(DocumentReference) and DocumentModelBridge.getContent() since 2.2.1
getDocumentContent(String, String) - Method in interface org.xwiki.bridge.DocumentAccessBridge: Deprecated.
replaced by DocumentAccessBridge.getDocumentContent(DocumentReference, String) 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.
getDocumentContentForDefaultLanguage(String) - Method in interface org.xwiki.bridge.DocumentAccessBridge: Deprecated.
replaced by DocumentAccessBridge.getDocumentContentForDefaultLanguage(DocumentReference) 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.
getDocumentInstance(DocumentReference) - Method in interface org.xwiki.bridge.DocumentAccessBridge: Get the document object associated with the passed document.
getDocumentInstance(EntityReference) - Method in interface org.xwiki.bridge.DocumentAccessBridge: Get the document object associated with the passed reference.
getDocumentReference() - Method in interface org.xwiki.bridge.DocumentModelBridge
getDocumentReference() - Method in class org.xwiki.bridge.event.AbstractDocumentEvent
getDocumentReference(EntityReference) - Method in interface org.xwiki.bridge.DocumentAccessBridge: Find the document reference corresponding to the entity reference based on what exist in the database (page reference can means two different documents for example).
getDocumentSyntaxId(String) - Method in interface org.xwiki.bridge.DocumentAccessBridge: Deprecated.
replaced by DocumentAccessBridge.getDocument(DocumentReference) and DocumentModelBridge.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 relative (without the hostname) or absolute (with the hostname) URL that can be used to access a document, using a specific action.
getDocumentURL(EntityReference, 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(EntityReference, String, String, String, boolean) - Method in interface org.xwiki.bridge.DocumentAccessBridge: Retrieves the relative (without the hostname) or absolute (with the hostname) URL that can be used to access a document, using a specific action.
getEffectiveMetadataAuthor() - Method in interface org.xwiki.model.document.DocumentAuthors: The effective metadata author is the author responsible of any change but the content: e.g.
getFrom() - Method in class org.xwiki.bridge.event.DocumentVersionRangeDeletedEvent
getFrom() - Method in class org.xwiki.bridge.event.DocumentVersionRangeDeletingEvent
getFullName() - Method in interface org.xwiki.bridge.DocumentModelBridge: Deprecated.
use DocumentModelBridge.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.
getOriginalMetadataAuthor() - Method in interface org.xwiki.model.document.DocumentAuthors: The original metadata author is the author who have triggered a save on the document, but who does not hold responsibility for those changes in terms of rights.
getPageName() - Method in interface org.xwiki.bridge.DocumentModelBridge: Deprecated.
since 2.2M1 use DocumentModelBridge.getDocumentReference() instead
getProperties(String, String) - Method in interface org.xwiki.bridge.DocumentAccessBridge
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.
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(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(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(ObjectPropertyReference) - Method in interface org.xwiki.bridge.DocumentAccessBridge: Retrieves the value for an object property.
getProperty(ObjectReference, String) - Method in interface org.xwiki.bridge.DocumentAccessBridge: Retrieves the value for an object property.
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
getRevision() - Method in class org.xwiki.bridge.event.DocumentRolledBackEvent
getRevision() - Method in class org.xwiki.bridge.event.DocumentRollingBackEvent
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 DocumentModelBridge.getDocumentReference() instead
getSyntax() - Method in interface org.xwiki.bridge.DocumentModelBridge
getSyntaxId() - Method in interface org.xwiki.bridge.DocumentModelBridge: Deprecated.
since 3.0M1 use DocumentModelBridge.getSyntax() instead
getTargetWikiId() - Method in class org.xwiki.bridge.event.WikiCopiedEvent
getTitle() - Method in interface org.xwiki.bridge.DocumentModelBridge
getTo() - Method in class org.xwiki.bridge.event.DocumentVersionRangeDeletedEvent
getTo() - Method in class org.xwiki.bridge.event.DocumentVersionRangeDeletingEvent
getTranslatedDocumentInstance(DocumentModelBridge) - Method in interface org.xwiki.bridge.DocumentAccessBridge: Get the document object associated with the passed document and context locale.
getTranslatedDocumentInstance(DocumentReference) - Method in interface org.xwiki.bridge.DocumentAccessBridge: Get the document object associated with the passed document name and context locale.
getTranslatedDocumentInstance(EntityReference) - Method in interface org.xwiki.bridge.DocumentAccessBridge: Get the document object associated with the passed entity reference and context locale.
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 DocumentModelBridge.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: Deprecated.
since 6.1RC1, use ContextualAuthorizationManager.hasAccess(org.xwiki.security.authorization.Right) instead

I

isAdvancedUser() - Method in interface org.xwiki.bridge.DocumentAccessBridge
isAdvancedUser(EntityReference) - Method in interface org.xwiki.bridge.DocumentAccessBridge
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: Deprecated.
since 6.1, use ContextualAuthorizationManager.checkAccess(org.xwiki.security.authorization.Right, org.xwiki.model.reference.EntityReference) with Right.EDIT instead
isDocumentViewable(String) - Method in interface org.xwiki.bridge.DocumentAccessBridge: Deprecated.
use DocumentAccessBridge.isDocumentViewable(org.xwiki.model.reference.DocumentReference) instead
isDocumentViewable(DocumentReference) - Method in interface org.xwiki.bridge.DocumentAccessBridge: Deprecated.
since 6.1, use ContextualAuthorizationManager.checkAccess(org.xwiki.security.authorization.Right, org.xwiki.model.reference.EntityReference) with Right.VIEW instead
isHidden() - Method in interface org.xwiki.bridge.DocumentModelBridge
isPropertyCustomMapped(String, String) - Method in interface org.xwiki.bridge.DocumentAccessBridge
isRestricted() - Method in interface org.xwiki.bridge.DocumentModelBridge

M

matches(Object) - Method in class org.xwiki.bridge.event.AbstractActionExecutionEvent
matches(Object) - Method in class org.xwiki.bridge.event.AbstractDocumentRestoreEvent
matches(Object) - Method in class org.xwiki.bridge.event.ApplicationReadyEvent
matches(Object) - Method in class org.xwiki.bridge.event.DocumentRolledBackEvent
matches(Object) - Method in class org.xwiki.bridge.event.DocumentRollingBackEvent
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
org.xwiki.model.document - package org.xwiki.model.document

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>, DocumentModelBridge) - 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.
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(String, String, byte[]) - Method in interface org.xwiki.bridge.DocumentAccessBridge: Deprecated.
replaced by DocumentAccessBridge.setAttachmentContent(AttachmentReference, byte[]) since 2.2.1
setAttachmentContent(AttachmentReference, byte[]) - Method in interface org.xwiki.bridge.DocumentAccessBridge: Sets the content of a document attachment.
setContentAuthor(UserReference) - Method in interface org.xwiki.model.document.DocumentAuthors: Specify the author of the content of the document: this author is only responsible to the content, and not to other information of the document such as xobjects.
setCreator(UserReference) - Method in interface org.xwiki.model.document.DocumentAuthors: Specify the original creator of the document.
setCurrentUser(String) - Method in interface org.xwiki.bridge.DocumentAccessBridge: Utility method to set the current user.
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
setDocumentContent(DocumentReference, String, String, boolean) - Method in interface org.xwiki.bridge.DocumentAccessBridge: Updates the target document with the new content provided.
setDocumentParentReference(DocumentReference, DocumentReference) - Method in interface org.xwiki.bridge.DocumentAccessBridge: Sets the parent document name attribute for this document.
setDocumentSyntaxId(String, String) - Method in interface org.xwiki.bridge.DocumentAccessBridge: Deprecated.
replaced by DocumentAccessBridge.setDocumentSyntaxId(DocumentReference, String) since 2.2.1
setDocumentSyntaxId(DocumentReference, String) - Method in interface org.xwiki.bridge.DocumentAccessBridge: Changes the syntax Id of the target document to the given syntaxId.
setDocumentTitle(DocumentReference, String) - Method in interface org.xwiki.bridge.DocumentAccessBridge: Sets the title of this document.
setEffectiveMetadataAuthor(UserReference) - Method in interface org.xwiki.model.document.DocumentAuthors: Specify the metadata author of the document: this author is not responsible to the content, but responsible to the xobjects and other metadata.
setOriginalMetadataAuthor(UserReference) - Method in interface org.xwiki.model.document.DocumentAuthors: Specify the original metadata author of the document: the author who have triggered a save on the document, but who does not hold responsibility for those changes in terms of rights.
setProperty(String, String, String, Object) - Method in interface org.xwiki.bridge.DocumentAccessBridge: Deprecated.
use 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.
WikiProvisionedEvent - Class in org.xwiki.bridge.event: An event triggered just after a provisioning job is finished.
WikiProvisionedEvent() - Constructor for class org.xwiki.bridge.event.WikiProvisionedEvent: Matches all WikiProvisionedEvent events.
WikiProvisionedEvent(String) - Constructor for class org.xwiki.bridge.event.WikiProvisionedEvent: Constructor initializing the event filter with a FixedNameEventFilter, meaning that this event will match only events affecting the same wiki.
WikiProvisionedEvent(EventFilter) - Constructor for class org.xwiki.bridge.event.WikiProvisionedEvent: Constructor using a custom EventFilter.
WikiProvisioningEvent - Class in org.xwiki.bridge.event: An event triggered just before a provisioning job is started for a wiki.
WikiProvisioningEvent() - Constructor for class org.xwiki.bridge.event.WikiProvisioningEvent: Matches all WikiProvisioningEvent events.
WikiProvisioningEvent(String) - Constructor for class org.xwiki.bridge.event.WikiProvisioningEvent: Constructor initializing the event filter with a FixedNameEventFilter, meaning that this event will match only events affecting the same wiki.
WikiProvisioningEvent(EventFilter) - Constructor for class org.xwiki.bridge.event.WikiProvisioningEvent: Constructor using a custom EventFilter.
WikiProvisioningFailedEvent - Class in org.xwiki.bridge.event: An event triggered when a provisioning job has failed to perform its task.
WikiProvisioningFailedEvent() - Constructor for class org.xwiki.bridge.event.WikiProvisioningFailedEvent: Matches all WikiProvisioningFailedEvent events.
WikiProvisioningFailedEvent(String) - Constructor for class org.xwiki.bridge.event.WikiProvisioningFailedEvent: Constructor initializing the event filter with a FixedNameEventFilter, meaning that this event will match only events affecting the same wiki.
WikiProvisioningFailedEvent(EventFilter) - Constructor for class org.xwiki.bridge.event.WikiProvisioningFailedEvent: Constructor using a custom EventFilter.
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
All Classes All Packages