001    /**
002     * Copyright 2005-2013 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.kim.framework.role;
017    
018    import org.kuali.rice.kim.api.role.RoleContract;
019    import org.kuali.rice.krad.bo.ExternalizableBusinessObject;
020    
021    /**
022     * TODO: Likely should remove all methods from this interface after KULRICE-7170 is fixed
023     */
024    public interface RoleEbo extends RoleContract, ExternalizableBusinessObject {
025        
026        /**
027         * A namespace for this role.  A namespace for a role identifies the system/module to which this role applies.
028         *
029         * @return Namespace for the role.
030         */
031        String getNamespaceCode();
032    
033        /**
034         * The human readable name for this role.
035         *
036         * @return Human readable role name.
037         */
038        String getName();
039    
040        /**
041         * A full textual description of this role.  This String should provide a verbose description of the role, what
042         * it is meant to provide to principals assigned to it, and what permissions it implies.
043         *
044         * @return Description of the role.
045         */
046        String getDescription();
047    
048        /**
049         * Provides the associated KimType identifier for this role.  This controls what additional attributes
050         * are available.
051         *
052         * @return KimType Id
053         */
054        String getKimTypeId();
055        
056        /**
057         * Returns the version number for 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         * This version number is generally used for the purposes of optimistic locking.
060         * 
061         * @return the version number, or null if one has not been assigned yet
062         */
063        Long getVersionNumber();
064        
065        /**
066         * The unique identifier for an object.  This can be null.
067         *
068         * @return the id
069         */
070        String getId();
071        
072        /**
073         * The active indicator for an object.
074         *
075         * @return true if active false if not.
076         */
077        boolean isActive();
078        
079        /**
080         * Return the globally unique object id of this object.  In general, this value should only
081         * be null if the object has not yet been stored to a persistent data store.
082         * 
083         * @return the objectId of this object, or null if it has not been set yet
084         */
085        String getObjectId();
086    }