org.jmythapi.protocol.response
Interface IBasicProgramInfo

All Superinterfaces:

IVersionable

All Known Subinterfaces:

IProgramInfo, IRecorderNextProgramInfo, IRecorderProgramInfo, ISchedule

All Known Implementing Classes:

AProgramInfo, ARecorderProgramInfo, ProgramInfo, RecorderNextProgramInfo, RecorderNextProgramInfo, RecorderProgramInfo, Schedule

public interface IBasicProgramInfo
extends IVersionable

This interface is used to access basic program informations.

The following interfaces extend from this interface. The table below shows which program-related informations are provided by which interfaces.

Program Informations
Interface	Range	IBasicProgramInfo								Additional Informations
		Title	Subtitle	Descr.	Category	Start Time	End Time	Series ID	Program ID	Channel Infos	Output Filters	Repeat	Airdate	Stars	Recording Infos
IRecorderNextProgramInfo	[00,-1)	X	X	X	X	X	X	X	X	X	-	-	-	-	-
IRecorderProgramInfo	[00,21)	X	X	X	X	X	X	X	X	X	X	X	X	X	-
IProgramInfo	[00,-1)	X	X	X	X	X	X	X	X	X	X	X	X	X	X

Method Summary

String	getCategory() Gets the category of the program.
String	getDescription() Gets the program description.
int	getDuration() Gets the duration for the program in minutes.
Date	getEndDateTime() Gets the scheduled end of the program.
String	getFullTitle() Gets the full title of the program.
int	getMinutesAfterMidnight() Gets the the start time of the program in minutes after midnight.
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.
String	getUniqueProgramId() Generates a unique id for this program-info.
boolean	isValid() Checks if the program object contains valid data.

Methods inherited from interface org.jmythapi.IVersionable

getVersionNr

Method Detail

getTitle

String getTitle()

Gets the program title.

Returns:

the title of the program

getSubtitle

String getSubtitle()

Gets the program subtitle.

Returns:

the subtitle of the program

getFullTitle

String getFullTitle()

Gets the full title of the program.

If a program has no subtitle, than this function is the same as getTitle(), otherwise the returned full title is in the format "title - subtitle"

Returns:

the full title of the program

getDescription

String getDescription()

Gets the program description.

Returns:

the program description

getCategory

String getCategory()

Gets the category of the program.

Returns:

the program category, e.g. Comedy

getStartDateTime

Date getStartDateTime()

Gets the scheduled start of the program.

Returns:

the scheduled start time.

getEndDateTime

Date getEndDateTime()

Gets the scheduled end of the program.

Returns:

the scheduled end time.

getDuration

int getDuration()

Gets the duration for the program in minutes.

Returns:

the duration of the program in minutes or -1 if unknown.

getMinutesAfterMidnight

int getMinutesAfterMidnight()

Gets the the start time of the program in minutes after midnight.

Returns:

the start time in minutes after midnight

getSeriesID

String getSeriesID()

Gets the series ID of the program.

Returns:

the series ID.

getProgramID

String getProgramID()

Get the program ID.

Returns:

the program ID.

isValid

boolean isValid()

Checks if the program object contains valid data.

Returns:

true if the program contains valid data.

getUniqueProgramId

String getUniqueProgramId()

Generates a unique id for this program-info.

This id has the format: [channel-id]_[program-start-time]

Returns:

a unique id, e.g. 1000_20110719162900