shopowner.java

噶额外噶外骨骼感广泛高热感 就 啊啊

/*
* @author                        : Sujatha
* @Version                       : 1.0
*
* Development Environment        : Oracle9i JDeveloper
* Name of the File               : ShopOwner.java
* Creation/Modification History  :
*
* Sujatha    30-Dec-2002      Created
*
*/
package oracle.otnsamples.vsm.services;

// Java Utility import
import java.rmi.RemoteException;

import java.util.List;

import javax.ejb.EJBObject;

import oracle.otnsamples.vsm.services.data.Item;
import oracle.otnsamples.vsm.services.data.Shop;
import oracle.otnsamples.vsm.services.data.SubCategory;


/**
 * This is the interface for Shop management Service.
 * The interface provides method signatures for Shop management Services like
 * adding/deleting an item, updation of item information, sub-category maintenence
 * functionality etc.
 */
public interface ShopOwner extends EJBObject {

  /**
   * This business method adds a new item to a shop
   * @param <b>item</b> - Information about the item to be added
   * @throws <b>ItemException</b> if the item cannot be added
   * @throws <b>RemoteException</b> container error
   */
  String addItem( Item item ) throws ItemException, RemoteException;

  /**
   * This business method adds attributes to an item
   * @param <b>item</b> - Information about the item and attributes to be added
   * @throws <b>ItemException</b> if the item attributes cannot be added
   * @throws <b>RemoteException</b> container error
   */
  void addItemAttributes( Item item ) throws ItemException, RemoteException;

  /**
   * This business method deletes an item from a shop
   * @param <b>itemID</b> - ID of the item to be removed
   * @param <b>shopID</b> - ID of the shop from which the item has to be removed
   * @throws <b>ItemException</b> if the item cannot be deleted
   * @throws <b>RemoteException</b> container error
   */
  void deleteItem( String itemID, String shopID ) 
                   throws ItemException, RemoteException;

  /**
   * This business method searches a specified shop for items matching the keyword
   * @param <b>keyword</b> - Search information given by user to look up an item
   * @param <b>shopID</b> - ID of the shop from which the item has to be queried
   * @param <b>langID</b> - Language in which the item information has to be retrieved
   * @return <b>TreeMap</b>  - Ordered Map of items matching the specified criterion   
   * @throws <b>ItemException</b> if the shop cannot be queried for items
   * @throws <b>RemoteException</b> container error
   */
  java.util.TreeMap findItems( String keyword, String shopID, String langID ) 
                               throws  ItemException, RemoteException;

  /**
   * This business method updates an item
   * @param <b>Item</b> - Item information to be updated
   * @throws <b>ItemException</b> if the item cannot be updated
   * @throws <b>RemoteException</b> container error
   */
  void updateItem( Item item ) throws ItemException, RemoteException;

  /**
   * This business method adds a subcategory
   * @param <b>subCat</b> - Subcategory information to be added
   * @throws <b>CategoryException</b> if the subcategory cannot be added
   * @throws <b>RemoteException</b> container error
   */
  void addSubcategory( SubCategory subCat ) 
                       throws CategoryException, RemoteException;

  /**
   * This business method updates a sub-category
   * @param <b>subCat</b> - Subcategory information to be updated
   * @throws <b>CategoryException</b> if the subcategory cannot be updated
   * @throws <b>RemoteException</b> container error
   */
  void updateSubCategory( SubCategory subCat ) 
                          throws CategoryException, RemoteException;

  /**
   * This business method deletes an subcategory from a shop
   * @param <b>subCatID</b> - ID of the subcategory to be removed
   * @param <b>shopID</b> - ID of the shop from which the subcategory has to be removed
   * @throws <b>CategoryException</b> if the subcategory cannot be deleted
   * @throws <b>RemoteException</b> container error
   */
  void deleteSubCategory( String subCatID, String shopID ) 
                         throws CategoryException, RemoteException;

  /**
   * This business method looks up all the sub-categories for a shop
   * @param <b>shopID</b> - ID of the shop whose subcategories are to be queried
   * @param <b>langID</b> - Language in which the subcategories have to be queried
   * @return <b>SubCategory[]</b>  - Array of sub-category value objects
   * @throws <b>CategoryException</b> if the subcategories cannot be looked up
   * @throws <b>RemoteException</b> container error
   */
  SubCategory[] getSubCategories( String shopID, String langID ) 
                                  throws CategoryException, RemoteException;

  /**
   * This business method ship the pending orders
   * @param <b>orderDetails</b> - List of order Details that need to be managed
   * @throws <b>OrderException</b> if the order item status cannot be modified
   * @throws <b>RemoteException</b> container error
   */
  void manageOrders( List orderDetails ) 
                     throws OrderException, RemoteException;

  /**
   * This business method look up the details for a given shop
   * @param <b>shopID</b> - ID of the shop whose details have to be queried
   * @param <b>langID</b> - Language in which the details have to be queried
   * @return <b>Shop</b>  - Details of the shop
   * @throws <b>ShopException</b> if the shop details cannot be queried
   * @throws <b>RemoteException</b> container error
   */
  Shop getShopDetails( String shopID, String langID )
                       throws ShopException, RemoteException ;

  /**
   * This business method processes a discontinuance request for a shop
   * @param <b>shopID</b> - ID of the shop which has to be discontinued
   * @param <b>reason</b> - Reason for the discontinuance
   * @param <b>langID</b> - Language in which the reason for discontinuance 
   *                        is specified
   * @throws <b>ShopException</b> if the shop cannot be discontinued
   * @throws <b>RemoteException</b> container error
   */
  void discontinueShop( String shopID, String reason, String langID ) 
                        throws ShopException, RemoteException;

  /**
   * This business method retrieves the shop ID owned by the specified user
   * @param <b>userName</b> - username of the shop owner
   * @return <b>String</b>  - ID of the shop
   * @throws <b>ShopException</b> if the shop information cannot be retrieved
   * @throws <b>RemoteException</b> container error
   */
  String getShopForUser( String userName ) throws ShopException, RemoteException;  

  /**
   * The business method updates information about a shop
   * @param <b>shop</b> - Information about the shop
   * @throws <b>ShopException</b> if the shop cannot be updated
   * @throws <b>RemoteException</b> container error
   */
  void updateShopDetails( Shop shop ) throws ShopException, RemoteException;

  /**
   * This business method retrieves subcategory information
   * @param <b>subCatID</b> - ID of the subcategory that needs to be queried
   * @param <b>langID</b> - Language in which information has to be queried
   * @return <b>SubCategory</b>  - Details of the subcategory
   * @throws <b>ShopException</b> if the subcategory cannot be queried
   * @throws <b>RemoteException</b> container error
   */
  SubCategory getSubCategory( String subCatID, String langID ) 
                              throws CategoryException, RemoteException; 

  /**
   * This business method retrieves item information
   * @param <b>itemID</b> - ID of the item that needs to be queried
   * @param <b>langID</b> - Language in which information has to be queried
   * @return <b>Item</b>  - Details of the item
   * @throws <b>ShopException</b> if the item cannot be queried
   * @throws <b>RemoteException</b> container error
   */
  Item getItemDetails( String itemID, String langID ) 
                       throws ItemException, RemoteException;   
  
}