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.location.framework.campus;
017
018import org.kuali.rice.core.api.mo.common.active.MutableInactivatable;
019import org.kuali.rice.krad.bo.ExternalizableBusinessObject;
020import org.kuali.rice.location.api.campus.CampusContract;
021import org.kuali.rice.location.api.campus.CampusTypeContract;
022
023/**
024 * TODO: Likely should remove all methods from this interface after KULRICE-7170 is fixed
025 */
026public interface CampusEbo extends CampusContract, ExternalizableBusinessObject, MutableInactivatable {
027
028    /**
029     * This is the name for the Campus.
030     *
031     * <p>
032     * It is a name a campus.
033     * </p>
034     *
035     * @return name for Campus.
036     */
037    String getName();
038
039    /**
040     * This is the short name for the Campus.
041     *
042     * <p>
043     * It is a shorter name for a campus.
044     * </p>
045     *
046     * @return short name for Campus.
047     */
048    String getShortName();
049
050    /**
051     * This is the campus type for the Campus.
052     *
053     * <p>
054     * It is a object that defines the type of a campus.
055     * </p>
056     *
057     * @return short name for Campus.
058     */
059    CampusTypeContract getCampusType();
060    
061    /**
062     * The code value for this object.  In general a code value cannot be null or a blank string.
063     *
064     * @return the code value for this object.
065     */
066    String getCode();
067    
068    /**
069     * Returns the version number for this object.  In general, this value should only
070     * be null if the object has not yet been stored to a persistent data store.
071     * This version number is generally used for the purposes of optimistic locking.
072     * 
073     * @return the version number, or null if one has not been assigned yet
074     */
075    Long getVersionNumber();
076    
077    /**
078     * Return the globally unique object id of this object.  In general, this value should only
079     * be null if the object has not yet been stored to a persistent data store.
080     * 
081     * @return the objectId of this object, or null if it has not been set yet
082     */
083    String getObjectId();
084    
085    /**
086     * The active indicator for an object.
087     *
088     * @return true if active false if not.
089     */
090    boolean isActive();
091    
092    /**
093     * Sets the record to active or inactive.
094     */
095    void setActive(boolean active);
096}