org.jmythapi.database.impl
Class Schedule

java.lang.Object
  org.jmythapi.impl.AData<E>
      org.jmythapi.database.impl.ADatabaseRow<ISchedule.Props>
          org.jmythapi.database.impl.Schedule

All Implemented Interfaces:

Cloneable, ISchedule, IPropertyAware<ISchedule.Props>, IVersionable, IBasicProgramInfo

public class Schedule
extends ADatabaseRow<ISchedule.Props>
implements ISchedule, IBasicProgramInfo

Nested Class Summary

Nested classes/interfaces inherited from interface org.jmythapi.database.ISchedule

ISchedule.Props

Field Summary

Fields inherited from class org.jmythapi.impl.AData

logger, propsClass, protoVersion, respArgs

Fields inherited from interface org.jmythapi.database.ISchedule

CATEGORY_MANUAL_RECORDING, DESCRIPTION_MANUALLY_SCHEDULED

Constructor Summary

Schedule(ProtocolVersion protoVersion, int dbVersion)

Schedule(ProtocolVersion protoVersion, int dbVersion, List<String> data)

Method Summary

String	getCategory() Gets the category of the program.
Integer	getChannelID()
String	getChannelSign()
String	getDescription() Gets the program description.
int	getDuration() Gets the duration for the program in minutes.
Date	getEndDate()
Date	getEndDateTime() Gets the scheduled end of the program.
Integer	getEndOffset()
Time	getEndTime()
Integer	getFindDay()
Integer	getFindId()
Time	getFindTime()
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.
Integer	getRecordingId()
Integer	getRecordingPriority()
IProgramRecordingType	getRecordingType()
IProgramRecordingSearchType	getSearch()
Integer	getSeason()
String	getSeriesID() Gets the series ID of the program.
Date	getStartDate()
Date	getStartDateTime() Gets the scheduled start of the program.
Integer	getStartOffset()
Time	getStartTime()
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.
void	setCategory(String category)
void	setChannel(IBasicChannelInfo channelInfo)
void	setChannelID(Integer channelId)
void	setChannelSign(String sign)
void	setDescription(String description)
void	setEndDate(Date endDate)
void	setEndDateTime(Date endDateTime)
void	setEndOffset(Integer endOffset)
void	setEndTime(Date endDate)
void	setFindDay(Date dayDateTime)
void	setFindDay(Integer day)
void	setFindId(Date startDateTime)
void	setFindId(Integer findId)
void	setFindTime(Date findTime)
void	setProgramID(String programId)
void	setRecordingId(Integer recordId)
void	setRecordingPriority(Integer priority)
void	setRecordingType(IProgramRecordingType recType)
void	setSearch(IProgramRecordingSearchType search)
void	setSeason(Integer season)
void	setSeriesID(String seriesId)
void	setStartDate(Date startDate)
void	setStartDateTime(Date startDateTime)
void	setStartOffset(Integer startOffset)
void	setStartTime(Date startTime)
void	setSubtitle(String subTitle)
void	setTitle(String title)
static Schedule	valueOf(ProtocolVersion protoVersion, int dbVersion, IRecorderNextProgramInfo nextProgramInfo)
static Schedule	valueOf(ProtocolVersion protoVersion, int dbVersion, IRecorderNextProgramInfo nextProgramInfo, IProgramRecordingType.Type recordingType)

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

Schedule

public Schedule(ProtocolVersion protoVersion,
                int dbVersion)

Schedule

public Schedule(ProtocolVersion protoVersion,
                int dbVersion,
                List<String> data)

Method Detail

getRecordingId

public Integer getRecordingId()

Specified by:

getRecordingId in interface ISchedule

setRecordingId

public void setRecordingId(Integer recordId)

Specified by:

setRecordingId in interface ISchedule

getRecordingType

public IProgramRecordingType getRecordingType()

Specified by:

getRecordingType in interface ISchedule

setRecordingType

public void setRecordingType(IProgramRecordingType recType)

Specified by:

setRecordingType in interface ISchedule

getChannelID

public Integer getChannelID()

Specified by:

getChannelID in interface ISchedule

setChannelID

public void setChannelID(Integer channelId)

Specified by:

setChannelID in interface ISchedule

getChannelSign

public String getChannelSign()

Specified by:

getChannelSign in interface ISchedule

setChannelSign

public void setChannelSign(String sign)

Specified by:

setChannelSign in interface ISchedule

setChannel

public void setChannel(IBasicChannelInfo channelInfo)

Specified by:

setChannel in interface ISchedule

See Also:

ISchedule.setChannelSign(String), ISchedule.setChannelID(Integer)

getStartDate

public Date getStartDate()

Specified by:

getStartDate in interface ISchedule

getStartTime

public Time getStartTime()

Specified by:

getStartTime in interface ISchedule

getStartDateTime

public Date getStartDateTime()

Description copied from interface: IBasicProgramInfo

Gets the scheduled start of the program.

Specified by:

getStartDateTime in interface ISchedule

Specified by:

getStartDateTime in interface IBasicProgramInfo

Returns:

the scheduled start time.

See Also:

ISchedule.getStartDate(), ISchedule.getStartTime()

setStartDate

public void setStartDate(Date startDate)

Specified by:

setStartDate in interface ISchedule

setStartTime

public void setStartTime(Date startTime)

Specified by:

setStartTime in interface ISchedule

setStartDateTime

public void setStartDateTime(Date startDateTime)

Specified by:

setStartDateTime in interface ISchedule

See Also:

