View Javadoc

1   /**
2    * Copyright 2005-2015 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.rice.location.framework.county;
17  
18  import org.kuali.rice.core.api.mo.common.active.MutableInactivatable;
19  import org.kuali.rice.krad.bo.ExternalizableBusinessObject;
20  import org.kuali.rice.location.api.county.CountyContract;
21  
22  /**
23   * TODO: Likely should remove all methods from this interface after KULRICE-7170 is fixed
24   */
25  public interface CountyEbo extends CountyContract, ExternalizableBusinessObject, MutableInactivatable {
26  
27      /**
28       * This the postal country code for the County.  This cannot be null or a blank string.
29       *
30       * @return postal country code
31       */
32      String getCountryCode();
33  
34      /**
35       * This the postal state code for the County.  This cannot be null or a blank string.
36       *
37       * @return postal state code
38       */
39      String getStateCode();
40  
41      /**
42       * This the name for the County.  This cannot be null or a blank string.
43       *
44       * @return name
45       */
46      String getName();
47      
48      /**
49       * The code value for this object.  In general a code value cannot be null or a blank string.
50       *
51       * @return the code value for this object.
52       */
53      String getCode();
54      
55      /**
56       * Returns the version number for this object.  In general, this value should only
57       * be null if the object has not yet been stored to a persistent data store.
58       * This version number is generally used for the purposes of optimistic locking.
59       * 
60       * @return the version number, or null if one has not been assigned yet
61       */
62      Long getVersionNumber();
63      
64      /**
65       * The active indicator for an object.
66       *
67       * @return true if active false if not.
68       */
69      boolean isActive();
70      
71      /**
72       * Sets the record to active or inactive.
73       */
74      void setActive(boolean active);
75  }