com.sun.tv.si

Class ProgramScheduleImpl

java.lang.Object

com.sun.tv.si.ProgramScheduleImpl

All Implemented Interfaces:

ProgramSchedule

public class ProgramScheduleImpl
extends Object
implements ProgramSchedule

This interface represents a collection of program events for a given Service ordered by time. It provides the current, next and future events.
Note that all time values (java.util.Date) are in UTC time.

See Also:

Date, Calendar

Constructor Summary

Constructors

Constructor and Description
ProgramScheduleImpl(Service service)

Method Summary

Methods

Modifier and Type	Method and Description
void	addListener(ProgramScheduleListener listener) Registers an SIChangeListener to be notified of changes to program events on this ProgramScheduleImpl.
Locator	getServiceLocator() Reports the transport-dependent locator referencing the service to which this ProgramSchedule belongs.
void	notifyListeners(ProgramScheduleEvent event) Notify all listeners that this program schedule has been changed.
void	removeListener(ProgramScheduleListener listener) Called to unregister an SIChangeListener.
SIRequest	retrieveCurrentProgramEvent(SIRequestor requestor) Retrieves the current ProgramEvent.
SIRequest	retrieveFutureProgramEvent(Date time, SIRequestor requestor) Retrieves the program event for the specified time.
SIRequest	retrieveFutureProgramEvents(Date begin, Date end, SIRequestor requestor) Retrieves all known program events on this service for the specified time interval.
SIRequest	retrieveNextProgramEvent(ProgramEvent anEvent, SIRequestor requestor) Retrieves an event which follows the specified event.
SIRequest	retrieveProgramEvent(Locator locator, SIRequestor requestor) Retrieves a program event matching the locator.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ProgramScheduleImpl

public ProgramScheduleImpl(Service service)

Method Detail

retrieveCurrentProgramEvent

public SIRequest retrieveCurrentProgramEvent(SIRequestor requestor)

Retrieves the current ProgramEvent. The resulting ProgramEvent will be available for immediate viewing.

This method delivers its results asynchronously.

Specified by:

retrieveCurrentProgramEvent in interface ProgramSchedule

Parameters:

requestor - The SIRequestor to be notified when this retrieval operation completes.

Returns:

An SIRequest object identifying this asynchronous retrieveal request.

See Also:

ProgramEvent

retrieveFutureProgramEvent

public SIRequest retrieveFutureProgramEvent(Date time,
                                   SIRequestor requestor)
                                     throws SIException

Retrieves the program event for the specified time. The program event which contains the specified time (the specified time falls between the program event's start time and end time) will be returned.

This method delivers its results asynchronously.

Specified by:

retrieveFutureProgramEvent in interface ProgramSchedule

Parameters:

time - The time which the program event should be searched for. This is a UTC time. This method delivers its results asynchronously.

requestor - The SIRequestor to be notified when this retrieval operation completes.

Returns:

An SIRequest object identifying this asynchronous retrieveal request.

Throws:

SIException - If time does not represent a future time value.

See Also:

ProgramEvent

retrieveFutureProgramEvents

public SIRequest retrieveFutureProgramEvents(Date begin,
                                    Date end,
                                    SIRequestor requestor)
                                      throws SIException

Retrieves all known program events on this service for the specified time interval.

This method returns data asynchronously.

Specified by:

retrieveFutureProgramEvents in interface ProgramSchedule

Parameters:

begin - Time identifying the beginning of the interval. This is UTC time.

end - Time identifying the end of the interval. This is UTC time.

requestor - The SIRequestor to be notified when this retrieval operation completes.

Returns:

An SIRequest object identifying this asynchronous retrieveal request.

Throws:

SIException - If end represents a time value before begin, or if end does not represent a future time value.

See Also:

ProgramEvent

retrieveProgramEvent

public SIRequest retrieveProgramEvent(Locator locator,
                             SIRequestor requestor)
                               throws InvalidLocatorException,
                                      SecurityException

Retrieves a program event matching the locator. Note that the event must be part of this schedule.

This method returns data asynchronously.

Specified by:

retrieveProgramEvent in interface ProgramSchedule

Parameters:

locator - Locator referencing the ProgramEvent of interest.

requestor - The SIRequestor to be notified when this retrieval operation completes.

Returns:

An SIRequest object identifying this asynchronous retrieveal request.

Throws:

InvalidLocatorException - If locator does not reference a valid ProgramEvent.

SecurityException - if the caller does not have javax.tv.service.ReadPermission(locator)

See Also:

ProgramEvent, ReadPermission

addListener

public void addListener(ProgramScheduleListener listener)

Registers an SIChangeListener to be notified of changes to program events on this ProgramScheduleImpl.

This method is only a request for notification. No guarantee is provided that the SI database will detect all, or even any, changes to the ProgramScheduleImpl, or whether such changes will be detected in a timely fashion.

If the specified SIChangeListener is already registered, no action is performed.

Specified by:

addListener in interface ProgramSchedule

Parameters:

listener - An SIChangeListener to be notified of changes to program events on this ProgramScheduleImpl.

See Also:

ProgramEvent

removeListener

public void removeListener(ProgramScheduleListener listener)

Called to unregister an SIChangeListener. If the specified SIChangeListener is not registered, no action is performed.

Specified by:

removeListener in interface ProgramSchedule

Parameters:

listener - A previously registered listener.

retrieveNextProgramEvent

public SIRequest retrieveNextProgramEvent(ProgramEvent anEvent,
                                 SIRequestor requestor)
                                   throws SIException

Retrieves an event which follows the specified event.

This method delivers its results asynchronously.

Specified by:

retrieveNextProgramEvent in interface ProgramSchedule

Parameters:

anEvent - A reference event

requestor - The SIRequestor to be notified when this retrieval operation completes.

Returns:

An SIRequest object identifying this asynchronous retrieveal request.

Throws:

SIException - If event does not belong to this ProgramSchedule.

See Also:

ProgramEvent

getServiceLocator

public Locator getServiceLocator()

Reports the transport-dependent locator referencing the service to which this ProgramSchedule belongs. Note that applications may use this method to establish the identity of a ProgramSchedule after it has changed.

Specified by:

getServiceLocator in interface ProgramSchedule

Returns:

The transport-dependent locator referencing the service to which this ProgramSchedule belongs.

See Also:

ProgramScheduleEvent.getProgramSchedule()

notifyListeners

public void notifyListeners(ProgramScheduleEvent event)

Notify all listeners that this program schedule has been changed.