Package org.xwiki.filter

Interface UnknownFilter

public interface UnknownFilter

Unknown elements related events.

Since:

5.2M1

Version:

$Id: 0c6ac8f099e721dc058962dc03a20f1f8d13cab1 $

Field Summary

Fields

Modifier and Type	Field	Description
static String	FILTER_ELEMENT_ID	The identifier of the unknown events.

Method Summary

Modifier and Type	Method	Description
void	beginUnknwon(String id, FilterEventParameters parameters)
void	endUnknwon(String id, FilterEventParameters parameters)
void	onUnknwon(String id, FilterEventParameters parameters)

Field Detail

FILTER_ELEMENT_ID

static final String FILTER_ELEMENT_ID

The identifier of the unknown events.

See Also:

Constant Field Values

Method Detail

beginUnknwon

void beginUnknwon(String id,
                  @Default("")
                  FilterEventParameters parameters)
           throws FilterException

Parameters:

id - the id of the event

parameters - the data of the event

Throws:

FilterException - when an error occurs after sending the event

endUnknwon

void endUnknwon(String id,
                @Default("")
                FilterEventParameters parameters)
         throws FilterException

Parameters:

id - the id of the event

parameters - the data of the event

Throws:

FilterException - when an error occurs after sending the event

onUnknwon

void onUnknwon(String id,
               @Default("")
               FilterEventParameters parameters)
        throws FilterException

Parameters:

id - the id of the event

parameters - the data of the event

Throws:

FilterException - when an error occurs after sending the event