WikiClassFilter.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.model;

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

/**
 * Class related events.
 * 
 * @version $Id: fc946bb55c738b1e604b20b32996f92503e90935 $
 * @since 6.2M1
 */
public interface WikiClassFilter
{
    /**
     * @type {@link String}
     * @since 9.0RC1
     */
    String PARAMETER_NAME = "name";

    /**
     * @type {@link String}
     */
    String PARAMETER_CUSTOMCLASS = "customclass";

    /**
     * @type {@link String}
     */
    String PARAMETER_CUSTOMMAPPING = "custommapping";

    /**
     * @type {@link String}
     */
    String PARAMETER_SHEET_DEFAULTVIEW = "sheet_defaultview";

    /**
     * @type {@link String}
     */
    String PARAMETER_SHEET_DEFAULTEDIT = "sheet_defaultedit";

    /**
     * @type {@link String}
     */
    String PARAMETER_DEFAULTSPACE = "defaultspace";

    /**
     * @type {@link String}
     */
    String PARAMETER_NAMEFIELD = "namefield";

    /**
     * @type {@link String}
     */
    String PARAMETER_VALIDATIONSCRIPT = "validationscript";

    /**
     * @param parameters the properties of the class
     * @throws FilterException when failing to send event
     */
    void beginWikiClass(@Default(FilterEventParameters.DEFAULT) FilterEventParameters parameters)
        throws FilterException;

    /**
     * @param parameters the properties of the class
     * @throws FilterException when failing to send event
     */
    void endWikiClass(@Default(FilterEventParameters.DEFAULT) FilterEventParameters parameters) throws FilterException;
}