001package ca.uhn.fhir.rest.gclient;
002
003/*
004 * #%L
005 * HAPI FHIR - Core Library
006 * %%
007 * Copyright (C) 2014 - 2017 University Health Network
008 * %%
009 * Licensed under the Apache License, Version 2.0 (the "License");
010 * you may not use this file except in compliance with the License.
011 * You may obtain a copy of the License at
012 * 
013 *      http://www.apache.org/licenses/LICENSE-2.0
014 * 
015 * Unless required by applicable law or agreed to in writing, software
016 * distributed under the License is distributed on an "AS IS" BASIS,
017 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
018 * See the License for the specific language governing permissions and
019 * limitations under the License.
020 * #L%
021 */
022public interface IOperation extends IBaseOn<IOperationUnnamed> {
023
024    /**
025     * This operation is called <b><a href="https://www.hl7.org/fhir/messaging.html">$process-message</a></b> as defined by the FHIR
026     * specification.<br><br>
027     * Usage :<br>
028     * <code>
029     * <pre>
030     * Bundle response = client
031     * .operation()
032     * .processMessage()
033     * .synchronous(Bundle.class)
034     * .setResponseUrlParam("http://myserver/fhir")
035     * .setMessageBundle(msgBundle)
036     * .execute();
037     * 
038     * //if you want to send an async message
039     * 
040     * OperationOutcome response = client
041     * .operation()
042     * .processMessage()
043     * .asynchronous(OperationOutcome.class)
044     * .setResponseUrlParam("http://myserver/fhir")
045     * .setMessageBundle(msgBundle)
046     * .execute();
047     *
048     * </pre>
049     * </code>
050     *
051     * @see <a href="https://www.hl7.org/fhir/messaging.html">2.4 Messaging
052     * using FHIR Resources</a>
053     *
054     * @return An interface that defines the operation related to sending
055     * Messages to a Messaging Server
056     */
057    IOperationProcessMsg processMessage();
058}