01: /*
02: * Copyright 2004-2007 Gary Bentley
03: *
04: * Licensed under the Apache License, Version 2.0 (the "License"); you may
05: * not use this file except in compliance with the License.
06: * You may obtain a copy of the License at
07: * http://www.apache.org/licenses/LICENSE-2.0
08: *
09: * Unless required by applicable law or agreed to in writing, software
10: * distributed under the License is distributed on an "AS IS" BASIS,
11: * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12: * See the License for the specific language governing permissions and
13: * limitations under the License.
14: */
15: package org.josql.functions;
16:
17: import org.josql.Query;
18:
19: /**
20: * Defines an interface that custom objects can use to indicate that they can
21: * store a reference to the Query object.
22: * A function handler object does NOT have to implement this class, this is here purely
23: * as a convenience for developers so that they can easily get a reference to the Query
24: * object, since the Query object will call the {@link #setQuery(Query)} method.
25: */
26: public interface FunctionHandler {
27:
28: /**
29: * Set the Query object that the function handler should use.
30: *
31: * @param q The Query object.
32: */
33: public void setQuery(Query q);
34:
35: }
|