org.jmythapi.database.impl
Class RecorderNextProgramInfo

java.lang.Object
  extended by org.jmythapi.impl.AData<E>
      extended by org.jmythapi.database.impl.ADatabaseRow<IRecorderNextProgramInfo.Props>
          extended by org.jmythapi.database.impl.RecorderNextProgramInfo
All Implemented Interfaces:
Cloneable, IBasicChannelInfo, IPropertyAware<IRecorderNextProgramInfo.Props>, IVersionable, IBasicProgramInfo, IRecorderNextProgramInfo

public class RecorderNextProgramInfo
extends ADatabaseRow<IRecorderNextProgramInfo.Props>
implements IRecorderNextProgramInfo


Nested Class Summary
 
Nested classes/interfaces inherited from interface org.jmythapi.protocol.response.IRecorderNextProgramInfo
IRecorderNextProgramInfo.Props
 
Field Summary
 
Fields inherited from class org.jmythapi.impl.AData
logger, propsClass, protoVersion, respArgs
 
Constructor Summary
RecorderNextProgramInfo(ProtocolVersion protoVersion, int dbVersion, List<String> data)
           
 
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.
 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 class org.jmythapi.database.impl.ADatabaseRow
clone, decodeProperty, encodeProperty, equals, getDatabaseVersion, getProperties, getProperty, getPropertyIndex
 
Methods inherited from class org.jmythapi.impl.AData
getPropertyClass, getPropertyCount, getPropertyMap, getPropertyValue, getPropertyValue, getPropertyValueObject, getPropertyValueObject, getPropertyValues, getVersionNr, hashCode, init, postProcessArguments, setPropertyValue, setPropertyValue, setPropertyValueObject, toString
 
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait
 
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
 

Constructor Detail

RecorderNextProgramInfo

public RecorderNextProgramInfo(ProtocolVersion protoVersion,
                               int dbVersion,
                               List<String> data)
Method Detail

getCategory

public String getCategory()
Description copied from interface: IRecorderNextProgramInfo
Gets the category of the program.

Specified by:
getCategory in interface IBasicProgramInfo
Specified by:
getCategory in interface IRecorderNextProgramInfo
Returns:
the program category, e.g. Comedy
See Also:
IRecorderNextProgramInfo.Props.CATEGORY

getChannelID

public Integer getChannelID()
Description copied from interface: IRecorderNextProgramInfo
Gets the MythTV internal channel ID.

Specified by:
getChannelID in interface IBasicChannelInfo
Specified by:
getChannelID in interface IRecorderNextProgramInfo
Returns:
the ID of the channel, e.g. 11123
See Also:
IRecorderNextProgramInfo.Props.CHANNEL_ID

getChannelIconPath

public String getChannelIconPath()
Description copied from interface: IRecorderNextProgramInfo
Gets the path to the channel icon.

Specified by:
getChannelIconPath in interface IRecorderNextProgramInfo
See Also:
IRecorderNextProgramInfo.Props.CHANNEL_ICON_PATH

getChannelNumber

public String getChannelNumber()
Description copied from interface: IRecorderNextProgramInfo
Gets the user defined channel number.

Specified by:
getChannelNumber in interface IBasicChannelInfo
Specified by:
getChannelNumber in interface IRecorderNextProgramInfo
Returns:
the user defined number. This could contain '-', '_' or '.'
See Also:
IRecorderNextProgramInfo.Props.CHANNEL_NUMBER

getChannelSign

public String getChannelSign()
Description copied from interface: IRecorderNextProgramInfo
Gets the station abbreviation.

Specified by:
getChannelSign in interface IBasicChannelInfo
Specified by:
getChannelSign in interface IRecorderNextProgramInfo
Returns:
the channel abbreviation, e.g. PULS 4
See Also:
IRecorderNextProgramInfo.Props.CHANNEL_SIGN

getDescription

public String getDescription()
Description copied from interface: IRecorderNextProgramInfo
Gets the program description.

Specified by:
getDescription in interface IBasicProgramInfo
Specified by:
getDescription in interface IRecorderNextProgramInfo
Returns:
the program description
See Also:
IRecorderNextProgramInfo.Props.DESCRIPTION

getEndDateTime

public Date getEndDateTime()
Description copied from interface: IRecorderNextProgramInfo
Gets the scheduled end of the program.

Specified by:
getEndDateTime in interface IBasicProgramInfo
Specified by:
getEndDateTime in interface IRecorderNextProgramInfo
Returns:
the scheduled end time.
See Also:
IRecorderNextProgramInfo.Props.END_DATE_TIME

getProgramID

public String getProgramID()
Description copied from interface: IRecorderNextProgramInfo
Get the program ID.

Specified by:
getProgramID in interface IBasicProgramInfo
Specified by:
getProgramID in interface IRecorderNextProgramInfo
Returns:
the program ID.
See Also:
IRecorderNextProgramInfo.Props.PROGRAM_ID

getSeriesID

public String getSeriesID()
Description copied from interface: IRecorderNextProgramInfo
Gets the series ID of the program.

Specified by:
getSeriesID in interface IBasicProgramInfo
Specified by:
getSeriesID in interface IRecorderNextProgramInfo
Returns:
the series ID.
See Also:
IRecorderNextProgramInfo.Props.SERIES_ID

getStartDateTime

public Date getStartDateTime()
Description copied from interface: IRecorderNextProgramInfo
Gets the scheduled start of the program.

Specified by:
getStartDateTime in interface IBasicProgramInfo
Specified by:
getStartDateTime in interface IRecorderNextProgramInfo
Returns:
the scheduled start time.
See Also:
IRecorderNextProgramInfo.Props.START_DATE_TIME

getSubtitle

public String getSubtitle()
Description copied from interface: IRecorderNextProgramInfo
Gets the program subtitle.

Specified by:
getSubtitle in interface IBasicProgramInfo
Specified by:
getSubtitle in interface IRecorderNextProgramInfo
Returns:
the subtitle of the program
See Also:
IRecorderNextProgramInfo.Props.SUBTITLE

getTitle

public String getTitle()
Description copied from interface: IRecorderNextProgramInfo
Gets the program title.

Specified by:
getTitle in interface IBasicProgramInfo
Specified by:
getTitle in interface IRecorderNextProgramInfo
Returns:
the title of the program
See Also:
IRecorderNextProgramInfo.Props.TITLE

getFullTitle

public String getFullTitle()
Description copied from interface: IBasicProgramInfo
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"

Specified by:
getFullTitle in interface IBasicProgramInfo
Returns:
the full title of the program

getDuration

public int getDuration()
Description copied from interface: IBasicProgramInfo
Gets the duration for the program in minutes.

Specified by:
getDuration in interface IBasicProgramInfo
Returns:
the duration of the program in minutes or -1 if unknown.

getMinutesAfterMidnight

public int getMinutesAfterMidnight()
Description copied from interface: IBasicProgramInfo
Gets the the start time of the program in minutes after midnight.

Specified by:
getMinutesAfterMidnight in interface IBasicProgramInfo
Returns:
the start time in minutes after midnight

getUniqueProgramId

public String getUniqueProgramId()
Description copied from interface: IBasicProgramInfo
Generates a unique id for this program-info.

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

Specified by:
getUniqueProgramId in interface IBasicProgramInfo
Returns:
a unique id, e.g. 1000_20110719162900

isValid

public boolean isValid()
Description copied from interface: IBasicProgramInfo
Checks if the program object contains valid data.

Specified by:
isValid in interface IBasicProgramInfo
Returns:
true if the program contains valid data.


Copyright © 2008-2013. All Rights Reserved.