bbc.rd.tvanytime.groupInformation
Class GroupInformation

java.lang.Object
  extended by bbc.rd.tvanytime.groupInformation.GroupInformation

public class GroupInformation
extends java.lang.Object

GroupInformation: Represents a TV-Anytime GroupInformation object

Version:
1.0
Author:
Chris Akanbi, BBC Research & Development, April 2002

Field Summary
static java.lang.String[] groupTypeStrings
          Strings for group types.
static int MAGAZINE
           
static int OTHER_CHOICE
           
static int OTHER_COLLECTION
           
static int PROGRAM_COMPILATION
           
static int PROGRAM_CONCEPT
           
static int SERIES
          Valid group types.
static int SHOW
           
 
Constructor Summary
GroupInformation()
          Constructor for objects of class GroupInformation
GroupInformation(ContentReference groupId, BasicDescription basicDescription, int groupType)
          Constructor for objects of class GroupInformation
 
Method Summary
 void addMemberOf(MemberOf memberOf)
          addMemberOf - adds a MemberOf object to the GroupInformation object
 java.lang.Object clone()
          Clones itself.
 BasicDescription getBasicDescription()
          getBasicDescription - gets the BasicDesciption object for this GroupInformation object
 ContentReference getGroupId()
          getGroupId - gets the groupId (a ContentReference object) for this GroupInformation object
 int getGroupType()
          getGroupType - gets the group type for this GroupInformation object
 MemberOf getMemberOf(int index)
          getMemberOf - gets the MemberOf object at the specified index
 int getNumMemberOfs()
          getNumMemberOfs - gets the number of MemberOf objects belonging to this GroupInformation object
 java.lang.Boolean isOrdered()
          isOrdered - gets the ordered variable(a Boolean object) for this GroupInformation object
 void removeAll()
          removeAll - removes all MemberOf objects
 void removeMemberOf(int index)
          removeMemberOf - Removes a MemberOf object from the GroupInformation object
 void setBasicDescription(BasicDescription basicDescription)
          setBasicDescription - sets the BasicDescription object for this GroupInformation object
 void setGroupId(ContentReference groupId)
          setGroupId - sets the groupId for this GroupInformation object
 void setGroupType(int groupType)
          setGroupType - sets the group type for this GroupInformation object
 void setOrdered(java.lang.Boolean ordered)
          setOrdered - sets the ordered variable to true, false or undefined for this GroupInformation object
 java.lang.String toString()
          toString - returns a String representation of this GroupInformation object
 java.lang.String toString(int indent)
          toString - returns a String representation of this GroupInformation object with the specified number of tab indentations
 java.lang.String toXML()
          Returns XML representation of this table.
 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
 

Field Detail

SERIES

public static final int SERIES
Valid group types.

See Also:
Constant Field Values

SHOW

public static final int SHOW
See Also:
Constant Field Values

PROGRAM_CONCEPT

public static final int PROGRAM_CONCEPT
See Also:
Constant Field Values

PROGRAM_COMPILATION

public static final int PROGRAM_COMPILATION
See Also:
Constant Field Values

OTHER_COLLECTION

public static final int OTHER_COLLECTION
See Also:
Constant Field Values

MAGAZINE

public static final int MAGAZINE
See Also:
Constant Field Values

OTHER_CHOICE

public static final int OTHER_CHOICE
See Also:
Constant Field Values

groupTypeStrings

public static final java.lang.String[] groupTypeStrings
Strings for group types.

Constructor Detail

GroupInformation

public GroupInformation()
Constructor for objects of class GroupInformation


GroupInformation

public GroupInformation(ContentReference groupId,
                        BasicDescription basicDescription,
                        int groupType)
                 throws TVAnytimeException
Constructor for objects of class GroupInformation

Parameters:
groupId - groupId for this object
basicDescription - the BasicDescription object for this GroupInformation object
groupType - the group type GroupInformation object
Throws:
TVAnytimeException
Method Detail

getBasicDescription

public BasicDescription getBasicDescription()
getBasicDescription - gets the BasicDesciption object for this GroupInformation object

Returns:
the BasicDesciption object

getGroupId

public ContentReference getGroupId()
getGroupId - gets the groupId (a ContentReference object) for this GroupInformation object

Returns:
the groupId

getGroupType

public int getGroupType()
getGroupType - gets the group type for this GroupInformation object

Returns:
the group type

isOrdered

public java.lang.Boolean isOrdered()
isOrdered - gets the ordered variable(a Boolean object) for this GroupInformation object

Returns:
the ordered variable

setBasicDescription

public void setBasicDescription(BasicDescription basicDescription)
setBasicDescription - sets the BasicDescription object for this GroupInformation object

Parameters:
basicDescription - the BasicDescription object

setGroupId

public void setGroupId(ContentReference groupId)
setGroupId - sets the groupId for this GroupInformation object

Parameters:
groupId - the groupId(a ContentReference object)

setGroupType

public void setGroupType(int groupType)
                  throws TVAnytimeException
setGroupType - sets the group type for this GroupInformation object

Parameters:
groupType - the group type
Throws:
TVAnytimeException

setOrdered

public void setOrdered(java.lang.Boolean ordered)
setOrdered - sets the ordered variable to true, false or undefined for this GroupInformation object

Parameters:
ordered - the ordered variable(a Boolean object)

getNumMemberOfs

public int getNumMemberOfs()
getNumMemberOfs - gets the number of MemberOf objects belonging to this GroupInformation object

Returns:
the number of MemberOf objects in this GroupInformation object

getMemberOf

public MemberOf getMemberOf(int index)
getMemberOf - gets the MemberOf object at the specified index

Parameters:
index - the index of the required MemberOf object
Returns:
the MemberOf object at the specified index

addMemberOf

public void addMemberOf(MemberOf memberOf)
addMemberOf - adds a MemberOf object to the GroupInformation object

Parameters:
memberOf - the MemberOf object

removeMemberOf

public void removeMemberOf(int index)
removeMemberOf - Removes a MemberOf object from the GroupInformation object

Parameters:
index - The index of the object to remove.

removeAll

public void removeAll()
removeAll - removes all MemberOf objects


toString

public java.lang.String toString()
toString - returns a String representation of this GroupInformation object

Overrides:
toString in class java.lang.Object
Returns:
the String representation of this GroupInformation object

toString

public java.lang.String toString(int indent)
toString - returns a String representation of this GroupInformation object with the specified number of tab indentations

Returns:
the String representation of the GroupInformation object

toXML

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

Returns:
XML representation of this table.

toXML

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

Parameters:
indent - Number of tabs with which to indent the string.
Returns:
XML representation of the table.

clone

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

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