Package com.rometools.modules.base

Interface Event

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

      • setEventDateRange

        void setEventDateRange​(DateTimeRange eventDateRange)
        The time during which this event takes place.
        event_date_range
        Details Information on the date and time an event will take place, in ISO 8601 format. Two sub-attributes are included in the event_date_range attribute:
        • from = Date and time an event will begin in format YYYY-MM-DDThh:mm:ss
        • to = (Optional). Date and time an event will end, in format YYYY-MM-DDThh:mm:ss
        Example <g:event_dateTime>
        <g:from>2005-12-20T14:00:00</g:from>
        <g:to>2005-12-20T19:00:00</g:to>
        </g:eventdateTime>
        Attribute of Events
        Content type dateTimeRange
        Parameters:
        eventDateRange - The time during which this event takes place.

      • getEventDateRange

        DateTimeRange getEventDateRange()
        The time during which this event takes place.
        event_date_range
        Details Information on the date and time an event will take place, in ISO 8601 format. Two sub-attributes are included in the event_date_range attribute:
        • from = Date and time an event will begin in format YYYY-MM-DDThh:mm:ss
        • to = (Optional). Date and time an event will end, in format YYYY-MM-DDThh:mm:ss
        Example <g:event_dateTime>
        <g:from>2005-12-20T14:00:00</g:from>
        <g:to>2005-12-20T19:00:00</g:to>
        </g:eventdateTime>
        Attribute of Events
        Content type dateTimeRange
        Returns:
        The time during which this event takes place.

      • setLocation

        void setLocation​(String location)
        Location where the event will be held.
        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 where the event will be held.

      • getLocation

        String getLocation()
        Location where the event will be held.
        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 where the event will be held.

      • setPaymentAccepted

        void setPaymentAccepted​(PaymentTypeEnumeration[] paymentAccepted)
        Payment Methods acceptable for the event.
        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 event.

      • getPaymentAccepted

        PaymentTypeEnumeration[] getPaymentAccepted()
        Payment Methods acceptable for the event.
        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 event.

      • setPaymentNotes

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

      • getPaymentNotes

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

      • setPrice

        void setPrice​(FloatUnit price)
        Price of the event.
        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 of the event.

      • getPrice

        FloatUnit getPrice()
        Price of the event.
        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 event.

      • setPriceType

        void setPriceType​(PriceTypeEnumeration priceType)
        Price qualifier for the even cost.
        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 qualifier for the even cost.

      • getPriceType

        PriceTypeEnumeration getPriceType()
        Price qualifier for the even cost.
        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 qualifier for the even cost.

      • 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 information related to the event.
        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 information related to the event.

      • getShipping

        ShippingType[] getShipping()
        Shipping information related to the event.
        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 information related to the event.

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