bbc.rd.tvanytime.programLocation
Class ScheduleEvent

java.lang.Object
  extended by bbc.rd.tvanytime.programLocation.ScheduleEvent
All Implemented Interfaces:
java.lang.Cloneable

public class ScheduleEvent
extends java.lang.Object
implements java.lang.Cloneable

ScheduleEvent: Represents a TVA ScheduleEvent object.

Version:
1.0 Modified T.Ferne, August 2004
Author:
Tim Sargeant, BBC Research & Development, April 2002

Constructor Summary
ScheduleEvent()
          Constructor for objects of class ScheduleEvent.
ScheduleEvent(ContentReference crid)
          Constructor for objects of class ScheduleEvent with required fields.
 
Method Summary
 java.lang.Object clone()
          Clones itself.
 ContentReference getCRID()
          Get the CRID.
 InstanceMetadataId getInstanceMetadataId()
          Get the InstanceMetadataId.
 ProgramURL getProgramURL()
          Get the broadcast URL.
 Duration getPublishedDuration()
          Get the published duration.
 java.util.Date getPublishedEndTime()
          Get the published end time.
 java.util.Date getPublishedStartTime()
          Get the published start time.
 java.lang.Boolean isFirstShowing()
          Is this the first showing? (returns Boolean.TRUE, Boolean.FALSE, or null if not set).
 java.lang.Boolean isFree()
          Is this free? (returns Boolean.TRUE, Boolean.FALSE, or null if not set).
 java.lang.Boolean isLastShowing()
          Is this the last showing? (returns Boolean.TRUE, Boolean.FALSE, or null if not set).
 java.lang.Boolean isLive()
          Is this Live? (returns Boolean.TRUE, Boolean.FALSE, or null if not set).
 java.lang.Boolean isPPV()
          Is this PPV? (returns Boolean.TRUE, Boolean.FALSE, or null if not set).
 java.lang.Boolean isRepeat()
          Is this a Repeat? (returns Boolean.TRUE, Boolean.FALSE, or null if not set).
 void setCRID(ContentReference crid)
          Set the CRID of this ScheduleEvent.
 void setFirstShowing(java.lang.Boolean firstShowing)
          Sets whether this ScheduleEvent is the first showing.
 void setFree(java.lang.Boolean free)
          Sets whether this ScheduleEvent is a free showing.
 void setInstanceMetadataId(InstanceMetadataId imi)
          Set the InstanceMetadataId of this ScheduleEvent.
 void setLastShowing(java.lang.Boolean lastShowing)
          Sets whether this ScheduleEvent is the last showing.
 void setLive(java.lang.Boolean live)
          Sets whether this ScheduleEvent is a live showing.
 void setPPV(java.lang.Boolean ppv)
          Sets whether this ScheduleEvent is a pay-per-view showing.
 void setProgramURL(ProgramURL programURL)
          Set the broadcast URL of this ScheduleEvent.
 void setPublishedDuration(Duration publishedDuration)
          Set the published duration of this ScheduleEvent.
 void setPublishedEndTime(java.util.Date publishedEndTime)
          Set the published end time of this ScheduleEvent.
 void setPublishedStartTime(java.util.Date publishedStartTime)
          Set the published start time of this ScheduleEvent.
 void setRepeat(java.lang.Boolean repeat)
          Sets whether this ScheduleEvent is a repeat showing.
 java.lang.String toString()
          Returns string representation of this object.
 java.lang.String toString(int indent)
          Returns string representation of this table.
 java.lang.String toXML()
          Returns XML representation of this object.
 java.lang.String toXML(int indent)
          Returns XML representation of this table.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

ScheduleEvent

public ScheduleEvent()
Constructor for objects of class ScheduleEvent.


ScheduleEvent

public ScheduleEvent(ContentReference crid)
Constructor for objects of class ScheduleEvent with required fields.

Parameters:
crid - a ContentReference object identifying this ScheduleEvent
Method Detail

getCRID

public ContentReference getCRID()
Get the CRID.

Returns:
crid, or null if not set

getProgramURL

public ProgramURL getProgramURL()
Get the broadcast URL.

Returns:
programURL, or null if not set

getInstanceMetadataId

public InstanceMetadataId getInstanceMetadataId()
Get the InstanceMetadataId.

Returns:
InstanceMetadataId, or null if not set

getPublishedStartTime

