001    /*
002     * Copyright 2002-2004 the original author or authors.
003     * 
004     * Licensed under the Apache License, Version 2.0 (the "License"); you may not
005     * use this file except in compliance with the License. You may obtain a copy of
006     * 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, WITHOUT
012     * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
013     * License for the specific language governing permissions and limitations under
014     * the License.
015     */
016    package org.springframework.richclient.application;
017    
018    /**
019     * A registry for {@link ViewDescriptor} definitions.
020     *
021     * @author Keith Donald
022     *
023     */
024    public interface ViewDescriptorRegistry {
025        
026        /**
027         * Returns an array of all the view descriptors in the registry.
028         *
029         * @return An array of all the view descriptors in the registry. The array may be empty but
030         * will never be null.
031         */
032        public ViewDescriptor[] getViewDescriptors();
033    
034        /**
035         * Returns the view descriptor with the given identifier, or null if no such descriptor
036         * exists in the registry.
037         *
038         * @param viewDescriptorId The id of the view descriptor to be returned.
039         * @return The view descriptor with the given id, or null.
040         * 
041         * @throws IllegalArgumentException if {@code viewDescriptorId} is null.
042         */
043        public ViewDescriptor getViewDescriptor(String viewDescriptorId);
044        
045    }