org.schedulesdirect.api

Class Airing

java.lang.Object

org.schedulesdirect.api.Airing

public class Airing
extends Object

An Airing represents a scheduled broadcast of a Program object.

Only EpgClient can instantiate objects of this class.

When there's a discrepancy between the descriptions of data found in this source code and that found here then the latter web source will always take precedence!

Author:

Derek Battams <derek@battams.ca>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Airing.ContentType Represents the content type of the airing
static class	Airing.DolbyStatus Represents the possible values of the Dolby value of an airing
static class	Airing.FinaleStatus Represents the finale status of an airing
static class	Airing.LiveStatus Represents the live status of an airing
static class	Airing.PremiereStatus Represents the premiere status of an airing

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	getBroadcastLanguage() Get the language this airing broadcasts in.
String	getContentSource()
Airing.ContentType	getContentType()
Airing.DolbyStatus	getDolbyStatus()
int	getDuration()
Airing.FinaleStatus	getFinaleStatus()
Date	getGmtStart()
String	getId()
Airing.LiveStatus	getLiveStatus()
int	getPartNum()
Airing.PremiereStatus	getPremiereStatus()
Program	getProgram()
String	getSapLanguage()
Station	getStation()
String	getSubtitleLanguage()
int	getTotalParts()
ContentRating[]	getTvRatings()
int	hashCode()
boolean	is3d()
boolean	isCableInTheClassroom()
boolean	isClosedCaptioned()
boolean	isDescriptiveVideo()
boolean	isEducational()
boolean	isEnhanced()
boolean	isHdtv()
boolean	isJoinedInProgress()
boolean	isLeftInProgress()
boolean	isLetterboxed()
boolean	isNewAiring()
boolean	isSap()
boolean	isStereo()
boolean	isSubjectToBlackout()
boolean	isSubtitled()
boolean	isTimeApproximate()
void	setBroadcastLanguage(String lang) Set this airing's broadcasting language.
void	setCableInTheClassroom(boolean cableInTheClassroom)
void	setClosedCaptioned(boolean closedCaptioned)
void	setContentSource(String contentSource)
void	setContentType(Airing.ContentType contentType)
void	setDescriptiveVideo(boolean descriptiveVideo)
void	setDolbyStatus(Airing.DolbyStatus dolbyStatus)
void	setDuration(int duration)
void	setEducational(boolean educational)
void	setEnhanced(boolean enhanced)
void	setFinaleStatus(Airing.FinaleStatus finaleStatus)
void	setGmtStart(Date gmtStart)
void	setHdtv(boolean hdtv)
void	setId(String id) Modify this Airing's unique id; this is the id of the Program that this Airing represents
void	setIs3d(boolean is3d)
void	setJoinedInProgress(boolean joinedInProgress)
void	setLeftInProgress(boolean leftInProgress)
void	setLetterboxed(boolean letterboxed)
void	setLiveStatus(Airing.LiveStatus liveStatus)
void	setNewAiring(boolean newAiring)
void	setPartNum(int partNum)
void	setPremiereStatus(Airing.PremiereStatus premiereStatus)
void	setProgram(Program program) Change the Program this Airing is associated with; this airing's id is updated to that of the Program argument
void	setSap(boolean sap)
void	setSapLanguage(String sapLanguage)
void	setStation(Station station) Change the Station this Airing is associated with (i.e.
void	setStereo(boolean stereo)
void	setSubjectToBlackout(boolean subjectToBlackout)
void	setSubtitled(boolean subtitled)
void	setSubtitleLanguage(String subtitleLanguage)
void	setTimeApproximate(boolean timeApproximate)
void	setTotalParts(int totalParts)
void	setTvRatings(ContentRating[] tvRatings)
String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

getBroadcastLanguage

public String getBroadcastLanguage()

Get the language this airing broadcasts in.

This field is a hint and not 100% accurate; if null assume English, but not guaranteed.

Returns:

The language for this airing or null if the language is English or unknown

setBroadcastLanguage

public void setBroadcastLanguage(String lang)

Set this airing's broadcasting language.

Parameters:

lang - The language this airing is broadcasting in or null if English or unknown

isSubjectToBlackout

public boolean isSubjectToBlackout()

Returns:

True if this airing is subject to blackout or false otherwise

isEducational

public boolean isEducational()

Returns:

True if this airing is that of an educational or informational nature or false otherwise

isJoinedInProgress

public boolean isJoinedInProgress()

Returns:

True if this airing is joining a live event in progress or false otherwise

isLeftInProgress

public boolean isLeftInProgress()

Returns:

True if this airing is scheduled to end while the live event is expected to still be in progress or false otherwise

getContentSource

public String getContentSource()

Returns:

Returns the source of the content

getPartNum

public int getPartNum()

Returns:

Returns the part number of this airing or 0 if not applicable (i.e. there aren't multiple parts to the Program)

isClosedCaptioned

public boolean isClosedCaptioned()

Returns:

True if this airing is closed captioned or false otherwise

isStereo

public boolean isStereo()

Returns:

True if this airing is in stereo sound or false otherwise

isNewAiring

public boolean isNewAiring()

Returns:

True if this airing is new (as determined by the upstream) or false otherwise

getDuration

public int getDuration()

Returns:

Returns the duration of this airing, in seconds

getTotalParts

public int getTotalParts()

Returns:

Returns the total number of parts or 0 if not applicable (i.e. there aren't multiple parts to this Program)

getDolbyStatus

public Airing.DolbyStatus getDolbyStatus()

Returns:

Return the Dolby sound status of this airing

getLiveStatus

public Airing.LiveStatus getLiveStatus()

Returns:

Returns the live status of this airing

isHdtv

public boolean isHdtv()

Returns:

True if this airing is in HD or false otherwise

getPremiereStatus

public Airing.PremiereStatus getPremiereStatus()

Returns:

Returns the premiere status of this airing

getFinaleStatus

public Airing.FinaleStatus getFinaleStatus()

Returns:

Returns the finale status of this airing

getTvRatings

public ContentRating[] getTvRatings()

Returns:

Returns the assigned TV ratings for this airing

getId

public String getId()

Returns:

Returns the unique upstream (i.e. Data Direct) id for the Program this airing is attached to

getContentType

public Airing.ContentType getContentType()

Returns:

Returns the content type of this airing

isLetterboxed

public boolean isLetterboxed()

Returns:

True if this airing is letterboxed or false otherwise

getGmtStart

public Date getGmtStart()

Returns:

Returns the scheduled start time of this airing, represented in GMT time zone

isDescriptiveVideo

public boolean isDescriptiveVideo()

Returns:

True if this airing provies descriptive video or false otherwise

is3d

public boolean is3d()

Returns:

True if this airing is in 3D or false otherwise

isCableInTheClassroom

public boolean isCableInTheClassroom()

Returns:

True if this airing is available via Cable in the Classroom or false otherwise

isEnhanced

public boolean isEnhanced()

Returns:

True if this airing is enhanced or false otherwise (NOTE: I really don't know what this means)

isSap

public boolean isSap()

Returns:

True if this airing provides SAP or false otherwise

getSapLanguage

public String getSapLanguage()

Returns:

If SAP is available, this returns the alternate language that is available; will return null when data not available

isSubtitled

public boolean isSubtitled()

Returns:

True if this airing is subtitled or false otherwise

getSubtitleLanguage

public String getSubtitleLanguage()

Returns:

If subtitled, returns the language of the subtitles; will return null if no data is available

isTimeApproximate

public boolean isTimeApproximate()

Returns:

True if the duration is approximate or false otherwise

setId

public void setId(String id)
           throws IllegalArgumentException

Modify this Airing's unique id; this is the id of the Program that this Airing represents

Parameters:

id - The unique id for this Airing

Throws:

IllegalArgumentException - Thrown if id is null or if the id does not match the id of the attached Program object in this Airing

setSubjectToBlackout

public void setSubjectToBlackout(boolean subjectToBlackout)

Parameters:

subjectToBlackout - the subjectToBlackout to set

setEducational

public void setEducational(boolean educational)

Parameters:

educational - the educational to set

setJoinedInProgress

public void setJoinedInProgress(boolean joinedInProgress)

Parameters:

joinedInProgress - the joinedInProgress to set

setLeftInProgress

public void setLeftInProgress(boolean leftInProgress)

Parameters:

leftInProgress - the leftInProgress to set

setContentSource

public void setContentSource(String contentSource)

Parameters:

contentSource - the contentSource to set

setPartNum

public void setPartNum(int partNum)

Parameters:

partNum - the partNum to set

setClosedCaptioned

public void setClosedCaptioned(boolean closedCaptioned)

Parameters:

closedCaptioned - the closedCaptioned to set

setStereo

public void setStereo(boolean stereo)

Parameters:

stereo - the stereo to set

setNewAiring

public void setNewAiring(boolean newAiring)

Parameters:

newAiring - the newAiring to set

setDuration

public void setDuration(int duration)

Parameters:

duration - the duration to set

setTotalParts

public void setTotalParts(int totalParts)

Parameters:

totalParts - the totalParts to set

setDolbyStatus

public void setDolbyStatus(Airing.DolbyStatus dolbyStatus)

Parameters:

dolbyStatus - the dolbyStatus to set

setLiveStatus

public void setLiveStatus(Airing.LiveStatus liveStatus)

Parameters:

liveStatus - the liveStatus to set

setHdtv

public void setHdtv(boolean hdtv)

Parameters:

hdtv - the hdtv to set

setPremiereStatus

public void setPremiereStatus(Airing.PremiereStatus premiereStatus)

Parameters:

premiereStatus - the premiereStatus to set

setFinaleStatus

public void setFinaleStatus(Airing.FinaleStatus finaleStatus)

Parameters:

finaleStatus - the finaleStatus to set

setTvRatings

public void setTvRatings(ContentRating[] tvRatings)

Parameters:

tvRating - the tvRating to set

setContentType

public void setContentType(Airing.ContentType contentType)

Parameters:

contentType - the contentType to set

setLetterboxed

public void setLetterboxed(boolean letterboxed)

Parameters:

letterboxed - the letterboxed to set

setGmtStart

public void setGmtStart(Date gmtStart)

Parameters:

gmtStart - the gmtStart to set

setDescriptiveVideo

public void setDescriptiveVideo(boolean descriptiveVideo)

Parameters:

descriptiveVideo - the descriptiveVideo to set

setIs3d

public void setIs3d(boolean is3d)

Parameters:

is3d - the is3d to set

setCableInTheClassroom

public void setCableInTheClassroom(boolean cableInTheClassroom)

Parameters:

cableInTheClassroom - the cableInTheClassroom to set

setEnhanced

public void setEnhanced(boolean enhanced)

Parameters:

enhanced - the enhanced to set

setSap

public void setSap(boolean sap)

Parameters:

sap - the sap to set

setSapLanguage

public void setSapLanguage(String sapLanguage)

Parameters:

sapLanguage - the sapLanguage to set

setSubtitled

public void setSubtitled(boolean subtitled)

Parameters:

subtitled - the subtitled to set

setSubtitleLanguage

public void setSubtitleLanguage(String subtitleLanguage)

Parameters:

subtitleLanguage - the subtitleLanguage to set

setTimeApproximate

public void setTimeApproximate(boolean timeApproximate)

Parameters:

timeApproximate - the timeApproximate to set

getStation

public Station getStation()

Returns:

the station

setStation

public void setStation(Station station)
                throws IllegalArgumentException

Change the Station this Airing is associated with (i.e. change the station this airing will broadcast on)

Parameters:

station - The new Station to associate with this Airing

Throws:

IllegalArgumentException - Thrown if the argument is null

getProgram

public Program getProgram()

Returns:

the program

setProgram

public void setProgram(Program program)
                throws IllegalArgumentException

Change the Program this Airing is associated with; this airing's id is updated to that of the Program argument

Parameters:

program - The new Program to associate with this Airing

Throws:

IllegalArgumentException - Thrown if the Program argument is null

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object