1 /*
2 * Copyright 2009 the original author or authors.
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16 package org.openehealth.ipf.commons.ihe.xds.core.ebxml;
17
18 /**
19 * Encapsulation of the ebXML classes for {@code AdhocQueryRequest}.
20 * <p>
21 * This class contains convenience methods and provides a version independent
22 * abstraction of the ebXML data structure.
23 * @author Jens Riemschneider
24 */
25 public interface EbXMLAdhocQueryRequest extends EbXMLSlotList {
26 /**
27 * @param sql
28 * SQL string used by the query.
29 */
30 void setSql(String sql);
31
32 /**
33 * @return SQL string used by the query.
34 */
35 String getSql();
36
37 /**
38 * @param returnType
39 * the type of objects that the query should return.
40 */
41 void setReturnType(String returnType);
42
43 /**
44 * @return the type of objects that the query should return.
45 */
46 String getReturnType();
47
48 /**
49 * @param id
50 * the id of the query.
51 */
52 void setId(String id);
53
54 /**
55 * @return the id of the query.
56 */
57 String getId();
58
59 /**
60 * @param homeCommunityID
61 * home community ID.
62 */
63 void setHome(String homeCommunityID);
64
65 /**
66 * @return home community ID.
67 */
68 String getHome();
69
70 /**
71 * @return the ebXML object wrapped by this object.
72 */
73 Object getInternal();
74 }