ee.telekom.workflow.graph.GraphRepository Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of workflow-engine Show documentation

Telekom-workflow-engine core provides the runtime environment for workflow execution together with all the supporting services (clustering, persistence, error handling etc).

There is a newer version: 1.6.3

Show newest version

package ee.telekom.workflow.graph;

import java.util.Set;

/**
 * The {@link GraphRepository} is a container of {@link Graph} definitions.
 */
public interface GraphRepository{

    /**
     * Returns the {@link Graph} with the given name and the given version, 
     * or the latest graph with the given name if no version is null, 
     * or null if no such graph is found.

     * The latest graph is the graph with the greatest version number.
     * 
     * @param name
     *            the graph name
     * @param version
     *            the graph version
     * @return the {@link Graph} with the given name and the given version, or
     *         null if no suitable graph is found.
     */
    Graph getGraph( String name, Integer version );

    /**
     * Returns all graphs with the given name ordered with decreasing version
     * number.
     * 
     * @param name
     *            the graph name
     * @return all graphs with the given name ordered with decreasing version
     *         number.
     */
    Set getGraphs( String name );

    /**
     * Returns all graphs accessible via this repository.
     * 
     * @return all graphs accessible via this repository
     */
    Set getGraphs();

    /**
     * Adds a graph to the repository and overwrites any previously defined
     * graph with identical name and version.
     * 
     * @param graph
     *            the graph to be added
     */
    void addGraph( Graph graph );

}