public java.util.Date getPublishedStartTime()
Get the published start time.

Returns:
publishedStartTime, or null if not set

getPublishedEndTime

public java.util.Date getPublishedEndTime()
Get the published end time.

Returns:
publishedEndTime, or null if not set

getPublishedDuration

public Duration getPublishedDuration()
Get the published duration.

Returns:
publishedDuration, or null if not set

isLive

public java.lang.Boolean isLive()
Is this Live? (returns Boolean.TRUE, Boolean.FALSE, or null if not set).

Returns:
live, or null if not set

isRepeat

public java.lang.Boolean isRepeat()
Is this a Repeat? (returns Boolean.TRUE, Boolean.FALSE, or null if not set).

Returns:
repeat, or null if not set

isFirstShowing

public java.lang.Boolean isFirstShowing()
Is this the first showing? (returns Boolean.TRUE, Boolean.FALSE, or null if not set).

Returns:
firstShowing, or null if not set

isLastShowing

public java.lang.Boolean isLastShowing()
Is this the last showing? (returns Boolean.TRUE, Boolean.FALSE, or null if not set).

Returns:
lastShowing, or null if not set

isFree

public java.lang.Boolean isFree()
Is this free? (returns Boolean.TRUE, Boolean.FALSE, or null if not set).

Returns:
free, or null if not set

isPPV

public java.lang.Boolean isPPV()
Is this PPV? (returns Boolean.TRUE, Boolean.FALSE, or null if not set).

Returns:
ppv, or null if not set

setCRID

public void setCRID(ContentReference crid)
Set the CRID of this ScheduleEvent.

Parameters:
crid - the ContentReference object that identifys this ScheduleEvent

setProgramURL

public void setProgramURL(ProgramURL programURL)
Set the broadcast URL of this ScheduleEvent.

Parameters:
programURL - a programURL object

setInstanceMetadataId

public void setInstanceMetadataId(InstanceMetadataId imi)
Set the InstanceMetadataId of this ScheduleEvent.

Parameters:
imi - An InstanceMetadataId object

setPublishedStartTime

public void setPublishedStartTime(java.util.Date publishedStartTime)
Set the published start time of this ScheduleEvent.

Parameters:
publishedStartTime - a Date object

setPublishedEndTime

public void setPublishedEndTime(java.util.Date publishedEndTime)
Set the published end time of this ScheduleEvent.

Parameters:
publishedEndTime - a Date object

setPublishedDuration

public void setPublishedDuration(Duration publishedDuration)
Set the published duration of this ScheduleEvent.

Parameters:
publishedDuration - the published duration, represented by bbc.rd.tvanytime.Duration

setLive

public void setLive(java.lang.Boolean live)
Sets whether this ScheduleEvent is a live showing.

Parameters:
live - is this program a live showing?

setRepeat

public void setRepeat(java.lang.Boolean repeat)
Sets whether this ScheduleEvent is a repeat showing.

Parameters:
repeat - is this program a repeat showing?

setFirstShowing

public void setFirstShowing(java.lang.Boolean firstShowing)
Sets whether this ScheduleEvent is the first showing.

Parameters:
firstShowing - is this program the first showing?

setLastShowing

public void setLastShowing(java.lang.Boolean lastShowing)
Sets whether this ScheduleEvent is the last showing.

Parameters:
lastShowing - is this program the last showing?

setFree

public void setFree(java.lang.Boolean free)
Sets whether this ScheduleEvent is a free showing.

Parameters:
free - is this program a free showing?

setPPV

public void setPPV(java.lang.Boolean ppv)
Sets whether this ScheduleEvent is a pay-per-view showing.

Parameters:
ppv - is this program a pay-per-view showing?

toXML

public java.lang.String toXML()
Returns XML representation of this object.

Returns:
XML representation of this object.

toXML

public java.lang.String toXML(int indent)
Returns XML representation of this table.

Parameters:
indent - number of tabs to put before the string.
Returns:
XML representation of this table.

toString

public java.lang.String toString()
Returns string representation of this object.

Overrides:
toString in class java.lang.Object
Returns:
string representation of this object.

toString

public java.lang.String toString(int indent)
Returns string representation of this table.

Parameters:
indent - number of tabs to put before the string.
Returns:
string representation of this table.

clone

public java.lang.Object clone()
Clones itself.

Overrides:
clone in class java.lang.Object
Returns:
A copy of itself.