SavedMessage.java

Go to the documentation of this file.

/*
 * Project: Server for annotations sharing
 * Author: Ing. Jaroslav Dytrych idytrych@fit.vutbr.cz
 * File: SavedMessage.java
 * Description: Class represent saved message that unavailable StoryScope
 */

/**
 * @file SavedMessage.java
 *
 * @brief Class represent message that belongs to the StoryScope and it was 
 * saved because StoryScope was not available
 */

package cz.vutbr.fit.knot.annotations.modules.StoryscopeInterface;

import java.io.Serializable;
import javax.persistence.*;

/**
 * Class represent message that belongs to the StoryScope and it was 
 * saved because StoryScope was not available.
 * 
 * @brief This class represent saved message that belongs unavailable StoryScope.
 * @author Martin Petr (xpetrm05)
 */
@Entity
@Table(name = "savedMessages")
@NamedQueries({
  @NamedQuery(name = "SavedMessage.findAll", query = "SELECT s FROM SavedMessage s"),
  @NamedQuery(name = "SavedMessage.findById", query = "SELECT s FROM SavedMessage s WHERE s.id = :id"),
  @NamedQuery(name = "SavedMessage.findByStoryScopeId", query = "SELECT s FROM SavedMessage s WHERE s.storyScopeId = :storyScopeId"),
  @NamedQuery(name = "SavedMessage.findByStoryScopeAndType", query = "SELECT s FROM SavedMessage s WHERE s.storyScopeId = :storyScopeId AND s.messageType = :messageType")})
public class SavedMessage implements Serializable {
  /** Id of message */
  @Id
  @GeneratedValue(strategy = GenerationType.IDENTITY)
  @Basic(optional = false)
  @Column(name = "id")
  private Integer id;
  
  /** Id of StoryScope that this message belongs */
  @Basic(optional = false)
  @Column(name = "storyScopeId")
  private Integer storyScopeId;
  
  /** Type of message (add,change,remove) */
  @Basic(optional = false)
  @Column(name = "messageType")
  private int messageType;
  
  /** Saved message*/
  @Basic(optional = false)
  @Column(name = "message")
  private String message;
  
  /** Add message indicator */
  public static final int MESSAGE_ADD = 0;
  /** Change message indicator */
  public static final int MESSAGE_CHANGE = 1;
  /** Remove message indicator */
  public static final int MESSAGE_DELETE = 2;

  /**
   * Constructor
   */
  public SavedMessage() {
  }

  /**
   * Constructor
   *
   * @param storyScopeId id of StoryScope that this message belongs
   * @param messageType type of message (add,change,remove)
   * @param message messsage content to store
   */
  public SavedMessage(Integer storyScopeId, int messageType, String message) {
    this.storyScopeId = storyScopeId;
    this.messageType = messageType;
    this.message = message;
  }

  /**
   * Gets id of saved message
   *
   * @return Returns id of saved message
   */
  public Integer getId() {
    return id;
  }

  /**
   * Sets id of StoryScope
   *
   * @param id Id of StoryScope
   */
  public void setId(Integer id) {
    this.id = id;
  }

  /**
   * Gets id of StoryScope that this message belongs
   *
   * @return Returns id of StoryScope
   */
  public Integer getStoryScopeId() {
    return storyScopeId;
  }

  /**
   * Sets id of StoryScope that this message belongs
   *
   * @param storyScopeId Id of StoryScope
   */
  public void setStoryScopeId(Integer storyScopeId) {
    this.storyScopeId = storyScopeId;
  }

  /**
   * Gets type of message
   *
   * @return Returns type of message
   */
  public int getMessageType() {
    return messageType;
  }

  /**
   * Sets type of message
   *
   * @param messageType Type of message
   */
  public void setMessageType(int messageType) {
    this.messageType = messageType;
  }

  /**
   * Gets saved message for StoryScope
   *
   * @return Returns saved message
   */
  public String getMessage() {
    return message;
  }

  /**
   * Sets saved message for StoryScope
   *
   * @param message Message for save
   */
  public void setMessage(String message) {
    this.message = message;
  }
  
}  // public class SavedMessage