01 /*
02 * Copyright 1999-2003 Sun Microsystems, Inc. All Rights Reserved.
03 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
04 *
05 * This code is free software; you can redistribute it and/or modify it
06 * under the terms of the GNU General Public License version 2 only, as
07 * published by the Free Software Foundation. Sun designates this
08 * particular file as subject to the "Classpath" exception as provided
09 * by Sun in the LICENSE file that accompanied this code.
10 *
11 * This code is distributed in the hope that it will be useful, but WITHOUT
12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
13 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
14 * version 2 for more details (a copy is included in the LICENSE file that
15 * accompanied this code).
16 *
17 * You should have received a copy of the GNU General Public License version
18 * 2 along with this work; if not, write to the Free Software Foundation,
19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
20 *
21 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
22 * CA 95054 USA or visit www.sun.com if you need additional information or
23 * have any questions.
24 */
25
26 package javax.management;
27
28 // java import
29 import java.io.Serializable;
30
31 /**
32 * <p>Represents relational constraints that can be used in database
33 * query "where clauses". Instances of QueryExp are returned by the
34 * static methods of the {@link Query} class.</p>
35 *
36 * <p>It is possible, but not
37 * recommended, to create custom queries by implementing this
38 * interface. In that case, it is better to extend the {@link
39 * QueryEval} class than to implement the interface directly, so that
40 * the {@link #setMBeanServer} method works correctly.
41 *
42 * @since 1.5
43 */
44 public interface QueryExp extends Serializable {
45
46 /**
47 * Applies the QueryExp on an MBean.
48 *
49 * @param name The name of the MBean on which the QueryExp will be applied.
50 *
51 * @return True if the query was successfully applied to the MBean, false otherwise
52 *
53 * @exception BadStringOperationException
54 * @exception BadBinaryOpValueExpException
55 * @exception BadAttributeValueExpException
56 * @exception InvalidApplicationException
57 */
58 public boolean apply(ObjectName name)
59 throws BadStringOperationException,
60 BadBinaryOpValueExpException,
61 BadAttributeValueExpException, InvalidApplicationException;
62
63 /**
64 * Sets the MBean server on which the query is to be performed.
65 *
66 * @param s The MBean server on which the query is to be performed.
67 */
68 public void setMBeanServer(MBeanServer s);
69
70 }
|