devplugin

Interface ProgramReceiveIf

All Known Subinterfaces:

PluginAccess, PluginProxy

All Known Implementing Classes:

AbstractPluginProxy, BeanShellPluginProxy, BlogThisPlugin, CalendarExportPlugin, CapturePlugin, ClipboardPlugin, EMailPlugin, GenrePlugin, GrowlPlugin, I18NPlugin, ImdbPlugin, JavaPluginProxy, KNotifyPlugin, ListViewPlugin, MovieAwardPlugin, NewsPlugin, Plugin, PrintPlugin, ProgramListPlugin, ReminderPluginProxy, SimpleMarkerPlugin, TimeListPlugin, TVRaterPlugin, WebPlugin, WirSchauenPlugin

public interface ProgramReceiveIf

A interface for an object that supports receiving programs.

Author:

René Mach

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canReceivePrograms() Deprecated. Since 2.5 Use canReceiveProgramsWithTarget() instead.
boolean	canReceiveProgramsWithTarget() Gets whether the ProgramReceiveIf supports receiving programs from other plugins with a special target.
String	getId()
ProgramReceiveTarget[]	getProgramReceiveTargets() Returns an array of receive target or null if there is no target
void	receivePrograms(Program[] programArr) Deprecated. Since 2.5 Use receivePrograms(Program[],ProgramReceiveTarget) instead.
boolean	receivePrograms(Program[] programArr, ProgramReceiveTarget receiveTarget) Receives a list of programs from another plugin with a target.
boolean	receiveValues(String[] values, ProgramReceiveTarget receiveTarget) Receives a list of Strings from another plugin with a target.

Method Detail

canReceivePrograms

boolean canReceivePrograms()

Deprecated. Since 2.5 Use canReceiveProgramsWithTarget() instead.

Gets whether the ProgramReceiveIf supports receiving programs from other plugins.

Returns:

Whether the ProgramReceiveIf supports receiving programs from other plugins.

See Also:

receivePrograms(Program[])

receivePrograms

void receivePrograms(Program[] programArr)

Deprecated. Since 2.5 Use receivePrograms(Program[],ProgramReceiveTarget) instead.

Receives a list of programs from another plugin.

Parameters:

programArr - The programs passed from the other plugin.

See Also:

canReceivePrograms()

canReceiveProgramsWithTarget

boolean canReceiveProgramsWithTarget()

Gets whether the ProgramReceiveIf supports receiving programs from other plugins with a special target.

Returns:

Whether the ProgramReceiveIf supports receiving programs from other plugins with a special target.

Since:

2.5

See Also:

receivePrograms(Program[],ProgramReceiveTarget)

receivePrograms

boolean receivePrograms(Program[] programArr,
                      ProgramReceiveTarget receiveTarget)

Receives a list of programs from another plugin with a target.

Parameters:

programArr - The programs passed from the other plugin.

receiveTarget - The receive target of the programs.

Returns:

If the programs were correct received (the target really exists).

Since:

2.5

See Also:

canReceiveProgramsWithTarget()

getProgramReceiveTargets

ProgramReceiveTarget[] getProgramReceiveTargets()

Returns an array of receive target or null if there is no target

Returns:

The supported receive targets.

Since:

2.5

See Also:

canReceiveProgramsWithTarget(), receivePrograms(Program[],ProgramReceiveTarget)

receiveValues

boolean receiveValues(String[] values,
                    ProgramReceiveTarget receiveTarget)

Receives a list of Strings from another plugin with a target.

Parameters:

values - The value array passed from the other plugin.

receiveTarget - The receive target of the programs.

Returns:

True if the value array was handled correct, false otherwise.

Since:

2.7

See Also:

canReceiveProgramsWithTarget()

getId

String getId()