javax.tv.service.guide.ProgramEvent Maven / Gradle / Ivy
/*
* @(#)ProgramEvent.java 1.34 00/10/09
*
* Copyright 1998-2000 by Sun Microsystems, Inc.,
* 901 San Antonio Road, Palo Alto, California, 94303, U.S.A.
* All rights reserved.
*
* This software is the confidential and proprietary information
* of Sun Microsystems, Inc. ("Confidential Information"). You
* shall not disclose such Confidential Information and shall use
* it only in accordance with the terms of the license agreement
* you entered into with Sun.
*/
package javax.tv.service.guide;
import javax.tv.service.SIElement;
import javax.tv.service.SIRequest;
import javax.tv.service.SIRequestor;
import javax.tv.service.Service;
/**
* ProgramEvent represents collection of elementary
* streams with a common time base, an associated start time, and an
* associated end time. An event is equivalent to the common industry
* usage of "TV program."
*
*
* The Event Information Table (EIT) contains information (titles, start
* times, etc.) for events on defined services. An event is, in most cases,
* a typical TV program, however its definition may be extended to include
* particular data broadcasting sessions and other information segments.
*
* A ProgramEvent object may optionally implement the
* CAIdentification interface. Note that all time values
* are in UTC time.
*
* @see java.util.Date java.util.Date
*
* @see javax.tv.service.navigation.CAIdentification
*
* @see Optionally implemented interfaces */
public interface ProgramEvent extends SIElement {
/**
* Returns the start time of this program event. The start time is in UTC
* time.
*
* @return This program's start time (UTC).
*/
public abstract java.util.Date getStartTime();
/**
* Returns the end time of this program event. The end time is in UTC time.
*
* @return This program's end time (UTC).
*/
public abstract java.util.Date getEndTime();
/**
* Returns the duration of this program event in seconds.
*
* @return This program's duration in seconds.
*/
public abstract long getDuration();
/**
* Returns the program event title. This information may be obtained in
* the ATSC EIT table or the DVB Short Event Descriptor.
*
* @return A string representing this program's title, or an empty
* string if the title is unavailable.
*/
public abstract String getName();
/**
* Retrieves a textual description of the event. This method
* delivers its results asynchronously.
*
* @param requestor The SIRequestor to be notified
* when this retrieval operation completes.
*
* @return An SIRequest object identifying this
* asynchronous retrieval request.
*
* @see ProgramEventDescription */
public abstract SIRequest retrieveDescription(SIRequestor requestor);
/**
* Reports content advisory information associated with this program for
* the local rating region.
*
* @return A ContentRatingAdvisory object describing the
* rating of this ProgramEvent or null if
* no rating information is available.
*
*/
public abstract ContentRatingAdvisory getRating();
/**
* Reports the Service this program event is associated with.
*
* @return The Service this program event is delivered on.
*/
public abstract Service getService();
/**
* Retrieves an array of service components which are part of this
* ProgramEvent. Service component information may not
* always be available. If the ProgramEvent is current,
* this method will provide only service components associated with
* the Service to which the ProgramEvent
* belongs. If the ProgramEvent is not current, no
* guarantee is provided that all or even any of its service
* components will be available.
*
* This method delivers its results asynchronously. The retrieved
* array will only contain ServiceComponent instances
* c for which the caller has
* javax.tv.service.ReadPermission(c.getLocator()). If
* no ServiceComponent instances meet this criteria,
* this method will result in an SIRequestFailureType of
* DATA_UNAVAILABLE.
*
* @param requestor The SIRequestor to be notified
* when this retrieval operation completes.
*
* @return An SIRequest object identifying this
* asynchronous retrieval request.
*
* @see javax.tv.service.navigation.ServiceComponent
* @see javax.tv.service.ReadPermission
*/
public abstract SIRequest retrieveComponents(SIRequestor requestor);
}