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

com.sun.syndication.feed.module.base.Event Maven / Gradle / Ivy

/*
 * Event.java
 *
 * Created on November 16, 2005, 11:38 AM
 *
 * 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.sun.syndication.feed.module.base;

import com.sun.syndication.feed.module.base.types.CurrencyEnumeration;
import com.sun.syndication.feed.module.base.types.DateTimeRange;
import com.sun.syndication.feed.module.base.types.FloatUnit;
import com.sun.syndication.feed.module.base.types.PaymentTypeEnumeration;
import com.sun.syndication.feed.module.base.types.PriceTypeEnumeration;
import com.sun.syndication.feed.module.base.types.ShippingType;


/**
 * This is an interface for the GoogleBase plug in that exposes methods used for
 * Event entry types.
 * @author Robert "kebernet" Cooper
 * @version $Revision: 1.1 $
 */
public interface Event extends GlobalInterface {
    /**
     * 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
* @param value Currency of the price amount for an item. */ public 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
* @return Currency of the price amount for an item. */ public CurrencyEnumeration getCurrency(); /** * 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
* @param deliveryNotes Additional instructions to explain the item’s delivery process. */ public 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
* @return Additional instructions to explain the item’s delivery process. */ public String getDeliveryNotes(); /** * 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
* @param deliveryRadius The maximum distance you will deliver an item in any direction. */ public 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
* @return The maximum distance you will deliver an item in any direction. */ public FloatUnit getDeliveryRadius(); /** * 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
* @param eventDateRange The time during which this event takes place. */ public 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
* @return The time during which this event takes place. */ public DateTimeRange getEventDateRange(); /** * 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
* @param location Location where the event will be held. */ public 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
* @return Location where the event will be held. */ public String getLocation(); /** * 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
* @param paymentAccepted Payment Methods acceptable for the event. */ public 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
* @return Payment Methods acceptable for the event. */ public PaymentTypeEnumeration[] getPaymentAccepted(); /** * 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
* @param paymentNotes Additional information about payment. */ public 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
* * * @return Additional information about payment. */ public String getPaymentNotes(); /** * 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 typefloatUnit
* @param price Price of the event. */ public 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 typefloatUnit
* @return Price of the event. */ public FloatUnit getPrice(); /** * Price qualifier for the even cost. * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
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 qualifier for the even cost. */ public void setPriceType(PriceTypeEnumeration priceType); /** * Price qualifier for the even cost. * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
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 qualifier for the even cost. */ public PriceTypeEnumeration getPriceType(); /** * 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
* @param quantity Quantity available. */ public 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
* @return Quantity available. */ public Integer getQuantity(); /** * 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
* @param shipping Shipping information related to the event. */ public 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
* @return Shipping information related to the event. */ public ShippingType[] getShipping(); /** * 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
* @param taxPercent Tax rate associated with the event. */ public 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
* @return Tax rate associated with the event. */ public Float getTaxPercent(); /** * 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 typestring
* @param taxRegion Region where tax applies. */ public 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 typestring
* @return Region where tax applies. */ public String getTaxRegion(); }




© 2015 - 2024 Weber Informatics LLC | Privacy Policy