rtpi
Class RtpiSourceInfo

java.lang.Object
  |
  +--rtpi.RtpiSourceInfo

public final class RtpiSourceInfo
extends java.lang.Object

This class holds the information about local and remote participants. It is thread safe.


Constructor Summary
RtpiSourceInfo(int pid, java.lang.String cName)
           
 
Method Summary
 void clearEmail()
          This clears the item.
 void clearLoc()
          This clears the item.
 void clearName()
          This clears the item.
 void clearNote()
          This clears the item.
 void clearPhone()
          This clears the item.
 void clearTool()
          This clears the item.
 java.lang.String getCName()
          This returns the CNAME item of the participant.
 java.lang.String getEmail()
          This returns the EMAIL item of the participant.
 java.lang.String getLoc()
          This returns the LOC item of the participant.
 java.lang.String getName()
          This returns the NAME item of the participant.
 java.lang.String getNote()
          This returns the NOTE item of the participant.
 int getParticipantID()
          This returns the ID of the participant.
 java.lang.String getPhone()
          This returns the PHONE item of the participant.
 java.lang.String getTool()
          This returns the TOOL item of the participant.
 void setCName(java.lang.String cName)
          This sets the CNAME item of the participant.
 void setEmail(java.lang.String email)
          This sets the EMAIL item of the participant.
 void setLoc(java.lang.String loc)
          This sets the LOC item of the participant.
 void setName(java.lang.String name)
          This sets the NAME item of the participant.
 void setNote(java.lang.String note)
          This sets the NOTE item of the participant.
 void setPhone(java.lang.String phone)
          This sets the PHONE item of the participant.
 void setTool(java.lang.String tool)
          This sets the TOOL item of the participant.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

RtpiSourceInfo

public RtpiSourceInfo(int pid,
                      java.lang.String cName)
               throws IllegalValueException
Method Detail

setCName

public void setCName(java.lang.String cName)
              throws IllegalValueException
This sets the CNAME item of the participant.
Parameters:
cName - the CNAME (e.g. mauve@pandorra.cs.um.de)

getCName

public java.lang.String getCName()
                          throws IllegalValueException
This returns the CNAME item of the participant.
Returns:
The CNAME.

setName

public void setName(java.lang.String name)
             throws IllegalValueException
This sets the NAME item of the participant.
Parameters:
name - the NAME (e.g. Martin Mauve (University of Mannheim))

clearName

public void clearName()
This clears the item.

getName

public java.lang.String getName()
                         throws IllegalValueException
This returns the NAME item of the participant.
Returns:
The NAME.

setEmail

public void setEmail(java.lang.String email)
              throws IllegalValueException
This sets the EMAIL item of the participant.
Parameters:
email - The EMAIL.

clearEmail

public void clearEmail()
This clears the item.

getEmail

public java.lang.String getEmail()
                          throws IllegalValueException
This returns the EMAIL item of the participant.
Returns:
The EMAIL.

setPhone

public void setPhone(java.lang.String phone)
              throws IllegalValueException
This sets the PHONE item of the participant.
Parameters:
phone - The PHONE.

clearPhone

public void clearPhone()
This clears the item.

getPhone

public java.lang.String getPhone()
                          throws IllegalValueException
This returns the PHONE item of the participant.
Returns:
The PHONE.

setLoc

public void setLoc(java.lang.String loc)
            throws IllegalValueException
This sets the LOC item of the participant.
Parameters:
loc - The location.

clearLoc

public void clearLoc()
This clears the item.

getLoc

public java.lang.String getLoc()
                        throws IllegalValueException
This returns the LOC item of the participant.
Returns:
The location.

setTool

public void setTool(java.lang.String tool)
             throws IllegalValueException
This sets the TOOL item of the participant.
Parameters:
tool - The TOOL.

clearTool

public void clearTool()
This clears the item.

getTool

public java.lang.String getTool()
                         throws IllegalValueException
This returns the TOOL item of the participant.
Returns:
The TOOL.

setNote

public void setNote(java.lang.String note)
             throws IllegalValueException
This sets the NOTE item of the participant. Please notice that the NOTE item is transmitted with high priority. It should be cleared as soon as the NOTE is no longer needed. The value of the note item for a participant should be presented on the user interface.
Parameters:
note - The NOTE.

clearNote

public void clearNote()
This clears the item.

getNote

public java.lang.String getNote()
                         throws IllegalValueException
This returns the NOTE item of the participant.
Returns:
The NOTE.

getParticipantID

public int getParticipantID()
This returns the ID of the participant.
Returns:
The participant ID.