org.stanwood.media.model
Interface IFilm

All Superinterfaces:
IVideo, IVideoActors, IVideoCertification, IVideoGenre, IVideoRating
All Known Implementing Classes:
Film, XMLFilm

public interface IFilm
extends IVideo, IVideoActors, IVideoGenre, IVideoRating, IVideoCertification

Interface for all the film classes


Method Summary
 void addChapter(Chapter chapter)
          Used to add a chapter to the film
 java.util.List<Chapter> getChapters()
          Used to get the chapters of the film
 java.lang.String getCountry()
          This will return the country the film was made in, or null if it's not known.
 java.util.Date getDate()
          Used to get the release date of the film
 java.lang.String getDescription()
          Used to get the films long description
 java.net.URL getFilmUrl()
          Used to get the URL used to get a summary of the film
 java.lang.String getId()
          Used to get the id of the film used by the source that it was read from.
 java.net.URL getImageURL()
          Used to get the URL of the film poster.
 java.lang.String getSourceId()
          Used to get the source id of the source that was used to retrieve the film information.
 java.lang.String getStudio()
          Used to get the films studio
 void setChapters(java.util.List<Chapter> chapters)
          Used to set the chapter information for the film
 void setCountry(java.lang.String country)
          Used to set the country the film was made in.
 void setDate(java.util.Date date)
          Used to set the release date of the film
 void setDescription(java.lang.String description)
          Used to set the films long description
 void setFilmUrl(java.net.URL url)
          Used to set the URL used to get a summary of the film
 void setId(java.lang.String id)
          Used to set the id of the film used by the source that it was read from.
 void setImageURL(java.net.URL imageURL)
          Used to set the URL of the film poster
 void setSourceId(java.lang.String sourceId)
          Used to set the source id of the source that was used to retrieve the film information.
 void setStudio(java.lang.String studio)
          Used to set the films studio
 
Methods inherited from interface org.stanwood.media.model.IVideo
getDirectors, getFiles, getSummary, getTitle, getWriters, setDirectors, setFiles, setSummary, setTitle, setWriters
 
Methods inherited from interface org.stanwood.media.model.IVideoActors
getActors, setActors
 
Methods inherited from interface org.stanwood.media.model.IVideoGenre
addGenre, getGenres, getPreferredGenre, setGenres, setPreferredGenre
 
Methods inherited from interface org.stanwood.media.model.IVideoRating
getRating, setRating
 
Methods inherited from interface org.stanwood.media.model.IVideoCertification
getCertifications, setCertifications
 

Method Detail

getId

java.lang.String getId()
Used to get the id of the film used by the source that it was read from.

Returns:
The id of the film

setId

void setId(java.lang.String id)
Used to set the id of the film used by the source that it was read from.

Parameters:
id - The id of the film

getSourceId

java.lang.String getSourceId()
Used to get the source id of the source that was used to retrieve the film information.

Returns:
The source id

setSourceId

void setSourceId(java.lang.String sourceId)
Used to set the source id of the source that was used to retrieve the film information.

Parameters:
sourceId - The source id

setFilmUrl

void setFilmUrl(java.net.URL url)
Used to set the URL used to get a summary of the film

Parameters:
url - The summary URL

getFilmUrl

java.net.URL getFilmUrl()
Used to get the URL used to get a summary of the film

Returns:
The summary URL

getDate

java.util.Date getDate()
Used to get the release date of the film

Returns:
The release date of the film

setDate

void setDate(java.util.Date date)
Used to set the release date of the film

Parameters:
date - The release date of the film

setImageURL

void setImageURL(java.net.URL imageURL)
Used to set the URL of the film poster

Parameters:
imageURL - The URL of the film poster.

getImageURL

java.net.URL getImageURL()
Used to get the URL of the film poster. This will return null if a poster could not be found.

Returns:
The film poster, or null if it does not have one

addChapter

void addChapter(Chapter chapter)
Used to add a chapter to the film

Parameters:
chapter - The chapter to add

getChapters

java.util.List<Chapter> getChapters()
Used to get the chapters of the film

Returns:
The chapters of the film

setChapters

void setChapters(java.util.List<Chapter> chapters)
Used to set the chapter information for the film

Parameters:
chapters - The chapters of the film

setDescription

void setDescription(java.lang.String description)
Used to set the films long description

Parameters:
description - The films long description

getDescription

java.lang.String getDescription()
Used to get the films long description

Returns:
the films long description

getCountry

java.lang.String getCountry()
This will return the country the film was made in, or null if it's not known.

Returns:
the country the film was made in.

setCountry

void setCountry(java.lang.String country)
Used to set the country the film was made in.

Parameters:
country - the country to set

getStudio

java.lang.String getStudio()
Used to get the films studio

Returns:
the films studio

setStudio

void setStudio(java.lang.String studio)
Used to set the films studio

Parameters:
studio - the films studio