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 PageDescriptor} definitions.
020     *
021     * @author Keith Donald
022     * @author Rogan Dawes
023     *
024     */
025    public interface PageDescriptorRegistry {
026    
027        /**
028         * Returns an array of all the page descriptors in the registry.
029         *
030         * @return An array of all the page descriptors in the registry. The array may be empty but
031         * will never be null.
032         */
033        public PageDescriptor[] getPageDescriptors();
034    
035        /**
036         * Returns the page descriptor with the given identifier, or null if no such descriptor
037         * exists in the registry.
038         *
039         * @param pageDescriptorId The id of the page descriptor to be returned.
040         * @return The page descriptor with the given id, or null.
041         *
042         * @throws IllegalArgumentException if {@code pageDescriptorId} is null.
043         */
044        public PageDescriptor getPageDescriptor(String pageDescriptorId);
045    
046    }