Module com.rometools.rome.modules
Package com.rometools.modules.base

Interface Vehicle

    • Method Detail

      • setColors

        void setColors​(String[] color)
        Color of an item.
        color
        Details Color of an item.
        Example <g:color>Black</g:color>
        Attribute of Products, Vehicles
        Content type string
        Parameters:
        color - Color of an item.

      • getColors

        String[] getColors()
        Color of an item.
        color
        Details Color of an item.
        Example <g:color>Black</g:color>
        Attribute of Products, Vehicles
        Content type string
        Returns:
        Color of an item.

      • setCondition

        void setCondition​(String condition)
        Condition of the item. For example: new, used, or refurbished.
        condition
        Details Condition of the item. For example: new, used, or refurbished.
        Example <g:condition>refurbished</g:condition>
        Attribute of Products, Vehicles
        Content type string
        Parameters:
        condition - Condition of the item. For example: new, used, or refurbished.

      • getCondition

        String getCondition()
        Condition of the item. For example: new, used, or refurbished.
        condition
        Details Condition of the item. For example: new, used, or refurbished.
        Example <g:condition>refurbished</g:condition>
        Attribute of Products, Vehicles
        Content type string
        Returns:
        Condition of the item. For example: new, used, or refurbished.

      • 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.

      • setLocation

        void setLocation​(String location)
        Location of a property. Should include street, city, state, postal code, and country, in that order.
        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 a property. Should include street, city, state, postal code, and country, in that order.

      • getLocation

        String getLocation()
        Location of a property. Should include street, city, state, postal code, and country, in that order.
        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 a property. Should include street, city, state, postal code, and country, in that order.

      • setMake

        void setMake​(String make)
        The vehicle manufacturer.
        make
        Details The vehicle manufacturer.
        Example <g:make>Honda</g:make>
        Attribute of Vehicles
        Content type string
        Parameters:
        make - The vehicle manufacturer.

      • getMake

        String getMake()
        The vehicle manufacturer.
        make
        Details The vehicle manufacturer.
        Example <g:make>Honda</g:make>
        Attribute of Vehicles
        Content type string
        Returns:
        The vehicle manufacturer.

      • setMileage

        void setMileage​(Integer mileage)
        Current mileage of the vehicle.
        mileage
        Details Current mileage of the vehicle.
        Example <g:mileage>1700</g:mileage>

        <g:mileage>1,700 miles</g:mileage>
        Attribute of Vehicles
        Content type intUnit
        Parameters:
        mileage - Current mileage of the vehicle.

      • getMileage

        Integer getMileage()
        Current mileage of the vehicle.
        mileage
        Details Current mileage of the vehicle.
        Example <g:mileage>1700</g:mileage>

        <g:mileage>1,700 miles</g:mileage>
        Attribute of Vehicles
        Content type intUnit
        Returns:
        Current mileage of the vehicle.

      • setModel

        void setModel​(String model)
        The vehicle model.
        model
        Details The vehicle model.
        Example <g:model>Camry</g:model>
        Attribute of Vehicles
        Content type string
        Parameters:
        model - The vehicle model.

      • getModel

        String getModel()
        The vehicle model.
        model
        Details The vehicle model.
        Example <g:model>Camry</g:model>
        Attribute of Vehicles
        Content type string
        Returns:
        The vehicle model.

      • setPaymentAccepted

        void setPaymentAccepted​(PaymentTypeEnumeration[] paymentAccepted)
        Payment Methods acceptable for the service.
        payment_accepted
        Details Acceptable payment methods for item purchases. Acceptable values are "Cash," "Check," "Traveler’s Check," "Visa," "MasterCard," "American Express," "Discover," "Wire transfer" or "Paypal." 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>
        <g:payment_accepted>Paypal</g:payment_accepted>
        Not acceptable:
        <g:payment_accepted>Cash Check Paypal</g:payment_accepted>
        Attribute of Events, Housing, Products, Services, Travel, Vehicles
        Content type paymentMethodEnumeration
        Parameters:
        paymentAccepted - Payment Methods acceptable for the service.

      • getPaymentAccepted

        PaymentTypeEnumeration[] getPaymentAccepted()
        Payment Methods acceptable for the service.
        payment_accepted
        Details Acceptable payment methods for item purchases. Acceptable values are "Cash," "Check," "Traveler’s Check," "Visa," "MasterCard," "American Express," "Discover," "Wire transfer" or "Paypal." 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>
        <g:payment_accepted>Paypal</g:payment_accepted>
        Not acceptable:
        <g:payment_accepted>Cash Check Paypal</g:payment_accepted>
        Attribute of Events, Housing, Products, Services, Travel, Vehicles
        Content type paymentMethodEnumeration
        Returns:
        Payment Methods acceptable for the service.

      • setPaymentNotes

        void setPaymentNotes​(String paymentNotes)
        Additional payment information.
        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 payment information.

      • getPaymentNotes

        String getPaymentNotes()
        Additional payment information.
        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 payment information.

      • setPrice

        void setPrice​(FloatUnit price)
        Price for the service.
        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
        Parameters:
        price - Price for the service.

      • getPrice

        FloatUnit getPrice()
        Price for the service.
        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 for the service.

      • setPriceType

        void setPriceType​(PriceTypeEnumeration priceType)
        Price type information.
        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 - Price type information.

      • getPriceType

        PriceTypeEnumeration getPriceType()
        Price type information.
        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:
        Price type information.

      • 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.

      • setShipping

        void setShipping​(ShippingType[] shipping)
        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
        Parameters:
        shipping - Shipping options available for an item.

      • 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.

      • setTaxPercent

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

      • setVehicleType

        void setVehicleType​(String vehicleType)
        The type of vehicle: Car, motorcycle, scooter, etc.
        vehicle_type
        Details The type of vehicle: Car, motorcycle, scooter, etc.
        Example <g:vehicle_type>truck</g:vehicle_type>
        Attribute of Products
        Content type string
        Parameters:
        vehicleType - The type of vehicle: Car, motorcycle, scooter, etc.

      • getVehicleType

        String getVehicleType()
        The type of vehicle: Car, motorcycle, scooter, etc.
        vehicle_type
        Details The type of vehicle: Car, motorcycle, scooter, etc.
        Example <g:vehicle_type>truck</g:vehicle_type>
        Attribute of Products
        Content type string
        Returns:
        The type of vehicle: Car, motorcycle, scooter, etc.

      • setVin

        void setVin​(String vin)
        Vehicle Identification Number.
        vin
        Details Vehicle Identification Number.
        Example <g:vin>1M8GDM9AXKP042788</g:vin>
        Attribute of Vehicles
        Content type string
        Parameters:
        vin - Vehicle Identification Number.

      • getVin

        String getVin()
        Vehicle Identification Number.
        vin
        Details Vehicle Identification Number.
        Example <g:vin>1M8GDM9AXKP042788</g:vin>
        Attribute of Vehicles
        Content type string
        Returns:
        Vehicle Identification Number.

      • setYear

        void setYear​(YearType year)
        The four digit model year or year built.
        year
        Details The four digit model year or year built. Format YYYY
        Example Acceptable:
        <g:year>2005</g:year>
        Not acceptable:
        <g:year>79</g:year>
        <g:year>26</g:year>
        Attribute of Housing, Vehicles
        Content type year
        Parameters:
        year - The four digit model year or year built.

      • getYear

        YearType getYear()
        The four digit model year or year built.
        year
        Details The four digit model year or year built. Format YYYY
        Example Acceptable:
        <g:year>2005</g:year>
        Not acceptable:
        <g:year>79</g:year>
        <g:year>26</g:year>
        Attribute of Housing, Vehicles
        Content type year
        Returns:
        The four digit model year or year built.