001    /*
002     * Copyright 1999-2001,2004 The Apache Software Foundation.
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    
017    package org.apache.commons.workflow;
018    
019    
020    /**
021     * <p>Implementing <strong>Descriptors</strong> indicates that the corresponding
022     * object has an associated list of <code>Descriptor</code> objects associated
023     * with it, which can be manipulated through the methods defined in this
024     * interface.  The documentation for each implementing object will describe
025     * the semantics of associated <code>Descriptor</code> object list.
026     * </p>
027     *
028     * @version $Revision: 155475 $ $Date: 2005-02-26 13:31:11 +0000 (Sat, 26 Feb 2005) $
029     * @author Craig R. McClanahan
030     */
031    
032    public interface Descriptors {
033    
034    
035        // --------------------------------------------------------- Public Methods
036    
037    
038        /**
039         * Add a new <code>Descriptor</code> to the set associated with
040         * this object.
041         *
042         * @param descriptor The Descriptor to be added
043         */
044        public void addDescriptor(Descriptor descriptor);
045    
046    
047        /**
048         * Return the set of <code>Descriptor</code> objects associated with
049         * this object, in the order that they were originally added.
050         */
051        public Descriptor[] findDescriptors();
052    
053    
054        /**
055         * Remove an existing <code>Descriptor</code> from the set associated
056         * with this object.
057         *
058         * @param descriptor The Descriptor to be removed
059         */
060        public void removeDescriptor(Descriptor descriptor);
061    
062    
063    }