View Javadoc
1   /*
2    * Copyright 2012 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  import org.openehealth.ipf.commons.ihe.xds.core.requests.RetrieveStudy;
19  
20  import java.util.List;
21  
22  /**
23   * Encapsulation of the ebXML classes for {@code RetrieveImagingDocumentSetRequestType}. 
24   * <p>
25   * This class contains convenience methods and provides a version independent
26   * abstraction of the ebXML data structure.
27   *
28   * @author Clay Sebourn
29   */
30  public interface EbXMLRetrieveImagingDocumentSetRequest
31  {
32      /**
33       * Sets the retrieveStudies of the request.
34       * @param retrieveStudies    the retrieveStudies.
35       */
36      void setRetrieveStudies(List<RetrieveStudy> retrieveStudies);
37  
38      /**
39       * @return the retrieveStudies of the request.
40       */
41      List<RetrieveStudy> getRetrieveStudies();
42  
43      /**
44       * Sets the transferSyntaxUIDList of the request.
45       * @param transferSyntaxUIDList  the transferSyntaxUIDList.
46       */
47      void setTransferSyntaxUIDList(List<String> transferSyntaxUIDList);
48  
49      /**
50       * @return the transferSyntaxUIDList of the request.
51       */
52      List<String> getTransferSyntaxUIDList();
53  
54      /**
55       * @return the ebXML object being wrapped by this class. 
56       */
57      Object getInternal();
58  }