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.krms.api.repository.type;
017
018import org.kuali.rice.core.api.mo.common.Identifiable;
019import org.kuali.rice.core.api.mo.common.Versioned;
020import org.kuali.rice.core.api.mo.common.active.Inactivatable;
021
022import java.util.List;
023
024/**
025 * Defines the contract for a KRMS type definition.
026 * <p>A KrmsTypeDefinition is a metadata wrapper around a KRMS type service. This contains a
027 * collection of related attributes. This also provides the name of the service used to resolve these attributes.
028 * </p>
029 */
030public interface KrmsTypeDefinitionContract extends Identifiable, Inactivatable, Versioned {
031
032        /**
033         * Returns the name of the KrmsTypeDefinition.  All KrmsTypeDefinitions have a name, so this
034     * value can not be null or blank. The combination of name and namespace must
035     * be unique within the entire KRMS system.
036         *
037         * @return the name of this KrmsTypeDefinition
038         */
039        public String getName();
040
041        /**
042         * Returns the namespace to which the KrmsTypeDefinition belongs. All type definitions
043     * exist within a namespace. This value can not be null or blank. The combination
044     * of name and namespace must be unique within the entire KRMS system.
045         *
046         * @return the namespace of this KrmsTypeDefinition
047         */
048        public String getNamespace();
049
050        /**
051         * Returns the name of the service used to resolve attribute values. The service name
052     * may be null or blank.
053         * 
054         * @return the service name of this KrmsTypeDefinition
055         */
056        public String getServiceName();
057
058        /**
059         * Returns a list of attributes associated with the KRMS type definition.
060     * This can be empty, but will never be null. If no attribute definitions are associated with the KRMS type
061     * then this will return an empty collection.
062         * 
063         * @return the list of KrmsTypeAttributeContract attribute definition contracts
064         */
065        public List<? extends KrmsTypeAttributeContract> getAttributes();
066}