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.framework.namespace;
017    
018    import org.kuali.rice.core.api.mo.common.active.MutableInactivatable;
019    import org.kuali.rice.coreservice.api.namespace.NamespaceContract;
020    import org.kuali.rice.krad.bo.ExternalizableBusinessObject;
021    
022    /**
023     * TODO: Likely should remove all methods from this interface after KULRICE-7170 is fixed
024     */
025    public interface NamespaceEbo extends NamespaceContract,
026                    ExternalizableBusinessObject, MutableInactivatable {
027    
028        /**
029         * This the id of the application which owns this Namespace.  If this namespace has no application owner,
030         * then this method will return null.
031         *
032         * <p>
033         * It is a way of assigning the Namespace to a specific rice application or rice ecosystem.
034         * </p>
035         *
036         * @return application id
037         */
038        String getApplicationId();
039    
040        /**
041         * This the name for the Namespace.  This can be null or a blank string.
042         *
043         * @return name
044         */
045        String getName();
046            
047            /**
048             * Returns the version number for this object.  In general, this value should only
049             * be null if the object has not yet been stored to a persistent data store.
050             * This version number is generally used for the purposes of optimistic locking.
051             * 
052             * @return the version number, or null if one has not been assigned yet
053             */
054            Long getVersionNumber();
055            
056            /**
057             * Return the globally unique object id of this object.  In general, this value should only
058             * be null if the object has not yet been stored to a persistent data store.
059             * 
060             * @return the objectId of this object, or null if it has not been set yet
061             */
062            String getObjectId();
063            
064            /**
065         * The active indicator for an object.
066         *
067         * @return true if active false if not.
068         */
069        boolean isActive();
070        
071        /**
072         * Sets the record to active or inactive.
073         */
074        void setActive(boolean active);
075        
076        /**
077             * The code value for this object.  In general a code value cannot be null or a blank string.
078             *
079             * @return the code value for this object.
080             */
081            String getCode();
082    }