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

Go to download

Show more of this group Show more artifacts with this name
Show all versions of rome-modules Show documentation

Plugin collection for the ROME RSS and Atom Utilities

The newest version!

/*
 * Person.java
 *
 * Created on November 16, 2005, 1:26 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 com.sun.syndication.feed.module.base.types.GenderEnumeration;


/** This is an interface for the GoogleBase plug in that exposes methods used for
 * Person (personal ad, resume, profile) entry types.
 * @author Robert "kebernet" Cooper
 * @version $Revision: 1.2 $
 */
public interface Person extends GlobalInterface {
    /**
     * Age of the individual.
     * 
     *          
     *            
     *          
     *          
     *            
     *            
     *
     *          
     *          
     *            
     *            
     *          
     *          
     *            
     *            
     *
     *          
     *
     *          
     *            
     *            
     *          
     *        age
Details Minimum age requirement for the event or the age of the individual in a People profiles
     *            bulk upload entry.
Example Acceptable:

     * <
     *              g:age>18</g:age>

     *              Not acceptable:

     *
     * <
     *            g:age>18 and over</g:age>
Attribute of Events, People profiles
Content type integer
     * @param age Age of the individual.
     */
    public void setAge(Integer age);

    /**
     * Age of the individual.
     * 
     *          
     *            
     *          
     *          
     *            
     *            
     *
     *          
     *          
     *            
     *            
     *          
     *          
     *            
     *            
     *
     *          
     *
     *          
     *            
     *            
     *          
     *        age
Details Minimum age requirement for the event or the age of the individual in a People profiles
     *            bulk upload entry.
Example Acceptable:

     * <
     *              g:age>18</g:age>

     *              Not acceptable:

     *
     * <
     *            g:age>18 and over</g:age>
Attribute of Events, People profiles
Content type integer
     * @return Age of the individual.
     */
    public Integer getAge();

    /**
     * Education of the individual.
     *        
     *          
     *            
     *          
     *          
     *            
     *
     *            
     *          
     *          
     *            
     *            
     *
     *          
     *          
     *            
     *            
     *          
     *          
     *            
     *
     *            
     *          
     *         education
 Details  Level of education required for an employment
     *              position.
 Example  <g:education>PhD</g:education>
 Attribute of  Jobs
 Content type  string
     * @param education Education of the individual.
     */
    public void setEducation(String education);

    /**
     * Education of the individual.
     *        
     *          
     *            
     *          
     *          
     *            
     *
     *            
     *          
     *          
     *            
     *            
     *
     *          
     *          
     *            
     *            
     *          
     *          
     *            
     *
     *            
     *          
     *         education
 Details  Level of education required for an employment
     *              position.
 Example  <g:education>PhD</g:education>
 Attribute of  Jobs
 Content type  string
     * @return Education of the individual.
     */
    public String getEducation();

    /**
     * Individuals employer.
     *
     *        
     *          
     *            
     *
     *          
     *          
     *            
     *            
     *          
     *          
     *            
     *
     *            
     *          
     *          
     *            
     *            
     *
     *          
     *          
     *            
     *            
     *          
     *         employer
 Details  Company providing employment.
 Example  <g:employer>Google, Inc</g:employer>
 Attribute of  Jobs
 Content type  string
     * @param employer Individuals employer.
     */
    public void setEmployer(String employer);

    /**
     * Individuals employer.
     *
     *        
     *          
     *            
     *
     *          
     *          
     *            
     *            
     *          
     *          
     *            
     *
     *            
     *          
     *          
     *            
     *            
     *
     *          
     *          
     *            
     *            
     *          
     *         employer
 Details  Company providing employment.
 Example  <g:employer>Google, Inc</g:employer>
 Attribute of  Jobs
 Content type  string
     * @return Individuals employer.
     */
    public String getEmployer();

    /**
     * Ethnicity of the individual in the People profiles bulk upload entry.
     *
     *        
     *          
     *            
     *          
     *          
     *            
     *
     *            
     *
     *          
     *          
     *            
     *            
     *
     *          
     *          
     *            
     *
     *            
     *          
     *          
     *            
     *
     *            
     *          
     *
     *         ethnicity
 Details  Ethnicity of the individual in the People profiles
     *              bulk upload entry.
 Example  <g:ethnicity>Latino</g:ethnicity>
 Attribute of  People profiles
 Content type  string
     * @param ethnicities Ethnicity of the individual in the People profiles bulk upload entry.
     */
    public void setEthnicities(String[] ethnicities);

    /**
     * Ethnicity of the individual in the People profiles bulk upload entry.
     *
     *        
     *          
     *            
     *          
     *          
     *            
     *
     *            
     *
     *          
     *          
     *            
     *            
     *
     *          
     *          
     *            
     *
     *            
     *          
     *          
     *            
     *
     *            
     *          
     *
     *         ethnicity
 Details  Ethnicity of the individual in the People profiles
     *              bulk upload entry.
 Example  <g:ethnicity>Latino</g:ethnicity>
 Attribute of  People profiles
 Content type  string
     * @return Ethnicity of the individual in the People profiles bulk upload entry.
     */
    public String[] getEthnicities();

