
%%%%%%%%%%%%%%%%%%%%%
Components of mRUBiS:
%%%%%%%%%%%%%%%%%%%%%

(1) User Management Service
(2) Item Management Service
(3) Authentication Service
(4) Bid and Buy Service
(5) Inventory Service
(6) Reputation Service
(7) Persistence Service
(8) Query Service


===============================================================================

-------------------------------------------------------------------------------
(1) User Management Service
===========================

Service for registering and browsing users.

PROVIDES:
	* AboutMeService: Service to retrieve information about the currently 
		logged in user.
	* BrowseRegionsService: Service for browsing the regions to which users
		belong.
	* UserRegistrationService: Service for registering a new user.
	* ViewUserInfoService: Retrieves information about any user to be presented
		to the user who is currently logged in.

REQUIRES:
	* Authentication Service (AuthenticationService)
	* Query Service (QueryService, BasicQueryService)
	* Persistence Service (BusinessObjectsPersistenceService)


-------------------------------------------------------------------------------
(2) Item Management Service
===========================

Service for registering and browsing items.

PROVIDES:
	* BrowseCategoriesService: Service for browsing categories and items.
	* ItemRegistrationService: Service for registering new items.

REQUIRES:
	* Authentication Service (AuthenticationService)
	* Query Service (QueryService, BasicQueryService)
	* Persistence Service (BusinessObjectsPersistenceService)


-------------------------------------------------------------------------------
(3) Authentication Service
==========================

Service for authenticating a user.

PROVIDES:
	* AuthenticationService: Service for authenticating a user.

REQUIRES:
	* Query Service (BasicQueryService)


-------------------------------------------------------------------------------
(4) Bid and Buy Service
=======================

Service for bidding and buying items.

PROVIDES:
	* BidService: Service for bidding on items.
	* BuyNowService: Service to buy-now items.

REQUIRES:
	* Authentication Service (AuthenticationService)
	* Query Service (QueryService, BasicQueryService)
	* Persistence Service (BusinessObjectsPersistenceService)
	* Inventory Service (InventoryService)


-------------------------------------------------------------------------------
(5) Inventory Service
=====================

Service for managing the inventory.

PROVIDES:
	* InventoryService: Service for managing the inventory.

REQUIRES:
	* Query Service (QueryService)
	* Persistence Service (BusinessObjectsPersistenceService)


-------------------------------------------------------------------------------
(6) Reputation Service
======================

Service for the user reputation system.

PROVIDES:
	* ReputationService: Service for the user reputation system.

REQUIRES:
	* Authentication Service (AuthenticationService)
	* Query Service (QueryService, BasicQueryService)
	* Persistence Service (BusinessObjectsPersistenceService)


-------------------------------------------------------------------------------
(7) Persistence Service
=======================

Service for persisting business objects.

PROVIDES:
	* BusinessObjectsPersistenceService: Service for persisting business 
		objects.

REQUIRES:
	* N/A


-------------------------------------------------------------------------------
(8) Query Service
=================



PROVIDES:
	* BasicQueryService: Service to retrieve basic information from the 
		database.
	* QueryService: Service to retrieve advanced information from the 
		database.

REQUIRES:
	* N/A


===============================================================================



%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
Project Structure of RUBiS-EJB3:
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

The folders "res" contain resources especially configuration files such as
deployment descriptors. The folders "src" contain Java source code.


  // Authentication Service
- authservice
	|_ res
	|_ src
  // Bid and Buy Service
- bidandbuyservice
	|_ res
	|_ src
  // Objects used by all Services 
  // (business objects are used by the service interfaces)
- businessobjects
	|_ res
	|_ src
  // Client Sample Application
- client
	|_ src
  // Interfaces of the Services 
  // (interfaces uses the business objects)
- contracts
	|_ res
	|_ src
  // SQL code for the database and test data
- database
  // Documentation
- doc
  // Database Entities
- entities
	|_ res
	|_ src
  // Inventory Service
- inventorymgmt
	|_ res
	|_ src
  // Item Management Service
- itemmgmt
	|_ res
	|_ src
  // Persistence Service
- persistenceservice
	|_ res
	|_ src
  // Query Service
- queryservice
	|_ res
	|_ src
  // Reputation Service
- reputationservice
	|_ res
	|_ src
  // User Management Service
- usermgmt
	|_ res
	|_ src
  // ANT script and properties
- build.properties
- build.xml
