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

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

Go to download 

/*
 * CourseInformation.java
 *
 * Created on November 16, 2005, 11:12 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.DateTimeRange;


/**
 * This is an interface for the GoogleBase plug in that exposes methods used for
 * Class or Course information entry types.
 * @author Robert "kebernet" Cooper
 * @version $Revision: 1.2 $
 */
public interface Course extends GlobalInterface {
    /**
     * The timeframe a course is running.
     *
     *
     * 
     *
     * 
     *
     *  
     * 
     * 
     *  
     *  
     * 
     * 
     *  
     *  
     * 
     * 
     *
     *  
     *  
     * 
     * 
     *  
     *
     *  
     * 
     * 

     *  course_date_range

     *  DetailsDate and time range a class is in session, in ISO 8601.  Two  sub-attributes
     *  are included in course_date_range attribute.
    
     *
     *  
  • start = Start date and time of a trip in
     *  format YYYY-MM-DDThh:mm:ss
    • 
     *  
  • end = End date and time of a trip in
     *  format YYYY-MM-DDThh:mm:ss

     *  Example <g:course_date_range> 

     *
     * <g:start>2005-12-20T09:30:01</g:start>
     *  

     * <g:end>2005-12-29T10:30:59</g:end>

     * </g:course_date_range>

     *
     *  Attribute of
     *  Course schedules

     *
     *  Content type
     * dateTimeRange

     * @param courseDateRange The timeframe a course is running
     */
    public void setCourseDateRange(DateTimeRange courseDateRange);

    /**
     * The timeframe a course is running.
     *
     *
     * 
     *
     * 
     *
     *  
     * 
     * 
     *  
     *  
     * 
     * 
     *  
     *  
     * 
     * 
     *
     *  
     *  
     * 
     * 
     *  
     *
     *  
     * 
     * 

     *  course_date_range

     *  DetailsDate and time range a class is in session, in ISO 8601.  Two  sub-attributes
     *  are included in course_date_range attribute.
    
     *
     *  
  • start = Start date and time of a trip in
     *  format YYYY-MM-DDThh:mm:ss
    • 
     *  
  • end = End date and time of a trip in
     *  format YYYY-MM-DDThh:mm:ss

     *  Example <g:course_date_range> 

     *
     * <g:start>2005-12-20T09:30:01</g:start>
     *  

     * <g:end>2005-12-29T10:30:59</g:end>

     * </g:course_date_range>

     *
     *  Attribute of
     *  Course schedules

     *
     *  Content type
     * dateTimeRange

     * @return The timeframe a course is running
     */
    public DateTimeRange getCourseDateRange();

    /**
     * ID code associated with a course.
     *
     *
     *        
     *          
     *            
     *          
     *          
     *            
     *
     *            
     *
     *          
     *          
     *            
     *            
     *
     *          
     *          
     *
     *            
     *            
     *          
     *          
     *            
     *
     *            
     *
     *          
     *        
 course_number
 Details ID code associated with a course
 Example <g:course_number>HIST-90A</g:course_number>
 Attribute
     *                of Course schedules
 Content
     *                type string

     * @param courseNumber ID code associated with a course
     */
    public void setCourseNumber(String courseNumber);

    /**
     * ID code associated with a course.
     *
     *
     *
     *        
     *          
     *            
     *          
     *          
     *            
     *
     *            
     *
     *          
     *          
     *            
     *            
     *
     *          
     *          
     *
     *            
     *            
     *          
     *          
     *            
     *
     *            
     *
     *          
     *        
 course_number
 Details ID code associated with a course
 Example <g:course_number>HIST-90A</g:course_number>
 Attribute
     *                of Course schedules
 Content
     *                type string

     * @return ID code associated with a course
     */
    public String getCourseNumber();

    /**
     * Time a class is in session.
     *
     *
     *  
     *          
     *            
     *
     *          
     *
     *          
     *            
     *            
     *          
     *          
     *            
     *
     *            
     *
     *          
     *          
     *            
     *            
     *
     *          
     *          
     *            
     *
     *            
     *          
     *        
 course_times
 Details Time a class is in session.
 Example <g:course_times>MWF 08:30 - 09:45</g:course_times>
 Attribute
     *                of Course schedules
 Content
     *                type string

     * @param courseTimes Time a class is in session
     */
    public void setCourseTimes(String courseTimes);

