Workspace/Siman-Common/src/org/splat/som/Proxy.java

   1 package org.splat.som;
   2 /**
   3  * Stand proxy for entities such as Study and Knowledge Element returned by Lucene-based searches.
   4  * This interface provides access to properties of searched entities which can be presented in a result search list
   5  * before loading the corresponding persistent objects from the database (reason for most properties to be returned as
   6  * strings).
   7  * One of these properties is the internal persistent identifier of the object represented by a proxy allowing the
   8  * user of this interface to load the object from the database.
   9  *
  10  * @see Database#selectStudiesWhere(Study.Properties...)
  11  * @see Database#selectKnowledgeElementsWhere(KnowledgeElement.Properties)
  12  * @see Database#selectStudy(int)
  13  * @see Database#selectKnowledgeElement(int)
  14  * @see Index
  15  * @see Index.ObjectProxy
  16  * @author    Daniel Brunier-Coulin
  17  * @copyright OPEN CASCADE 2012
  18  */
  19
  20 public interface Proxy {
  21
  22         public String        getAuthorName ();
  23
  24 /**
  25  * Returns the internal persistent identifier of the object represented by this proxy. The returned identifier can be used
  26  * for selecting the corresponding persistent object from the database.
  27  * @return the internal persistent identifier of the object represented by this proxy.
  28  */
  29     public Integer       getIndex ();
  30
  31         public ProgressState getProgressState ();
  32
  33 /**
  34  * Returns the external reference number of the object represented by this proxy. The returned reference is formated
  35  * according to the format defined in the configuration file of the application.
  36  * @return the external reference number of the object represented by this proxy.
  37  */
  38     public String        getReference ();
  39
  40         public String        getTitle ();
  41
  42 /**
  43  * Returns the type of the object represented by this proxy. Depending on the implementation, the returned type may or
  44  * may not be localized in the current locale of final user.
  45  * @return the type of the object represented by this proxy.
  46  */
  47     public String        getType ();
  48 }