View Javadoc
1   package fr.ifremer.tutti.persistence.entities;
2   
3   /*
4    * #%L
5    * Tutti :: Persistence
6    * %%
7    * Copyright (C) 2012 - 2014 Ifremer
8    * %%
9    * This program is free software: you can redistribute it and/or modify
10   * it under the terms of the GNU General Public License as
11   * published by the Free Software Foundation, either version 3 of the 
12   * License, or (at your option) any later version.
13   * 
14   * This program is distributed in the hope that it will be useful,
15   * but WITHOUT ANY WARRANTY; without even the implied warranty of
16   * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
17   * GNU General Public License for more details.
18   * 
19   * You should have received a copy of the GNU General Public 
20   * License along with this program.  If not, see
21   * <http://www.gnu.org/licenses/gpl-3.0.html>.
22   * #L%
23   */
24  
25  import fr.ifremer.tutti.persistence.TuttiPersistence;
26  
27  /**
28   * Contract to place on enumeration that must be synched to field inside this class.
29   *
30   * {@link #getFieldValue()} will be filled when {@link TuttiPersistence#init()} method is
31   * invoked and then the {@link #isInit()} will return true.
32   *
33   * @param <O> type of fieldValue
34   * @since 1.0.2
35   */
36  public interface TuttiEnumerable<O> {
37  
38      String getFieldName();
39  
40      O getFieldValue();
41  
42      void setFieldValue(O fieldValue);
43  
44      boolean isInit();
45  
46      void setInit(boolean init);
47  }