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.service.technical.IndexServiceImpl;
   5
   6 /**
   7  * Stand proxy for entities such as Study and Knowledge Element returned by Lucene-based searches.
   8  * This interface provides access to properties of searched entities which can be presented in a result search list
   9  * before loading the corresponding persistent objects from the database (reason for most properties to be returned as
  10  * strings).
  11  * One of these properties is the internal persistent identifier of the object represented by a proxy allowing the
  12  * user of this interface to load the object from the database.
  13  *
  14  * @see IndexServiceImpl
  15  * @see IndexServiceImpl.ObjectProxy
  16  * @author    Daniel Brunier-Coulin
  17  * @copyright OPEN CASCADE 2012
  18  */
  19
  20 public interface Proxy {
  21
  22         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     Long       getIndex ();
  30
  31         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     String        getReference ();
  39
  40         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     String        getType ();
  48 }