EditStoryScope.java

Go to the documentation of this file.

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

/**
 * @file EditStoryScope.java
 *
 * @brief Backbean for pages for adding, editing and deleting of StoryScopes
 */

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.modules.StoryscopeInterface.StoryScope;
import cz.vutbr.fit.knot.annotations.modules.StoryscopeInterface.SubscribedItem;
import java.io.Serializable;
import java.util.Iterator;
import java.util.List;
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 StoryScopes
 *
 * @brief Backbean for pages for adding, editing and deleting of StoryScopes
 * @author Martin Petr (xpetrm05)
 */
@ManagedBean
@ViewScoped
public class EditStoryScope implements Serializable {
  /**
   * Value represent name of StoryScope
   */
  private String storyScopeName = null;
  /**
   * Value represent URL of SEC Client for StoryScope
   */
  private String secClientURL = null;
  /**
   * Edited StoryScope or StoryScope to be deleted
   */
  private StoryScope storyScope = null;
  /**
   * Error message displayed in form
   */
  private String errorMessage = null;
  
  
  /**
   * Constructor
   */
  public EditStoryScope(){
  }
  
  /**
   * Gets edited StoryScope name field in form
   * If StoryScope not set yet, pick up it from session
   *
   * @return Returns name of edited StoryScope
   */
  public String getStoryScopeName(){
    if(storyScope == null){
      storyScope = SessionManager.getSession().getEditedStoryScope();
    }
    
    StoryScope backup = null;
    if (SessionManager.getSession().getFormBackup() != null) {
       if (SessionManager.getSession().getFormBackup().getClass().getName().endsWith("StoryScope")) {
         backup = (StoryScope) SessionManager.getSession().getFormBackup();
         if (backup.getId() != storyScope.getId()) {
          backup = null;
        }
       }
    }
    
    if(storyScopeName == null && backup != null) {
      storyScopeName = backup.getName();
    } else if(storyScopeName == null && storyScope != null) {
      storyScopeName = storyScope.getName();
    } else if(storyScopeName == null) {
      storyScopeName = "";
    }
    return storyScopeName;
  }
  
  /**
   * Sets name of edited StoryScope in to field in form 
   *
   * @param storyScopeName Name of edited StoryScope
   */
  public void setStoryScopeName(String storyScopeName){
    this.storyScopeName = storyScopeName;
  }
  
  /**
   * Gets URL of SEC clinet for edited StoryScope field in form
   * If StoryScope not set yet, pick up it from session
   *
   * @return Returns URL of SEC client for edited StorySapce
   */
  public String getSECClientURL(){
    if(storyScope == null){
      storyScope = SessionManager.getSession().getEditedStoryScope();
    }
    
    StoryScope backup = null;
    if (SessionManager.getSession().getFormBackup() != null) {
       if (SessionManager.getSession().getFormBackup().getClass().getName().endsWith("StoryScope")) {
         backup = (StoryScope) SessionManager.getSession().getFormBackup();
         if (backup.getId() != storyScope.getId()) {
          backup = null;
        }
       }
    }
    
    if(secClientURL == null && backup != null) {
      secClientURL = backup.getClientURL();
    } else if(secClientURL == null && storyScope != null) {
      secClientURL = storyScope.getClientURL();
    } else if(secClientURL == null) {
      secClientURL = "";
    }
    
    return secClientURL;
  }
  
  /**
   * Sets URL of SEC clinet for edited StoryScope in to field in form
   *
   * @param secClientURL URL of SEC client for edited StorySapce
   */
  public void setSECClientURL(String secClientURL){
    this.secClientURL = secClientURL;
  }
  
  /**
   * Gets edited StoryScope
   * If StoryScope not set yet, pick up it from session
   *
   * @return Returns edited StoryScope
   */
  public StoryScope getStoryScope(){
    if(storyScope == null){
      storyScope = SessionManager.getSession().getEditedStoryScope();
    }
    return storyScope;
  }
  
  /**
   * Sets edited StoryScope
   *
   * @param storyScope Edited StorySapce
   */
  public void setStoryScope(StoryScope storyScope){
    this.storyScope = storyScope;
  }
  
