Workspace/Siman-Common/src/org/splat/service/dto/Proxy.java

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