org.jmythapi.protocol.response
Interface IRecorderNextProgramInfo

All Superinterfaces:

Cloneable, IBasicChannelInfo, IBasicProgramInfo, IPropertyAware<IRecorderNextProgramInfo.Props>, IVersionable

All Known Implementing Classes:

RecorderNextProgramInfo, RecorderNextProgramInfo

public interface IRecorderNextProgramInfo
extends IBasicChannelInfo, IBasicProgramInfo, IVersionable, IPropertyAware<IRecorderNextProgramInfo.Props>

An interface to get the next program of a MythTV recorder channel.

This interface represents the response to a IRecorder.getNextProgramInfo(...) request.
This interface is property-aware. See the properties-list for all properties of this interface.

Response example:

<00>TITLE: Formel 1 | <01>SUBTITLE: | <02>DESCRIPTION: Countdown Grosser Preis von Malaysia. mit Christian Danner, Heiko Wasser | <03>CATEGORY: | <04>START_DATE_TIME: Sun Apr 10 08:45:00 CEST 2011 | <05>END_DATE_TIME: Sun Apr 10 10:00:00 CEST 2011 | <06>CHANNEL_SIGN: RTL | <07>CHANNEL_ICON_PATH: /home/theli/.mythtv/channels/rtl.jpg | <08>CHANNEL_NUMBER: 3 | <09>CHANNEL_ID: 1066 | <10>SERIES_ID: 110344929 | <11>PROGRAM_ID:

See Also:

IBackend.getNextProgramInfos(Date), IRecorder.getNextProgramInfos(Date), QUERY_RECORDER_GET_NEXT_PROGRAM_INFO

Nested Class Summary

static class

IRecorderNextProgramInfo.Props The properties of an IRecorderNextProgramInfo response.

Method Summary

String	getCategory() Gets the category of the program.
String	getChannelIconPath() Gets the path to the channel icon.
Integer	getChannelID() Gets the MythTV internal channel ID.
String	getChannelNumber() Gets the user defined channel number.
String	getChannelSign() Gets the station abbreviation.
String	getDescription() Gets the program description.
Date	getEndDateTime() Gets the scheduled end of the program.
String	getProgramID() Get the program ID.
String	getSeriesID() Gets the series ID of the program.
Date	getStartDateTime() Gets the scheduled start of the program.
String	getSubtitle() Gets the program subtitle.
String	getTitle() Gets the program title.

Methods inherited from interface org.jmythapi.protocol.response.IBasicProgramInfo

getDuration, getFullTitle, getMinutesAfterMidnight, getUniqueProgramId, isValid

Methods inherited from interface org.jmythapi.IVersionable

getVersionNr

Methods inherited from interface org.jmythapi.IPropertyAware

getProperties, getProperty, getPropertyClass, getPropertyCount, getPropertyIndex, getPropertyMap, getPropertyValue, getPropertyValue, getPropertyValueObject, getPropertyValues, setPropertyValue, setPropertyValue, setPropertyValueObject

Method Detail

getTitle

String getTitle()

Gets the program title.

Specified by:

getTitle in interface IBasicProgramInfo

Returns:

the title of the program

See Also:

IRecorderNextProgramInfo.Props.TITLE

getSubtitle

String getSubtitle()

Gets the program subtitle.

Specified by:

getSubtitle in interface IBasicProgramInfo

Returns:

the subtitle of the program

See Also:

IRecorderNextProgramInfo.Props.SUBTITLE

getDescription

String getDescription()

Gets the program description.

Specified by:

getDescription in interface IBasicProgramInfo

Returns:

the program description

See Also:

IRecorderNextProgramInfo.Props.DESCRIPTION

getCategory

String getCategory()

Gets the category of the program.

Specified by:

getCategory in interface IBasicProgramInfo

Returns:

the program category, e.g. Comedy

See Also:

IRecorderNextProgramInfo.Props.CATEGORY

getStartDateTime

Date getStartDateTime()

Gets the scheduled start of the program.

Specified by:

getStartDateTime in interface IBasicProgramInfo

Returns:

the scheduled start time.

See Also:

IRecorderNextProgramInfo.Props.START_DATE_TIME

getEndDateTime

Date getEndDateTime()

Gets the scheduled end of the program.

Specified by:

getEndDateTime in interface IBasicProgramInfo

Returns:

the scheduled end time.

See Also:

IRecorderNextProgramInfo.Props.END_DATE_TIME

getSeriesID

String getSeriesID()

Gets the series ID of the program.

Specified by:

getSeriesID in interface IBasicProgramInfo

Returns:

the series ID.

See Also:

IRecorderNextProgramInfo.Props.SERIES_ID

getProgramID

String getProgramID()

Get the program ID.

Specified by:

getProgramID in interface IBasicProgramInfo

Returns:

the program ID.

See Also:

IRecorderNextProgramInfo.Props.PROGRAM_ID

getChannelID

Integer getChannelID()

Gets the MythTV internal channel ID.

Specified by:

getChannelID in interface IBasicChannelInfo

Returns:

the ID of the channel, e.g. 11123

See Also:

IRecorderNextProgramInfo.Props.CHANNEL_ID

getChannelSign

String getChannelSign()

Gets the station abbreviation.

Specified by:

getChannelSign in interface IBasicChannelInfo

Returns:

the channel abbreviation, e.g. PULS 4

See Also:

IRecorderNextProgramInfo.Props.CHANNEL_SIGN

getChannelNumber

String getChannelNumber()

Gets the user defined channel number.

Specified by:

getChannelNumber in interface IBasicChannelInfo

Returns:

the user defined number. This could contain '-', '_' or '.'

See Also:

IRecorderNextProgramInfo.Props.CHANNEL_NUMBER

getChannelIconPath

String getChannelIconPath()

Gets the path to the channel icon.

See Also:

IRecorderNextProgramInfo.Props.CHANNEL_ICON_PATH