Package com.rometools.modules.base

Interface Travel

    • Method Detail

      • setCurrency

        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>
        Attribute of Events, Housing, Products, Services, Travel, Vehicles
        Content type currencyEnumeration
        Parameters:
        value - Currency of the price amount for an item.

      • getCurrency

        CurrencyEnumeration getCurrency()
        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>
        Attribute of Events, Housing, Products, Services, Travel, Vehicles
        Content type currencyEnumeration
        Returns:
        Currency of the price amount for an item.

      • setDeliveryNotes

        void setDeliveryNotes​(String deliveryNotes)
        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>
        Attribute of Events, Products, Reviews, Services, Travel, Vehicles, Wanted Ads.
        Content type string
        Parameters:
        deliveryNotes - Additional instructions to explain the item’s delivery process.

      • getDeliveryNotes

        String getDeliveryNotes()
        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>
        Attribute of Events, Products, Reviews, Services, Travel, Vehicles, Wanted Ads.
        Content type string
        Returns:
        Additional instructions to explain the item’s delivery process.

      • setDeliveryRadius

        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.
        Example <g:delivery_radius>10<g:/delivery_radius>
        <g:delivery_radius>10km</g:delivery_radius>
        Attribute of Events, Products, Reviews, Services, Travel, Vehicles, Wanted Ads.
        Content type floatUnit
        Parameters:
        deliveryRadius - The maximum distance you will deliver an item in any direction.

      • getDeliveryRadius

        FloatUnit getDeliveryRadius()
        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.
        Example <g:delivery_radius>10<g:/delivery_radius>
        <g:delivery_radius>10km</g:delivery_radius>
        Attribute of Events, Products, Reviews, Services, Travel, Vehicles, Wanted Ads.
        Content type floatUnit
        Returns:
        The maximum distance you will deliver an item in any direction.

      • setFromLocation

        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
        Parameters:
        fromLocation - Starting city and state/country of the trip.

      • getFromLocation

        String getFromLocation()
        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
        Returns:
        Starting city and state/country of the trip.

      • setPaymentAccepted

        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.
        Example Acceptable:
        <g:payment_accepted>Cash</g:payment_accepted>
        <g:payment_accepted>Check</g:payment_accepted>
        Not acceptable:
        <g:payment_accepted>Cash Check</g:payment_accepted>
        Attribute of Events, Housing, Products, Services, Travel, Vehicles
        Content type paymentMethodEnumeration
        Parameters:
        paymentAccepted - Acceptable payment methods for item purchases.

      • getPaymentAccepted

        PaymentTypeEnumeration[] getPaymentAccepted()
        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.
        Example Acceptable:
        <g:payment_accepted>Cash</g:payment_accepted>
        <g:payment_accepted>Check</g:payment_accepted>
        Not acceptable:
        <g:payment_accepted>Cash Check</g:payment_accepted>
        Attribute of Events, Housing, Products, Services, Travel, Vehicles
        Content type paymentMethodEnumeration
        Returns:
        Acceptable payment methods for item purchases.

      • setPaymentNotes

        void setPaymentNotes​(String paymentNotes)
        Additional instructions to explain a payment policy.
        payment_notes
        Details Additional instructions to explain a payment policy.
        Example <g:payment_notes>Cash only for local orders.</g:payment_notes>
        Attribute of Events, Housing, Products, Services, Travel, Vehicles
        Content type string
        Parameters:
        paymentNotes - Additional instructions to explain a payment policy.

      • getPaymentNotes

        String getPaymentNotes()
        Additional instructions to explain a payment policy.
        payment_notes
        Details Additional instructions to explain a payment policy.
        Example <g:payment_notes>Cash only for local orders.</g:payment_notes>
        Attribute of Events, Housing, Products, Services, Travel, Vehicles
        Content type string
        Returns:
        Additional instructions to explain a payment policy.

      • getPrice

        FloatUnit getPrice()
        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>
        Attribute of Events, Housing, Products, Services, Travel, Vehicles
        Content type floatUnit
        Returns:
        Price of the item.

      • setPriceType

        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>
        Attribute of Events, Housing, Products, Services, Travel, Vehicles
        Content type priceTypeEnumeration
        Parameters:
        priceType - The type of pricing for the item.

      • getPriceType

        PriceTypeEnumeration getPriceType()
        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>
        Attribute of Events, Housing, Products, Services, Travel, Vehicles
        Content type priceTypeEnumeration
        Returns:
        The type of pricing for the item.

      • setQuantity

        void setQuantity​(Integer quantity)
        Quantity available.
        quantity
        Details 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
        Parameters:
        quantity - Quantity available.

      • getQuantity

        Integer getQuantity()
        Quantity available.
        quantity
        Details 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
        Returns:
        Quantity available.

      • setTaxPercent

        void setTaxPercent​(Float taxPercent)
        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
        Parameters:
        taxPercent - Tax rate associated with the event.

      • getTaxPercent

        Float getTaxPercent()
        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
        Returns:
        Tax rate associated with the event.

      • setTaxRegion

        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
        Parameters:
        taxRegion - Region where tax applies.

      • getTaxRegion

        String getTaxRegion()
        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
        Returns:
        Region where tax applies.

      • setToLocation

        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
        Parameters:
        toLocation - Destination city and state/country of the trip.

      • getToLocation

        String getToLocation()
        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
        Returns:
        Destination city and state/country of the trip.

      • setTravelDateRange

        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
        Example <g:travel_date_range>
        <g:start>2005-12-20T06:00:00</g:start>
        <g:end>2005-12-29T13:00:00</g:end>
        </g:travel_date_range>
        Attribute of Travel
        Content type dateTimeRange
        Parameters:
        travelDateRange - Departure date and time of the trip.

      • getTravelDateRange

        DateTimeRange getTravelDateRange()
        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
        Example <g:travel_date_range>
        <g:start>2005-12-20T06:00:00</g:start>
        <g:end>2005-12-29T13:00:00</g:end>
        </g:travel_date_range>
        Attribute of Travel
        Content type dateTimeRange
        Returns:
        Departure date and time of the trip.

      • setLocation

        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
        Parameters:
        location - Location of the property.

      • getLocation

        String getLocation()
        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
        Returns:
        Location of the property.

      • getShipping

        ShippingType[] getShipping()
        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 are ISO 3166 country codes.
        • price = the price of shipping.
        Example <g:shipping>
        <g:country>US</g:country>
        <g:service>UPS</g:shipping>
        <g:price>35.95</g:price>
        </g:shipping>
        Attribute of Products
        Content type shippingType
        Returns:
        Shipping options available for an item.