org.xwiki.filter.event.user

Interface UserFilter

public interface UserFilter

User related events.

Since:

6.2M1

Version:

$Id: e248ef6a07379c574a0080d86aaa4682348f0c92 $

Field Summary

Fields

Modifier and Type	Field and Description
static String	PARAMETER_ACTIVE
static String	PARAMETER_CREATION_DATE
static String	PARAMETER_EMAIL
static String	PARAMETER_FIRSTNAME
static String	PARAMETER_LASTNAME
static String	PARAMETER_REVISION_DATE

Method Summary

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

Field Detail

PARAMETER_FIRSTNAME

static final String PARAMETER_FIRSTNAME

See Also:

Constant Field Values

Type:

String

PARAMETER_LASTNAME

static final String PARAMETER_LASTNAME

See Also:

Constant Field Values

Type:

String

PARAMETER_EMAIL

static final String PARAMETER_EMAIL

See Also:

Constant Field Values

Type:

String

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

PARAMETER_ACTIVE

static final String PARAMETER_ACTIVE

See Also:

Constant Field Values

Type:

Boolean

Method Detail

beginUser

void beginUser(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

endUser

void endUser(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