001/* QueryExp.java -- Represents a query expression.
002   Copyright (C) 2006 Free Software Foundation, Inc.
003
004This file is part of GNU Classpath.
005
006GNU Classpath is free software; you can redistribute it and/or modify
007it under the terms of the GNU General Public License as published by
008the Free Software Foundation; either version 2, or (at your option)
009any later version.
010
011GNU Classpath is distributed in the hope that it will be useful, but
012WITHOUT ANY WARRANTY; without even the implied warranty of
013MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
014General Public License for more details.
015
016You should have received a copy of the GNU General Public License
017along with GNU Classpath; see the file COPYING.  If not, write to the
018Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
01902110-1301 USA.
020
021Linking this library statically or dynamically with other modules is
022making a combined work based on this library.  Thus, the terms and
023conditions of the GNU General Public License cover the whole
024combination.
025
026As a special exception, the copyright holders of this library give you
027permission to link this library with independent modules to produce an
028executable, regardless of the license terms of these independent
029modules, and to copy and distribute the resulting executable under
030terms of your choice, provided that you also meet, for each linked
031independent module, the terms and conditions of the license of that
032module.  An independent module is a module which is not derived from
033or based on this library.  If you modify this library, you may extend
034this exception to your version of the library, but you are not
035obligated to do so.  If you do not wish to do so, delete this
036exception statement from your version. */
037
038package javax.management;
039
040import java.io.Serializable;
041
042/**
043 * Applies the type of relational constraints seen in the
044 * <code>where</code> clauses of databases to an
045 * {@link ObjectName}.  Instances of this class are usually
046 * returned by the static methods of the {@link Query} classes.
047 * If a custom implementation is required, it is better to
048 * extend the {@link QueryEval} class, rather than simply
049 * implementing this interface, in order to ensure that
050 * the {@link #setMBeanServer(MBeanServer)} method functions
051 * correctly.
052 *
053 * @author Andrew John Hughes (gnu_andrew@member.fsf.org)
054 * @since 1.5
055 */
056public interface QueryExp
057  extends Serializable
058{
059
060  /**
061   * Applies the query to the specified management bean.
062   *
063   * @param name the name of the management bean.
064   * @return true if the query was applied successfully.
065   * @throws BadStringOperationException if an invalid string
066   *                                     operation is used by
067   *                                     the query.
068   * @throws BadBinaryOpValueExpException if an invalid expression
069   *                                      is used by the query.
070   * @throws BadAttributeValueExpException if an invalid attribute
071   *                                       is used by the query.
072   * @throws InvalidApplicationException if the query is applied
073   *                                     to the wrong type of bean.
074   */
075  boolean apply(ObjectName name)
076    throws BadStringOperationException, BadBinaryOpValueExpException,
077           BadAttributeValueExpException, InvalidApplicationException;
078
079  /**
080   * Changes the {@link MBeanServer} on which this query is performed.
081   *
082   * @param server the new server to use.
083   */
084  void setMBeanServer(MBeanServer server);
085
086}
087