View Javadoc
1   /*
2    * Copyright 2013 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  import org.openehealth.ipf.commons.ihe.xds.core.metadata.ObjectReference;
20  
21  import java.util.List;
22  
23  /**
24   * Encapsulation of the ebXML classes for {@code RemoveObjectsRequest}.
25   * <p>
26   * This class contains convenience methods and provides a version independent
27   * abstraction of the ebXML data structure.
28   * @author Jens Riemschneider
29   */
30  public interface EbXMLRemoveMetadataRequest extends EbXMLAdhocQueryRequest {
31  
32      /**
33       * Sets the object references of the remove request.
34       * @param references
35       *          the object references.
36       */
37      void setReferences(List<ObjectReference> references);
38  
39      /**
40       * @return the object reference of the remove request.
41       */
42      List<ObjectReference> getReferences();
43  
44      /**
45       *
46       * @return the deletionScope of the remove request.
47       */
48      String getDeletionScope();
49  
50      /**
51       * Sets the deletionScope of the remove request.
52       */
53      void setDeletionScope(String deletionScope);
54  
55      /**
56       * @return the wrapped ebXML representation of this request.
57       */
58      Object getInternal();
59  }