    /**
     * Gender of an individual in a People profiles bulk upload.
     *
     *        
     *          
     *            
     *
     *          
     *          
     *            
     *
     *            
     *          
     *          
     *            
     *
     *            
     *          
     *          
     *            
     *            
     *
     *          
     *          
     *            
     *            
     *          
     *         gender
 Details  Gender of an individual in a People profiles bulk upload
     *              item. Acceptable values are �Male�, �M�,
     *              �Female�, or �F�.
 Example 
     *              <gender>Female</gender>
 Attribute of  People profiles
 Content type  genderEnumeration
     * @param gender Gender of an individual in a People profiles bulk upload.
     */
    public void setGender(GenderEnumeration gender);

    /**
     * Gender of an individual in a People profiles bulk upload.
     *
     *        
     *          
     *            
     *
     *          
     *          
     *            
     *
     *            
     *          
     *          
     *            
     *
     *            
     *          
     *          
     *            
     *            
     *
     *          
     *          
     *            
     *            
     *          
     *         gender
 Details  Gender of an individual in a People profiles bulk upload
     *              item. Acceptable values are �Male�, �M�,
     *              �Female�, or �F�.
 Example 
     *              <gender>Female</gender>
 Attribute of  People profiles
 Content type  genderEnumeration
     * @return Gender of an individual in a People profiles bulk upload.
     */
    public GenderEnumeration getGender();

    /**
     * Interest of a person being profiled.
     *
     * 
     *          
     *            
     *
     *          
     *          
     *            
     *            
     *
     *          
     *          
     *            
     *
     *            
     *          
     *          
     *            
     *
     *            
     *
     *          
     *          
     *            
     *            
     *          
     *
     *         interested_in
 Details  Interest of a person being profiled.
Example 
     *              <g:interested_in>Long walks on the beach.</g:interested_in>
 Attribute of People profiles
 Content type  string
     * @param interestedIn Interest of a person being profiled.
     */
    public void setInterestedIn(String[] interestedIn);

    /**
     * Interest of a person being profiled.
     *
     * 
     *          
     *            
     *
     *          
     *          
     *            
     *            
     *
     *          
     *          
     *            
     *
     *            
     *          
     *          
     *            
     *
     *            
     *
     *          
     *          
     *            
     *            
     *          
     *
     *         interested_in
 Details  Interest of a person being profiled.
Example 
     *              <g:interested_in>Long walks on the beach.</g:interested_in>
 Attribute of People profiles
 Content type  string
     * @return Interest of a person being profiled.
     */
    public String[] getInterestedIn();

    /**
     * Location of a person.
     * 
     * 
     *
     *  
     * 
     * 
     *
     *  
     *  
     *
     * 
     * 
     *  
     *
     *  
     *
     * 
     * 
     *  
     *  
     * 
     *
     * 
     *
     *  
     *  
     * 
     * 
     *  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 a person.
     */
    public void setLocation(String location);

    /**
     * Location of a person.
     * 
     * 
     *
     *  
     * 
     * 
     *
     *  
     *  
     *
     * 
     * 
     *  
     *
     *  
     *
     * 
     * 
     *  
     *  
     * 
     *
     * 
     *
     *  
     *  
     * 
     * 
     *  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 a person.
     */
    public String getLocation();

    /**
     * Marital status of an individual.
     *
     * 
     *
     * 
     *  
     * 
     * 
     *  
     *  
     *
     * 
     * 
     *  
     *
     *  
     *
     * 
     *  
     *
     *  
     * 
     * 
     *  
     *  
     * 
     * 
     *  marital_status

     *
     *  Details  Marital status of an individual
     *  in a People profiles bulk upload entry.
     *  For example -single, divorced, separated, widowed, married, and �in
     *  relationship.�

     *  Example 
     * <g:marital_status>single</g:marital_status>

     *
     * 

     *  Attribute of 
     *  People profiles

     *
     *  Content type 
     *
     *  string
     * @param maritalStatus Marital status of an individual.
     */
    public void setMaritalStatus(String maritalStatus);

    /**
     * Marital status of an individual.
     *
     * 
     *
     * 
     *  
     * 
     * 
     *  
     *  
     *
     * 
     * 
     *  
     *
     *  
     *
     * 
     *  
     *
     *  
     * 
     * 
     *  
     *  
     * 
     * 
     *  marital_status

     *
     *  Details  Marital status of an individual
     *  in a People profiles bulk upload entry.
     *  For example -single, divorced, separated, widowed, married, and �in
     *  relationship.�

     *  Example 
     * <g:marital_status>single</g:marital_status>

     *
     * 

     *  Attribute of 
     *  People profiles

     *
     *  Content type 
     *
     *  string
     * @return  Marital status of an individual.
     */
    public String getMaritalStatus();

