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

   1 /*****************************************************************************
   2  * Company         OPEN CASCADE
   3  * Application     SIMAN
   4  * File            $Id$
   5  * Creation date   20.02.2013
   6  * @author         $Author$
   7  * @version        $Revision$
   8  * @copyright      OPEN CASCADE 2012
   9  *****************************************************************************/
  10
  11 package org.splat.service.dto;
  12
  13 import java.io.Serializable;
  14
  15 import org.splat.dal.bo.som.ProgressState;
  16
  17 /**
  18  * Study DTO class. Used in study search results.
  19  *
  20  * @author <a href="mailto:roman.kozlov@opencascade.com">Roman Kozlov (RKV)</a>
  21  */
  22 public class StudyDTO implements Proxy, Serializable {
  23         /**
  24          * Study persistent id.
  25          */
  26         private transient final Long _rid;
  27         /**
  28          * Study reference.
  29          */
  30         private transient final String _sid;
  31         /**
  32          * Study progress state.
  33          */
  34         private transient final ProgressState _state;
  35         /**
  36          * Study title.
  37          */
  38         private transient final String _title;
  39         /**
  40          * Study name.
  41          */
  42         private transient final String _name;
  43         /**
  44          * Type.
  45          */
  46         private transient String _type;
  47         /**
  48          * Serialization version id.
  49          */
  50         private static final long serialVersionUID = -4386494192709562221L;
  51
  52         /**
  53          * Costructor from properties.
  54          *
  55          * @param id
  56          *            study persistent id
  57          * @param reference
  58          *            study reference
  59          * @param state
  60          *            study progress state
  61          * @param title
  62          *            study title
  63          * @param author
  64          *            study author display name
  65          */
  66         public StudyDTO(final Long id, final String reference,
  67                         final ProgressState state, final String title, final String author) {
  68                 _rid = id;
  69                 _sid = reference;
  70                 _state = state;
  71                 _title = title;
  72                 _name = author;
  73         }
  74
  75         /**
  76          * {@inheritDoc}
  77          *
  78          * @see org.splat.service.dto.Proxy#getAuthorName()
  79          */
  80         public String getAuthorName() {
  81                 return _name;
  82         }
  83
  84         /**
  85          * {@inheritDoc}
  86          *
  87          * @see org.splat.service.dto.Proxy#getIndex()
  88          */
  89         public Long getIndex() {
  90                 return _rid;
  91         }
  92
  93         /**
  94          * {@inheritDoc}
  95          *
  96          * @see org.splat.service.dto.Proxy#getProgressState()
  97          */
  98         public ProgressState getProgressState() {
  99                 return _state;
 100         }
 101
 102         /**
 103          * {@inheritDoc}
 104          *
 105          * @see org.splat.service.dto.Proxy#getReference()
 106          */
 107         public String getReference() {
 108                 return _sid;
 109         }
 110
 111         /**
 112          * {@inheritDoc}
 113          *
 114          * @see org.splat.service.dto.Proxy#getTitle()
 115          */
 116         public String getTitle() {
 117                 return _title;
 118         }
 119
 120         /**
 121          * {@inheritDoc}
 122          *
 123          * @see org.splat.service.dto.Proxy#getType()
 124          */
 125         public String getType() {
 126                 return _type;
 127         }
 128 }