Package com.rometools.modules.base

Interface Product

    • Method Detail

      • setActors

        void setActors​(String[] actors)
        Actor featured in the video.
        actor
        Details Actor featured in the video.
        Example <g:actor>Charlie Chaplin</g:actor>
        Attribute of Products
        Content type string
        Parameters:
        actors - Actor featured in the video.

      • getActors

        String[] getActors()
        Actor featured in the video.
        actor
        Details Actor featured in the video.
        Example <g:actor>Charlie Chaplin</g:actor>
        Attribute of Products
        Content type string
        Returns:
        Actor featured in the video.

      • setApparelType

        void setApparelType​(String apparelType)
        The type of apparel being offered.
        apparel_type
        Details The type of apparel being offered. Skirt, pants, sleepwear, etc.
        Example <g:apparel_type>sweater</g:apparel_type>
        Attribute of Products
        Content type string
        Parameters:
        apparelType - The type of apparel being offered.

      • getApparelType

        String getApparelType()
        The type of apparel being offered.
        apparel_type
        Details The type of apparel being offered. Skirt, pants, sleepwear, etc.
        Example <g:apparel_type>sweater</g:apparel_type>
        Attribute of Products
        Content type string
        Returns:
        The type of apparel being offered.

      • setArtists

        void setArtists​(String[] artists)
        Artist that created the work.
        artist
        Details Artist that created the work.
        Example <g:artist>Vincent van Gogh</g:artist>
        Attribute of Products
        Content type string
        Parameters:
        artists - Artist that created the work.

      • getArtists

        String[] getArtists()
        Artist that created the work.
        artist
        Details Artist that created the work.
        Example <g:artist>Vincent van Gogh</g:artist>
        Attribute of Products
        Content type string
        Returns:
        Artist that created the work.

      • setAuthors

        void setAuthors​(String[] authors)
        Author of the item.
        author
        Details Author of the item.
        Example <g:author>John Steinbeck</g:author>
        Attribute of Reference Items, News and Articles
        Content type string
        Parameters:
        authors - Author of the item.

      • getAuthors

        String[] getAuthors()
        Author of the item.
        author
        Details Author of the item.
        Example <g:author>John Steinbeck</g:author>
        Attribute of Reference Items, News and Articles
        Content type string
        Returns:
        Author of the item.

      • setBrand

        void setBrand​(String brand)
        The brand name of an item.
        brand
        Details The brand name of an item.
        Example <g:brand>Acme</g:brand>
        Attribute of Products
        Content type string
        Parameters:
        brand - The brand name of an item.

      • getBrand

        String getBrand()
        The brand name of an item.
        brand
        Details The brand name of an item.
        Example <g:brand>Acme</g:brand>
        Attribute of Products
        Content type string
        Returns:
        The brand name of an item.

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

      • setFormat

        void setFormat​(String[] format)
        Format of the content.
        format
        Details Format of the content.
        Example <g:format>DVD</g:format>
        <g:format>CD</g:format>
        Attribute of Products
        Content type string
        Parameters:
        format - Format of the content.

      • getFormat

        String[] getFormat()
        Format of the content.
        format
        Details Format of the content.
        Example <g:format>DVD</g:format>
        <g:format>CD</g:format>
        Attribute of Products
        Content type string
        Returns:
        Format of the content.

      • setIsbn

        void setIsbn​(String isbn)
        A unique 10 or 13 digit number assigned to every printed book.
        isbn
        Details A unique 10 or 13 digit number assigned to every printed book.
        Example <g:isbn>0451524233</g:isbn>
        Attribute of Products
        Content type string
        Parameters:
        isbn - A unique 10 or 13 digit number assigned to every printed book.

      • getIsbn

        String getIsbn()
        A unique 10 or 13 digit number assigned to every printed book.
        isbn
        Details A unique 10 or 13 digit number assigned to every printed book.
        Example <g:isbn>0451524233</g:isbn>
        Attribute of Products
        Content type string
        Returns:
        A unique 10 or 13 digit number assigned to every printed book.

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

      • setManufacturer

        void setManufacturer​(String manufacturer)
        Company that manufactures the item.
        manufacturer
        Details Company that manufactures the item.
        Example <g:manufacturer>Acme, Inc</g:manufacturer>
        Attribute of Products
        Content type string
        Parameters:
        manufacturer - Company that manufactures the item.

      • getManufacturer

        String getManufacturer()
        Company that manufactures the item.
        manufacturer
        Details Company that manufactures the item.
        Example <g:manufacturer>Acme, Inc</g:manufacturer>
        Attribute of Products
        Content type string
        Returns:
        Company that manufactures the item.

      • setManufacturerId

        void setManufacturerId​(String manufacturerId)
        Unique product ID code assigned by its manufacturer.
        manufacturer_id
        Details Unique product ID code assigned by its manufacturer.
        Example <g:manufacturer_id>030779A</g:manufacturer_id>
        Attribute of Products
        Content type string
        Parameters:
        manufacturerId - Unique product ID code assigned by its manufacturer.

      • getManufacturerId

        String getManufacturerId()
        Unique product ID code assigned by its manufacturer.
        manufacturer_id
        Details Unique product ID code assigned by its manufacturer.
        Example <g:manufacturer_id>030779A</g:manufacturer_id>
        Attribute of Products
        Content type string
        Returns:
        Unique product ID code assigned by its manufacturer.

      • setMegapixels

        void setMegapixels​(FloatUnit megapixels)
        Resolution of a digital imaging device.
        megapixels
        Details Resolution of a digital imaging device.
        Example <g:megapixels>5.2 MP</g:megapixels>
        Attribute of Products
        Content type floatUnit
        Parameters:
        megapixels - Resolution of a digital imaging device.

      • getMegapixels

        FloatUnit getMegapixels()
        Resolution of a digital imaging device.
        megapixels
        Details Resolution of a digital imaging device.
        Example <g:megapixels>5.2 MP</g:megapixels>
        Attribute of Products
        Content type floatUnit
        Returns:
        Resolution of a digital imaging device.

      • setMemory

        void setMemory​(FloatUnit memory)
        The amount of memory included in an item.
        memory
        Details The amount of memory included in an item.
        Example <g:memory>128 MB</g:memory>
        Attribute of Products
        Content type floatUnit
        Parameters:
        memory - The amount of memory included in an item.

      • getMemory

        FloatUnit getMemory()
        The amount of memory included in an item.
        memory
        Details The amount of memory included in an item.
        Example <g:memory>128 MB</g:memory>
        Attribute of Products
        Content type floatUnit
        Returns:
        The amount of memory included in an item.

      • setModelNumber

        void setModelNumber​(String modelNumber)
        Model number of the product.
        model_number
        Details Model number of the product.
        Example <g:model_number>1924863</g:model_number>
        Attribute of Products
        Content type string
        Parameters:
        modelNumber - Model number of the product.

      • getModelNumber

        String getModelNumber()
        Model number of the product.
        model_number
        Details Model number of the product.
        Example <g:model_number>1924863</g:model_number>
        Attribute of Products
        Content type string
        Returns:
        Model number of the product.

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

      • setPickup

        void setPickup​(Boolean pickup)
        Whether or not an item is available for pick up.
        pickup
        Details Information about whether or not an item is available for pick up. Acceptable values are "True and "False".
        Example Acceptable:
        <g:pickup>True</g:pickup>
        Not acceptable:
        <g:pickup>Not on Tuesdays</g:pickup>
        Attribute of Products
        Content type boolean
        Parameters:
        pickup - Whether or not an item is available for pick up.

      • getPickup

        Boolean getPickup()
        Whether or not an item is available for pick up.
        pickup
        Details Information about whether or not an item is available for pick up. Acceptable values are "True and "False".
        Example Acceptable:
        <g:pickup>True</g:pickup>
        Not acceptable:
        <g:pickup>Not on Tuesdays</g:pickup>
        Attribute of Products
        Content type boolean
        Returns:
        Whether or not an item is available for pick up.

      • setPrice

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

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

      • setProcessorSpeed

        void setProcessorSpeed​(FloatUnit processorSpeed)
        The processor speed for the product.
        processor_speed
        Details The processor speed for the product.
        Example <g:processor_speed>2</g:processor_speed>
        Attribute of Products
        Content type floatUnit
        Parameters:
        processorSpeed - The processor speed for the product.

      • getProcessorSpeed

        FloatUnit getProcessorSpeed()
        The processor speed for the product.
        processor_speed
        Details The processor speed for the product.
        Example <g:processor_speed>2</g:processor_speed>
        Attribute of Products
        Content type floatUnit
        Returns:
        The processor speed for the product.

      • setProductTypes

        void setProductTypes​(String[] productTypes)
        The type of product being offered.
        product_type
        Details The type of product being offered. Toys, books, flowers, etc.
        Example <g:product_type>electronics</g:product_type>
        Attribute of Products
        Content type string
        Parameters:
        productTypes - The type of product being offered.

      • getProductTypes

        String[] getProductTypes()
        The type of product being offered.
        product_type
        Details The type of product being offered. Toys, books, flowers, etc.
        Example <g:product_type>electronics</g:product_type>
        Attribute of Products
        Content type string
        Returns:
        The type of product being offered.

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

      • setSize

        void setSize​(Size size)
        Dimensions of the item, expressed in either two or three dimensions.
        size
        Details Dimensions of the item, expressed in either two or three dimensions.
        Example <g:size>12x10x4</g:size>
        Attribute of Products
        Content type string
        Parameters:
        size - Dimensions of the item, expressed in either two or three dimensions.

      • getSize

        Size getSize()
        Dimensions of the item, expressed in either two or three dimensions.
        size
        Details Dimensions of the item, expressed in either two or three dimensions.
        Example <g:size>12x10x4</g:size>
        Attribute of Products
        Content type string
        Returns:
        Dimensions of the item, expressed in either two or three dimensions.

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

      • setUpc

        void setUpc​(String upc)
        Product UPC code (Isn't that redundant?).
        upc
        Details Product UPC code.
        Example <g:upc>834721479305</g:upc>
        Attribute of Products
        Content type string
        Parameters:
        upc - Product UPC code (Isn't that redundant?).

      • getUpc

        String getUpc()
        Product UPC code (Isn't that redundant?).
        upc
        Details Product UPC code.
        Example <g:upc>834721479305</g:upc>
        Attribute of Products
        Content type string
        Returns:
        Product UPC code (Isn't that redundant?).

      • setWeight

        void setWeight​(FloatUnit weight)
        Weight of the item.
        weight
        Details Weight of the item.
        Example <g:weight>5</g:weight>
        Attribute of Products
        Content type floatUnit
        Parameters:
        weight - Weight of the item.

      • getWeight

        FloatUnit getWeight()
        Weight of the item.
        weight
        Details Weight of the item.
        Example <g:weight>5</g:weight>
        Attribute of Products
        Content type floatUnit
        Returns:
        Weight of the item.