GroupFilter.java

/*
 * See the NOTICE file distributed with this work for additional
 * information regarding copyright ownership.
 *
 * This is free software; you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License as
 * published by the Free Software Foundation; either version 2.1 of
 * the License, or (at your option) any later version.
 *
 * This software is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this software; if not, write to the Free
 * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
 * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
 */
package org.xwiki.filter.event.user;

import org.xwiki.filter.FilterEventParameters;
import org.xwiki.filter.FilterException;
import org.xwiki.filter.annotation.Default;
import org.xwiki.filter.annotation.Name;

/**
 * Group related events.
 * 
 * @version $Id: bebf2357d1fc7566eae8864d33835f52b91dc5ae $
 * @since 6.2M1
 */
public interface GroupFilter
{
    // Properties

    /**
     * @type {@link java.util.Date}
     */
    String PARAMETER_CREATION_DATE = "creation_date";

    /**
     * @type {@link java.util.Date}
     */
    String PARAMETER_REVISION_DATE = "revision_date";

    // Events

    /**
     * @param name the name of the group
     * @param parameters the parameters of the group
     * @throws FilterException when failing to send event
     * @since 8.3M1
     * @since 8.2.2
     * @since 7.4.5
     */
    default void beginGroupContainer(String name,
        @Default(FilterEventParameters.DEFAULT) FilterEventParameters parameters) throws FilterException
    {
        beginGroup(name, parameters);
    }

    /**
     * @param name the name of the group
     * @param parameters the parameters of the group
     * @throws FilterException when failing to send event
     * @since 8.3M1
     * @since 8.2.2
     * @since 7.4.5
     */
    default void endGroupContainer(String name,
        @Default(FilterEventParameters.DEFAULT) FilterEventParameters parameters) throws FilterException
    {
        endGroup(name, parameters);
    }

    /**
     * @param name the name of the user
     * @param parameters the parameters of the user
     * @throws FilterException when failing to send event
     */
    void onGroupMemberUser(String name, @Default(FilterEventParameters.DEFAULT) FilterEventParameters parameters)
        throws FilterException;

    /**
     * @param name the name of the group
     * @param parameters the parameters of the group
     * @throws FilterException when failing to send event
     */
    void onGroupMemberGroup(String name, @Default(FilterEventParameters.DEFAULT) FilterEventParameters parameters)
        throws FilterException;

    // Deprecated

    /**
     * @param name the name of the group
     * @param parameters the parameters of the group
     * @throws FilterException when failing to send event
     * @deprecated since 7.4.5, 8.2.2, 8.3M1 because it's conflicting with Rendering Listener events, use
     *             {@link #beginGroupContainer(String, FilterEventParameters)} instead
     */
    @Name("groupContainer")
    @Deprecated
    void beginGroup(String name, @Default(FilterEventParameters.DEFAULT) FilterEventParameters parameters)
        throws FilterException;

    /**
     * @param name the name of the group
     * @param parameters the parameters of the group
     * @throws FilterException when failing to send event
     * @deprecated since 7.4.5, 8.2.2, 8.3M1 because it's conflicting with Rendering Listener events, use
     *             {@link #beginGroupContainer(String, FilterEventParameters)} instead
     */
    @Name("groupContainer")
    @Deprecated
    void endGroup(String name, @Default(FilterEventParameters.DEFAULT) FilterEventParameters parameters)
        throws FilterException;
}