    /**
     * Time a class is in session.
     *
     *
     *
     *  
     *          
     *            
     *
     *          
     *
     *          
     *            
     *            
     *          
     *          
     *            
     *
     *            
     *
     *          
     *          
     *            
     *            
     *
     *          
     *          
     *            
     *
     *            
     *          
     *        
 course_times
 Details Time a class is in session.
 Example <g:course_times>MWF 08:30 - 09:45</g:course_times>
 Attribute
     *                of Course schedules
 Content
     *                type string

     * @return Time a class is in session
     */
    public String getCourseTimes();

    /**
     * Salary for this position.
     *
     *
     *
     * 
     * 
     *  
     * 
     *
     * 
     *
     *  
     *  
     * 
     * 
     *
     *  
     *  
     * 
     * 
     *  
     *
     *  
     * 
     * 
     *  
     *
     *  
     * 
     * 

     *  salary

     *  Details
     *  Salary for this position. Non-numeric values such as "$" symbols are not acceptable. 

     *
     *  Example
     * <g:salary>55000</g:salary>

     *
     *  Attribute of
     *  Jobs

     *  Content type
     *
     * float

     * @param salary Salary for this position
     */
    public void setSalary(Float salary);

    /**
     * Salary for this position.
     *
     *
     * 
     * 
     *  
     * 
     *
     * 
     *
     *  
     *  
     * 
     * 
     *
     *  
     *  
     * 
     * 
     *  
     *
     *  
     * 
     * 
     *  
     *
     *  
     * 
     * 

     *  salary

     *  Details
     *  Salary for this position. Non-numeric values such as "$" symbols are not acceptable. 

     *
     *  Example
     * <g:salary>55000</g:salary>

     *
     *  Attribute of
     *  Jobs

     *  Content type
     *
     * float

     * @return Salary for this position
     */
    public Float getSalary();

    /**
     * Topics of study for a course.
     *
     *
     * 
     * 
     *  
     * 
     * 
     *
     *  
     *  
     * 
     * 
     *  
     *
     *  
     * 
     * 
     *  
     *  
     * 
     * 
     *  
     *  
     *
     * 
     * 

     *  subject

     *
     *  Details
     *  Topic of study for a course.

     *  Example <g:subject>Trigonometry</g:subject>

     *  Attribute of
     *
     *  Course schedules

     *  Content type
     *  string

     * @param subject Topics of study for a course
     */
    public void setSubjects(String[] subject);

    /**
     * Topics of study for a course.
     *
     *
     * 
     * 
     *  
     * 
     * 
     *
     *  
     *  
     * 
     * 
     *  
     *
     *  
     * 
     * 
     *  
     *  
     * 
     * 
     *  
     *  
     *
     * 
     * 

     *  subject

     *
     *  Details
     *  Topic of study for a course.

     *  Example <g:subject>Trigonometry</g:subject>

     *  Attribute of
     *
     *  Course schedules

     *  Content type
     *  string

     * @return Topics of study for a course
     */
    public String[] getSubjects();

    /**
     * Name of the school at which a class is offered.
     * 
     * 
     *  
     *
     * 
     * 
     *  
     *  
     * 
     *
     * 
     *
     *  
     *  
     * 
     * 
     *
     *  
     *  
     * 
     * 
     *  
     *
     *  
     * 
     * 

     *  university

     *  Details
     *  Name of the school a class is offered at. 

     *  Example <g:university>Stanford</g:university>

     *
     *  Attribute of
     * Course schedules

     *  Content type
     *
     *  string

     * @param university Name of the school at which a class is offered.
     */
    public void setUniversity(String university);

    /**
     * Name of the school at which a class is offered.
     * 
     * 
     *  
     *
     * 
     * 
     *  
     *  
     * 
     *
     * 
     *
     *  
     *  
     * 
     * 
     *
     *  
     *  
     * 
     * 
     *  
     *
     *  
     * 
     * 

     *  university

     *  Details
     *  Name of the school a class is offered at. 

     *  Example <g:university>Stanford</g:university>

     *
     *  Attribute of
     * Course schedules

     *  Content type
     *
     *  string

     * @return Name of the school at which a class is offered.
     */
    public String getUniversity();
}




© 2015 - 2024 Weber Informatics LLC | Privacy Policy