Module tvbrowser

Package devplugin

Interface ProgramReceiveIf

All Superinterfaces:

java.lang.Comparable<ProgramReceiveIf>

All Known Subinterfaces:

PluginAccess, PluginProxy

All Known Implementing Classes:

tvbrowser.extras.common.AbstractInternalPluginProxy, AbstractPluginProxy, BeanShellPluginProxy, DummyPlugin, JavaPluginProxy, Plugin, ReminderPluginProxy

public interface ProgramReceiveIf
extends java.lang.Comparable<ProgramReceiveIf>

A interface for an object that supports receiving programs.

Author:

René Mach

Method Summary

Modifier and Type	Method	Description
boolean	canReceiveProgramsWithTarget()	Gets whether the ProgramReceiveIf supports receiving programs from other plugins with a special target.
java.lang.String	getId()
ProgramReceiveTarget[]	getProgramReceiveTargets()	Returns an array of receive targets or null if there is no target
boolean	receivePrograms(int eventType, Program[] programArr, ProgramReceiveTarget receiveTarget)	Method called when programs are send to this plugin.
boolean	receivePrograms(Program[] programArr, ProgramReceiveTarget receiveTarget)	Deprecated. since 4.2.2
boolean	receiveValues(int eventType, java.lang.String[] values, ProgramReceiveTarget receiveTarget)	Receives a list of Strings from another plugin with a target.
boolean	receiveValues(java.lang.String[] values, ProgramReceiveTarget receiveTarget)	Deprecated. since 4.2.2

Methods inherited from interface java.lang.Comparable

compareTo

Method Detail

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

@Deprecated(since="4.2.2")
boolean receivePrograms(Program[] programArr,
                        ProgramReceiveTarget receiveTarget)

Deprecated.

since 4.2.2

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:

true, if the programs were correctly received and the target really exists.

Since:

2.5

See Also:

canReceiveProgramsWithTarget()

receivePrograms

boolean receivePrograms(int eventType,
                        Program[] programArr,
                        ProgramReceiveTarget receiveTarget)

Method called when programs are send to this plugin.

Parameters:

type - The type of the programs send by other plugin.

programArr - The programs passed from the other plugin.

receiveTarget - The receive target of the programs.

Returns:

true, if the programs were correctly received and the target really exists.

Since:

4.2.2

See Also:

#getSupportedProgramRecieveType()

getProgramReceiveTargets

ProgramReceiveTarget[] getProgramReceiveTargets()

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

Returns:

The supported receive targets.

Since:

2.5

See Also:

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

receiveValues

@Deprecated(since="4.2.2")
boolean receiveValues(java.lang.String[] values,
                      ProgramReceiveTarget receiveTarget)

Deprecated.

since 4.2.2

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()

receiveValues

boolean receiveValues(int eventType,
                      java.lang.String[] values,
                      ProgramReceiveTarget receiveTarget)

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

Parameters:

eventType - The type of the programs send by other plugin.

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:

4.2.2

See Also:

#getSupportedProgramRecieveType()

getId

java.lang.String getId()