/*
 * $Header: /home/cvs/jakarta-commons-sandbox/workflow/src/java/org/apache/commons/workflow/Activity.java,v 1.3 2001/08/22 01:01:49 craigmcc Exp $
 * $Revision: 1.3 $
 * $Date: 2001/08/22 01:01:49 $
 *
 * ====================================================================
 *
 * The Apache Software License, Version 1.1
 *
 * Copyright (c) 1999-2001 The Apache Software Foundation.  All rights
 * reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 *
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in
 *    the documentation and/or other materials provided with the
 *    distribution.
 *
 * 3. The end-user documentation included with the redistribution, if
 *    any, must include the following acknowlegement:
 *       "This product includes software developed by the
 *        Apache Software Foundation (http://www.apache.org/)."
 *    Alternately, this acknowlegement may appear in the software itself,
 *    if and wherever such third-party acknowlegements normally appear.
 *
 * 4. The names "The Jakarta Project", "Commons", and "Apache Software
 *    Foundation" must not be used to endorse or promote products derived
 *    from this software without prior written permission. For written
 *    permission, please contact apache@apache.org.
 *
 * 5. Products derived from this software may not be called "Apache"
 *    nor may "Apache" appear in their names without prior written
 *    permission of the Apache Group.
 *
 * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED.  IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
 * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
 * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
 * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 * ====================================================================
 *
 * This software consists of voluntary contributions made by many
 * individuals on behalf of the Apache Software Foundation.  For more
 * information on the Apache Software Foundation, please see
 * <http://www.apache.org/>.
 *
 */

package simple.workflow;


import org.apache.commons.workflow.Activity;


/**
 * <p>The <strong>Registry</strong> collection into which multiple Process
 * and Activity static descriptions can be stored and retrieved by
 * String-valued keys.</p>
 * <p>This implementation only addresses Activities, and ignores
 * Processes</p>
 *
 * @version $Revision: 1.1 $ $Date: 2001/09/28 01:01:49 $
 * @author Craig R. McClanahan
 * @author Ted Husted
 */

public interface Registry {


    /**
     * The unique identifier of this Registry.
     */
    public static String REGISTRY =
        "org.apache.commons.workflow.REGISTRY";


    // ------------------------------------------------------------- Properties


    /**
     * Return the unique identifier of this Registry.
     */
    public String getId();


    /**
     * Set the unique identifier of this Registry.
     *
     * @param id The new unique identifier
     */
    public void setId(String id);


    // --------------------------------------------------------- Public Methods


    /**
     * Add a new Activity to the collection.
     *
     * @param id The unique identifier
     * @param activity The new activity to be added
     */
    public void addActivity(Activity activity);


    /**
     * Return Activity for given ID.
     *
     * @param id The unique identifier

     */
    public Activity getActivity(String id);


    /**
     * Clear any existing Activities associated with this Registry.
     */
    public void clearActivities();


    /**
     * Return the set of Activities associated with this Registry.
     */
    public Activity[] getActivities();


    /**
     * Set the set of Steps associated with this Activity, replacing any
     * existing ones.
     *
     * @param steps The new set of steps.
     */
    public void setActivities(Activity activities[]);


    /**
     * Perform any optimizations or related tasks on Registry once it is
     * populated with Activities.
     *
     */
    public void initActivities();


}