| Classes in this File | Line Coverage | Branch Coverage | Complexity | ||||
| GloballyUnique |
|
| 1.0;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 globally unique identifier. | |
| 20 | * This globally unique identifier is referred as the "objectId" of the object. The means by | |
| 21 | * which it is generated or general format of this value is not specified, however it is | |
| 22 | * intended that some sort of GUID algorithm is used to generate this value, such as the one | |
| 23 | * provided by {@link java.util.UUID}. | |
| 24 | * | |
| 25 | * @author Kuali Rice Team (rice.collab@kuali.org) | |
| 26 | * | |
| 27 | */ | |
| 28 | public interface GloballyUnique { | |
| 29 | ||
| 30 | /** | |
| 31 | * Return the globally unique object id of this object. In general, this value should only | |
| 32 | * be null if the object has not yet been stored to a persistent data store. | |
| 33 | * | |
| 34 | * @return the objectId of this object, or null if it has not been set yet | |
| 35 | */ | |
| 36 | String getObjectId(); | |
| 37 | ||
| 38 | } |