org.dvb.spi.si.simple
Interface SimpleSIProvider

All Superinterfaces:
Provider, SystemBoundProvider

public interface SimpleSIProvider
extends SystemBoundProvider

This interface describes a source of information about the schedules and program events in a broadcast channel.

This class and related classes and interfaces are intended to be used as follows:

In this API, collections of data are represented with random-access java.util.List type.

This class involves several methods that pass an instance of List to the terminal. Once a list instance has been give to the terminal, it must not be changed. The results of changing a list that has been given to the terminal via this API are undefined, and may include termination of the enclosing xlet.

See Also:
SystemBoundProvider, SelectionProvider, List, ArrayList

Method Summary
 ProgramDescription[] getProgramDescriptions(ProgramReference[] programReferences, java.lang.String[] preferredLanguages)
          Called by a terminal to request program description information from a provider.
 ProgramReference[] getProgramReferences(ServiceReference r)
          Called by the terminal to request program information from a provider for a given service.
 ScheduleDescription[] getScheduleDescriptions(ServiceReference[] services, java.util.Date startDate, java.util.Date endDate)
          Called by the terminal to request schedule information from a provider.
 void registerListener(SimpleSIProviderListener l)
          Called by the platform in order to obtain events from this provider.
 void unregisterListener(SimpleSIProviderListener l)
          Called by the platform when it no longer wishes to receive events from this provider.
 
Methods inherited from interface org.dvb.spi.Provider
getName, getServiceProviderInterfaces, getVersion, providerRegistered, providerUnregistered
 

Method Detail

registerListener

void registerListener(SimpleSIProviderListener l)
Called by the platform in order to obtain events from this provider.

Parameters:
l - the listener to register

unregisterListener

void unregisterListener(SimpleSIProviderListener l)
Called by the platform when it no longer wishes to receive events from this provider.

Parameters:
l - the listener to remove

getProgramReferences

ProgramReference[] getProgramReferences(ServiceReference r)
Called by the terminal to request program information from a provider for a given service.

Parameters:
r - the service for which program information is requested
Returns:
references for all of the known programs for the given service.

getScheduleDescriptions

ScheduleDescription[] getScheduleDescriptions(ServiceReference[] services,
                                              java.util.Date startDate,
                                              java.util.Date endDate)
Called by the terminal to request schedule information from a provider. The output shall be returned in an array of the same size and order as the input. If the schedule is not available on any service listed in the input then the corresponding entry in the results array shall be null.

Parameters:
services - references identifying the services whose schedules are requested
startDate - the starting date and time from which to return schedule descriptions (inclusive)
endDate - the finishing date and time up to which schedule descriptons should be returned (exclusive)
Returns:
an array of schedule descriptions

getProgramDescriptions

ProgramDescription[] getProgramDescriptions(ProgramReference[] programReferences,
                                            java.lang.String[] preferredLanguages)
Called by a terminal to request program description information from a provider. The output shall be returned in an array of the same size and order as the input. If the schedule is not available on any service listed in the input then the corresponding entry in the results array shall be null.

Parameters:
programReferences - references identifying the programs whose schedules are requested
preferredLanguages - The preferred language(s) for program names and descriptions. This is a hint of the language(s) likely to be requested of the descriptions themselves.
Returns:
an array of program descriptions