net.sf.xtvdclient.xtvd.datatypes
Class Program

java.lang.Object
  net.sf.xtvdclient.xtvd.datatypes.AbstractDataType
      net.sf.xtvdclient.xtvd.datatypes.Program

All Implemented Interfaces:

java.lang.Comparable

public class Program
extends AbstractDataType

A bean that represents a program record.

Field Summary

Fields inherited from class net.sf.xtvdclient.xtvd.datatypes.AbstractDataType

END_OF_LINE

Constructor Summary

Program()
Default constructor.

Program(java.lang.String id, java.lang.String title)
Create a new instance of the class with the specified value for the mandatory id, and title fields.

Program(java.lang.String id, java.lang.String title, java.lang.String subtitle, java.lang.String description, MpaaRatings mpaaRating, StarRating starRating, Duration runTime, java.lang.String year, java.lang.String showType, java.lang.String series, java.lang.String colorCode, java.util.Collection advisories, java.lang.String syndicatedEpisodeNumber, XtvdDate originalAirDate)
Create a new instance of the class with the specified values for the class fields.

Method Summary

java.util.Collection<MovieAdvisories>	getAdvisories() Returns advisories.
java.lang.String	getColorCode() Returns colorCode.
java.lang.String	getDescription() Returns description.
java.lang.String	getId() Returns id.
MpaaRatings	getMpaaRating() Returns mpaaRating.
XtvdDate	getOriginalAirDate() Returns originalAirDate.
Duration	getRunTime() Returns runTime.
java.lang.String	getSeries() Returns series.
java.lang.String	getShowType() Returns showType.
StarRating	getStarRating() Returns starRating.
java.lang.String	getSubtitle() Returns subtitle.
java.lang.String	getSyndicatedEpisodeNumber() Returns syndicatedEpisodeNumber.
java.lang.String	getTitle() Returns title.
java.lang.String	getYear() Returns year.
void	reset() Reset the instance variable to empty values.
void	setAdvisories(java.util.Collection<MovieAdvisories> advisories) Set advisories.
void	setColorCode(java.lang.String colorCode) Set colorCode.
void	setDescription(java.lang.String description) Set description.
void	setId(java.lang.String id) Set id.
void	setMpaaRating(MpaaRatings mpaaRating) Set mpaaRating.
void	setOriginalAirDate(XtvdDate originalAirDate) Set originalAirDate.
void	setRunTime(Duration runTime) Set runTime.
void	setSeries(java.lang.String series) Set series.
void	setShowType(java.lang.String showType) Set showType.
void	setStarRating(StarRating starRating) Set starRating.
void	setSubtitle(java.lang.String subtitle) Set subtitle.
void	setSyndicatedEpisodeNumber(java.lang.String syndicatedEpisodeNumber) Set syndicatedEpisodeNumber.
void	setTitle(java.lang.String title) Set title.
void	setYear(java.lang.String year) Set year.
java.lang.String	toString() Over-ridden implementation.

Methods inherited from class net.sf.xtvdclient.xtvd.datatypes.AbstractDataType

compareTo, equals, replaceSpecialCharacters, replaceSpecialCharacters

Methods inherited from class java.lang.Object

clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

Program

public Program()

Default constructor. Not particularly useful, except if you wish to create an instance of the class, that will be re-used to associate with different program records.

Program

public Program(java.lang.String id,
               java.lang.String title)

Create a new instance of the class with the specified value for the mandatory id, and title fields.

Parameters:

id - The id value to set.

title - The title value to set.

Program

public Program(java.lang.String id,
               java.lang.String title,
               java.lang.String subtitle,
               java.lang.String description,
               MpaaRatings mpaaRating,
               StarRating starRating,
               Duration runTime,
               java.lang.String year,
               java.lang.String showType,
               java.lang.String series,
               java.lang.String colorCode,
               java.util.Collection advisories,
               java.lang.String syndicatedEpisodeNumber,
               XtvdDate originalAirDate)

Create a new instance of the class with the specified values for the class fields.

Parameters:

id - The id value to set.

title - The title value to set.

subtitle - The subtitle value to set.

description - The description value to set.

mpaaRating - The mpaaRating value to set.

starRating - The starRating value to set.

