org.xwiki.filter.event.user

Interface GroupFilter

public interface GroupFilter

Group related events.

Since:

6.2M1

Version:

$Id: bebf2357d1fc7566eae8864d33835f52b91dc5ae $

Field Summary

Fields

Modifier and Type	Field and Description
static String	PARAMETER_CREATION_DATE
static String	PARAMETER_REVISION_DATE

Method Summary

Modifier and Type	Method and Description
void	beginGroup(String name, org.xwiki.filter.FilterEventParameters parameters) Deprecated. since 7.4.5, 8.2.2, 8.3M1 because it's conflicting with Rendering Listener events, use beginGroupContainer(String, FilterEventParameters) instead
default void	beginGroupContainer(String name, org.xwiki.filter.FilterEventParameters parameters)
void	endGroup(String name, org.xwiki.filter.FilterEventParameters parameters) Deprecated. since 7.4.5, 8.2.2, 8.3M1 because it's conflicting with Rendering Listener events, use beginGroupContainer(String, FilterEventParameters) instead
default void	endGroupContainer(String name, org.xwiki.filter.FilterEventParameters parameters)
void	onGroupMemberGroup(String name, org.xwiki.filter.FilterEventParameters parameters)
void	onGroupMemberUser(String name, org.xwiki.filter.FilterEventParameters parameters)

Field Detail

PARAMETER_CREATION_DATE

static final String PARAMETER_CREATION_DATE

See Also:

Constant Field Values

Type:

Date

PARAMETER_REVISION_DATE

static final String PARAMETER_REVISION_DATE

See Also:

Constant Field Values

Type:

Date

Method Detail

beginGroupContainer

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

Parameters:

name - the name of the group

parameters - the parameters of the group

Throws:

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

Since:

8.3M1, 8.2.2, 7.4.5

endGroupContainer

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

Parameters:

name - the name of the group

parameters - the parameters of the group

Throws:

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

Since:

8.3M1, 8.2.2, 7.4.5

onGroupMemberUser

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

Parameters:

name - the name of the user

parameters - the parameters of the user

Throws:

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

onGroupMemberGroup

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

Parameters:

name - the name of the group

parameters - the parameters of the group

Throws:

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

beginGroup

@Name(value="groupContainer")
 @Deprecated
void beginGroup(String name,
                                                           @Default(value="")
                                                           org.xwiki.filter.FilterEventParameters parameters)
                                                    throws org.xwiki.filter.FilterException

Deprecated. since 7.4.5, 8.2.2, 8.3M1 because it's conflicting with Rendering Listener events, use beginGroupContainer(String, FilterEventParameters) instead

Parameters:

name - the name of the group

parameters - the parameters of the group

Throws:

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

endGroup

@Name(value="groupContainer")
 @Deprecated
void endGroup(String name,
                                                         @Default(value="")
                                                         org.xwiki.filter.FilterEventParameters parameters)
                                                  throws org.xwiki.filter.FilterException

Deprecated. since 7.4.5, 8.2.2, 8.3M1 because it's conflicting with Rendering Listener events, use beginGroupContainer(String, FilterEventParameters) instead

Parameters:

name - the name of the group

parameters - the parameters of the group

Throws:

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