• Home
• org.rometools
• rome-modules
• 1.0
• source code
• GlobalInterface.java

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

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

/*
 * GlobalInterface.java
 *
 * Created on November 16, 2005, 5:27 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.sun.syndication.feed.module.base;

import java.io.Serializable;
import java.net.URL;
import java.util.Date;


/**
 * This is an interface representing the universals.
 * @author Robert "kebernet" Cooper
 * @version $Revision: 1.2 $
 */
public interface GlobalInterface extends Serializable {
    /**Expiration Date for this item.
     * 

     *
     *        
     *          
     *            
     *          
     *          
     *            
     *
     *            
     *          
     *          
     *            
     *            
     *          
     *          
     *            
     *            
     *          
     *          
     *            
     *
     *            
     *          
     *        
 expiration_date
 Details
 Date that the item expires in ISO 8601 format:
     *              YYYY-MM-DD
Example

     *              <g:expiration_date>2005-20-12</g:expiration_date>
     *
     * 
 Attribute of
 Reference Items, Events, Housing,
     *              Jobs, People profiles, Products, Services, Travel, Vehicles, Wanted Ads.
 Content type
 date
     * @param expirationDate the date this entry will expire
     */
    public void setExpirationDate(Date expirationDate);

    /** Expiration Date for this item.
     * 

     *
     *        
     *          
     *            
     *          
     *          
     *            
     *
     *            
     *          
     *          
     *            
     *            
     *          
     *          
     *            
     *            
     *          
     *          
     *            
     *
     *            
     *          
     *        
 expiration_date
 Details
 Date that the item expires in ISO 8601 format:
     *              YYYY-MM-DD
Example

     *              <g:expiration_date>2005-20-12</g:expiration_date>
     *
     * 
 Attribute of
 Reference Items, Events, Housing,
     *              Jobs, People profiles, Products, Services, Travel, Vehicles, Wanted Ads.
 Content type
 date
     * @return the date this entry will expire
     */
    public Date getExpirationDate();

    /**
     * Date and time that the item expires.
     *
     *        
     *          
     *            
     *
     *          
     *          
     *            
     *            
     *          
     *
     *          
     *            
     *
     *            
     *          
     *          
     *            
     *
     *            
     *
     *          
     *          
     *            
     *            
     *          
     *
     *        
 expiration_date_time
 Details
 Date and time that the item expires in ISO 8601 format:
     *              YYYY-MM-DDThh:mm:ss
Example

     *              <g:expiration_date_time>12-20-05T11:59:59</g:expiration_date_time>
     * 
 Attribute of
 Reference Items, Events, Housing,
     *              Jobs, People profiles, Products, Services, Travel, Vehicles, Wanted Ads.
 Content type
 dateTime
     * @param expirationDateTime Date and time that the item expires.
     */
    public void setExpirationDateTime(Date expirationDateTime);

    /**
     * Date and time that the item expires.
     *
     *        
     *          
     *            
     *
     *          
     *          
     *            
     *            
     *          
     *
     *          
     *            
     *
     *            
     *          
     *          
     *            
     *
     *            
     *
     *          
     *          
     *            
     *            
     *          
     *
     *        
 expiration_date_time
 Details
 Date and time that the item expires in ISO 8601 format:
     *              YYYY-MM-DDThh:mm:ss
Example

     *              <g:expiration_date_time>12-20-05T11:59:59</g:expiration_date_time>
     * 
 Attribute of
 Reference Items, Events, Housing,
     *              Jobs, People profiles, Products, Services, Travel, Vehicles, Wanted Ads.
 Content type
 dateTime
     * @return Date and time that the item expires.
     */
    public Date getExpirationDateTime();

    /** Unique id for this item.
     * 
     *          
     *            
     *          
     *          
     *            
     *
     *            
     *          
     *          
     *            
     *            
     *          
     *          
     *            
     *            
     *
     *          
     *
     *          
     *            
     *            
     *          
     *        
 id
 Details
 Unique alphanumeric identifier for each item
     *              - e.g., your internal ID code.

     *              IMPORTANT: Once you submit an item with a unique id, this identifier
     *              must not change when you send in a new bulk upload. Each item must
     *              retain the same id in subsequent bulk uploads.
 Example
 
     *
     *              <g:id>01flx</g:id>
 Attribute of
 Reference Items, Events, Housing,
     *              Jobs, News and Articles, People profiles, Products, Reviews, Services,
     *              Travel, Vehicles, Wanted Ads.
 Content type
 string
     * @param id unique identifier for this entry
     */
    public void setId(String id);

    /** Unique id for this item.
     * 
     *          
     *            
     *          
     *          
     *            
     *
     *            
     *          
     *          
     *            
     *            
     *          
     *          
     *            
     *            
     *
     *          
     *
     *          
     *            
     *            
     *          
     *        
 id
 Details
 Unique alphanumeric identifier for each item
     *              - e.g., your internal ID code.

     *              IMPORTANT: Once you submit an item with a unique id, this identifier
     *              must not change when you send in a new bulk upload. Each item must
     *              retain the same id in subsequent bulk uploads.
 Example
 
     *
     *              <g:id>01flx</g:id>
 Attribute of
 Reference Items, Events, Housing,
     *              Jobs, News and Articles, People profiles, Products, Reviews, Services,
     *              Travel, Vehicles, Wanted Ads.
 Content type
 string
     * @return unique identifier for this entry
     */
    public String getId();

