org.jmythapi.database
Interface ISchedule

All Superinterfaces:

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

All Known Implementing Classes:

Schedule

public interface ISchedule
extends IBasicProgramInfo, IPropertyAware<ISchedule.Props>

An interface to create a new recording schedule.

This interface is used to insert a new recording schedule into the MythTV database.
See ISchedule.Props for properties of this interface.

A response example:

A "find one record" example:

<00>REC_ID: 1221 | <01>REC_TYPE: 6=> {FIND_ONE_RECORD} | <02>CHANNEL_ID: 1067 | <03>START_TIME: 22:25:00 | <04>START_DATE: 2011-07-27 | <05>END_TIME: 00:10:00 | <06>END_DATE: 2011-07-28 | <07>TITLE: Airforce Two | <08>SUBTITLE: | <09>DESCRIPTION: | <10>CATEGORY: spielfilm | <11>PROFILE: Default | <12>REC_PRIORITY: 0 | <13>AUTOEXPIRE: true | <14>MAX_EPISODES: 0 | <15>MAX_NEWEST: false | <16>START_OFFSET: 5 | <17>END_OFFSET: 15 | <18>REC_GROUP: Default | <19>DUP_METHOD: 6=> {DUP_CHECK_SUB,DUP_CHECK_DESC,DUP_CHECK_SUB_DESC} | <20>DUP_IN: 15=> {DUPS_IN_RECORDED,DUPS_IN_OLD_RECORDED,DUPS_IN_ALL} | <21>CHANNEL_SIGN: SAT.1 | <22>SERIES_ID: 202888895 | <23>PROGRAM_ID: | <24>SEARCH: 0 | <25>AUTO_TRANSCODE: false | <26>AUTO_COMMFLAG: false | <27>AUTO_USERJOB_1: false | <28>AUTO_USERJOB_2: false | <29>AUTO_USERJOB_3: false | <30>AUTO_USERJOB_4: false | <31>FIND_DAY: 4 | <32>FIND_TIME: 22:25:00 | <33>FIND_ID: 0 | <34>INACTIVE: false | <35>PARENT_ID: 0 | <36>TRANSCODER: 0 | <37>TS_DEFAULT: 1.0 | <38>PLAY_GROUP: Default | <39>PREF_INPUT: 0 | <40>NEXT_RECORD: null | <41>LAST_RECORD: Sun Jul 31 00:20:02 CEST 2011 | <42>LAST_DELETE: null | <43>STORAGEGROUP: Default | <44>AVG_DELAY: 100

A "Do not record" example:

<00>REC_ID: 1280 | <01>REC_TYPE: 8=> {DONT_RECORD} | <02>CHANNEL_ID: 1063 | <03>START_TIME: 07:15:00 | <04>START_DATE: 2011-07-30 | <05>END_TIME: 07:45:00 | <06>END_DATE: 2011-07-30 | <07>TITLE: The Big Bang Theory | <08>SUBTITLE: | <09>DESCRIPTION: Sheldon pro se Serie mit Kaley Cuoco, Johnny Galecki<10>CATEGORY: serie | <11>PROFILE: Default | <12>REC_PRIORITY: 0 | <13>AUTOEXPIRE: true | <14>MAX_EPISODES: 0 | <15>MAX_NEWEST: false | <16>START_OFFSET: 5 | <17>END_OFFSET: 15 | <18>REC_GROUP: Default | <19>DUP_METHOD: 6=> {DUP_CHECK_SUB,DUP_CHECK_DESC,DUP_CHECK_SUB_DESC} | <20>DUP_IN: 15=> {DUPS_IN_RECORDED,DUPS_IN_OLD_RECORDED,DUPS_IN_ALL} | <21>CHANNEL_SIGN: PRO7 | <22>SERIES_ID: 100797097 | <23>PROGRAM_ID: | <24>SEARCH: 0 | <25>AUTO_TRANSCODE: false | <26>AUTO_COMMFLAG: false | <27>AUTO_USERJOB_1: false | <28>AUTO_USERJOB_2: false | <29>AUTO_USERJOB_3: false | <30>AUTO_USERJOB_4: false | <31>FIND_DAY: 6 | <32>FIND_TIME: 06:45:00 | <33>FIND_ID: 0 | <34>INACTIVE: false | <35>PARENT_ID: 0 | <36>TRANSCODER: 0 | <37>TS_DEFAULT: 1.0 | <38>PLAY_GROUP: Default | <39>PREF_INPUT: 0 | <40>NEXT_RECORD: null | <41>LAST_RECORD: Fri Jul 29 12:40:02 CEST 2011 | <42>LAST_DELETE: null | <43>STORAGEGROUP: Default | <44>AVG_DELAY: 100

Nested Class Summary

static class

ISchedule.Props Properties of an ISchedule object.

Field Summary

