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 java.util.Map;
19  
20  import javax.activation.DataHandler;
21  
22  /**
23   * Encapsulation of the ebXML classes for {@code ProvideAndRegisterDocumentSetRequestType}. 
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 EbXMLProvideAndRegisterDocumentSetRequest extends EbXMLSubmitObjectsRequest {
30      /**
31       * @return the documents contained in the request. This map is read-only.
32       */
33      Map<String, DataHandler> getDocuments();
34      
35      /**
36       * Adds a new document to the request.
37       * @param id
38       *          the id of the document.
39       * @param dataHandler
40       *          the data handler allowing access and describing to the document contents.
41       */
42      void addDocument(String id, DataHandler dataHandler);
43      
44      /**
45       * Removes a document from the request.
46       * @param id
47       *          the id of the document.
48       */
49      void removeDocument(String id);
50  }