bbc.rd.tvanytime
Class MemberOf

java.lang.Object
  extended by bbc.rd.tvanytime.ContentReference
      extended by bbc.rd.tvanytime.MemberOf
All Implemented Interfaces:
java.io.Serializable, java.lang.Cloneable

public class MemberOf
extends ContentReference
implements java.lang.Cloneable

MemberOf: Represents a CRID that is used to identify a group.

Version:
1.0
Author:
Tristan Ferne, BBC Research & Development, April 2002
See Also:
Serialized Form

Constructor Summary
MemberOf()
          Constructor for objects of class MemberOf.
MemberOf(java.lang.String crid)
          Constructor for objects of class MemberOf.
 
Method Summary
 java.lang.Object clone()
          Clones itself.
 java.lang.Integer getIndex()
          Returns the index for this CRID within a group
 void setIndex(java.lang.Integer index)
          Sets the index for this CRID within a group
 java.lang.String toString(int indent)
          Returns a string representation of this object.
 java.lang.String toXML(int indent)
          Returns an XML representation of this object.
 
Methods inherited from class bbc.rd.tvanytime.ContentReference
equals, getAuthority, getCRID, getData, hashCode, setCRID, toString, toXML
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

MemberOf

public MemberOf()
Constructor for objects of class MemberOf.


MemberOf

public MemberOf(java.lang.String crid)
         throws TVAnytimeException
Constructor for objects of class MemberOf.

Parameters:
crid - String representation of the CRID (e.g. "crid://bbc.co.uk/21837").
Throws:
TVAnytimeException - Thrown if passed invalid CRID.
Method Detail

getIndex

public java.lang.Integer getIndex()
Returns the index for this CRID within a group

Returns:
The index of this object within its group.

setIndex

public void setIndex(java.lang.Integer index)
Sets the index for this CRID within a group

Parameters:
index - The index of this object within its group.

toXML

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

Overrides:
toXML in class ContentReference
Parameters:
indent - Number of tabs with which to indent the string.
Returns:
XML representation of the MemberOf object.

toString

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

Overrides:
toString in class ContentReference
Parameters:
indent - Number of tabs with which to indent the string.
Returns:
string representation of the MemberOf object.

clone

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

Overrides:
clone in class ContentReference
Returns:
A copy of itself.