bbc.rd.tvanytime.programInformation
Class ProgramInformation

java.lang.Object
  bbc.rd.tvanytime.programInformation.ProgramInformation

All Implemented Interfaces:

java.lang.Cloneable

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

ProgramInformation: Represents the descriptive information of a program.

Version:

1.0

Author:

Tristan Ferne, BBC Research & Development, April 2002

Constructor Summary

ProgramInformation()
Constructor for ProgramInformation.

ProgramInformation(ContentReference programID)
Constructor for ProgramInformation.

ProgramInformation(ContentReference programID, BasicDescription basicDescription)
Constructor for ProgramInformation.

Method Summary

void	addMemberOf(MemberOf memberOf) Add MemberOf object to this program.
java.lang.Object	clone() Clones itself.
AVAttributes	getAVAttributes() Get audio-visual attributes object for this program.
BasicDescription	getBasicDescription() Get description of this program.
MemberOf	getMemberOf(int index) Get MemberOf object for this program.
int	getNumMemberOfs() Get number of MemberOf objects contained in this program.
ContentReference	getProgramID() Returns CRID for this program.
void	removeAll() Remove all MemberOf and Keyword objects.
void	removeMemberOf(int index) removeMemberOf - Removes a MemberOf object from the Description object
void	setAVAttributes(AVAttributes avAttributes) Set audio-visual attributes object for this program.
void	setBasicDescription(BasicDescription basicDescription) Set description of this program.
void	setProgramID(ContentReference programID) Set CRID for this program.
java.lang.String	toString() Returns string representation of this program.
java.lang.String	toString(int indent) Returns string representation of this program.
java.lang.String	toXML() Returns string representation of this program.
java.lang.String	toXML(int indent) Returns string representation of this program.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

ProgramInformation

public ProgramInformation()

Constructor for ProgramInformation.

ProgramInformation

public ProgramInformation(ContentReference programID,
                          BasicDescription basicDescription)

Constructor for ProgramInformation.

Parameters:

programID - CRID for this program.

basicDescription - Description of this program.

ProgramInformation

public ProgramInformation(ContentReference programID)

Constructor for ProgramInformation.

Parameters:

programID - CRID for this program.

Method Detail

getProgramID

public ContentReference getProgramID()

Returns CRID for this program.

Returns:

CRID for this program.

setProgramID

public void setProgramID(ContentReference programID)

Set CRID for this program.

Parameters:

programID - CRID for this program.

getBasicDescription

public BasicDescription getBasicDescription()

Get description of this program.

Returns:

Description of this program.

setBasicDescription

public void setBasicDescription(BasicDescription basicDescription)

Set description of this program.

Parameters:

basicDescription - Description of this program.

getAVAttributes

public AVAttributes getAVAttributes()

Get audio-visual attributes object for this program.

Returns:

Audio-visual attributes of this program.

setAVAttributes

public void setAVAttributes(AVAttributes avAttributes)

Set audio-visual attributes object for this program.

Parameters:

avAttributes - Audio-visual attributes of this program.

getNumMemberOfs

public int getNumMemberOfs()

Get number of MemberOf objects contained in this program.

Returns:

Number of MemberOf objects contained in this program.

getMemberOf

public MemberOf getMemberOf(int index)

Get MemberOf object for this program.

Parameters:

index - The index of the MemberOf object to access.

Returns:

Specified MemberOf object.

addMemberOf

public void addMemberOf(MemberOf memberOf)

Add MemberOf object to this program.

Parameters:

memberOf - The MemberOf object to add to this program.

removeMemberOf

public void removeMemberOf(int index)

removeMemberOf - Removes a MemberOf object from the Description object

Parameters:

index - The index of the object to remove.

removeAll

public void removeAll()

Remove all MemberOf and Keyword objects.

toXML

public java.lang.String toXML()

Returns string representation of this program.

Returns:

XML representation of this program.

toXML

public java.lang.String toXML(int indent)

Returns string representation of this program.

Parameters:

indent - Number of tabs with which to indent the string.

Returns:

XML representation of the program.

toString

public java.lang.String toString()

Returns string representation of this program.

Overrides:

toString in class java.lang.Object

Returns:

string representation of this program.

toString

public java.lang.String toString(int indent)

Returns string representation of this program.

Parameters:

indent - Number of tabs with which to indent the string.

Returns:

string representation of the program.

clone

public java.lang.Object clone()

Clones itself.

Overrides:

clone in class java.lang.Object

Returns:

A copy of itself.