static String	CATEGORY_MANUAL_RECORDING
static String	DESCRIPTION_MANUALLY_SCHEDULED

Method Summary

String	getCategory() Gets the category of the program.
Integer	getChannelID()
String	getChannelSign()
String	getDescription() Gets the program description.
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.
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.
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 recordingId)
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)

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

getDuration, 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

Field Detail

CATEGORY_MANUAL_RECORDING

static final String CATEGORY_MANUAL_RECORDING

See Also:

Constant Field Values

DESCRIPTION_MANUALLY_SCHEDULED

static final String DESCRIPTION_MANUALLY_SCHEDULED

See Also:

Constant Field Values

Method Detail

getRecordingId

Integer getRecordingId()

setRecordingId

void setRecordingId(Integer recordingId)

getRecordingType

IProgramRecordingType getRecordingType()

setRecordingType

void setRecordingType(IProgramRecordingType recType)

getChannelID

Integer getChannelID()

setChannelID

void setChannelID(Integer channelId)

getChannelSign

String getChannelSign()

setChannelSign

void setChannelSign(String sign)

setChannel

void setChannel(IBasicChannelInfo channelInfo)

Parameters:

channelInfo -

See Also:

setChannelSign(String), setChannelID(Integer)

getStartDate

Date getStartDate()

getStartTime

Time getStartTime()

getStartDateTime

Date getStartDateTime()

Description copied from interface: IBasicProgramInfo

Gets the scheduled start of the program.

Specified by:

getStartDateTime in interface IBasicProgramInfo

Returns:

the scheduled start time.

See Also:

getStartDate(), getStartTime()

setStartDate

void setStartDate(Date startDate)

setStartTime

void setStartTime(Date startTime)

setStartDateTime

void setStartDateTime(Date startDateTime)

See Also:

setStartDate(Date), setStartTime(Date)

getEndDate

Date getEndDate()

getEndTime

Time getEndTime()

getEndDateTime

Date getEndDateTime()

Description copied from interface: IBasicProgramInfo

Gets the scheduled end of the program.

Specified by:

getEndDateTime in interface IBasicProgramInfo

Returns:

the scheduled end time.

See Also:

getEndDate(), getEndTime()

setEndDate

void setEndDate(Date endDate)

setEndTime

void setEndTime(Date endDate)

setEndDateTime

void setEndDateTime(Date endDateTime)

See Also:

setEndDate(Date), setEndTime(Date)

getTitle

String getTitle()

Description copied from interface: IBasicProgramInfo

Gets the program title.

Specified by:

getTitle in interface IBasicProgramInfo

Returns:

the title of the program

setTitle

void setTitle(String title)

getFullTitle

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

getSubtitle

String getSubtitle()

Description copied from interface: IBasicProgramInfo

Gets the program subtitle.

Specified by:

getSubtitle in interface IBasicProgramInfo

Returns:

the subtitle of the program

setSubtitle

void setSubtitle(String subTitle)

getDescription

String getDescription()

Description copied from interface: IBasicProgramInfo

Gets the program description.

Specified by:

getDescription in interface IBasicProgramInfo

Returns:

the program description

setDescription

void setDescription(String description)

getCategory

String getCategory()

Description copied from interface: IBasicProgramInfo

Gets the category of the program.

Specified by:

getCategory in interface IBasicProgramInfo

Returns:

the program category, e.g. Comedy

setCategory

void setCategory(String category)

getSeason

Integer getSeason()

setSeason

void setSeason(Integer season)

getRecordingPriority

Integer getRecordingPriority()

setRecordingPriority

void setRecordingPriority(Integer priority)

getFindDay

Integer getFindDay()

setFindDay

void setFindDay(Date dayDateTime)

setFindDay

void setFindDay(Integer day)

getFindTime

Time getFindTime()

setFindTime

void setFindTime(Date findTime)

getFindId

Integer getFindId()

setFindId

void setFindId(Date startDateTime)

setFindId

void setFindId(Integer findId)

getSearch

IProgramRecordingSearchType getSearch()

setSearch

void setSearch(IProgramRecordingSearchType search)

getSeriesID

String getSeriesID()

Description copied from interface: IBasicProgramInfo

Gets the series ID of the program.

Specified by:

getSeriesID in interface IBasicProgramInfo

Returns:

the series ID.

setSeriesID

void setSeriesID(String seriesId)

getProgramID

String getProgramID()

Description copied from interface: IBasicProgramInfo

Get the program ID.

Specified by:

getProgramID in interface IBasicProgramInfo

Returns:

the program ID.

setProgramID

void setProgramID(String programId)

getStartOffset

Integer getStartOffset()

setStartOffset

void setStartOffset(Integer startOffset)

getEndOffset

Integer getEndOffset()

setEndOffset

void setEndOffset(Integer endOffset)