View Javadoc
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  import org.openehealth.ipf.commons.ihe.xds.core.requests.DocumentReference;
19  
20  import java.util.List;
21  
22  /**
23   * Encapsulation of the ebXML classes for {@code RetrieveDocumentSetRequestType} and {@code RemoveDocumentsRequestType}.
24   * <p>
25   * This class contains convenience methods and provides a version independent
26   * abstraction of the ebXML data structure.
27   * @author Jens Riemschneider
28   */
29  public interface EbXMLNonconstructiveDocumentSetRequest {
30      /**
31       * Sets the documents of the request.
32       * @param documents
33       *          the documents.
34       */
35      void setDocuments(List<DocumentReference> documents);
36  
37      /**
38       * @return the documents of the request.
39       */
40      List<DocumentReference> getDocuments();
41  
42      /**
43       * @return the ebXML object being wrapped by this class. 
44       */
45      Object getInternal();
46  }