javax.tv.service.guide.ProgramScheduleEvent Maven / Gradle / Ivy

/**
This is not an official specification document, and usage is restricted.


NOTICE





(c) 2005-2008 Sun Microsystems, Inc. All Rights Reserved.


Neither this file nor any files generated from it describe a complete
specification, and they may only be used as described below.  

Sun Microsystems Inc. owns the copyright in this file and it is provided
to you for informative use only. For example, 
this file and any files generated from it may be used to generate other documentation, 
such as a unified set of documents of API signatures for a platform 
that includes technologies expressed as Java APIs. 
This file may also be used to produce "compilation stubs," 
which allow applications to be compiled and validated for such platforms. 
By contrast, no permission is given for you to incorporate this file, 
in whole or in part, in an implementation of a Java specification.

Any work generated from this file, such as unified javadocs or compiled
stub files, must be accompanied by this notice in its entirety.

This work corresponds to the API signatures of JSR 927: Java TV API 1.1.1.  
In the event of a discrepency between this work and the JSR 927 specification, 
which is available at http://www.jcp.org/en/jsr/detail?id=927, the latter takes precedence.
*/



  


package javax.tv.service.guide;

import javax.tv.service.*;

/** 
 * A ProgramScheduleEvent notifies an
 * ProgramScheduleListener of changes to program events
 * detected in a ProgramSchedule.  Specifically, this
 * event signals the addition, removal, or modification of a
 * ProgramEvent in a ProgramSchedule, or a
 * change to the ProgramEvent that is current.
 *
 * The class ProgramScheduleChangeType defines the kinds
 * of changes reported by ProgramScheduleEvent.  A
 * ProgramScheduleChangeType of
 * CURRENT_PROGRAM_EVENT indicates that the current
 * ProgramEvent of a ProgramSchedule has
 * changed in identity.
 *
 * @see ProgramScheduleListener
 * @see ProgramScheduleChangeType
 */
public class ProgramScheduleEvent extends SIChangeEvent
{

    /** 
     * Constructs a ProgramScheduleEvent.
     *
     * @param schedule The schedule in which the change occurred.
     *
     * @param type The type of change that occurred.
     *
     * @param e The ProgramEvent that changed.
     */
    public ProgramScheduleEvent(ProgramSchedule schedule, SIChangeType type,
        ProgramEvent e)
    { super(schedule, type, e); }

    /** 
     * Reports the ProgramSchedule that generated the
     * event.  The object returned will be identical to the object
     * returned by the inherited EventObject.getSource()
     * method.
     *
     * @return The ProgramSchedule that generated the event.
     *
     * @see java.util.EventObject#getSource
     */
    public ProgramSchedule getProgramSchedule() {
        return null;
    }

    /** 
     * Reports the ProgramEvent that changed.  If the
     * ProgramScheduleChangeType is
     * CURRENT_PROGRAM_EVENT, the ProgramEvent
     * that became current will be returned.  The object returned will
     * be identical to the object returned by inherited
     * SIChangeEvent.getSIElement method.
     *
     * @return The ProgramEvent that changed.
     *
     * @see javax.tv.service.SIChangeEvent#getSIElement
     */
    public ProgramEvent getProgramEvent() {
        return null;
    }
}