Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance. Project price only 1 $
You can buy this project and download/modify it how often you want.
/*
* Travel.java
*
* Created on November 16, 2005, 3:15 PM
*
* This library is provided under dual licenses.
* You may choose the terms of the Lesser General Public License or the Apache
* License at your discretion.
*
* Copyright (C) 2005 Robert Cooper, Temple of the Screaming Penguin
*
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2.1 of the License, or (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.rometools.modules.base;
import com.rometools.modules.base.types.CurrencyEnumeration;
import com.rometools.modules.base.types.DateTimeRange;
import com.rometools.modules.base.types.FloatUnit;
import com.rometools.modules.base.types.PaymentTypeEnumeration;
import com.rometools.modules.base.types.PriceTypeEnumeration;
import com.rometools.modules.base.types.ShippingType;
/**
* This is an interface for the GoogleBase plug in that exposes methods used for travel items.
*
* @author Robert "kebernet" Cooper
* @version $Revision: 1.1 $
*/
public interface Travel extends GlobalInterface {
/**
* Currency of the price amount for an item.
*
*
*
*
*
currency
*
*
*
*
Details
*
*
Currency of the price amount for an item. Values must be in ISO 4217
* currency code format.
*
*
*
Example
*
*
Acceptable:
* <g:currency>USD</g:currency>
*
* Not acceptable:
* <g:currency>US Dollars</g:currency>
*
* @param value Currency of the price amount for an item.
*/
public void setCurrency(CurrencyEnumeration value);
/**
* Currency of the price amount for an item.
*
*
*
*
*
currency
*
*
*
*
Details
*
*
Currency of the price amount for an item. Values must be in ISO 4217
* currency code format.
*
*
*
Example
*
*
Acceptable:
* <g:currency>USD</g:currency>
*
* Not acceptable:
* <g:currency>US Dollars</g:currency>
*
* @return Currency of the price amount for an item.
*/
public CurrencyEnumeration getCurrency();
/**
* Additional instructions to explain the item’s delivery process.
*
*
*
*
*
delivery_notes
*
*
*
Details
*
*
Additional instructions to explain the item’s delivery process.
*
*
*
Example
*
* <g:delivery_notes>Items usually shipped within 24
* hours.<g:/delivery_notes>
*
*
*
* @return Additional instructions to explain the item’s delivery process.
*/
public String getDeliveryNotes();
/**
* The maximum distance you will deliver an item in any direction.
*
*
*
*
delivery_radius
*
*
*
*
Details
*
The maximum distance you will deliver an item in any direction.
*
* @param deliveryRadius The maximum distance you will deliver an item in any direction.
*/
public void setDeliveryRadius(FloatUnit deliveryRadius);
/**
* The maximum distance you will deliver an item in any direction.
*
*
*
*
delivery_radius
*
*
*
*
Details
*
The maximum distance you will deliver an item in any direction.
*
* @return The maximum distance you will deliver an item in any direction.
*/
public FloatUnit getDeliveryRadius();
/**
* Starting city and state/country of the trip.
*
*
*
*
*
from_location
*
*
*
*
Details
*
*
Starting city and state/country of the trip.
*
*
*
Example
*
*
Acceptable:
* <g:from_location>San Francisco,
* CA</g:from_location>
*
* <g:from_location>Paris,
* France</g:from_location>
*
* Not acceptable:
* <g:from_location> San Francisco
* International
* Airport</g:from_location>
*
*
*
*
Attribute of
*
*
Travel
*
*
*
Content type
*
*
location
*
*
*
*
*
* @param fromLocation Starting city and state/country of the trip.
*/
public void setFromLocation(String fromLocation);
/**
* Starting city and state/country of the trip.
*
*
*
*
*
from_location
*
*
*
*
Details
*
*
Starting city and state/country of the trip.
*
*
*
Example
*
*
Acceptable:
* <g:from_location>San Francisco,
* CA</g:from_location>
*
* <g:from_location>Paris,
* France</g:from_location>
*
* Not acceptable:
* <g:from_location> San Francisco
* International
* Airport</g:from_location>
*
*
*
*
Attribute of
*
*
Travel
*
*
*
Content type
*
*
location
*
*
*
*
*
* @return Starting city and state/country of the trip.
*/
public String getFromLocation();
/**
* Acceptable payment methods for item purchases.
*
*
*
*
*
*
payment_accepted
*
*
*
Details
*
Acceptable payment methods for item purchases. Acceptable values are
* “Cash,” “Check,” “Traveler’s Check,” “Visa,” “MasterCard,”
*
* “American Express,” “Discover,” or “Wire transfer.” If you accept more than one method,
* include multiple instances of the <payment_accepted> attribute for each acceptable
* method.
*
* @param paymentAccepted Acceptable payment methods for item purchases.
*/
public void setPaymentAccepted(PaymentTypeEnumeration[] paymentAccepted);
/**
* Acceptable payment methods for item purchases.
*
*
*
*
*
*
payment_accepted
*
*
*
Details
*
Acceptable payment methods for item purchases. Acceptable values are
* “Cash,” “Check,” “Traveler’s Check,” “Visa,” “MasterCard,”
*
* “American Express,” “Discover,” or “Wire transfer.” If you accept more than one method,
* include multiple instances of the <payment_accepted> attribute for each acceptable
* method.
*
* @return Additional instructions to explain a payment policy.
*/
public String getPaymentNotes();
/**
* Price of the item.
*
*
*
*
*
*
*
price
*
*
*
Details
*
Prices can be a single price, 0 (free), or blank if not applicable.
* Numerice values only. When used as a sub-attribute of <shipping>, the value included
* reflects the price of shipping.
*
*
*
*
Example
*
Acceptable:
* <g:price>5.95</g:price>
*
* <g:price>0</g:price>
* Not acceptable:
* <g:price>5,95</g:price>
* <g:price>5.00 – 10.00</g:price>
*
* <g:price>100 or best offer</g:price>
* <g:price>free</g:price>
*
* @param priceType The type of pricing for the item.
*/
public void setPriceType(PriceTypeEnumeration priceType);
/**
* The type of pricing for the item.
*
*
*
*
*
price_type
*
*
*
*
*
Details
*
The type of pricing for the item. Acceptable values are “negotiable,” or
* “starting.” The default is “starting”
*
*
*
*
Example
*
*
Acceptable:
* <g:price_type>starting</g:price_type>
* Not acceptable:
* <g:price_type>100 OBO</g:price_type>
The number of units available for purchase. This attribute can be left
* blank if you have a large quantity or if it is not applicable.
*
*
*
*
*
Example
*
Acceptable:
* <g:quantity>18</g:quantity>
*
* <g:quantity>0</g:quantity>
*
* Not acceptable:
* <g:quantity>out of stock</g:quantity>
*
*
*
*
* Attribute of
*
*
Events, Products, Services, Travel, Vehicles
*
*
*
Content type
*
*
*
* integer
*
*
*
*
* @return Quantity available.
*/
public Integer getQuantity();
/**
* Tax rate associated with the event.
*
*
*
*
*
tax_percent
*
*
*
*
*
* Details
*
Tax rate as a percentage.
*
*
*
*
Example
*
*
<g:tax_percent>8.2<g:/tax_percent>
*
*
*
*
* Attribute of
*
*
* Products, Events
*
*
*
Content type
*
*
percentType
*
*
*
*
*
* @param taxPercent Tax rate associated with the event.
*/
public void setTaxPercent(Float taxPercent);
/**
* Tax rate associated with the service.
*
*
*
*
*
tax_percent
*
*
*
*
*
* Details
*
Tax rate as a percentage.
*
*
*
*
Example
*
*
<g:tax_percent>8.2<g:/tax_percent>
*
*
*
*
* Attribute of
*
*
* Products, Events
*
*
*
Content type
*
*
percentType
*
*
*
*
*
* @return Tax rate associated with the event.
*/
public Float getTaxPercent();
/**
* Region where tax applies.
*
*
*
*
*
*
*
*
* tax_region
*
*
*
*
Details
*
Geographical region a tax rate applies to.
*
*
*
*
*
* Example
*
<g:tax_region>California</g:tax_region>
*
*
*
*
Attribute of
*
*
Product, Events,
*
*
*
*
Content type
*
string
*
*
*
*
*
* @param taxRegion Region where tax applies.
*/
public void setTaxRegion(String taxRegion);
/**
* Region where tax applies.
*
*
*
*
*
*
*
*
* tax_region
*
*
*
*
Details
*
Geographical region a tax rate applies to.
*
*
*
*
*
* Example
*
<g:tax_region>California</g:tax_region>
*
*
*
*
Attribute of
*
*
Product, Events,
*
*
*
*
Content type
*
string
*
*
*
*
*
* @return Region where tax applies.
*/
public String getTaxRegion();
/**
* Destination city and state/country of the trip.
*
*
*
*
*
*
to_location
*
*
*
*
*
* Details
*
Destination city and state/country of the trip.
*
*
*
*
* Example
*
*
Acceptable:
* <g:to_location>San Francisco,
* CA</g:to_location>
* <g:to_location>Paris,
* France</g:to_location>
*
* Not acceptable:
* <g:to_location>San Francisco
* International
* Airport</g:to_location>
*
*
*
*
* Attribute of
*
Travel
*
*
*
Content type
*
*
locationyTpe
*
*
*
*
* @param toLocation Destination city and state/country of the trip.
*/
public void setToLocation(String toLocation);
/**
* Destination city and state/country of the trip.
*
*
*
*
*
*
to_location
*
*
*
*
*
* Details
*
Destination city and state/country of the trip.
*
*
*
*
* Example
*
*
Acceptable:
* <g:to_location>San Francisco,
* CA</g:to_location>
* <g:to_location>Paris,
* France</g:to_location>
*
* Not acceptable:
* <g:to_location>San Francisco
* International
* Airport</g:to_location>
*
*
*
*
* Attribute of
*
Travel
*
*
*
Content type
*
*
locationyTpe
*
*
*
*
* @return Destination city and state/country of the trip.
*/
public String getToLocation();
/**
* Departure date and time of the trip.
*
*
*
*
*
travel_date_range
*
*
*
*
Details
*
Departure date and time of the trip in ISO 8601
* format: YYYY-MM-DD,hh:mmAM (12 hour clock) or YYYY-MM-DD,hh:mm (24 hour clock). Two
* sub-attributes are included in travel_date_range attribute.
*
*
*
start = Start date and time of a trip in format YYYY-MM-DDThh:mm:ss
*
end = End date and time of a trip in format YYYY-MM-DDThh:mm:ss
*
* @param travelDateRange Departure date and time of the trip.
*/
public void setTravelDateRange(DateTimeRange travelDateRange);
/**
* Departure date and time of the trip.
*
*
*
*
*
travel_date_range
*
*
*
*
Details
*
Departure date and time of the trip in ISO 8601
* format: YYYY-MM-DD,hh:mmAM (12 hour clock) or YYYY-MM-DD,hh:mm (24 hour clock). Two
* sub-attributes are included in travel_date_range attribute.
*
*
*
start = Start date and time of a trip in format YYYY-MM-DDThh:mm:ss
*
end = End date and time of a trip in format YYYY-MM-DDThh:mm:ss
*
* @return Departure date and time of the trip.
*/
public DateTimeRange getTravelDateRange();
/**
* Location of the property.
*
*
*
*
*
location
*
*
*
*
Details
*
Location of a property. Should include street, city, state, postal code,
* and country, in that order.
*
*
*
*
Example
*
*
Acceptable:
* <g:location>123 Main St, Anytown,
* CA, 12345,
* USA</g:location>
*
* Not acceptable:
* <g:location>123 Main St,, CA,
* 12345,
* USA</g:location>
* <g:location> Anytown, CA,
* 12345,
* USA</g:location>
*
*
*
*
Attribute of
*
Reference Items, Events, Housing, Jobs, News and Articles, People
* profiles, Products, Reviews, Services, Travel, Vehicles, Wanted Ads.
*
*
*
*
*
Content type
*
locationType
*
*
*
*
* @param location Location of the property.
*/
public void setLocation(String location);
/**
* Location of the property.
*
*
*
*
*
location
*
*
*
*
Details
*
Location of a property. Should include street, city, state, postal code,
* and country, in that order.
*
*
*
*
Example
*
*
Acceptable:
* <g:location>123 Main St, Anytown,
* CA, 12345,
* USA</g:location>
*
* Not acceptable:
* <g:location>123 Main St,, CA,
* 12345,
* USA</g:location>
* <g:location> Anytown, CA,
* 12345,
* USA</g:location>
*
*
*
*
Attribute of
*
Reference Items, Events, Housing, Jobs, News and Articles, People
* profiles, Products, Reviews, Services, Travel, Vehicles, Wanted Ads.
*
*
*
*
*
Content type
*
locationType
*
*
*
*
* @return Location of the property.
*/
public String getLocation();
/**
* Shipping options available for an item.
*
*
*
*
*
*
* shipping
*
*
*
Details
*
*
Shipping options available for an item. Up to 10 shipping options can be
* included for each item. Three sub-attributes are included in the shipping attribute:
*
*
*
service = The type of service used to ship an item. Acceptable values are 'FedEx', 'UPS',
* 'DHL', 'Mail', and 'Other'
*
country = The country an item will ship to. Only acceptable values areISO 3166
* country codes.
