001    /**
002     * Copyright 2005-2012 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     */
016    package org.kuali.rice.coreservice.api.namespace;
017    
018    import org.kuali.rice.core.api.mo.common.Coded;
019    import org.kuali.rice.core.api.mo.common.GloballyUnique;
020    import org.kuali.rice.core.api.mo.common.Versioned;
021    import org.kuali.rice.core.api.mo.common.active.Inactivatable;
022    
023    /**
024     * Defines the contract for a Namespace.  A namespace is a mechanism for partitioning of data into
025     * areas of responsibility.  Since much of the Kuali Rice middleware is shared across multiple integrating
026     * applications, this notion of a namespace is a critical element in keeping related data elements
027     * grouped together and isolated from those to which they should have no relation or access.
028     */
029    public interface NamespaceContract extends Versioned, GloballyUnique, Inactivatable, Coded {
030    
031        /**
032         * This the id of the application which owns this Namespace.  If this namespace has no application owner,
033         * then this method will return null.
034         *
035         * <p>
036         * It is a way of assigning the Namespace to a specific rice application or rice ecosystem.
037         * </p>
038         *
039         * @return application id
040         */
041        String getApplicationId();
042    
043        /**
044         * This the name for the Namespace.  This can be null or a blank string.
045         *
046         * @return name
047         */
048        String getName();
049    }