All Downloads are FREE. Search and download functionalities are using the official Maven repository.

com.rometools.modules.base.Housing Maven / Gradle / Ivy

/*
 * Housing.java
 *
 * Created on November 16, 2005, 12:48 PM
 *
 * This library is provided under dual licenses.
 * You may choose the terms of the Lesser General Public License or the Apache
 * License at your discretion.
 *
 *  Copyright (C) 2005  Robert Cooper, Temple of the Screaming Penguin
 *
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 *
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package com.rometools.modules.base;

import com.rometools.modules.base.types.CurrencyEnumeration;
import com.rometools.modules.base.types.FloatUnit;
import com.rometools.modules.base.types.IntUnit;
import com.rometools.modules.base.types.PaymentTypeEnumeration;
import com.rometools.modules.base.types.PriceTypeEnumeration;
import com.rometools.modules.base.types.YearType;

/**
 * This is an interface for the GoogleBase plug in that exposes methods used for Housing entry
 * types.
 *
 * @author Robert "kebernet" Cooper
 * @version $Revision: 1.1 $
 */
public interface Housing extends GlobalInterface {
    /**
     * An array of agent name Strings, not to exceed 10 in lenght.
     * 
     * 
     * 
     * 
     *
     * 
     * 
     * 
     * 
     *
     * 
     * 
     * 
     *
     * 
     * 
     * 
     *
     * 
     * 
     * 
     *
     * 
     * 
     * 
     *
     * 
     * 
     * 
agent
DetailsIndividual who is negotiating and arranging the real estate sale.
Example<g:agent>Sue Smith</g:agent>
Attribute ofHousing
Content typestring
* * @param agents An array of agent name Strings, not to exceed 10 in lenght. */ public void setAgents(String[] agents); /** * An array of agent name Strings, not to exceed 10 in lenght. * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
agent
DetailsIndividual who is negotiating and arranging the real estate sale.
Example<g:agent>Sue Smith</g:agent>
Attribute ofHousing
Content typestring
* * @return An array of agent name Strings, not to exceed 10 in lenght. */ public String[] getAgents(); /** * The area of the real estate. * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
area
DetailsThe size of an area of real estate.
Example<g:area>1000</g:area>
Attribute ofHousing
Content typeintUnit
* * @param area The area of the real estate */ public void setArea(IntUnit area); /** * The area of the real estate. * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
area
DetailsThe size of an area of real estate.
Example<g:area>1000</g:area>
Attribute ofHousing
Content typeintUnit
* * @return The area of the real estate */ public IntUnit getArea(); /** * 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
* * @param bathrooms The number of bathrooms. */ public 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
* * @return number of bathrooms */ public Float getBathrooms(); /** * 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
* * @param bedrooms Number of bedrooms. */ public 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
* * @return Number of bedrooms */ public Integer getBedrooms(); /** * Currency of the price amount for an item. * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
currency
DetailsCurrency of the price amount for an item. Values must be in ISO 4217 * currency code format.
ExampleAcceptable:
* <g:currency>USD</g:currency>
* * Not acceptable:
* <g:currency>US Dollars</g:currency>
Attribute ofEvents, Housing, Products, Services, Travel, Vehicles
Content typecurrencyEnumeration
* * @param value Currency of the price amount for an item. */ public void setCurrency(CurrencyEnumeration value); /** * Currency of the price amount for an item. * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
currency
DetailsCurrency of the price amount for an item. Values must be in ISO 4217 * currency code format.
ExampleAcceptable:
* <g:currency>USD</g:currency>
* * Not acceptable:
* <g:currency>US Dollars</g:currency>
Attribute ofEvents, Housing, Products, Services, Travel, Vehicles
Content typecurrencyEnumeration
* * @return Currency of the price amount for an item. */ public CurrencyEnumeration getCurrency(); /** * 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
* * @param hoaDues Homeowners association dues on the property. */ public 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
* * @return Homeowners association dues on the property. */ public Float getHoaDues(); /** * 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
* * @param forSale Indicates whether this property is for sale or not. */ public 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
* * @return Indicates whether this property is for sale or not. */ public Boolean getListingType(); /** * 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
* * @param location Location of the property. */ public 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
* * @return Location of the property. */ public String getLocation(); /** * 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
* * @param paymentAccepted Payment Methods acceptable for the property. */ public 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
* * @return Payment Methods acceptable for the property. */ public PaymentTypeEnumeration[] getPaymentAccepted(); /** * 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
* * @param paymentNotes Additional payment information. */ public 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
* * @return Additional payment information. */ public String getPaymentNotes(); /** * 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 typefloatUnit
* * @param price Price for the property. */ public 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 typefloatUnit
* * @return Price for the property. */ public FloatUnit getPrice(); /** * Price type information. * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
price_type
DetailsThe type of pricing for the item. Acceptable values are �negotiable,� or * �starting.� The default is �starting�
ExampleAcceptable:
* <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
* * @param priceType Price type information. */ public void setPriceType(PriceTypeEnumeration priceType); /** * Price type information. * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
price_type
DetailsThe type of pricing for the item. Acceptable values are �negotiable,� or * �starting.� The default is �starting�
ExampleAcceptable:
* <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
* * @return Price type information. */ public PriceTypeEnumeration getPriceType(); /** * 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
* * @param propertyTypes Types of property represented here. Limit 10. */ public void setPropertyTypes(String[] propertyTypes); /** * 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
* * @return Types of property represented here. Limit 10. */ public String[] getPropertyTypes(); /** * 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
* * @param schoolDistrict School district a property is in. */ public 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
* * @return School district a property is in. */ public String getSchoolDistrict(); /** * 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
* * @param taxPercent Percentage tax rate. */ public 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
* * @return Percentage tax rate. */ public Float getTaxPercent(); /** * 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 typestring
* * @param taxRegion Geographical region a tax rate applies to. */ public 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 typestring
* * @return Geographical region a tax rate applies to. */ public String getTaxRegion(); /** * 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
* * @param year The four digit model year or year built. */ public 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
* * @return The four digit model year or year built. */ public YearType getYear(); }




© 2015 - 2025 Weber Informatics LLC | Privacy Policy