org.xwiki.filter.event.model

Interface WikiObjectFilter

public interface WikiObjectFilter

Object related events.

Since:

6.2M1

Version:

$Id: 74e5e92b0d28eae098bc5a2f8690bb0cabcc0af9 $

Field Summary

Fields

Modifier and Type	Field and Description
static String	PARAMETER_CLASS_REFERENCE
static String	PARAMETER_GUID
static String	PARAMETER_NAME
static String	PARAMETER_NUMBER

Method Summary

Modifier and Type	Method and Description
void	beginWikiObject(String name, org.xwiki.filter.FilterEventParameters parameters)
void	endWikiObject(String name, org.xwiki.filter.FilterEventParameters parameters)

Field Detail

PARAMETER_NAME

static final String PARAMETER_NAME

Since:

9.0RC1

See Also:

Constant Field Values

Type:

String

PARAMETER_NUMBER

static final String PARAMETER_NUMBER

See Also:

Constant Field Values

Type:

Integer

PARAMETER_CLASS_REFERENCE

static final String PARAMETER_CLASS_REFERENCE

See Also:

Constant Field Values

Type:

String

PARAMETER_GUID

static final String PARAMETER_GUID

See Also:

Constant Field Values

Type:

String

Method Detail

beginWikiObject

void beginWikiObject(String name,
                     @Default(value="")
                     org.xwiki.filter.FilterEventParameters parameters)
              throws org.xwiki.filter.FilterException

Parameters:

name - the name of the object

parameters - the properties of the object

Throws:

org.xwiki.filter.FilterException - when failing to send event

endWikiObject

void endWikiObject(String name,
                   @Default(value="")
                   org.xwiki.filter.FilterEventParameters parameters)
            throws org.xwiki.filter.FilterException

Parameters:

name - the name of the object

parameters - the properties of the object

Throws:

org.xwiki.filter.FilterException - when failing to send event