1 package org.splat.service.dto;
3 import org.splat.dal.bo.som.ProgressState;
4 import org.splat.service.technical.IndexServiceImpl;
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.
12 * @see IndexServiceImpl
13 * @see IndexServiceImpl.ObjectProxy
14 * @author Daniel Brunier-Coulin
15 * @copyright OPEN CASCADE 2012-2015
18 public interface Proxy {
21 * Get the name of the object author.
23 * @return the author name
25 String getAuthorName();
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.
31 * @return the internal persistent identifier of the object represented by this proxy.
36 * Get the progress state of the object.
38 * @return the progress state
40 ProgressState getProgressState();
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.
46 * @return the external reference number of the object represented by this proxy.
48 String getReference();
51 * Get a title of the object.
53 * @return the object title
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.
61 * @return the type of the object represented by this proxy.