DisseminationInfo.java

/**
 * The contents of this file are subject to the license and copyright
 * detailed in the LICENSE file at the root of the source
 * tree and available online at
 *
 * https://github.com/keeps/roda
 */
/**
 * 
 */
package org.roda.wui.client.browse;

import java.io.Serializable;

import org.roda.core.RodaCoreFactory;

/**
 * @author Luis Faria
 * 
 */
public class DisseminationInfo implements Serializable {

  private static final long serialVersionUID = -6014468773068700324L;

  public static final String DOWNLOAD_DISSEMINATOR_ID = RodaCoreFactory.getRodaConfigurationAsString("core", "download",
    "disseminator", "id");

  private String id;
  private String url;
  private String windowName;
  private String windowFeatures;
  private String iconURL;

  /**
   * Create a new dissemination info
   */
  public DisseminationInfo() {
    // do nothing

  }

  /**
   * Create a new dissemination info
   * 
   * @param id
   *          the dissemination id
   * @param url
   *          the dissemination URL
   * @param windowName
   *          the name where to open the window (e.g. "_self", "_top" or
   *          "_blank")
   * @param windowFeatures
   *          the window features (e.g. "fullscreen=yes, menubar=no,
   *          scrollbars=yes")
   * @param iconURL
   *          the URL of the dissemination icon, null for none
   */
  public DisseminationInfo(String id, String url, String windowName, String windowFeatures, String iconURL) {
    this.id = id;
    this.url = url;
    this.windowName = windowName;
    this.windowFeatures = windowFeatures;
    this.iconURL = iconURL;
  }

  /**
   * Get dissemination id
   * 
   * @return the id
   */
  public String getId() {
    return id;
  }

  /**
   * Set dissemination id
   * 
   * @param id
   */
  public void setId(String id) {
    this.id = id;
  }

  /**
   * Get dissemination URL
   * 
   * @return the URL
   */
  public String getUrl() {
    return url;
  }

  /**
   * Set dissemination URL
   * 
   * @param url
   */
  public void setUrl(String url) {
    this.url = url;
  }

  /**
   * Get target window features
   * 
   * @return the window features
   */
  public String getWindowFeatures() {
    return windowFeatures;
  }

  /**
   * Set target window features
   * 
   * @param windowFeatures
   */
  public void setWindowFeatures(String windowFeatures) {
    this.windowFeatures = windowFeatures;
  }

  /**
   * Get target window name
   * 
   * @return "_blank", "_self", "_top", etc.
   */
  public String getWindowName() {
    return windowName;
  }

  /**
   * Set target window name
   * 
   * @param windowName
   *          "_blank", "_self", "_top", etc.
   */
  public void setWindowName(String windowName) {
    this.windowName = windowName;
  }

  /**
   * Get dissemination icon URL
   * 
   * @return an URL pointing to the icon image
   */
  public String getIconURL() {
    return iconURL;
  }

  /**
   * Set dissemination icon URL
   * 
   * @param iconURL
   *          URL pointing to the icon image
   */
  public void setIconURL(String iconURL) {
    this.iconURL = iconURL;
  }

  /**
   * Does this disseminator return the download of the AIP
   * 
   * @return true if this disseminator returns the download of the AIP
   */
  public boolean isDownloadDisseminator() {
    return DOWNLOAD_DISSEMINATOR_ID.equals(id);
  }

}