View Javadoc

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.dto;
18  
19  import java.io.Serializable;
20  
21  import javax.xml.bind.annotation.XmlAttribute;
22  import javax.xml.bind.annotation.XmlTransient;
23  
24  import org.kuali.student.r2.common.infc.KeyEntity;
25  
26  /**
27   * Provides basic method for entities identified by a key.
28   *
29   * @author tom
30   */
31  
32  @SuppressWarnings("serial")
33  @XmlTransient
34  public abstract class KeyEntityInfo 
35      extends EntityInfo 
36      implements KeyEntity, Serializable {
37  
38      @XmlAttribute
39      private String key;
40  
41  
42      /**
43       * Constructs a new KeyEntityInfo.
44       */
45      public KeyEntityInfo() {
46      }
47  
48      /**
49       * Constructs a new KeyEntityInfo from another KeyEntity.
50       *
51       * @param keyEntity the KeyEntity to copy
52       */
53      public KeyEntityInfo(KeyEntity keyEntity) {
54          super(keyEntity);
55          if (null != keyEntity) {
56              this.key = keyEntity.getKey();
57          }
58      }
59  
60      @Override
61      public String getKey() {
62          return key;
63      }
64      
65      public void setKey(String key) {
66          this.key = key;
67      }
68  }