1/*
2 * Copyright (c) 1999, 2015, Oracle and/or its affiliates. All rights reserved.
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * This code is free software; you can redistribute it and/or modify it
6 * under the terms of the GNU General Public License version 2 only, as
7 * published by the Free Software Foundation.  Oracle designates this
8 * particular file as subject to the "Classpath" exception as provided
9 * by Oracle 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 Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
22 * or visit www.oracle.com if you need additional information or have any
23 * questions.
24 */
25
26package javax.management;
27
28// java import
29import java.io.Serializable;
30
31
32/**
33 * <p>Represents relational constraints similar to database query "where
34 * clauses". Instances of QueryExp are returned by the static methods of the
35 * {@link Query} class.</p>
36 *
37 * <p>It is possible, but not
38 * recommended, to create custom queries by implementing this
39 * interface.  In that case, it is better to extend the {@link
40 * QueryEval} class than to implement the interface directly, so that
41 * the {@link #setMBeanServer} method works correctly.
42 *
43 * @see MBeanServer#queryNames MBeanServer.queryNames
44 * @since 1.5
45 */
46public interface QueryExp extends Serializable {
47
48
49     /**
50      * Applies the QueryExp on an MBean.
51      *
52      * @param name The name of the MBean on which the QueryExp will be applied.
53      *
54      * @return  True if the query was successfully applied to the MBean, false otherwise
55      *
56      * @throws BadStringOperationException when an invalid string
57      * operation is passed to a method for constructing a query
58      * @throws BadBinaryOpValueExpException when an invalid expression
59      * is passed to a method for constructing a query
60      * @throws BadAttributeValueExpException when an invalid MBean
61      * attribute is passed to a query constructing method
62      * @throws InvalidApplicationException when an invalid apply is attempted
63      */
64     public boolean apply(ObjectName name) throws BadStringOperationException, BadBinaryOpValueExpException,
65         BadAttributeValueExpException, InvalidApplicationException ;
66
67     /**
68      * Sets the MBean server on which the query is to be performed.
69      *
70      * @param s The MBean server on which the query is to be performed.
71      */
72     public void setMBeanServer(MBeanServer s) ;
73
74 }
75