Coverage Report - org.kuali.rice.core.api.mo.common.Versioned
 
Classes in this File Line Coverage Branch Coverage Complexity
Versioned
N/A
N/A
1
 
 1  
 /*
 2  
  * Copyright 2011 The Kuali Foundation
 3  
  *
 4  
  * Licensed under the Educational Community License, Version 1.0 (the "License");
 5  
  * you may not use this file except in compliance with the License.
 6  
  * You may obtain a copy of the License at
 7  
  *
 8  
  * http://www.opensource.org/licenses/ecl1.php
 9  
  *
 10  
  * Unless required by applicable law or agreed to in writing, software
 11  
  * distributed under the License is distributed on an "AS IS" BASIS,
 12  
  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 13  
  * See the License for the specific language governing permissions and
 14  
  * limitations under the License.
 15  
  */
 16  
 package org.kuali.rice.core.api.mo.common;
 17  
 
 18  
 /**
 19  
  * This interface can be used to identify a model object which has a version number
 20  
  * that is used for the purposes of optimistic locking.
 21  
  * 
 22  
  * @author Kuali Rice Team (rice.collab@kuali.org)
 23  
  *
 24  
  */
 25  
 public interface Versioned {
 26  
 
 27  
         
 28  
         /**
 29  
          * Returns the version number for this object.  In general, this value should only
 30  
          * be null if the object has not yet been stored to a persistent data store.
 31  
          * This version number is generally used for the purposes of optimistic locking.
 32  
          * 
 33  
          * @return the version number, or null if one has not been assigned yet
 34  
          */
 35  
         Long getVersionNumber();
 36  
         
 37  
 }