ISchedule.setStartDate(Date), ISchedule.setStartTime(Date)

getEndDate

public Date getEndDate()

Specified by:

getEndDate in interface ISchedule

getEndTime

public Time getEndTime()

Specified by:

getEndTime in interface ISchedule

getEndDateTime

public Date getEndDateTime()

Description copied from interface: IBasicProgramInfo

Gets the scheduled end of the program.

Specified by:

getEndDateTime in interface ISchedule

Specified by:

getEndDateTime in interface IBasicProgramInfo

Returns:

the scheduled end time.

See Also:

ISchedule.getEndDate(), ISchedule.getEndTime()

setEndDate

public void setEndDate(Date endDate)

Specified by:

setEndDate in interface ISchedule

setEndTime

public void setEndTime(Date endDate)

Specified by:

setEndTime in interface ISchedule

setEndDateTime

public void setEndDateTime(Date endDateTime)

Specified by:

setEndDateTime in interface ISchedule

See Also:

ISchedule.setEndDate(Date), ISchedule.setEndTime(Date)

getTitle

public String getTitle()

Description copied from interface: IBasicProgramInfo

Gets the program title.

Specified by:

getTitle in interface ISchedule

Specified by:

getTitle in interface IBasicProgramInfo

Returns:

the title of the program

setTitle

public void setTitle(String title)

Specified by:

setTitle in interface ISchedule

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 ISchedule

Specified by:

getFullTitle in interface IBasicProgramInfo

Returns:

the full title of the program

getSubtitle

public String getSubtitle()

Description copied from interface: IBasicProgramInfo

Gets the program subtitle.

Specified by:

getSubtitle in interface ISchedule

Specified by:

getSubtitle in interface IBasicProgramInfo

Returns:

the subtitle of the program

setSubtitle

public void setSubtitle(String subTitle)

Specified by:

setSubtitle in interface ISchedule

getDescription

public String getDescription()

Description copied from interface: IBasicProgramInfo

Gets the program description.

Specified by:

getDescription in interface ISchedule

Specified by:

getDescription in interface IBasicProgramInfo

Returns:

the program description

setDescription

public void setDescription(String description)

Specified by:

setDescription in interface ISchedule

getCategory

public String getCategory()

Description copied from interface: IBasicProgramInfo

Gets the category of the program.

Specified by:

getCategory in interface ISchedule

Specified by:

getCategory in interface IBasicProgramInfo

Returns:

the program category, e.g. Comedy

setCategory

public void setCategory(String category)

Specified by:

setCategory in interface ISchedule

getSeason

public Integer getSeason()

Specified by:

getSeason in interface ISchedule

setSeason

public void setSeason(Integer season)

Specified by:

setSeason in interface ISchedule

getRecordingPriority

public Integer getRecordingPriority()

Specified by:

getRecordingPriority in interface ISchedule

setRecordingPriority

public void setRecordingPriority(Integer priority)

Specified by:

setRecordingPriority in interface ISchedule

getFindDay

public Integer getFindDay()

Specified by:

getFindDay in interface ISchedule

setFindDay

public void setFindDay(Date dayDateTime)

Specified by:

setFindDay in interface ISchedule

setFindDay

public void setFindDay(Integer day)

Specified by:

setFindDay in interface ISchedule

getFindTime

public Time getFindTime()

Specified by:

getFindTime in interface ISchedule

setFindTime

public void setFindTime(Date findTime)

Specified by:

setFindTime in interface ISchedule

getFindId

public Integer getFindId()

Specified by:

getFindId in interface ISchedule

setFindId

public void setFindId(Date startDateTime)

Specified by:

setFindId in interface ISchedule

setFindId

public void setFindId(Integer findId)

Specified by:

setFindId in interface ISchedule

getSearch

public IProgramRecordingSearchType getSearch()

Specified by:

getSearch in interface ISchedule

setSearch

public void setSearch(IProgramRecordingSearchType search)

Specified by:

setSearch in interface ISchedule

getSeriesID

public String getSeriesID()

Description copied from interface: IBasicProgramInfo

Gets the series ID of the program.

Specified by:

getSeriesID in interface ISchedule

Specified by:

getSeriesID in interface IBasicProgramInfo

Returns:

the series ID.

setSeriesID

public void setSeriesID(String seriesId)

Specified by:

setSeriesID in interface ISchedule

getProgramID

public String getProgramID()

Description copied from interface: IBasicProgramInfo

Get the program ID.

Specified by:

getProgramID in interface ISchedule

Specified by:

getProgramID in interface IBasicProgramInfo

Returns:

the program ID.

setProgramID

public void setProgramID(String programId)

Specified by:

setProgramID in interface ISchedule

getStartOffset

public Integer getStartOffset()

Specified by:

getStartOffset in interface ISchedule

setStartOffset

public void setStartOffset(Integer startOffset)

Specified by:

setStartOffset in interface ISchedule

getEndOffset

public Integer getEndOffset()

Specified by:

getEndOffset in interface ISchedule

setEndOffset

public void setEndOffset(Integer endOffset)

Specified by:

setEndOffset in interface ISchedule

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.

valueOf

public static Schedule valueOf(ProtocolVersion protoVersion,
                               int dbVersion,
                               IRecorderNextProgramInfo nextProgramInfo)

valueOf

public static Schedule valueOf(ProtocolVersion protoVersion,
                               int dbVersion,
                               IRecorderNextProgramInfo nextProgramInfo,
                               IProgramRecordingType.Type recordingType)