com.genesyslab.ail
Interface Media

All Superinterfaces:
IdObject, Possible

public interface Media
extends Possible

This class represents a Media that is on a Place.


Nested Class Summary
static class Media.Action
          Constants that describe actions on Media.
static class Media.Reason
          Constants that describe possible reasons for PlaceEventMediaStatusChanged.
static class Media.Status
          Constants that describe possible statuses for the Media.
 
Nested classes/interfaces inherited from interface com.genesyslab.ail.IdObject
IdObject.ObjectType
 
Method Summary
 java.lang.String getName()
          Returns the name of this Media.
 Place getPlace()
          Returns the Place to which this Media belongs.
 Media.Status getStatus()
          Returns the status of this Media.
 MediaType getType()
          Returns the type of this Media.
 void login(java.lang.String reason, java.lang.String reason_description)
          Logs this media in.
 void logout(java.lang.String reason, java.lang.String reason_description)
          Logs this media out.
 void notReady(java.lang.String reason, java.lang.String reason_description)
          Sets this media to 'ready'.
 void ready(java.lang.String reason, java.lang.String reason_description)
          Sets this media to 'not ready'.
 
Methods inherited from interface com.genesyslab.ail.Possible
arePossible, isPossible
 
Methods inherited from interface com.genesyslab.ail.IdObject
getId, getObjectType
 

Method Detail

getName

java.lang.String getName()
Returns the name of this Media.


getStatus

Media.Status getStatus()
Returns the status of this Media.


getType

MediaType getType()
Returns the type of this Media.


getPlace

Place getPlace()
Returns the Place to which this Media belongs.


ready

void ready(java.lang.String reason,
           java.lang.String reason_description)
           throws RequestFailedException
Sets this media to 'not ready'.

Parameters:
reason - The reason for going 'not ready'.
reason_description - The description of this reason.
Throws:
IsServiceException - if there is a problem with the Interaction Server.
RequestFailedException

notReady

void notReady(java.lang.String reason,
              java.lang.String reason_description)
              throws RequestFailedException
Sets this media to 'ready'.

Parameters:
reason - The reason for going 'ready'.
reason_description - The description of this reason.
Throws:
IsServiceException - if there is a problem with the Interaction Server.
RequestFailedException

login

void login(java.lang.String reason,
           java.lang.String reason_description)
           throws RequestFailedException
Logs this media in.

Parameters:
reason - The reason for logging in.
reason_description - The description of this reason.
Throws:
IsServiceException - if there is a problem with the Interaction Server.
RequestFailedException

logout

void logout(java.lang.String reason,
            java.lang.String reason_description)
            throws RequestFailedException
Logs this media out.

Parameters:
reason - The reason for logging out.
reason_description - The description of this reason.
Throws:
IsServiceException - if there is a problem with the Interaction Server.
RequestFailedException