| Classes in this File | Line Coverage | Branch Coverage | Complexity | ||||
| HasMeta |
|
| 1.0;1 |
| 1 | /** | |
| 2 | * Copyright 2010 The Kuali Foundation | |
| 3 | * | |
| 4 | * Licensed under the Educational Community License, Version 2.0 (the | |
| 5 | * "License"); you may not use this file except in compliance with the | |
| 6 | * License. You may obtain a copy of the License at | |
| 7 | * | |
| 8 | * http://www.osedu.org/licenses/ECL-2.0 | |
| 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 | |
| 13 | * implied. See the License for the specific language governing | |
| 14 | * permissions and limitations under the License. | |
| 15 | */ | |
| 16 | ||
| 17 | package org.kuali.student.r2.common.infc; | |
| 18 | ||
| 19 | /** | |
| 20 | * A common service pattern for entities. This interface is applied to | |
| 21 | * entities the hold Meta information. Typically, any entity that is | |
| 22 | * created or updated through service operations. | |
| 23 | * | |
| 24 | * @author nwright | |
| 25 | */ | |
| 26 | ||
| 27 | public interface HasMeta { | |
| 28 | ||
| 29 | /** | |
| 30 | * Create and last update info for the structure. This is optional | |
| 31 | * and treated as read only since the data is set by the internals | |
| 32 | * of the service during maintenance operations. | |
| 33 | * | |
| 34 | * Contains audit trail information about the creation and last | |
| 35 | * update of this object Also contains the version ind used for | |
| 36 | * optimistic locking. | |
| 37 | * | |
| 38 | * Attempts to set or update should result in a ReadOnlyException | |
| 39 | * being thrown. | |
| 40 | * | |
| 41 | * @name Meta | |
| 42 | * @readOnly | |
| 43 | * @required on updates | |
| 44 | */ | |
| 45 | public Meta getMeta(); | |
| 46 | } |