devplugin

Interface TvDataService

All Superinterfaces:

ButtonActionIf, ContextMenuIf

Deprecated.

since 2.2.4/2.6 Your TvDataService should not implement this interface. The visibility will be set to protected with TV-Browser 3.0 and a later release of the 2.2.x branch, so your TvDataService will not be able to implement this interface. You have to extend the class devplugin.AbstractTvDataService instead to provide your data service.

public interface TvDataService
extends ContextMenuIf, ButtonActionIf

Interface for data services methods.

Method Summary

Methods

Modifier and Type	Method and Description
ChannelGroup[]	checkForAvailableChannelGroups(ProgressMonitor monitor) Deprecated.
Channel[]	checkForAvailableChannels(ChannelGroup group, ProgressMonitor monitor) Deprecated. Some TvDataServices may need to connect to the internet to know their channels.
Channel[]	getAvailableChannels(ChannelGroup group) Deprecated. Gets the list of the channels that are available for the given channel group.
ChannelGroup[]	getAvailableGroups() Deprecated.
PluginInfo	getInfo() Deprecated. Gets information about this TvDataService
SettingsPanel	getSettingsPanel() Deprecated.
boolean	hasSettingsPanel() Deprecated. A TvDataService can have a settings panel within the settings dialog.
void	loadSettings(Properties settings) Deprecated. Called by the host-application during start-up.
void	setWorkingDirectory(File dataDir) Deprecated. This method is called by the host application to set the working folder.
Properties	storeSettings() Deprecated. Called by the host-application during shut-down.
boolean	supportsAutoUpdate() Deprecated. Gets if the data service supports auto upate of data.
boolean	supportsDynamicChannelGroups() Deprecated.
boolean	supportsDynamicChannelList() Deprecated.
void	updateTvData(TvDataUpdateManager updateManager, Channel[] channelArr, Date startDate, int dateCount, ProgressMonitor monitor) Deprecated. Updates the TV listings provided by this data service.

Methods inherited from interface devplugin.ContextMenuIf

getContextMenuActions, getId

Methods inherited from interface tvbrowser.core.plugin.ButtonActionIf

getButtonAction, getButtonActionDescription, getId

Method Detail

setWorkingDirectory

void setWorkingDirectory(File dataDir)

Deprecated.

This method is called by the host application to set the working folder. If required, TvDataService implementations should store their data within this 'dataDir' directory

Parameters:

dataDir -

getAvailableGroups

ChannelGroup[] getAvailableGroups()

Deprecated.

Returns:

an array of the available channel groups.

updateTvData

void updateTvData(TvDataUpdateManager updateManager,
                Channel[] channelArr,
                Date startDate,
                int dateCount,
                ProgressMonitor monitor)
                  throws TvBrowserException

Deprecated.

Updates the TV listings provided by this data service.

Throws:

TvBrowserException

loadSettings

void loadSettings(Properties settings)

Deprecated.

Called by the host-application during start-up. Implement this method to load your dataservices settings from the file system.

storeSettings

Properties storeSettings()

Deprecated.

Called by the host-application during shut-down. Implements this method to store your dataservices settings to the file system.

hasSettingsPanel

boolean hasSettingsPanel()

Deprecated.

A TvDataService can have a settings panel within the settings dialog. If the hasSettingsPanel() method returns false, the getSettingsPanel() method is never called.

Returns:

true, if the settings panel feature is used by this TvDataService

getSettingsPanel

SettingsPanel getSettingsPanel()

Deprecated.

Returns:

the SettingsPanel of this TvDataService

getAvailableChannels

Channel[] getAvailableChannels(ChannelGroup group)

Deprecated.

Gets the list of the channels that are available for the given channel group.

checkForAvailableChannels

Channel[] checkForAvailableChannels(ChannelGroup group,
                                  ProgressMonitor monitor)
                                    throws TvBrowserException

Deprecated.

Some TvDataServices may need to connect to the internet to know their channels. If supportsDanymicChannelList() returns true, this method is called to check for available channels.

Parameters:

group -

monitor -

Returns:

array of all available channels (new and old)

Throws:

TvBrowserException

checkForAvailableChannelGroups

ChannelGroup[] checkForAvailableChannelGroups(ProgressMonitor monitor)
                                              throws TvBrowserException

Deprecated.

Throws:

TvBrowserException

supportsDynamicChannelList

boolean supportsDynamicChannelList()

Deprecated.

Returns:

true, if this TvDataService can dynamically load other channels

supportsDynamicChannelGroups

boolean supportsDynamicChannelGroups()

Deprecated.

Returns:

true, if this TvDataService can dynamically load other groups

getInfo

PluginInfo getInfo()

Deprecated.

Gets information about this TvDataService

supportsAutoUpdate

boolean supportsAutoUpdate()

Deprecated.

Gets if the data service supports auto upate of data.

Returns:

True if the data service supports the auto update, false otherwise.

Since:

2.7