org.xwiki.wikistream.model.filter

Interface WikiObjectFilter

@Unstable
public interface WikiObjectFilter

Object related events.

Since:

5.2M2

Version:

$Id: 4436f59af23f716aade4466f29c698a6c88bcffe $

Field Summary

Fields

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

Method Summary

Methods

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_NUMBER

static final String PARAMETER_NUMBER

See Also:

Constant Field Values

PARAMETER_CLASS_REFERENCE

static final String PARAMETER_CLASS_REFERENCE

See Also:

Constant Field Values

PARAMETER_GUID

static final String PARAMETER_GUID

See Also:

Constant Field Values

Method Detail

beginWikiObject

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

Parameters:

name - the name of the object

parameters - the properties of the object

Throws:

WikiStreamException - when failing to send event

endWikiObject

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

Parameters:

name - the name of the object

parameters - the properties of the object

Throws:

WikiStreamException - when failing to send event