[Join-cvs] join/src/main/org/figure8/join/businessobjects/configuration/ejb NotificationFailureBean.java,NONE,1.1

[<lbr...@us...>]

Update of /cvsroot/join/join/src/main/org/figure8/join/businessobjects/configuration/ejb
In directory sc8-pr-cvs1:/tmp/cvs-serv31343

Added Files:
	NotificationFailureBean.java 
Log Message:
Initial checkin

--- NEW FILE: NotificationFailureBean.java ---
/*
 * NotificationFailureBean.java
 *
 * Created on 17 march 2003, 18:51
 */
package org.figure8.join.businessobjects.configuration.ejb;

import org.figure8.join.businessobjects.configuration.interfaces.ClientLocal;
import org.figure8.join.businessobjects.configuration.interfaces.NotificationFailureData;
import org.figure8.join.businessobjects.configuration.util.NotificationFailureUtil;

import java.sql.Date;
/**
 * This is the representation of a failure of a client's notification. Notification
 * failures tracing help Join system administrator to tune the notifyer parameters and
 * to recover a consistent system status after a technical exception (network failure,
 * client technical failure, ...). Notification failures can be seen through Join http
 * portal, must be recovered "manually" and then removed from "opened failures" list.
 * @author  <a href="mailto:lau...@fr...">Laurent Broudoux</a>
 *
 * @ejb.bean   name="NotificationFailure"
               type="CMP" cmp-version="2.x" view-type="local"
               jndi-name="${objects.conf.failure.jndi-name}"
               local-jndi-name="${objects.conf.failure.jndi-name}Local"
               primkey-field="id"
 * @ejb.home local-class="org.figure8.join.businessobjects.configuration.interfaces.NotificationFailureLocalHome"
 * @ejb.interface local-class="org.figure8.join.businessobjects.configuration.interfaces.NotificationFailureLocal"
 * @ejb.data-object package="org.figure8.join.businessobjects.configuration.interfaces"
 *
 * @ejb.finder signature="Collection findByConfiguration(org.figure8.join.businessobjects.configuration.interfaces.ConfigurationLocal config)"
               unchecked="true" transaction-type="Supports"
               query="SELECT DISTINCT OBJECT(nf) FROM NotificationFailure AS nf WHERE nf.client.configuration=?1"
 *
 * @ejb.pk class="java.lang.String" generate="false" unchecked="true"
 * @ejb.persistence table-name="${objects.conf.failure.table-name}"
 *
 * @jboss.read-ahead strategy="${objects.conf.failure.jboss.read-ahead}"
 * @jboss.tuned-updates "${objects.conf.failure.jboss.tuned-updates}"
 *
 * @jboss:query   signature="Collection findByConfiguration(org.figure8.join.businessobjects.configuration.interfaces.ConfigurationLocal config)"
 *                query="SELECT DISTINCT OBJECT(nf) FROM NotificationFailure AS nf WHERE nf.client.configuration=?1 ORDER BY nf.creationDate DESC"
 */
public abstract class NotificationFailureBean implements javax.ejb.EntityBean{

   // Public -------------------------------------------------------------------
   
   /**
    * Notification failure id
    * @ejb.pk-field
    * @ejb.persistence column-name="s_id"
    */
   public abstract String getId();
   
   /** Notification failure id */
   public abstract void setId(String id);
   
   /**
    * Notification failure creation date
    * @ejb.interface-method
    * @ejb.persistence  column-name="d_creation"
    *                   sql-type="TIMESTAMP"
    */
   public abstract java.sql.Date getCreationDate();
   
   /**
    * Notification failure creation date
    * @ejb.interface-method
    */
   public abstract void setCreationDate(java.sql.Date creationDate);
   
   /**
    * Notification type
    * @ejb.interface-method
    * @ejb.persistence column-name="s_type" 
    */
   public abstract String getType();
   
   /**
    * Notification type
    * @ejb.interface-method
    */
   public abstract void setType(String type);
   
   /**
    * Notification reference
    * @ejb.interface-method
    * @ejb.persistence column-name="s_reference"
    */
   public abstract String getReference();
   
   /**
    * Notification reference
    * @ejb.interface-method
    */
   public abstract void setReference(String reference);
   
   
   /**
    * Client concerned by the notification failure
    * @ejb.interface-method view-type="local" 
    * @ejb.relation  name="Client-OneToMany-Failures-Bi"
    *                role-name="Failure-has-Client"
    *                cascade-delete="yes"
    * @jboss.relation   fk-constraint="true"
    *                   related-pk-field="id"
    *                   fk-column="s_client_fk"
    */
   public abstract ClientLocal getClient();
   
   /**
    * Client concerned by the notification failure
    * @ejb.interface-method view-type="local"
    */
   public abstract void setClient(ClientLocal client);
   
   
   /**
    * Generated bulk accessor
    * @ejb.interface-method
    */
   public abstract NotificationFailureData getData();
   
   /** Generated bulk accessor */
   public abstract void setData(NotificationFailureData data);
   
   
   // Implementation of EntityBean ---------------------------------------------
   
   /**
    * Create a new Notification failure
    * @ejb.create-method
    */
   public String ejbCreate(NotificationFailureData data, ClientLocal client) throws javax.ejb.CreateException{
      if (data != null){
         setId(NotificationFailureUtil.generateGUID(this));
         setData(data);
      }
      else throw new javax.ejb.CreateException("Data object for Notification Failure must be non null.");
      return null;
   }
   
   /** Create a new Notification failure */
   public void ejbPostCreate(NotificationFailureData data, ClientLocal client) throws javax.ejb.CreateException{
      setClient(client); 
   }
   
   /**
    * Remove this Notificaton failure
    * @ejb.transaction type="Mandatory"
    */
   public void ejbRemove() throws javax.ejb.RemoveException, javax.ejb.EJBException {}
}