EditUserSetting.java

Go to the documentation of this file.

/*
 * Project: Server for annotations sharing
 * Author: Ing. Jaroslav Dytrych idytrych@fit.vutbr.cz
 * File: EditUserSetting.java
 * Description: Backbean for pages for adding, editing and deleting of simple user settings
 */

/**
 * @file EditUserSetting.java
 *
 * @brief Backbean for pages for adding, editing and deleting of simple user settings
 */

package cz.vutbr.fit.knot.annotations.web;

import cz.vutbr.fit.knot.annotations.app.AppBean;
import cz.vutbr.fit.knot.annotations.app.Constants;
import cz.vutbr.fit.knot.annotations.entity.Settings;
import java.io.Serializable;
import java.util.logging.Level;
import java.util.logging.Logger;
import javax.faces.bean.ManagedBean;
import javax.faces.bean.ViewScoped;

/**
 * Backbean for pages for adding, editing and deleting of simple user settings
 *
 * @brief Backbean for pages for adding, editing and deleting of simple user settings
 * @author Martin Petr (xpetrm05)
 */
@ManagedBean
@ViewScoped
public class EditUserSetting implements Serializable{
  /**
   * User simple setting name
   */
  String name = null;
  
  /**
   * Value of user simple setting
   */
  String value = null;
  
  /**
   * Description of user simple setting
   */
  String description = null;
  
  /**
   * Edited setting or setting to be deleted
   */
  Settings setting = null;
  
  /**
   * Error message displayed in form
   */
  private String errorMessage = "";
  
  /**
   * Constructor
   */
  public EditUserSetting() {
  }

  /**
   * Gets name of user simple setting
   *
   * @return Returns name of user simple setting
   */
  public String getName() {
    if ((setting = SessionManager.getSession().getEditedSetting()) != null) {
      name = setting.getName();
      return name;
    } else {
      return "";
    }
  }

  /**
   * Sets name of user simple setting
   *
   * @param name Name of user simple setting
   */
  public void setName(String name) {
    this.name = name;
  }

  /**
   * Gets value of user simple setting
   *
   * @return Returns value of user simple setting
   */
  public String getValue() {
    if ((setting = SessionManager.getSession().getEditedSetting()) != null) {
      value = setting.getValue();
      return value;
    } else {
      return "";
    }
  }

  /**
   * Sets value of user simple setting
   *
   * @param value Value of user simple setting
   */
  public void setValue(String value) {
    this.value = value;
  }

  /**
   * Gets description of user simple setting
   * 
   * @return REturns description of user simple setting
   */
  public String getDescription() {
    if ((setting = SessionManager.getSession().getEditedSetting()) != null) {
      description = setting.getDescription();
      return description;
    } else {
      return "";
    }
  }

  /**
   * Sets description of user simple setting
   * 
   * @param description Description of user simple setting
   */
  public void setDescription(String description) {
    this.description = description;
  }
  
  /**
   * Gets error message displayed in form
   *
   * @return Returns error message displayed in form
   */
  public String getErrorMessage() {
    return errorMessage;
  }

  /**
   * Sets error message to be displayed in form
   *
   * @param errorMessage Error message to be displayed in form
   */
  public void setErrorMessage(String errorMessage) {
    this.errorMessage = errorMessage;
  }
  
  /**
   * Action listener for save button in the page for editing of user setting
   *
   * @return Returns page outcome (identificator of next page or null to stay here)
   */
  public String btnSaveAction(){
    boolean errorOccurred = false;
    errorMessage = "";
    
    if(name.isEmpty()){
      errorMessage = errorMessage + MessageProvider.getMessage("userSettingsNameErr") + " ";
      errorOccurred = true;
    }
    
    if(value.isEmpty()){
      errorMessage = errorMessage + MessageProvider.getMessage("userSettingsValueErr") + " ";
      errorOccurred = true;
    }
    
    if(errorOccurred){
      errorMessage = MessageProvider.getMessage("error") + " " + errorMessage;
      return "error";
    }
    
    setting.setName(name);
    setting.setValue(value);
    setting.setDescription(description);
    setting.setUser(SessionManager.getSession().getEditedUser());

    if ((AppBean.getPersistenceManager().saveEntityChanges(setting)) == null) {
      errorMessage = MessageProvider.getMessage("changesNSDatabaseFailure");
      if (Constants.LOG_LEVEL >= Constants.LOG_LEVEL_SERVER_ERRORS) {
        String msg = "Persisting of changes in the user settings failed.";
        Logger.getLogger(EditUser.class.getName()).log(Level.SEVERE, msg);
      }
      return "error";
    }
    
    SessionManager.getSession().setEditedSetting(null);
    return "saved";
  }
  
  /**
   * Action listener for save button on page for adding new user setting
   *
   * @return Returns page outcome (identificator of next page or null to stay here)
   */
  public String btnSaveNewAction(){
    boolean errorOccurred = false;
    errorMessage = "";
    
    if(name.isEmpty()){
      errorMessage = errorMessage + MessageProvider.getMessage("userSettingsNameErr") + " ";
      errorOccurred = true;
    }
    
    if(value.isEmpty()){
      errorMessage = errorMessage + MessageProvider.getMessage("userSettingsValueErr") + " ";
      errorOccurred = true;
    }
    
    if(errorOccurred){
      errorMessage = MessageProvider.getMessage("error") + " " + errorMessage;
      return "error";
    }
    
    setting = new Settings(SessionManager.getSession().getEditedUser(),name,value,description);
    
    if (AppBean.getPersistenceManager().persistEntity(setting)) {
      errorMessage = MessageProvider.getMessage("newUserSettingDBFailure");
      if (Constants.LOG_LEVEL >= Constants.LOG_LEVEL_SERVER_ERRORS) {
        String msg = "Persisting of new user settings failed.";
        Logger.getLogger(EditUser.class.getName()).log(Level.SEVERE, msg);
      }
      return "error";
    }
    
    SessionManager.getSession().setEditedSetting(null);
    return "saved";
  }
  
  /**
   * Action listener for delete button on deleting page. 
   *
   * @return Returns page outcome (identificator of next page or null to stay here)
   */
  public String btnDeleteAction(){
    if(AppBean.getPersistenceManager().removeEntity(setting)){
      errorMessage = MessageProvider.getMessage("userSettingsDeleteError");
      if (Constants.LOG_LEVEL >= Constants.LOG_LEVEL_SERVER_ERRORS) {
        String msg = "DB failure during deleting of user settings.";
        Logger.getLogger(EditSubscriptions.class.getName()).log(Level.SEVERE, msg);
      }
      
      return null;
    }

    SessionManager.getSession().setFormBackup(null);
    SessionManager.getSession().setEditedSetting(null);  // clean up variable in session
    return "cancel";
  }
  
  /**
   * Action listener for cancel button
   *
   * @return Returns page outcome (identificator of next page or null to stay here)
   */
  public String btnCancelAction(){
    SessionManager.getSession().setEditedSetting(null);
    return "cancel";
  }
}