  /**
   * 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 the StoryScope
   *
   * @return Returns page outcome (identificator of next page or null to stay here)
   */
  public String btnSaveAction() {
    boolean errorOccurred = false;
    
    // name of story space must be fill 
    if (storyScopeName.isEmpty()) {
      errorMessage = errorMessage + MessageProvider.getMessage("ssNameCantBeEmpty") + " ";
      errorOccurred = true;
    }
    
    // addres of SEC client must be fill
    if (secClientURL.isEmpty()) {
      errorMessage = errorMessage + MessageProvider.getMessage("ssClientCantBeEmpty") + " ";
      errorOccurred = true;
    }
    
    if(errorOccurred){
      errorMessage = MessageProvider.getMessage("error") + " " + errorMessage;
    }
    
    // update data in object
    storyScope.setName(storyScopeName);
    storyScope.setClientURL(secClientURL);
    
    //persist data into DB
    StoryScope saved = (StoryScope) AppBean.getPersistenceManager().saveEntityChanges(storyScope);
    if (saved == null) {
      errorMessage = MessageProvider.getMessage("ssEditDatabaseFailure");
      if (Constants.LOG_LEVEL >= Constants.LOG_LEVEL_SERVER_ERRORS) {
        String msg = "Persisting of changes in the StoryScope account failed.";
        Logger.getLogger(EditStoryScope.class.getName()).log(Level.SEVERE, msg);
      }
      return null;
    } else {  // if changes was successfully saved
      storyScope = saved;
    }

    SessionManager.getSession().setEditedStoryScope(null); 
    return "StoryscopesMain";
  } // btnSaveAction()
  
  /**
   * Action listener for save button on page for adding new StoryScope
   *
   * @return Returns page outcome (identificator of next page or null to stay here)
   */
  public String btnNewAction(){
    boolean errorOccurred = false;
    
    // name of story space must be fill 
    if (storyScopeName.isEmpty()) {
      errorMessage = errorMessage + MessageProvider.getMessage("ssNameCantBeEmpty") + " ";
      errorOccurred = true;
    }
    
    // addres of SEC client must be fill
    if (secClientURL.isEmpty()) {
      errorMessage = errorMessage + MessageProvider.getMessage("ssClientCantBeEmpty") + " ";
      errorOccurred = true;
    }
    
    if(errorOccurred){
      errorMessage = MessageProvider.getMessage("error") + " " + errorMessage;
    }
    
    // create new story space and store data
    storyScope = new StoryScope();
    storyScope.setName(storyScopeName);
    storyScope.setClientURL(secClientURL);
    
    // persist new StoryScope
    if(AppBean.getPersistenceManager().persistEntity(storyScope)){
      errorMessage = MessageProvider.getMessage("ssAddDatabaseFailure");
      if (Constants.LOG_LEVEL >= Constants.LOG_LEVEL_SERVER_ERRORS) {
        String msg = "Persisting of new StoryScope account failed.";
        Logger.getLogger(EditStoryScope.class.getName()).log(Level.SEVERE, msg);
      }
      return null;
    }
    
    SessionManager.getSession().setEditedStoryScope(null); 
    return "StoryscopesMain";
  } //btnNewAction()
  
  /**
   * Action listener for delete button on deleting page. At first delete all 
   * subscriptions of StoryScope and then delete StoryScope.
   *
   * @return Returns page outcome (identificator of next page or null to stay here)
   */
  public String btnDeleteAction(){
    List<Object> subscriptions = storyScope.getSubscriptions();
    
    // at first check if StoryScope have any subscriptions
    if((subscriptions != null) && (!subscriptions.isEmpty())){
      Iterator <Object> subIterator = subscriptions.iterator();
      // if story space have any subscriptions then that subscriptions must be delete first
      while(subIterator.hasNext()){
        SubscribedItem actualSubscription = (SubscribedItem) subIterator.next();
        
        if(AppBean.getPersistenceManager().removeEntity(actualSubscription)){
          errorMessage = MessageProvider.getMessage("ssSubsDeleteDatabaseFailure");
          if (Constants.LOG_LEVEL >= Constants.LOG_LEVEL_SERVER_ERRORS) {
            String msg = "DB failure during deleting subscribed items of current StoryScope.";
            Logger.getLogger(EditStoryScope.class.getName()).log(Level.SEVERE, msg);
          }
        }
      }
    }
    
    // at second delete StoryScope
    if(AppBean.getPersistenceManager().removeEntity(storyScope)){
      errorMessage = MessageProvider.getMessage("ssDeleteDatabaseFailure");
      if (Constants.LOG_LEVEL >= Constants.LOG_LEVEL_SERVER_ERRORS) {
        String msg = "DB failure during deleting of StoryScope account.";
        Logger.getLogger(EditStoryScope.class.getName()).log(Level.SEVERE, msg);
      }
    }
    
    SessionManager.getSession().setFormBackup(null);
    SessionManager.getSession().setEditedStoryScope(null);  // clean up variable in session
    return "StoryscopesMain";
  } // btnDeleteAction()
  
  /**
   * Action listener for cancel button
   *
   * @return Returns page outcome
   */
  public String btnCancelAction() {
    SessionManager.getSession().setFormBackup(null);
    SessionManager.getSession().setEditedStoryScope(null);  // clean up variable in session
    return "StoryscopesMain";
  }
}