001/**
002 * Copyright 2005-2016 The Kuali Foundation
003 *
004 * Licensed under the Educational Community 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.opensource.org/licenses/ecl2.php
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 */
016package org.kuali.rice.krad.data.metadata;
017
018import java.util.Map;
019
020import org.kuali.rice.krad.data.metadata.DataObjectMetadata;
021
022/**
023 * Public (read-only) interface to MetadataProvider stack.
024 * Implementations must be thread safe.
025 *
026 * @author Kuali Rice Team (rice.collab@kuali.org)
027 */
028public interface MetadataRepository {
029
030    /**
031     * Obtain metadata for specified data object type.
032     *
033     * @param type the data object type for which to return metadata
034     * @return DataObjectMetadata for the type or null if none is known
035     */
036        DataObjectMetadata getMetadata(Class<?> type);
037
038    /**
039     * Returns all metadata for all known data object types.
040     *
041     * @return all metadata for all known data object types
042     */
043        Map<Class<?>, DataObjectMetadata> getAllMetadata();
044
045    /**
046     * Indicates whether or not the repository contains metadata for the given type.
047     *
048     * @param type the type to check metadata for
049     * @return true if the repository contains metadata for the given type, false otherwise
050     */
051    boolean contains(Class<?> type);
052
053}