001/**
002 * Copyright 2005-2018 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.kim.api.type;
017
018import org.kuali.rice.core.api.mo.common.GloballyUnique;
019import org.kuali.rice.core.api.mo.common.Identifiable;
020import org.kuali.rice.core.api.mo.common.Versioned;
021import org.kuali.rice.core.api.mo.common.active.Inactivatable;
022
023import java.util.List;
024
025/**
026 * This is the contract for a KimType.  A KimType is a metadata wrapper around a
027 * kim type service which aides in attribute resolution.
028 */
029public interface KimTypeContract extends Versioned, GloballyUnique, Identifiable, Inactivatable {
030
031    /**
032     * The service name used to resolve attribute values.
033     *
034     * @return the service name
035     */
036    String getServiceName();
037
038    /**
039     * The namespace code that this kim type belongs too.
040     *
041     * @return namespace code
042     */
043    String getNamespaceCode();
044
045    /**
046     * The name of the kim type.
047     *
048     * @return the name
049     */
050    String getName();
051
052    /**
053     * The list of attribute definitions associated with the kim type. This cannot be null.  If no
054     * attribute definitions are associated with the kim type then this will return an empty collection.
055     *
056     * @return the list of attribute definitions
057     */
058    List<? extends KimTypeAttributeContract> getAttributeDefinitions();
059}