Files
-----
We use eight files in order to encode the information about vendors:


=================================
File names index: vendorFiles.ord
=================================
This file contains the list of the names of the other files in the system. 

File format:


<files>
	<file id="costFunction">costFunction.ord</file>
	<file id="vendorsList">vendorsList.ord</file>
	<file id="lowestCost">lowestCost.ord</file>
	<file id="resourceFn">resourceFn.ord</file>
	<file id="preOrder">preOrder.ord</file>
	<file id="order">order.ord</file>
	<file id="orderChanges">orderChanges.ord</file>
<files>


====================================
Cost function file: costFunction.ord
====================================
This file encodes the relationship between the cost of vendor 
allocations and incurred penalty. The rule for coming up with
cost based on various conference properties is also included.

File format:


<costFunction weight="1.0">
	<plf priority="150">
		<v1>...</v1>
		<v2>...</v2>
	</plf>
	<rule type="cost" id="costFnFromBudget"> 
		<p type="priority">100</p> 
		<p type="conferenceProperty" property="conferenceBudget">		
			known</p> 
		<p type="conferenceVariables"><var name="conferenceBudget"/> 
			</p>
 	...
	<rule>
</costFunction>

V1 is money in cents.
v2 is penalty.

Conference budget is given by the conferenceBudget conference variable.

========================================
Worldstate Modifications: worldstate.stp
========================================
Each property definition (pdef) has an optional attribute called 
serviceCategory which can be one of the three strings:
	- Room
	- Service
	- Combined
Service Preferences: These are plfs.

=============================
Vendor list file: vendors.ord
=============================
This file contains the list of vendors in the system with the 
offered items. There are two main "objects" in this file - 
the vendors list and the items list.

Vendors list contains information about each vendor including
the ids of the offered items and costs.

Items list contains information about each item given the
item id.

File format:

<vendorsAndItems>
<vendorsList complete="false">
	<vendor>
		<id>v1</id>
		<label>First Vendor</label>
		<items>
			<item>
				<id>dellProj</id>
				<cost>1000</cost>
			</item>
			<item>
				<id>HPNotebook</id>
				<cost>absent</cost>
			</item>
		</items>
	</vendor>
</vendorsList>

<itemsList>
	<item>
		<id>dellProj</id>
		<label>Dell Projector</label>
		<services>
			<service>computer-projector</service>
			<service>slide-projector</service>
		</services>
		<costType>item-hour</costType>
	</item>
	<item>
		<id>HPNotebook</id>
		<label>HP Notebook</label>
		<services>
			<service>computer</service>
		</services>
		<costType>item-hour</costType>
	</item>
	<item>
		<id>veggie</id>
		<label>Vegetarian Meal</label>
		<services>
			<service>vegetarian</service>
		</services>
		<costType>item</costType>
	</item>
</itemsList>
</vendorsAndItems>

===================================================
Lowest costs list: lowestCosts.ord (auto-generated)
===================================================
This automatically generated file keeps the list of
lowest costs for each item id.

File format:

<lowestCosts>
	<lowestCost>
		<itemID>dell</itemID>
		<cost>1000</cost>
	</lowestCost>
	<lowestCost>
		<itemID>hp</itemID>
		<cost>1500</cost>
	</lowestCost>
	<lowestCost>
		<itemID>proj</itemID>
		<cost>Unknown</cost>
	</lowestCost>
	<lowestCost>
		<itemID>vegie</itemID>
		<cost>600</cost>
	</lowestCost>
</lowestCosts>

===================================================
Resource functions: resourceFn.ord (auto-generated)
===================================================
This automatically generated file lists the relationship
between each event's score and cost with a given service.


<functions>
	<function>
		<eventID>SessionA1</eventID>
		<service>computer</service>
		<scorePlf>
			<plf>
				<v1>0</v1>
				<v2>-4</v2>
				<v1>1</v1>
				<v2>-2.5</v2>
				...
			</plf>
		</scorePlf>
		<costPlf>
			<plf>
				<v1>1</v1>
				<v2>2000</v2>
				<v1>2</v1>
				<v2>4000</v2>
				...
			</plf>
		</costPlf>
	</function>
</functions>

=========================================
Pre-orders: preOrder.ord (auto-generated)
=========================================
This automatically generated file lists preorders with
eventID, type of service and the number to be ordered.

File format:


<preOrders>
	<preOrder>
		<eventID>SessionA1</eventID>
		<service>computer</service>
		<itemCount>2</itemCount>
	</preOrder>
</preOrders>

===================================
Orders: orders.ord (auto-generated)
===================================
This automatically generated file contains the whole
order including the eventID, service type, number of
items ordered, vendor ordered from, itemID, cost of
ordering, id of the room, start time and duration.

File format:

<orders>
	<order>
		<eventID>SessionA1</eventID>
		<service>computer</service>
		<itemCount>2</itemCount>
		<vendorID>v1</vendorID>
		<itemID>HPNotebook</itemID>
		<cost>4000</cost>
		<roomID>McConomy</roomID>
		<startTime>1374000</startTime>
		<duration>3600</duration>
		<url>http://www.myurl.com/vendors.jsp</url>
	</order>
</orders>
Start time is in number of secs since 1/1/1970, duration in secs

================================================
Order changes: orderChanges.ord (auto-generated)
================================================
This automatically generated file holds the difference between
the previously placed order and the new order. These differences
are broken down into placements, cancellations and modifications.
The utility of order changes can be given as an attribute at the 
top but is optional.

File format:


<orderChanges>
	<placements>
		<placement utility="0.02">
			<eventID>SessionA1</eventID>
			<service>computer</service>
		</placement>
		<placement>
			...
		</placement>
	</placements>
	<cancellations>
		<cancellation utility="-0.005">
			<eventID>SessionA1</eventID>
			<service>projector</service>
		</cancellation>
		<cancellation>
			...
		</cancellation>
	</cancellations>
	<modifications>
		<modification utility="0.01">
			<oldOrder>
				<eventID>SessionA1</eventID>
				<service>vegetarian</service>
			</oldOrder>
			<newOrder>
				<eventID>SessionA1</eventID>
				<service>vegan</service>
			</newOrder>			
		</modification>
		<modification>
			...
		</modification>
	</modifications>
</orderChanges>

==============================
Order changes: multiOrders.ord
==============================
This file keeps track of multiple orders placed. These orders are kept 
seperately in this file and are not immediately mixed with the orders.

<multiOrders>
	<multiOrder>
		<eventID>plenary1</eventID>
		<vendorID>conferNet</vendorID>
		<cost>11500</cost>
		<startTime>1374000</startTime>
		<duration>3600</duration>
		<roomID>McConomy</roomID>
		<orders>
			<order>
				<service>microphone</service>
				<itemCount>1</itemCount>
				<itemID>podiumMike</itemID>
			</order>
			<order>
				<service>computer</service>
				<itemCount>1</itemCount>
				<itemID>laptopPC</itemID>
			</order>
		</orders>
	</multiOrder>
</multiOrders>