package edu.rice.rubis.beans;
import java.rmi.*;
import javax.ejb.*;
import javax.naming.Context;
import javax.naming.InitialContext;
import javax.rmi.PortableRemoteObject;
import java.util.GregorianCalendar;
/**
* OldItemBean is an entity bean with "container managed persistence".
* The state of an instance is stored into a relational database.
* Items are considered old when the end auction date is over. A daemon
* moves at specific times items from the items table to the old_items table.
* The following table should exist:
*
* CREATE TABLE old_items (
* id INTEGER UNSIGNED NOT NULL UNIQUE,
* name VARCHAR(100),
* description TEXT,
* initial_price FLOAT UNSIGNED NOT NULL,
* quantity INTEGER UNSIGNED NOT NULL,
* reserve_price FLOAT UNSIGNED DEFAULT 0,
* buy_now FLOAT UNSIGNED DEFAULT 0,
* nb_of_bids INTEGER UNSIGNED DEFAULT 0,
* max_bid FLOAT UNSIGNED DEFAULT 0,
* start_date DATETIME,
* end_date DATETIME,
* seller INTEGER,
* category INTEGER,
* PRIMARY KEY(id),
* INDEX seller_id (seller),
* INDEX category_id (category)
* );
*
* @author Emmanuel Cecchet and Julie Marguerite
* @version 1.1
*/
public class OldItemBean implements EntityBean
{
private EntityContext entityContext;
private transient boolean isDirty; // used for the isModified function
/* Class member variables */
public Integer id;
public String name;
public String description;
public float initialPrice;
public int quantity;
public float reservePrice;
public float buyNow;
public int nbOfBids;
public float maxBid;
public String startDate;
public String endDate;
public Integer sellerId;
public Integer categoryId;
/**
* Get item id.
*
* @return item id
* @exception RemoteException if an error occurs
* @since 1.0
*/
public Integer getId()
{
return id;
}
/**
* Get item name. This description is usually a short description of the item.
*
* @return item name
* @exception RemoteException if an error occurs
* @since 1.0
*/
public String getName()
{
return name;
}
/**
* Get item description . This is usually an HTML file describing the item.
*
* @return item description
* @exception RemoteException if an error occurs
* @since 1.0
*/
public String getDescription()
{
return description;
}
/**
* Get item initial price set by the seller.
*
* @return item initial price
* @exception RemoteException if an error occurs
* @since 1.0
*/
public float getInitialPrice()
{
return initialPrice;
}
/**
* Get how many of this item are to be sold.
*
* @return item quantity
* @exception RemoteException if an error occurs
* @since 1.0
*/
public int getQuantity()
{
return quantity;
}
/**
* Get item reserve price set by the seller. The seller can refuse to sell if reserve price is not reached.
*
* @return item reserve price
* @exception RemoteException if an error occurs
* @since 1.0
*/
public float getReservePrice()
{
return reservePrice;
}
/**
* Get item Buy Now price set by the seller. A user can directly by the item at this price (no auction).
*
* @return item Buy Now price
* @exception RemoteException if an error occurs
* @since 1.0
*/
public float getBuyNow()
{
return buyNow;
}
/**
* Get item maximum bid (if any) for this item. This value should be the same as doing SELECT MAX(bid) FROM bids WHERE item_id=?
*
* @return current maximum bid or 0 if no bid
* @exception RemoteException if an error occurs
* @since 1.1
*/
public float getMaxBid()
{
return maxBid;
}
/**
* Get number of bids for this item. This value should be the same as doing SELECT COUNT(*) FROM bids WHERE item_id=?
*
* @return number of bids
* @exception RemoteException if an error occurs
* @since 1.1
*/
public int getNbOfBids()
{
return nbOfBids;
}
/**
* Start date of the auction in the format 'YYYY-MM-DD hh:mm:ss'
*
* @return start date of the auction
* @exception RemoteException if an error occurs
* @since 1.0
*/
public String getStartDate()
{
return startDate;
}
/**
* End date of the auction in the format 'YYYY-MM-DD hh:mm:ss'
*
* @return end date of the auction
* @exception RemoteException if an error occurs
* @since 1.0
*/
public String getEndDate()
{
return endDate;
}
/**
* Give the user id of the seller
*
* @return seller's user id
* @since 1.0
* @exception RemoteException if an error occurs
*/
public Integer getSellerId()
{
return sellerId;
}
/**
* Give the category id of the item
*
* @return item's category id
* @exception RemoteException if an error occurs
* @since 1.0
*/
public Integer getCategoryId()
{
return categoryId;
}
/**
* Get the seller's nickname by finding the Bean corresponding
* to the user.
*
* @return nickname
* @exception RemoteException if an error occurs
* @since 1.0
*/
public String getSellerNickname()
{
Context initialContext = null;
try
{
initialContext = new InitialContext();
}
catch (Exception e)
{
System.err.print("Cannot get initial context for JNDI: " + e);
return null;
}
// Try to find the user nick name corresponding to the sellerId
UserLocalHome uHome;
try
{
uHome = (UserLocalHome)initialContext.lookup("UserHome");
}
catch (Exception e)
{
System.err.print("Cannot lookup User: " +e);
return null;
}
try
{
UserLocal u = uHome.findByPrimaryKey(new UserPK(sellerId));
return u.getNickName();
}
catch (Exception e)
{
System.err.print("This user does not exist (got exception: " +e+")
");
return null;
}
}
/**
* Get the category name by finding the Bean corresponding to the category Id.
*
* @return category name
* @exception RemoteException if an error occurs
* @since 1.0
*/
public String getCategoryName()
{
Context initialContext = null;
try
{
initialContext = new InitialContext();
}
catch (Exception e)
{
System.err.print("Cannot get initial context for JNDI: " + e);
return null;
}
// Try to find the CategoryName corresponding to the categoryId
CategoryLocalHome cHome;
try
{
cHome = (CategoryLocalHome)initialContext.lookup("CategoryHome");
}
catch (Exception e)
{
System.err.print("Cannot lookup Category: " +e);
return null;
}
try
{
CategoryLocal c = cHome.findByPrimaryKey(new CategoryPK(id));
return c.getName();
}
catch (Exception e)
{
System.err.print("This category does not exist (got exception: " +e+")
");
return null;
}
}
/**
* Set a new item identifier
*
* @param newId item identifier
* @exception RemoteException if an error occurs
* @since 1.0
*/
public void setId(Integer newId)
{
id = newId;
isDirty = true; // the bean content has been modified
}
/**
* Set a new item name
*
* @param newName item name
* @exception RemoteException if an error occurs
* @since 1.0
*/
public void setName(String newName)
{
name = newName;
isDirty = true; // the bean content has been modified
}
/**
* Set a new item description
*
* @param newDescription item description
* @exception RemoteException if an error occurs
* @since 1.0
*/
public void setDescription(String newDescription)
{
description = newDescription;
isDirty = true; // the bean content has been modified
}
/**
* Set a new initial price for the item
*
* @param newInitialPrice item initial price
* @exception RemoteException if an error occurs
* @since 1.0
*/
public void setInitialPrice(float newInitialPrice)
{
initialPrice = newInitialPrice;
isDirty = true; // the bean content has been modified
}
/**
* Set a new item quantity
*
* @param qty item quantity
* @exception RemoteException if an error occurs
* @since 1.0
*/
public void setQuantity(int qty) throws RemoteException
{
quantity = qty;
isDirty = true; // the bean content has been modified
}
/**
* Set a new reserve price for the item
*
* @param newReservePrice item reserve price
* @exception RemoteException if an error occurs
* @since 1.0
*/
public void setReservePrice(float newReservePrice)
{
reservePrice = newReservePrice;
isDirty = true; // the bean content has been modified
}
/**
* Set a new Buy Now price for the item
*
* @param newBuyNow item Buy Now price
* @exception RemoteException if an error occurs
* @since 1.0
*/
public void setBuyNow(float newBuyNow)
{
buyNow = newBuyNow;
isDirty = true; // the bean content has been modified
}
/**
* Set item maximum bid. This function checks if newMaxBid is greater
* than current maxBid and only updates the value in this case.
*
* @param newMaxBid new maximum bid
* @exception RemoteException if an error occurs
* @since 1.1
*/
public void setMaxBid(float newMaxBid)
{
if (newMaxBid > maxBid)
maxBid = newMaxBid;
isDirty = true; // the bean content has been modified
}
/**
* Set the number of bids for this item
*
* @param newNbOfBids new number of bids
* @exception RemoteException if an error occurs
* @since 1.1
*/
public void setNbOfBids(int newNbOfBids)
{
nbOfBids = newNbOfBids;
isDirty = true; // the bean content has been modified
}
/**
* Add one bid for this item
*
* @exception RemoteException if an error occurs
* @since 1.1
*/
public void addOneBid()
{
nbOfBids++;
isDirty = true; // the bean content has been modified
}
/**
* Set a new beginning date for the auction
*
* @param newDate auction new beginning date
* @exception RemoteException if an error occurs
* @since 1.0
*/
public void setStartDate(String newDate)
{
startDate = newDate;
isDirty = true; // the bean content has been modified
}
/**
* Set a new ending date for the auction
*
* @param newDate auction new ending date
* @exception RemoteException if an error occurs
* @since 1.0
*/
public void setEndDate(String newDate)
{
endDate = newDate;
isDirty = true; // the bean content has been modified
}
/**
* Set a new seller identifier. This id must match
* the primary key of the users table.
*
* @param id seller id
* @exception RemoteException if an error occurs
* @since 1.0
*/
public void setSellerId(Integer id)
{
sellerId = id;
isDirty = true; // the bean content has been modified
}
/**
* Set a new category identifier. This id must match
* the primary key of the category table.
*
* @param id category id
* @exception RemoteException if an error occurs
* @since 1.0
*/
public void setCategoryId(Integer id)
{
categoryId = id;
isDirty = true; // the bean content has been modified
}
/**
* This method is used to create a new OldItem Bean. Note that the item id
* is automatically generated by the database (AUTO_INCREMENT) on the
* primary key.
*
* @param itemId item identifier
* @param itemName short item designation
* @param itemDescription long item description, usually an HTML file
* @param itemInitialPrice initial price fixed by the seller
* @param itemQuantity number to sell (of this item)
* @param itemReservePrice reserve price (minimum price the seller really wants to sell)
* @param itemBuyNow price if a user wants to buy the item immediatly
* @param duration duration of the auction in days (start date is when the method is called and end date is computed according to the duration)
* @param itemSellerId seller id, must match the primary key of table users
* @param itemCategoryId category id, must match the primary key of table categories
*
* @return pk primary key set to null
*
* @exception CreateException if an error occurs
* @exception RemoteException if an error occurs
* @exception RemoveException if an error occurs
* @since 1.0
*/
public OldItemPK ejbCreate(Integer itemId, String itemName, String itemDescription, float itemInitialPrice,
int itemQuantity, float itemReservePrice, float itemBuyNow, int duration,
Integer itemSellerId, Integer itemCategoryId) throws CreateException, RemoveException
{
GregorianCalendar start = new GregorianCalendar();
id = itemId;
name = itemName;
description = itemDescription;
initialPrice = itemInitialPrice;
quantity = itemQuantity;
reservePrice = itemReservePrice;
buyNow = itemBuyNow;
sellerId = itemSellerId;
categoryId = itemCategoryId;
nbOfBids = 0;
maxBid = 0;
startDate = TimeManagement.dateToString(start);
endDate = TimeManagement.dateToString(TimeManagement.addDays(start, duration));
return null;
}
/** This method does currently nothing */
public void ejbPostCreate(Integer itemId, String itemName, String itemDescription, float itemInitialPrice,
int itemQuantity, float itemReservePrice, float itemBuyNow, int duration,
Integer itemSellerId, Integer itemCategoryId) {}
/** Persistence is managed by the container and the bean
becomes up to date */
public void ejbLoad() throws RemoteException
{
isDirty = false;
}
/** Persistence is managed by the container and the bean
becomes up to date */
public void ejbStore()
{
isDirty = false;
}
/** This method is empty because persistence is managed by the container */
public void ejbActivate() {}
/** This method is empty because persistence is managed by the container */
public void ejbPassivate() {}
/** This method is empty because persistence is managed by the container */
public void ejbRemove() throws RemoveException {}
/**
* Sets the associated entity context. The container invokes this method
* on an instance after the instance has been created.
*
* This method is called in an unspecified transaction context.
*
* @param context An EntityContext interface for the instance. The instance should
* store the reference to the context in an instance variable.
* @exception EJBException Thrown by the method to indicate a failure
* caused by a system-level error.
* @exception RemoteException - This exception is defined in the method signature
* to provide backward compatibility for enterprise beans
* written for the EJB 1.0 specification.
* Enterprise beans written for the EJB 1.1 and
* higher specification should throw the javax.ejb.EJBException
* instead of this exception.
*/
public void setEntityContext(EntityContext context)
{
entityContext = context;
}
/**
* Unsets the associated entity context. The container calls this method
* before removing the instance. This is the last method that the container
* invokes on the instance. The Java garbage collector will eventually invoke
* the finalize() method on the instance.
*
* This method is called in an unspecified transaction context.
*
* @exception EJBException Thrown by the method to indicate a failure
* caused by a system-level error.
* @exception RemoteException - This exception is defined in the method signature
* to provide backward compatibility for enterprise beans
* written for the EJB 1.0 specification.
* Enterprise beans written for the EJB 1.1 and
* higher specification should throw the javax.ejb.EJBException
* instead of this exception.
*/
public void unsetEntityContext()
{
entityContext = null;
}
/**
* Returns true if the beans has been modified.
* It prevents the EJB server from reloading a bean
* that has not been modified.
*
* @return a boolean value
*/
public boolean isModified()
{
return isDirty;
}
}