net.sf.xtvdclient.xtvd.datatypes
Class Schedule

java.lang.Object
  extended by net.sf.xtvdclient.xtvd.datatypes.AbstractDataType
      extended by net.sf.xtvdclient.xtvd.datatypes.Schedule
All Implemented Interfaces:
java.lang.Comparable

public class Schedule
extends AbstractDataType

A bean that represents a schedule record.


Field Summary
 
Fields inherited from class net.sf.xtvdclient.xtvd.datatypes.AbstractDataType
END_OF_LINE
 
Constructor Summary
Schedule()
          Default constructor.
Schedule(java.lang.String program, int station, DateTime time, Duration duration)
          Create a new instance of the class and initialise the required instance variables with the specified values.
Schedule(java.lang.String program, int station, DateTime time, Duration duration, boolean repeat, TvRatings tvRating, boolean stereo, boolean subtitled, boolean hdtv, boolean closeCaptioned)
          Create a new instance of the class and initialise all the instance variables that represent attributes of the schedule element with the specified vlaues.
Schedule(java.lang.String program, int station, DateTime time, Duration duration, boolean repeat, TvRatings tvRating, boolean stereo, boolean subtitled, boolean hdtv, boolean closeCaptioned, Part part)
          Create a new instance of the class and initialise all the instance variables with the specified vlaues.
 
Method Summary
 boolean getCloseCaptioned()
          Returns closeCaptioned.
 Duration getDuration()
          Returns duration.
 boolean getHdtv()
          Returns hdtv.
 Part getPart()
          Returns part.
 java.lang.String getProgram()
          Returns program.
 boolean getRepeat()
          Returns repeat.
 int getStation()
          Returns station.
 boolean getStereo()
          Returns stereo.
 boolean getSubtitled()
          Returns subtitled.
 DateTime getTime()
          Returns time.
 TvRatings getTvRating()
          Returns tvRating.
 void reset()
          Reset all the instance variables to empty values.
 void setCloseCaptioned(boolean closeCaptioned)
          Set closeCaptioned.
 void setDuration(Duration duration)
          Set duration.
 void setHdtv(boolean hdtv)
          Set hdtv.
 void setPart(Part part)
          Set part.
 void setProgram(java.lang.String program)
          Set program.
 void setRepeat(boolean repeat)
          Set repeat.
 void setStation(int station)
          Set station.
 void setStereo(boolean stereo)
          Set stereo.
 void setSubtitled(boolean subtitled)
          Set subtitled.
 void setTime(DateTime time)
          Set time.
 void setTvRating(TvRatings tvRating)
          Set tvRating.
 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

Schedule

public Schedule()
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 schedule records.


Schedule

public Schedule(java.lang.String program,
                int station,
                DateTime time,
                Duration duration)
Create a new instance of the class and initialise the required instance variables with the specified values.

Parameters:
program - The program value to set.
station - The station value to set.
time - The time value to set.
duration - The duration value to set.

Schedule

public Schedule(java.lang.String program,
                int station,
                DateTime time,
                Duration duration,
                boolean repeat,
                TvRatings tvRating,
                boolean stereo,
                boolean subtitled,
                boolean hdtv,
                boolean closeCaptioned)
Create a new instance of the class and initialise all the instance variables that represent attributes of the schedule element with the specified vlaues.

Parameters:
program - The program value to set.
station - The station value to set.
time - The time value to set.
duration - The duration value to set.
repeat - The repeat value to set.
tvRating - The tvRating value to set.
stereo - The stereo value to set.
subtitled - The subtitled value to set.
hdtv - The hdtv value to set.
closeCaptioned - The closeCaptioned value to set.

Schedule

public Schedule(java.lang.String program,
                int station,
                DateTime time,
                Duration duration,
                boolean repeat,
                TvRatings tvRating,
                boolean stereo,
                boolean subtitled,
                boolean hdtv,
                boolean closeCaptioned,
                Part part)
Create a new instance of the class and initialise all the instance variables with the specified vlaues.

Parameters:
program - The program value to set.
station - The station value to set.
time - The time value to set.
duration - The duration value to set.
repeat - The repeat value to set.
tvRating - The tvRating value to set.
stereo - The stereo value to set.
subtitled - The subtitled value to set.
hdtv - The hdtv value to set.
closeCaptioned - The closeCaptioned value to set.
part - The part value to set.
Method Detail

reset

public void reset()
Reset all the instance variables to empty values. The time variable is not reset.


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 schedule record.

getProgram

public final java.lang.String getProgram()
Returns program.

Returns:
String - The value/reference of/to program.

setProgram

public final void setProgram(java.lang.String program)
Set program.

Parameters:
program - The value to set.

getStation

public final int getStation()
Returns station.

Returns:
The value/reference of/to station.

setStation

public final void setStation(int station)
Set station.

Parameters:
station - The value to set.

getTime

public final DateTime getTime()
Returns time.

Returns:
The value/reference of/to time.

setTime

public final void setTime(DateTime time)
Set time.

Parameters:
time - The value to set.

getDuration

public final Duration getDuration()
Returns duration.

Returns:
The value/reference of/to duration.

setDuration

public final void setDuration(Duration duration)
Set duration.

Parameters:
duration - The value to set.

getRepeat

public final boolean getRepeat()
Returns repeat.

Returns:
The value/reference of/to repeat.

setRepeat

public final void setRepeat(boolean repeat)
Set repeat.

Parameters:
repeat - The value to set.

getTvRating

public final TvRatings getTvRating()
Returns tvRating.

Returns:
The value/reference of/to tvRating.

setTvRating

public final void setTvRating(TvRatings tvRating)
Set tvRating.

Parameters:
tvRating - The value to set.

getStereo

public final boolean getStereo()
Returns stereo.

Returns:
The value/reference of/to stereo.

setStereo

public final void setStereo(boolean stereo)
Set stereo.

Parameters:
stereo - The value to set.

getSubtitled

public final boolean getSubtitled()
Returns subtitled.

Returns:
The value/reference of/to subtitled.

setSubtitled

public final void setSubtitled(boolean subtitled)
Set subtitled.

Parameters:
subtitled - The value to set.

getHdtv

public final boolean getHdtv()
Returns hdtv.

Returns:
The value/reference of/to hdtv.

setHdtv

public final void setHdtv(boolean hdtv)
Set hdtv.

Parameters:
hdtv - The value to set.

getCloseCaptioned

public final boolean getCloseCaptioned()
Returns closeCaptioned.

Returns:
The value/reference of/to closeCaptioned.

setCloseCaptioned

public final void setCloseCaptioned(boolean closeCaptioned)
Set closeCaptioned.

Parameters:
closeCaptioned - The value to set.

getPart

public final Part getPart()
Returns part.

Returns:
The value/reference of/to part.

setPart

public final void setPart(Part part)
Set part.

Parameters:
part - The value to set.