    /**
     * Occupation of an individual.
     *
     * 
     * 
     *
     *  
     * 
     * 
     *  
     *  
     *
     * 
     * 
     *  
     *
     *  
     * 
     *
     * 
     *  
     *  
     * 
     * 
     *  
     *  
     *
     * 
     * 
     *  occupation

     *
     *  Details 
     *  Industry the individual in a People profiles bulk upload
     *  is employed in.

     *  Example  <g:occupation>Sales</g:occupation>

     *  Attribute of 
     *
     *  People profiles

     *
     *  Content type 
     *  string
     * @param occupation Occupation of an individual.
     */
    public void setOccupation(String occupation);

    /**
     * Occupation of an individual.
     *
     * 
     * 
     *
     *  
     * 
     * 
     *  
     *  
     *
     * 
     * 
     *  
     *
     *  
     * 
     *
     * 
     *  
     *  
     * 
     * 
     *  
     *  
     *
     * 
     * 
     *  occupation

     *
     *  Details 
     *  Industry the individual in a People profiles bulk upload
     *  is employed in.

     *  Example  <g:occupation>Sales</g:occupation>

     *  Attribute of 
     *
     *  People profiles

     *
     *  Content type 
     *  string
     * @return  Occupation of an individual.
     */
    public String getOccupation();

    /**
     * Individual's sexual orientation.
     *
     * 
     * 
     *  
     * 
     * 
     *  
     *
     *  
     * 
     * 
     *  
     *
     *  
     *
     * 
     * 
     *  
     *  
     * 
     * 
     *
     *  
     *  
     *
     * 
     * 
     *  sexual_orientation

     *
     *  Details 
     *  Sexual orientation of an individual in a People profiles information type..

     *  Example  <g:sexual_orientation>straight</g:sexual_orientation>

     *  Attribute of 
     *
     *  Personal

     *  Content type 
     *  string
     * @param sexualOrientation Individual's sexual orientation.
     */
    public void setSexualOrientation(String sexualOrientation);

    /**
     * Individual's sexual orientation.
     *
     * 
     * 
     *  
     * 
     * 
     *  
     *
     *  
     * 
     * 
     *  
     *
     *  
     *
     * 
     * 
     *  
     *  
     * 
     * 
     *
     *  
     *  
     *
     * 
     * 
     *  sexual_orientation

     *
     *  Details 
     *  Sexual orientation of an individual in a People profiles information type..

     *  Example  <g:sexual_orientation>straight</g:sexual_orientation>

     *  Attribute of 
     *
     *  Personal

     *  Content type 
     *  string
     * @return  Individual's sexual orientation.
     */
    public String getSexualOrientation();
}

age
Details	Minimum age requirement for the event or the age of the individual in a People profiles * bulk upload entry.
Example	Acceptable: * < * g:age>18</g:age> * Not acceptable: * * < * g:age>18 and over</g:age>
Attribute of	Events, People profiles
Content type	integer

age
Details	Minimum age requirement for the event or the age of the individual in a People profiles * bulk upload entry.
Example	Acceptable: * < * g:age>18</g:age> * Not acceptable: * * < * g:age>18 and over</g:age>
Attribute of	Events, People profiles
Content type	integer

education
Details	Level of education required for an employment * position.
Example	<g:education>PhD</g:education>
Attribute of	Jobs
Content type	string

education
Details	Level of education required for an employment * position.
Example	<g:education>PhD</g:education>
Attribute of	Jobs
Content type	string

employer
Details	Company providing employment.
Example	<g:employer>Google, Inc</g:employer>
Attribute of	Jobs
Content type	string

ethnicity
Details	Ethnicity of the individual in the People profiles * bulk upload entry.
Example	<g:ethnicity>Latino</g:ethnicity>
Attribute of	People profiles
Content type	string

gender
Details	Gender of an individual in a People profiles bulk upload * item. Acceptable values are �Male�, �M�, * �Female�, or �F�.
Example	* <gender>Female</gender>
Attribute of	People profiles
Content type	genderEnumeration

interested_in
Details	Interest of a person being profiled.
Example	* <g:interested_in>Long walks on the beach.</g:interested_in>
Attribute of	People profiles
Content type	string

* 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

* marital_status
* * Details	Marital status of an individual * in a People profiles bulk upload entry. * For example -single, divorced, separated, widowed, married, and �in * relationship.�
* Example	* <g:marital_status>single</g:marital_status> * *
* Attribute of	* People profiles
* * Content type	* * string

* occupation
* * Details	* Industry the individual in a People profiles bulk upload * is employed in.
* Example	<g:occupation>Sales</g:occupation>
* Attribute of	* * People profiles
* * Content type	* string

* sexual_orientation
* * Details	* Sexual orientation of an individual in a People profiles information type..
* Example	<g:sexual_orientation>straight</g:sexual_orientation>
* Attribute of	* * Personal
* Content type	* string