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. This interface provides access to
   8  * properties of searched entities which can be presented in a result search list before loading the corresponding persistent objects from
   9  * the database (reason for most properties to be returned as strings). One of these properties is the internal persistent identifier of the
  10  * object represented by a proxy allowing the user of this interface to load the object from the database.
  11  *
  12  * @see IndexServiceImpl
  13  * @see IndexServiceImpl.ObjectProxy
  14  * @author Daniel Brunier-Coulin
  15  * @copyright OPEN CASCADE 2012
  16  */
  17
  18 public interface Proxy {
  19
  20         /**
  21          * Get the name of the object author.
  22          *
  23          * @return the author name
  24          */
  25         String getAuthorName();
  26
  27         /**
  28          * Returns the internal persistent identifier of the object represented by this proxy. The returned identifier can be used for selecting
  29          * the corresponding persistent object from the database.
  30          *
  31          * @return the internal persistent identifier of the object represented by this proxy.
  32          */
  33         Long getIndex();
  34
  35         /**
  36          * Get the progress state of the object.
  37          *
  38          * @return the progress state
  39          */
  40         ProgressState getProgressState();
  41
  42         /**
  43          * Returns the external reference number of the object represented by this proxy. The returned reference is formated according to the
  44          * format defined in the configuration file of the application.
  45          *
  46          * @return the external reference number of the object represented by this proxy.
  47          */
  48         String getReference();
  49
  50         /**
  51          * Get a title of the object.
  52          *
  53          * @return the object title
  54          */
  55         String getTitle();
  56
  57         /**
  58          * Returns the type of the object represented by this proxy. Depending on the implementation, the returned type may or may not be
  59          * localized in the current locale of final user.
  60          *
  61          * @return the type of the object represented by this proxy.
  62          */
  63         String getType();
  64 }