org.xwiki.wikistream.model.filter
Interface WikiClassPropertyFilter

@Unstable
public interface WikiClassPropertyFilter

Class property related events.

Since:

5.2M2

Version:

$Id: 76bb386beb8d6df192a9904d80ea6188a44a0640 $

Method Summary

void	beginWikiClassProperty(String name, String type, org.xwiki.filter.FilterEventParameters parameters)
void	endWikiClassProperty(String name, String type, org.xwiki.filter.FilterEventParameters parameters)
void	onWikiClassPropertyField(String name, String value, org.xwiki.filter.FilterEventParameters parameters)

Method Detail

beginWikiClassProperty

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

Parameters:

name - the name of the property

type - the type of the property

parameters - the parameters of the property

Throws:

WikiStreamException - when failing to send event

endWikiClassProperty

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

Parameters:

name - the name of the property

type - the type of the property

parameters - the parameters of the property

Throws:

WikiStreamException - when failing to send event

onWikiClassPropertyField

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

Parameters:

name - the name of the field

value - the value of the field

parameters - the properties of the field

Throws:

WikiStreamException - when failing to send event