runTime - The runTime value to set.

year - The year value to set.

showType - The showType value to set.

series - The series value to set.

colorCode - The colorCode value to set.

advisories - The advisories value to set.

syndicatedEpisodeNumber - The syndicatedEpisodeNumber value to set.

originalAirDate - The originalAirDate value to set.

Method Detail

reset

public void reset()

Reset the instance variable to empty values.

toString

public java.lang.String toString()

Over-ridden implementation. Return an XML representation of the class fields in the same format as in the original XTVD document.

Overrides:

toString in class java.lang.Object

Returns:

String - The XML representation of the program record.

getId

public final java.lang.String getId()

Returns id.

Returns:

The value/reference of/to id.

setId

public final void setId(java.lang.String id)

Set id.

Parameters:

id - The value to set.

getTitle

public final java.lang.String getTitle()

Returns title.

Returns:

The value/reference of/to title.

setTitle

public final void setTitle(java.lang.String title)

Set title.

Parameters:

title - The value to set.

getSubtitle

public final java.lang.String getSubtitle()

Returns subtitle.

Returns:

The value/reference of/to subtitle.

setSubtitle

public final void setSubtitle(java.lang.String subtitle)

Set subtitle.

Parameters:

subtitle - The value to set.

getDescription

public final java.lang.String getDescription()

Returns description.

Returns:

The value/reference of/to description.

setDescription

public final void setDescription(java.lang.String description)

Set description.

Parameters:

description - The value to set.

getMpaaRating

public final MpaaRatings getMpaaRating()

Returns mpaaRating.

Returns:

The value/reference of/to mpaaRating.

setMpaaRating

public final void setMpaaRating(MpaaRatings mpaaRating)

Set mpaaRating.

Parameters:

mpaaRating - The value to set.

getStarRating

public final StarRating getStarRating()

Returns starRating.

Returns:

The value/reference of/to starRating.

setStarRating

public final void setStarRating(StarRating starRating)

Set starRating.

Parameters:

starRating - The value to set.

getRunTime

public final Duration getRunTime()

Returns runTime.

Returns:

The value/reference of/to runTime.

setRunTime

public final void setRunTime(Duration runTime)

Set runTime.

Parameters:

runTime - The value to set.

getYear

public final java.lang.String getYear()

Returns year.

Returns:

The value/reference of/to year.

setYear

public final void setYear(java.lang.String year)

Set year.

Parameters:

year - The value to set.

getShowType

public final java.lang.String getShowType()

Returns showType.

Returns:

The value/reference of/to showType.

setShowType

public final void setShowType(java.lang.String showType)

Set showType.

Parameters:

showType - The value to set.

getSeries

public final java.lang.String getSeries()

Returns series.

Returns:

The value/reference of/to series.

setSeries

public final void setSeries(java.lang.String series)

Set series.

Parameters:

series - The value to set.

getColorCode

public final java.lang.String getColorCode()

Returns colorCode.

Returns:

The value/reference of/to colorCode.

setColorCode

public final void setColorCode(java.lang.String colorCode)

Set colorCode.

Parameters:

colorCode - The value to set.

getAdvisories

public final java.util.Collection<MovieAdvisories> getAdvisories()

Returns advisories.

Returns:

The value/reference of/to advisories.

setAdvisories

public final void setAdvisories(java.util.Collection<MovieAdvisories> advisories)

Set advisories.

Parameters:

advisories - The value to set.

getSyndicatedEpisodeNumber

public final java.lang.String getSyndicatedEpisodeNumber()

Returns syndicatedEpisodeNumber.

Returns:

The value/reference of/to syndicatedEpisodeNumber.

setSyndicatedEpisodeNumber

public final void setSyndicatedEpisodeNumber(java.lang.String syndicatedEpisodeNumber)

Set syndicatedEpisodeNumber.

Parameters:

syndicatedEpisodeNumber - The value to set.

getOriginalAirDate

public final XtvdDate getOriginalAirDate()

Returns originalAirDate.

Returns:

The value/reference of/to originalAirDate.

setOriginalAirDate

public final void setOriginalAirDate(XtvdDate originalAirDate)

Set originalAirDate.

Parameters:

originalAirDate - The value to set.