Package com.rometools.modules.base

Interface Housing

    • Method Detail

      • setAgents

        void setAgents​(String[] agents)
        An array of agent name Strings, not to exceed 10 in lenght.
        agent
        Details Individual who is negotiating and arranging the real estate sale.
        Example <g:agent>Sue Smith</g:agent>
        Attribute of Housing
        Content type string
        Parameters:
        agents - An array of agent name Strings, not to exceed 10 in lenght.

      • getAgents

        String[] getAgents()
        An array of agent name Strings, not to exceed 10 in lenght.
        agent
        Details Individual who is negotiating and arranging the real estate sale.
        Example <g:agent>Sue Smith</g:agent>
        Attribute of Housing
        Content type string
        Returns:
        An array of agent name Strings, not to exceed 10 in lenght.

      • setArea

        void setArea​(IntUnit area)
        The area of the real estate.
        area
        Details The size of an area of real estate.
        Example <g:area>1000</g:area>
        Attribute of Housing
        Content type intUnit
        Parameters:
        area - The area of the real estate

      • getArea

        IntUnit getArea()
        The area of the real estate.
        area
        Details The size of an area of real estate.
        Example <g:area>1000</g:area>
        Attribute of Housing
        Content type intUnit
        Returns:
        The area of the real estate

      • setBathrooms

        void setBathrooms​(Float bathrooms)
        The number of bathrooms.
        bathrooms
        Details Number of bathrooms. Numeric values only.
        Example Acceptable:
        <g:bathrooms>2</g:bathrooms>
        Not acceptable:
        <g:bathrooms>2 bathrooms</g:bathrooms>
        Attribute of Housing
        Content type float
        Parameters:
        bathrooms - The number of bathrooms.

      • getBathrooms

        Float getBathrooms()
        The number of bathrooms.
        bathrooms
        Details Number of bathrooms. Numeric values only.
        Example Acceptable:
        <g:bathrooms>2</g:bathrooms>
        Not acceptable:
        <g:bathrooms>2 bathrooms</g:bathrooms>
        Attribute of Housing
        Content type float
        Returns:
        number of bathrooms

      • setBedrooms

        void setBedrooms​(Integer bedrooms)
        Number of bedrooms.
        bedrooms
        Details Number of bedrooms. Numeric values only.
        Example Acceptable:
        <g:bedrooms>3</g:bedrooms>
        Not acceptable:
        <g:bedrooms>3 bedrooms</g:bedrooms>
        Attribute of Housing
        Content type integer
        Parameters:
        bedrooms - Number of bedrooms.

      • getBedrooms

        Integer getBedrooms()
        Number of bedrooms.
        bedrooms
        Details Number of bedrooms. Numeric values only.
        Example Acceptable:
        <g:bedrooms>3</g:bedrooms>
        Not acceptable:
        <g:bedrooms>3 bedrooms</g:bedrooms>
        Attribute of Housing
        Content type integer
        Returns:
        Number of bedrooms

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

      • setHoaDues

        void setHoaDues​(Float hoaDues)
        Homeowners association dues on the property.
        hoa_dues
        Details Monthly dues paid to a homeowners association.
        Example <g:hoa_dues>100</g:hoa_dues>
        Attribute of Housing
        Content type float
        Parameters:
        hoaDues - Homeowners association dues on the property.

      • getHoaDues

        Float getHoaDues()
        Homeowners association dues on the property.
        hoa_dues
        Details Monthly dues paid to a homeowners association.
        Example <g:hoa_dues>100</g:hoa_dues>
        Attribute of Housing
        Content type float
        Returns:
        Homeowners association dues on the property.

      • setListingType

        void setListingType​(Boolean forSale)
        Indicates whether this property is for sale or not.
        listing_type
        Details Information about whether or not a property is for sale or not. Acceptable values are "True" or "False".
        Example Acceptable:
        <g:for_sale>true</g:for_sale>
        <g:for_sale>false</g:for_sale>
        Not acceptable:
        <g:for_sale>Sale</g:for_sale>
        <g:for_sale>Rent</g:for_sale>
        Attribute of Housing
        Content type Boolean
        Parameters:
        forSale - Indicates whether this property is for sale or not.

      • getListingType

        Boolean getListingType()
        Indicates whether this property is for sale or not.
        listing_type
        Details Information about whether or not a property is for sale or not. Acceptable values are "True" or "False".
        Example Acceptable:
        <g:for_sale>true</g:for_sale>
        <g:for_sale>false</g:for_sale>
        Not acceptable:
        <g:for_sale>Sale</g:for_sale>
        <g:for_sale>Rent</g:for_sale>
        Attribute of Housing
        Content type Boolean
        Returns:
        Indicates whether this property is for sale or not.

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

      • setPaymentAccepted

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

      • getPaymentAccepted

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

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

      • getPrice

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

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

      • setPropertyTypes

        void setPropertyTypes​(String[] propertyTypes)
        Types of property represented here. Limit 10.
        property_type
        Details Type of property: house, apartment, condominium, etc.
        Example <g:property_type>house</g:property_type>
        Attribute of Housing
        Content type string
        Parameters:
        propertyTypes - Types of property represented here. Limit 10.

      • getPropertyTypes

        String[] getPropertyTypes()
        Types of property represented here.
        property_type
        Details Type of property: house, apartment, condominium, etc.
        Example <g:property_type>house</g:property_type>
        Attribute of Housing
        Content type string
        Returns:
        Types of property represented here. Limit 10.

      • setSchoolDistrict

        void setSchoolDistrict​(String schoolDistrict)
        School district a property is in.
        school_district
        Details The school district the property is in.
        Example <g:school_district>Union School District</g:school_district>
        Attribute of Housing
        Content type string
        Parameters:
        schoolDistrict - School district a property is in.

      • getSchoolDistrict

        String getSchoolDistrict()
        School district a property is in.
        school_district
        Details The school district the property is in.
        Example <g:school_district>Union School District</g:school_district>
        Attribute of Housing
        Content type string
        Returns:
        School district a property is in.

      • setTaxPercent

        void setTaxPercent​(Float taxPercent)
        Percentage tax rate.
        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 - Percentage tax rate.

      • getTaxPercent

        Float getTaxPercent()
        Percentage tax rate.
        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:
        Percentage tax rate.

      • setTaxRegion

        void setTaxRegion​(String taxRegion)
        Geographical region a tax rate applies to.
        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 - Geographical region a tax rate applies to.

      • getTaxRegion

        String getTaxRegion()
        Geographical region a tax rate applies to.
        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:
        Geographical region a tax rate applies to.

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