    /**Images for this item.
     * 

     *
     *        
     *          
     *            
     *
     *          
     *          
     *            
     *            
     *
     *          
     *          
     *            
     *            
     *
     *          
     *          
     *            
     *
     *            
     *          
     *          
     *            
     *
     *            
     *          
     *
     *        
 image_link
 Details
 URL of an associated image if available online.
     *              Use your full-sized images; do not use thumbnail images. Up to ten
     *              image_links, all placed in between their own <image_link>
     *              and </image_link> attributes, can be included with each item.
     *              If you do not have an image available, do not include this attribute.
     *              Please do not include an image that says "Image not available."
     *              Relative URLs and logo images are not acceptable.
 Example
 Acceptable:

     *              <image_link>http://example.com/images/1006.jpg</image_link>

     *
     *              <image_link>http://example.com/i/6.jpg,http://example.com/i/9.jpg</image_link>

     *
     *              Not acceptable:

     *              <image_link>/images/1006.jpg</image_link>

     *              <image_link>example.com/images/1006.jpg</image_link>
 Attribute of
 Reference Items, Events, Housing,
     *              Jobs, News and Articles, People profiles, Products, Reviews, Services,
     *              Travel, Vehicles, Wanted Ads.
 Content type
 url
     * @param imageLinks URLs to images. Limit 10.
     */
    public void setImageLinks(URL[] imageLinks);

    /**Images for this item.
     * 

     *
     *        
     *          
     *            
     *
     *          
     *          
     *            
     *            
     *
     *          
     *          
     *            
     *            
     *
     *          
     *          
     *            
     *
     *            
     *          
     *          
     *            
     *
     *            
     *          
     *
     *        
 image_link
 Details
 URL of an associated image if available online.
     *              Use your full-sized images; do not use thumbnail images. Up to ten
     *              image_links, all placed in between their own <image_link>
     *              and </image_link> attributes, can be included with each item.
     *              If you do not have an image available, do not include this attribute.
     *              Please do not include an image that says "Image not available."
     *              Relative URLs and logo images are not acceptable.
 Example
 Acceptable:

     *              <image_link>http://example.com/images/1006.jpg</image_link>

     *
     *              <image_link>http://example.com/i/6.jpg,http://example.com/i/9.jpg</image_link>

     *
     *              Not acceptable:

     *              <image_link>/images/1006.jpg</image_link>

     *              <image_link>example.com/images/1006.jpg</image_link>
 Attribute of
 Reference Items, Events, Housing,
     *              Jobs, News and Articles, People profiles, Products, Reviews, Services,
     *              Travel, Vehicles, Wanted Ads.
 Content type
 url
     * @return URLs to images
     */
    public URL[] getImageLinks();

    /**Labels for this item.
     * 

     *
     * 
     * 
     *
     *  
     * 
     * 
     *  
     *  
     * 
     *
     * 
     *  
     *  
     * 
     * 
     *  
     *
     *  
     * 
     * 
     *  
     *  
     *
     * 
     * 

     *  label

     *
     *  Details

     *  A
     *      list of classifications the item may fall under. Up to ten user-selected
     *      label, each  placed in between their own <label>
     *
     *  and </label> tags, can be included with each item. These attributes will be used to match your items to search queries. Each attribute value will be checked for policy compliance.

     *  Example

     *
     *  Acceptable:

     * For an automobile in a Vehicles information type:

     *  
     *
     *  <g:label>Leather</g:label>

     *  
     *  <g:label>Power locks</g:label>

     *
     *  
     *  <g:label>sunroof</g:label>

     *
     *  
     *  <g:label>ABS</g:label>


     *  
     * For a concert in an Events information type:

     *
     *  <g:label>VIP</g:label>

     *
     *  
     *  <g:label>front row</g:label>

     *  
     *  <g:label>backstage</g:label>

     *
     *  
     *
     *  <g:label>KROCK 101.5</g:label>

     *  
     *  <g:label>parking passes</g:label>


     *  
     *  Not acceptable:

     *
     *  
     *  <g:label> leater, power locks, sunroof, ABS </g:label>

     *  Attribute of

     *  Reference Items, Events, Housing, Jobs, News and Articles,
     *  People profiles, Products, Reviews, Services, Travel, Vehicles, Wanted Ads.

     *  Content type

     *
     *  string
     * @param labels labels for this entry. Limit 10.
     */
    public void setLabels(String[] labels);

    /**Labels for this item.
     * 

     *
     * 
     * 
     *
     *  
     * 
     * 
     *  
     *  
     * 
     *
     * 
     *  
     *  
     * 
     * 
     *  
     *
     *  
     * 
     * 
     *  
     *  
     *
     * 
     * 

     *  label

     *
     *  Details

     *  A
     *      list of classifications the item may fall under. Up to ten user-selected
     *      label, each  placed in between their own <label>
     *
     *  and </label> tags, can be included with each item. These attributes will be used to match your items to search queries. Each attribute value will be checked for policy compliance.

     *  Example

     *
     *  Acceptable:

     * For an automobile in a Vehicles information type:

     *  
     *
     *  <g:label>Leather</g:label>

     *  
     *  <g:label>Power locks</g:label>

     *
     *  
     *  <g:label>sunroof</g:label>

     *
     *  
     *  <g:label>ABS</g:label>


     *  
     * For a concert in an Events information type:

     *
     *  <g:label>VIP</g:label>

     *
     *  
     *  <g:label>front row</g:label>

     *  
     *  <g:label>backstage</g:label>

     *
     *  
     *
     *  <g:label>KROCK 101.5</g:label>

     *  
     *  <g:label>parking passes</g:label>


     *  
     *  Not acceptable:

     *
     *  
     *  <g:label> leater, power locks, sunroof, ABS </g:label>

     *  Attribute of

     *  Reference Items, Events, Housing, Jobs, News and Articles,
     *  People profiles, Products, Reviews, Services, Travel, Vehicles, Wanted Ads.

     *  Content type

     *
     *  string
     * @return labels for this entry
     */
    public String[] getLabels();
}