WikiDocumentFilter (XWiki Platform - Filter - Event

```
public interface WikiDocumentFilter
```
Document related events.

Since:

6.2M1

Version:

$Id: de7295f65fa37c3e7f168a39c6d878bfaf622aab $

Field Summary

Fields
Modifier and Type	Field and Description
`static org.slf4j.Marker`	`LOG_DOCUMENT_CREATED` Mark a log as a document save notification.
`static org.slf4j.Marker`	`LOG_DOCUMENT_DELETED` Mark a log as a document delete notification.
`static org.slf4j.Marker`	`LOG_DOCUMENT_ERROR` Mark a log as a document error notification.
`static org.slf4j.Marker`	`LOG_DOCUMENT_SKIPPED` Mark a log as a document skipped notification.
`static org.slf4j.Marker`	`LOG_DOCUMENT_UPDATED` Mark a log as a document save notification.
`static String`	`PARAMETER_CONTENT`
`static String`	`PARAMETER_CONTENT_AUTHOR`
`static String`	`PARAMETER_CONTENT_DATE`
`static String`	`PARAMETER_CONTENT_HTML`
`static String`	`PARAMETER_CREATION_AUTHOR`
`static String`	`PARAMETER_CREATION_DATE`
`static String`	`PARAMETER_CUSTOMCLASS`
`static String`	`PARAMETER_DEFAULTTEMPLATE`
`static String`	`PARAMETER_HIDDEN`
`static String`	`PARAMETER_LASTREVISION`
`static String`	`PARAMETER_LOCALE`
`static String`	`PARAMETER_PARENT`
`static String`	`PARAMETER_REVISION_AUTHOR`
`static String`	`PARAMETER_REVISION_COMMENT`
`static String`	`PARAMETER_REVISION_DATE`
`static String`	`PARAMETER_REVISION_MINOR`
`static String`	`PARAMETER_SYNTAX`
`static String`	`PARAMETER_TITLE`
`static String`	`PARAMETER_VALIDATIONSCRIPT`

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`beginWikiDocument(String name, org.xwiki.filter.FilterEventParameters parameters)`
`void`	`beginWikiDocumentLocale(Locale locale, org.xwiki.filter.FilterEventParameters parameters)`
`void`	`beginWikiDocumentRevision(String revision, org.xwiki.filter.FilterEventParameters parameters)`
`void`	`endWikiDocument(String name, org.xwiki.filter.FilterEventParameters parameters)`
`void`	`endWikiDocumentLocale(Locale locale, org.xwiki.filter.FilterEventParameters parameters)`
`void`	`endWikiDocumentRevision(String revision, org.xwiki.filter.FilterEventParameters parameters)`

- Field Detail
  - LOG_DOCUMENT_CREATED
```
static final org.slf4j.Marker LOG_DOCUMENT_CREATED
```
    Mark a log as a document save notification. First log parameter has to be the DocumentReference.
    
    Since:
    
    6.2M1
  - LOG_DOCUMENT_UPDATED
```
static final org.slf4j.Marker LOG_DOCUMENT_UPDATED
```
    Mark a log as a document save notification. First log parameter has to be the DocumentReference.
    
    Since:
    
    6.2M1
  - LOG_DOCUMENT_DELETED
```
static final org.slf4j.Marker LOG_DOCUMENT_DELETED
```
    Mark a log as a document delete notification. First log parameter has to be the DocumentReference.
    
    Since:
    
    6.2M1
  - LOG_DOCUMENT_SKIPPED
```
static final org.slf4j.Marker LOG_DOCUMENT_SKIPPED
```
    Mark a log as a document skipped notification. First log parameter has to be the DocumentReference.
    
    Since:
    
    6.2M1
  - LOG_DOCUMENT_ERROR
```
static final org.slf4j.Marker LOG_DOCUMENT_ERROR
```
    Mark a log as a document error notification. First log parameter has to be the DocumentReference.
    
    Since:
    
    6.2M1
  - PARAMETER_SYNTAX
```
static final String PARAMETER_SYNTAX
```
    See Also:
    
    Constant Field Values
    
    Type:
    
    Syntax
  - PARAMETER_PARENT
```
static final String PARAMETER_PARENT
```
    See Also:
    
    Constant Field Values
    
    Type:
    
    EntityReference
  - PARAMETER_TITLE
```
static final String PARAMETER_TITLE
```
    See Also:
    
    Constant Field Values
    
    Type:
    
    String
  - PARAMETER_HIDDEN
```
static final String PARAMETER_HIDDEN
```
    See Also:
    
    Constant Field Values
    
    Type:
    
    Boolean
  - PARAMETER_CUSTOMCLASS
```
static final String PARAMETER_CUSTOMCLASS
```
    See Also:
    
    Constant Field Values
    
    Type:
    
    String
  - PARAMETER_DEFAULTTEMPLATE
```
static final String PARAMETER_DEFAULTTEMPLATE
```
    See Also:
    
    Constant Field Values
    
    Type:
    
    String
  - PARAMETER_VALIDATIONSCRIPT
```
static final String PARAMETER_VALIDATIONSCRIPT
```
    See Also:
    
    Constant Field Values
    
    Type:
    
    String
  - PARAMETER_CONTENT
```
static final String PARAMETER_CONTENT
```
    See Also:
    
    Constant Field Values
    
    Type:
    
    String
  - PARAMETER_CONTENT_HTML
```
static final String PARAMETER_CONTENT_HTML
```
    See Also:
    
    Constant Field Values
    
    Type:
    
    String
  - PARAMETER_CONTENT_AUTHOR
```
static final String PARAMETER_CONTENT_AUTHOR
```
    See Also:
    
    Constant Field Values
    
    Type:
    
    String
  - PARAMETER_CONTENT_DATE
```
static final String PARAMETER_CONTENT_DATE
```
    See Also:
    
    Constant Field Values
    
    Type:
    
    Date
  - PARAMETER_CREATION_AUTHOR
```
static final String PARAMETER_CREATION_AUTHOR
```
    See Also:
    
    Constant Field Values
    
    Type:
    
    String
  - PARAMETER_CREATION_DATE
```
static final String PARAMETER_CREATION_DATE
```
    See Also:
    
    Constant Field Values
    
    Type:
    
    Date
  - PARAMETER_LOCALE
```
static final String PARAMETER_LOCALE
```
    See Also:
    
    Constant Field Values
    
    Type:
    
    Locale
  - PARAMETER_LASTREVISION
```
static final String PARAMETER_LASTREVISION
```
    Since:
    
    6.2M1
    
    See Also:
    
    Constant Field Values
    
    Type:
    
    String
  - PARAMETER_REVISION_DATE
```
static final String PARAMETER_REVISION_DATE
```
    See Also:
    
    Constant Field Values
    
    Type:
    
    Date
  - PARAMETER_REVISION_AUTHOR
```
static final String PARAMETER_REVISION_AUTHOR
```
    See Also:
    
    Constant Field Values
    
    Type:
    
    String
  - PARAMETER_REVISION_COMMENT
```
static final String PARAMETER_REVISION_COMMENT
```
    See Also:
    
    Constant Field Values
    
    Type:
    
    String
  - PARAMETER_REVISION_MINOR
```
static final String PARAMETER_REVISION_MINOR
```
    See Also:
    
    Constant Field Values
    
    Type:
    
    Boolean
- Method Detail
  - beginWikiDocument
```
void beginWikiDocument(String name,
                       @Default(value="")
                       org.xwiki.filter.FilterEventParameters parameters)
                throws org.xwiki.filter.FilterException
```
    Parameters:
    
    name - the name of the document
    
    parameters - the properties of the document
    
    Throws:
    
    org.xwiki.filter.FilterException - when failing to send event
  - endWikiDocument
```
void endWikiDocument(String name,
                     @Default(value="")
                     org.xwiki.filter.FilterEventParameters parameters)
              throws org.xwiki.filter.FilterException
```
    Parameters:
    
    name - the name of the document
    
    parameters - the properties of the document
    
    Throws:
    
    org.xwiki.filter.FilterException - when failing to send event
  - beginWikiDocumentLocale
```
void beginWikiDocumentLocale(@Default(value="")
                             Locale locale,
                             @Default(value="")
                             org.xwiki.filter.FilterEventParameters parameters)
                      throws org.xwiki.filter.FilterException
```
    Parameters:
    
    locale - the locale of the document
    
    parameters - the properties of the document locale
    
    Throws:
    
    org.xwiki.filter.FilterException - when failing to send event
  - endWikiDocumentLocale
```
void endWikiDocumentLocale(@Default(value="")
                           Locale locale,
                           @Default(value="")
                           org.xwiki.filter.FilterEventParameters parameters)
                    throws org.xwiki.filter.FilterException
```
    Parameters:
    
    locale - the locale of the document
    
    parameters - the properties of the document
    
    Throws:
    
    org.xwiki.filter.FilterException - when failing to send event
  - beginWikiDocumentRevision
```
void beginWikiDocumentRevision(String revision,
                               @Default(value="")
                               org.xwiki.filter.FilterEventParameters parameters)
                        throws org.xwiki.filter.FilterException
```
    Parameters:
    
    revision - the revision of the document
    
    parameters - the properties of the document revision
    
    Throws:
    
    org.xwiki.filter.FilterException - when failing to send event
  - endWikiDocumentRevision
```
void endWikiDocumentRevision(String revision,
                             @Default(value="")
                             org.xwiki.filter.FilterEventParameters parameters)
                      throws org.xwiki.filter.FilterException
```
    Parameters:
    
    revision - the revision of the document
    
    parameters - the properties of the document revision
    
    Throws:
    
    org.xwiki.filter.FilterException - when failing to send event

Interface WikiDocumentFilter

Field Summary

Method Summary

Field Detail

LOG_DOCUMENT_CREATED

LOG_DOCUMENT_UPDATED

LOG_DOCUMENT_DELETED

LOG_DOCUMENT_SKIPPED

LOG_DOCUMENT_ERROR

PARAMETER_SYNTAX

PARAMETER_PARENT

PARAMETER_TITLE

PARAMETER_HIDDEN

PARAMETER_CUSTOMCLASS

PARAMETER_DEFAULTTEMPLATE

PARAMETER_VALIDATIONSCRIPT

PARAMETER_CONTENT

PARAMETER_CONTENT_HTML

PARAMETER_CONTENT_AUTHOR

PARAMETER_CONTENT_DATE

PARAMETER_CREATION_AUTHOR

PARAMETER_CREATION_DATE

PARAMETER_LOCALE

PARAMETER_LASTREVISION

PARAMETER_REVISION_DATE

PARAMETER_REVISION_AUTHOR

PARAMETER_REVISION_COMMENT

PARAMETER_REVISION_MINOR

Method Detail

beginWikiDocument

endWikiDocument

beginWikiDocumentLocale

endWikiDocumentLocale

beginWikiDocumentRevision

endWikiDocumentRevision