bpel-api/src/main/java/org/apache/ode/bpel/eapi/ExtensionContext.java

/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *    http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */
package org.apache.ode.bpel.eapi;

import java.util.List;
import java.util.Map;

import org.apache.ode.bpel.common.FaultException;
import org.apache.ode.bpel.obj.OLink;
import org.apache.ode.bpel.obj.OProcess;
import org.apache.ode.bpel.obj.OScope;
import org.w3c.dom.Node;


/**
 * Context for executing extension activities or extension assign operations. 
 * Implementations of the {@link ExtensionOperation} class use this interface to access BPEL
 * variables, property sets and link status.
 * 
 * @author Tammo van Lessen (University of Stuttgart)
 */
public interface ExtensionContext {

	/**
	 * Returns a list of variables visible in the current scope.
	 * 
	 * @return an unmodifiable list of visible variables.
	 * @throws FaultException
	 */
	Map<String, OScope.Variable> getVisibleVariables() throws FaultException;
	
	/**
	 * Returns a list of links.
	 * 
	 * @return an unmodifiable list of visible variables.
	 * @throws FaultException
	 */
	List<OLink> getLinks() throws FaultException;

	/**
     * Read the value of a BPEL variable.
     *
     * @param variable
     *          variable to read
     * @param part
     *          the part (or <code>null</code>)
     * @return the value of the variable, wrapped in a <code>Node</code>
     */
    Node readVariable(OScope.Variable variable) throws FaultException;
    
	/**
     * Read the value of a BPEL variable.
     *
     * @param variableName
     *          variable to read
     * @param part
     *          the part (or <code>null</code>)
     * @return the value of the variable, wrapped in a <code>Node</code>
     */
    Node readVariable(String variableName) throws FaultException;

    /**
     * Write the value into a BPEL variable.
     *
     * @param variable
     *          variable to write
     * @param value
     *          the value to be stored into the variable
     * @return the value of the variable, wrapped in a <code>Node</code>
     */
    void writeVariable(OScope.Variable variable, Node value) throws FaultException;

    /**
     * Write the value into a BPEL variable.
     *
     * @param variableName
     *          variable to write
     * @param value
     *          the value to be stored into the variable
     * @return the value of the variable, wrapped in a <code>Node</code>
     */
    void writeVariable(String variableName, Node value) throws FaultException;

    /**
     * Read the value of a BPEL property.
     *
     * @param variable
     *          variable containing property
     * @param property
     *          property to read
     * @return value of the property
     */
    String readMessageProperty(OScope.Variable variable, OProcess.OProperty property)
            throws FaultException;
    
    /**
     * Obtain the status of a control link.
     *
     * @param olink
     *          link to check
     * @return <code>true</code> if the link is active, <code>false</code>
     *         otherwise.
     */
    boolean isLinkActive(OLink olink) throws FaultException;
    
    /**
     * Reads the current process instance id.
     * @return instance id
     */
    Long getProcessId();
    
}