com.gcapmedia.dab.epg
Class ProgrammeEvent

java.lang.Object
  com.gcapmedia.dab.epg.ProgrammeEvent

public class ProgrammeEvent
extends java.lang.Object

A programme event can be used to break a programme into sections or to highlight particular sections of the programme.

Constructor Summary

ProgrammeEvent()
Create a new programme

Method Summary

void	addGenre(Genre genre) Adds a genre to the programme
void	addLink(Link link) Add a link from this programme to additional information or content
void	addLocation(Location location) Add a location to this programme
void	addMembership(Membership membership) Add a membership to this programme
void	clearGenres() Clears all genre from the programme
void	clearLinks() Clear all links from this programme
void	clearLocations() Clear all locations from this programme
void	clearMemberships() Clears all memberships from this programme
BroadcastFlag	getBroadcastFlag()
CAType	getCA()
java.util.List<Genre>	getGenres()
Crid	getId()
Keywords	getKeywords()
java.lang.String	getLanguage()
java.util.Collection<Link>	getLinks()
java.util.Collection<Location>	getLocations()
MediaGroup	getMedia()
java.util.Collection<Membership>	getMemberships()
NameGroup	getNames()
Recommendation	getRecommendation()
int	getShortId()
void	removeGenre(Genre genre) Removes a genre from the programme
void	removeLink(Link link) Remove a link from this programme
void	removeLocation(Location location) Remove a location from this programme
void	removeMembership(Membership membership) Removes a membership from this programme
BroadcastFlag	setBroadcastFlag(BroadcastFlag flag) Sets the broadcast flag.
void	setCA(CAType ca) Sets the Conditional Access (CA) type
void	setId(Crid id) Sets the programme Content Reference ID (CRID)
void	setKeywords(Keywords keywords) Set the keywords associated with this programme
void	setLocale(java.util.Locale locale) Sets the locale associated with this programme
void	setRecommendation(Recommendation recommendation) Sets the recommendation flag on this programme
void	setShortId(int shortId) Sets the programme Short ID
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

ProgrammeEvent

public ProgrammeEvent()

Create a new programme

Method Detail

setBroadcastFlag

public BroadcastFlag setBroadcastFlag(BroadcastFlag flag)

Sets the broadcast flag.

Parameters:

By - default, this flag is on-air and should not be set. Can be set to off-air to generate dummy programmes for when a service is not being broadcast.

getBroadcastFlag

public BroadcastFlag getBroadcastFlag()

Returns:

Returns the broadcast flag: Can be set to off-air to generate dummy programmes for when a service is not being broadcast. By default, this flag is on-air and should not be set.

setCA

public void setCA(CAType ca)

Sets the Conditional Access (CA) type

Parameters:

ca - CA type to set

getCA

public CAType getCA()

Returns:

Returns the Conditional Access (CA) type

addGenre

public void addGenre(Genre genre)

Adds a genre to the programme

Parameters:

genre - Genre to add

clearGenres

public void clearGenres()

Clears all genre from the programme

removeGenre

public void removeGenre(Genre genre)

Removes a genre from the programme

Parameters:

genre - Genre to remove

getGenres

public java.util.List<Genre> getGenres()

Returns:

Returns the programme genres

setId

public void setId(Crid id)

Sets the programme Content Reference ID (CRID)

Parameters:

id - CRID to set

getId

public Crid getId()

Returns:

Returns the programme Content Reference ID (CRID)

setKeywords

public void setKeywords(Keywords keywords)

Set the keywords associated with this programme

Parameters:

keywords - Keywords to use

getKeywords

public Keywords getKeywords()

Returns:

Returns the keywords associated with this programme

setLocale

public void setLocale(java.util.Locale locale)

Sets the locale associated with this programme

Parameters:

locale - Locale associated with this programme

getLanguage

public java.lang.String getLanguage()

Returns:

Returns the language code (ISO-639) associated with this programme

getLinks

public java.util.Collection<Link> getLinks()

Returns:

Returns links to additional information or content

addLink

public void addLink(Link link)

Add a link from this programme to additional information or content

Parameters:

link - Link to add

removeLink

public void removeLink(Link link)

Remove a link from this programme

Parameters:

link - Link to remove

clearLinks

public void clearLinks()

Clear all links from this programme

getLocations

public java.util.Collection<Location> getLocations()

Returns:

Returns all locations from this programme

addLocation

public void addLocation(Location location)

Add a location to this programme

Parameters:

location - Location to add

removeLocation

public void removeLocation(Location location)

Remove a location from this programme

Parameters:

location - Location to remove

clearLocations

public void clearLocations()

Clear all locations from this programme

getMedia

public MediaGroup getMedia()

Returns:

Returns media descriptions related to this programme

getMemberships

public java.util.Collection<Membership> getMemberships()

Returns:

Returns memberships this programme has

addMembership

public void addMembership(Membership membership)

Add a membership to this programme

Parameters:

membership - Membership to add

removeMembership

public void removeMembership(Membership membership)

Removes a membership from this programme

Parameters:

membership - Membership to remove

clearMemberships

public void clearMemberships()

Clears all memberships from this programme

getNames

public NameGroup getNames()

Returns:

Returns the name group for this programme

setRecommendation

public void setRecommendation(Recommendation recommendation)

Sets the recommendation flag on this programme

Parameters:

recommendation - Recommendation flag to set

getRecommendation

public Recommendation getRecommendation()

Returns:

Returns whether this programme is recommended

setShortId

public void setShortId(int shortId)

Sets the programme Short ID

Parameters:

shortId - Programme Short ID

getShortId

public int getShortId()

Returns:

Returns the programme short ID

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

See Also:

Object.toString()