001/*
002 * (C) Copyright 2006-2011 Nuxeo SA (http://nuxeo.com/) and others.
003 *
004 * Licensed under the Apache License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 *
008 *     http://www.apache.org/licenses/LICENSE-2.0
009 *
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 * See the License for the specific language governing permissions and
014 * limitations under the License.
015 *
016 * Contributors:
017 *     bstefanescu
018 */
019package org.nuxeo.ecm.automation.client;
020
021import java.io.IOException;
022import java.util.Map;
023
024import org.nuxeo.ecm.automation.client.model.OperationDocumentation;
025
026/**
027 * @author <a href="mailto:[email protected]">Bogdan Stefanescu</a>
028 */
029// TODO: comment me.
030public interface OperationRequest {
031
032    Session getSession();
033
034    String getUrl();
035
036    /**
037     * Get the ID of the operation to be invoked
038     *
039     * @return
040     */
041    OperationDocumentation getOperation();
042
043    OperationRequest setInput(Object input);
044
045    Object getInput();
046
047    OperationRequest set(String key, Object value);
048
049    OperationRequest setContextProperty(String key, Object value);
050
051    Object execute() throws IOException;
052
053    Map<String, Object> getParameters();
054
055    Map<String, Object> getContextParameters();
056
057    OperationRequest setHeader(String key, String value);
058
059    Map<String, String> getHeaders();
060
061}