/**
    * Copyright 2005-2006 the original author or authors.
    *
    * Licensed under the Gnu General Pubic License, Version 2.0 (the
    * "License"); you may not use this file except in compliance with
    * the License. You may obtain a copy of the License at
    *
    *      http://www.opensource.org/licenses/gpl-license.php
    *
   * This program is distributed in the hope that it will be useful,
   * but WITHOUT ANY WARRANTY; without even the implied warranty of
   * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
   * See the Gnu General Public License for more details.
   */
  package org.figure8.join.services.scripting;
  
  import org.figure8.join.core.EntityObject;
  
  import java.util.Date;
  /**
   * This is an entity object representing information about the log
   * file produced by the execution of a script. These informations are
   * related to the entity this script has been launched for, the name and
   * file of the script and the log file itself.
   * @author <a href="mailto:laurent.broudoux@free.fr">Laurent Broudoux</a>
   * @version $Revision: 1.2 $
   *
   * @hibernate.class table="join_scriptlogs" lazy="true"
   * @hibernate.cache usage="read-write"
   *
   * @hibernate.query name="join.scriptlog_findByScript"
   *    query="from ScriptLogInfo info where info.scriptName = :name
   *          order by info.creationDate desc"
   * @hibernate.query name="join.scriptlog_findByEntity"
   *    query="from ScriptLogInfo info where info.entityId = :entityId
   *          and info.entityClass = :entityClass order by info.creationDate desc"
   * @hibernate.query name="join.scriptlog_findByNameAndCategory"
   *    query="from ScriptLogInfo info where info.scriptName = :name
   *          and info.scriptCategory = :category order by info.creationDate desc"
   */
  public class ScriptLogInfo extends EntityObject{
  
     // Attributes ---------------------------------------------------------------
  
     /** The date of creation of this log */
     private Date creationDate;
     /** The unique identifier of entity referenced by this log */
     private long entityId;
     /** The class of entity referenced by this log */
     private String entityClass;
     /** The path of file corresponding to log */
     private String logFile;
     /** The name of executed script */
     private String scriptName;
     /** The category of executed script */
     private String scriptCategory;
     /** The path of file corresponding to script */
     private String scriptFile;
     /** The exception message if script has failed */
     private String exceptionMsg;
  
  
     // Constructors -------------------------------------------------------------
  
     /** Creates a new instance of ScriptLogInfo. */
     public ScriptLogInfo(){
     }
  
     /**
      * Creates a new instance of ScriptLogInfo with mandatory attributes.
      * @param logFile The path of file corresponding to log
      * @param scriptName The name of the executed script
      * @param scriptCategory The category of the executed script
      * @param scriptFile The path of file containing executed script
      */
     public ScriptLogInfo(String logFile, String scriptName, String scriptCategory, String scriptFile){
        this.logFile = logFile;
        this.scriptName = scriptName;
        this.scriptCategory = scriptCategory;
        this.scriptFile = scriptFile;
        // Set the creation date as now.
        creationDate = new Date();
     }
  
     /**
      * Creates a new instance of ScriptLogInfo with attributes.
      * @param entity The referenced entity object
      * @param logFile The path of file corresponding to log
      * @param scriptName The name of the executed script
      * @param scriptCategory The category of the executed script
      * @param scriptFile The path of file containing executed script
      */
     public ScriptLogInfo(EntityObject entity, String logFile, String scriptName, String scriptCategory, String scriptFile){
        this.entityId = entity.getId();
        this.entityClass = entity.getClass().getName();
        this.logFile = logFile;
        this.scriptName = scriptName;
        this.scriptCategory = scriptCategory;
        this.scriptFile = scriptFile;
       // Set the creation date as now.
       creationDate = new Date();
    }
 
 
    // Public -------------------------------------------------------------------
 
    /**
     * @hibernate.property column="d_creation"
     *    not-null="true" type="timestamp"
     *    update="false"
     * @return The date of creation of this log
     */
    public Date getCreationDate(){
       return creationDate;
    }
    /** @param creationDate The date of creation of this log */
    public void setCreationDate(Date creationDate){
       this.creationDate = creationDate;
    }
 
    /**
     * @hibernate.property column="n_entityid" update="false"
     * @return The referenced entity unique identifier
     */
    public long getEntityId(){
       return entityId;
    }
    /** @param entityId The referenced entity unique identifier */
    public void setEntityId(long entityId){
       this.entityId = entityId;
    }
 
    /**
     * @hibernate.property column="s_entityclass"
     *    update="false" length="200"
     * @return The referenced entity class
     */
    public String getEntityClass(){
       return entityClass;
    }
    /** @param entityClass The referenced entity class */
    public void setEntityClass(String entityClass){
       this.entityClass = entityClass;
    }
 
    /**
     * @hibernate.property column="s_logfile"
     *    not-null="true" update="false"
     *    length="255"
     * @return The path of file corresponding to log
     */
    public String getLogFile(){
       return logFile;
    }
    /** @param logFile The path of file corresponding to log */
    public void setLogFile(String logFile){
       this.logFile = logFile;
    }
 
    /**
     * @hibernate.property column="s_scriptname" length="100"
     * @return The name of executed script
     */
    public String getScriptName(){
       return scriptName;
    }
    /** @param scriptName The name of executed script */
    public void setScriptName(String scriptName){
       this.scriptName = scriptName;
    }
 
    /**
     * @hibernate.property column="s_scriptclass" length="255"
     * @return The category of executed script
     */
    public String getScriptCategory(){
       return scriptCategory;
    }
    /** @param scriptCategory The category of executed script */
    public void setScriptCategory(String scriptCategory){
       this.scriptCategory = scriptCategory;
    }
 
    /**
     * @hibernate.property column="s_scriptfile" length="255"
     * @return The path of file correcponding to script
     */
    public String getScriptFile(){
       return scriptFile;
    }
    /** @param scriptFile The path of file correcponding to script */
    public void setScriptFile(String scriptFile){
       this.scriptFile = scriptFile;
    }
 
    /**
     * @hibernate.property column="s_exceptionmsg" length="255"
     * @return The exception message if script has failed
     */
    public String getExceptionMsg(){
       return exceptionMsg;
    }
    /** @param exceptionMsg The exception message if script has failed */
    public void setExceptionMsg(String exceptionMsg){
       this.exceptionMsg = exceptionMsg;
    }
 }