View Javadoc

1   /**
2    * Copyright 2004-2013 The Kuali Foundation
3    *
4    * Licensed under the Educational Community License, Version 2.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/ecl2.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.student.contract.model.test.source;
17  
18  import java.util.Date;
19  
20  /**
21   * Create and last update info for the structure.
22   * This is optional and treated as read only since the data is set by the
23   * internals of the service during maintenance operations.
24   * 
25   * @author nwright
26   */
27  public interface Meta {
28  
29      /**
30       * Name: Version Indicator
31       *
32       * This is the field used for optimistic locking.
33       *
34       * An indicator of the version of the thing being described with this meta
35       * information. This is set by the service implementation and will be used to
36       * determine conflicts in updates.
37       *
38       *
39       */
40      public String getVersionInd();
41  
42      /**
43       * Name: Create Time
44       *
45       * The date and time the thing being described with this meta information was last
46       * updated
47       */
48      public Date getCreateTime();
49  
50      /**
51       * Name: Create Id
52       *
53       * The principal who created the thing being described with this meta information
54       */
55      public String getCreateId();
56  
57      /**
58       * Name: Update Time
59       *
60       * The date and time the thing being described with this meta information was last
61       * updated
62       */
63      public Date getUpdateTime();
64  
65      /**
66       * Name: Update Id
67       * 
68       * The principal who last updated the thing being described with this meta
69       * information
70       */
71      public String getUpdateId();
72  }
73