Subversion Repositories bacoAlunos

/*
BERSERK - a BusinEss Runtime and SEcurity Resources Kit
Copyright (C) 2003 Goncalo Luiz

This library 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 library 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 library; if not, write to the Free Software
Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA

To contact Goncalo Luiz use the following e-mail address (use an @ instead of the _):
gedl_mega.ist.utl.pt
*/
/*
 * Created on 30/Set/2003, 9:17:23
 *
 *By Goncalo Luiz gedl [AT] rnl [DOT] ist [DOT] utl [DOT] pt
 */
package pt.utl.ist.berserk.logic.filterManager;
import pt.utl.ist.berserk.IDefinition;
/**
 * A configuration of a particular filter.
 * @author Goncalo Luiz gedl [AT] rnl [DOT] ist [DOT] utl [DOT] pt
 *
 *
 * Created at 30/Set/2003, 9:17:23
 *
 */
public interface IFilterDefinition extends IDefinition
{
        /**
         * Gets the logical name of the filter. This name shall be used in the filter chains configurations.
         * @see IFilterChain
         * @return the name of this filter
         */
        public abstract 1.5.0/docs/api/java/lang/String.html">String getName();
        /**
         * Sets the logical name of the filter. This name shall be used in the filter chains configurations.
         * @see IFilterChain
         * @param string the name to set
         */
        public abstract void setName(1.5.0/docs/api/java/lang/String.html">String string);
        /**
         * The class holding the <code>execute</code> method to be executed by the <b>IFilterBroker</b>.
         * @see IFilterBroker
         * @see IFilter
         * @return the class that implements this filter's execution logic.
         */
        public 1.5.0/docs/api/java/lang/Class.html">Class getImplementationClass();
        /**
         * Sets the class that implements this filter's execution logic.
         * @param class1 the class to set
         * @see IFilterBroker
         * @see IFilter
         */
        public void setImplementationClass(1.5.0/docs/api/java/lang/Class.html">Class class1);
        /**
         * Gets the transactional property of this filter. A filter should be marked transactional
         * if it does an acess to the persistent data storage system which should be transactional.<br/>
         * <b>IMPORTANT</b> marking a filter with <code>false</code> in this field, does <b>NOT</b>
         * guarantees that the filter is executed on a non-transactional environment.
         * @return the transactional property of the filter
         */
        public 1.5.0/docs/api/java/lang/Boolean.html">Boolean getIsTransactional();
        /**
         * Sets if its mandatory that this filter is executed on a transactional environment.
         * @see IFilterDefinition#getIsTransactional()
         * @param boolean1 the transactional property of the filter
         */
        public void setIsTransactional(1.5.0/docs/api/java/lang/Boolean.html">Boolean boolean1);
}