javax.telephony.media.provider
Class Base.MediaGroupEvent

java.lang.Object
  |
  +--java.util.EventObject
        |
        +--javax.telephony.media.provider.EventObject
              |
              +--javax.telephony.media.provider.Base.Event
                    |
                    +--javax.telephony.media.provider.Base.MediaServiceEvent
                          |
                          +--javax.telephony.media.provider.Base.MediaGroupEvent

All Implemented Interfaces:

Async.Event, Async.MediaGroupEvent, Async.MediaServiceEvent, Dispatcher.DispatchableEvent, MediaConstants, MediaEvent, MediaGroupEvent, MediaServiceConstants, MediaServiceEvent, java.io.Serializable

Direct Known Subclasses:

Base_MediaConnectionEvent

Enclosing class:

Base

public static class Base.MediaGroupEvent

extends Base.MediaServiceEvent

implements Async.MediaGroupEvent

Base class of completion events for Async.MediaService methods. These events are dispatched to the MediaGroupListener.

Is this just for MediaGroup methods?

See Also:

Serialized Form

Inner classes inherited from class javax.telephony.media.provider.Base.Event

Base.Event.SyncInterruptedException

Fields inherited from interface javax.telephony.media.MediaServiceConstants

ev_BindAndConnect, ev_BindToCall, ev_BindToServiceName, ev_BindToTerminal, ev_BindToTerminalName, ev_Configure, ev_Connected, ev_DelegateToService, ev_Disconnected, ev_GetConfigSpec, ev_GetConfiguration, ev_GetParameters, ev_GetTerminal, ev_GetTerminalName, ev_GetUserValues, ev_GroupStop, ev_Release, ev_ReleaseDelegated, ev_ReleaseToDestroy, ev_ReleaseToService, ev_ReleaseToTag, ev_Retrieve, ev_Retrieved, ev_SetParameters, ev_SetUserDictionary, ev_SetUserValues, ev_TerminalIdle, ev_TriggerRTC

Fields inherited from interface javax.telephony.media.MediaConstants

e_OK, q_Duration, q_Standard, q_Stop

Constructor Summary

Base.MediaGroupEvent(java.lang.Object source, Symbol eventID)

Method Summary

void	dispatch(java.util.EventListener listener) Invoke the appropriate callback method on the appropriate Listener.
void	done(java.lang.Exception exception, java.lang.Object retVal)
ConfigSpec	getConfigSpec() Return a ConfigSpec from getConfigSpec().
java.util.Dictionary	getDictionary() Return a Dictionary from a MediaGroupEvent.
Terminal	getTerminal() Return a Terminal from getTerminal().
java.lang.String	getTerminalName() Return a terminal name String from getTerminalName().
void	throwIfConfigException() Detect and throw MediaConfigException and RuntimeException.

Methods inherited from class javax.telephony.media.provider.Base.MediaServiceEvent

getMediaService

Methods inherited from class javax.telephony.media.provider.Base.Event

done, getError, getEventID, getException, getPayload, getQualifier, getSubError, getWarning, isDone, setError, setFields, setFields, setPayload, setQualifier, setSubError, throwIfRuntimeException, toString, waitForEventDone, waitForEventDone, waitForListenersDone

Methods inherited from class java.util.EventObject

getSource

Methods inherited from class java.lang.Object

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

Methods inherited from interface javax.telephony.media.async.Async.Event

isDone, throwIfRuntimeException, waitForEventDone, waitForEventDone, waitForListenersDone

Methods inherited from interface javax.telephony.media.MediaEvent

getError, getEventID, getException, getPayload, getQualifier, getSubError, getWarning

Methods inherited from interface javax.telephony.media.MediaServiceEvent

getMediaService

Constructor Detail

Base.MediaGroupEvent

public Base.MediaGroupEvent(java.lang.Object source,
                            Symbol eventID)

Method Detail

dispatch

public void dispatch(java.util.EventListener listener)

Description copied from class: Base.Event

Invoke the appropriate callback method on the appropriate Listener. Each sub-class must define an EventListener and callback method by supplying this method.

Implements Dispatcher.DispatchableEvent

Typically, Async.SomeEvent dispatches to like this:

public void dispatch(EventListener listener) {
if (listener instanceof Async.SomeListener)
((Async.SomeListener)listener).onSomeDone(this);
}

Invoked by Base_MediaService

Overrides:

dispatch in class Base.Event

Following copied from class: javax.telephony.media.provider.Base.Event

Parameters:

listener - an EventListener, some kind of MediaListener.

done

public void done(java.lang.Exception exception,
                 java.lang.Object retVal)

getTerminal

public Terminal getTerminal()

Description copied from interface: MediaGroupEvent

Return a Terminal from getTerminal(). Valid when (getEventID.equals(ev_GetTerminal)).

Specified by:

getTerminal in interface MediaGroupEvent

Following copied from interface: javax.telephony.media.MediaGroupEvent

Returns:

a Terminal from getTerminal()

getTerminalName

public java.lang.String getTerminalName()

Description copied from interface: MediaGroupEvent

Return a terminal name String from getTerminalName(). Valid when (getEventID.equals(ev_GetTerminalName)).

Specified by:

getTerminalName in interface MediaGroupEvent

Following copied from interface: javax.telephony.media.MediaGroupEvent

Returns:

a terminal name String from getTerminalName()

getConfigSpec

public ConfigSpec getConfigSpec()

Description copied from interface: MediaGroupEvent

Return a ConfigSpec from getConfigSpec(). Valid when (getEventID().equals(ev_GetConfigSpec)).

Specified by:

getConfigSpec in interface MediaGroupEvent

Following copied from interface: javax.telephony.media.MediaGroupEvent

Returns:

a ConfigSpec from getConfigSpec()

getDictionary

public java.util.Dictionary getDictionary()

Description copied from interface: MediaGroupEvent

Return a Dictionary from a MediaGroupEvent. Valid when:

Method called:	getEventID() equals:
getUserValues()	ev_GetUserValues
getParameters()	ev_GetParameters
getAttributes()	ev_GetAttributes

Specified by:

getDictionary in interface MediaGroupEvent

Following copied from interface: javax.telephony.media.MediaGroupEvent

Returns:

a Dictionary from a MediaGroupEvent.

throwIfConfigException

public void throwIfConfigException()
                            throws MediaConfigException

Description copied from interface: Async.MediaGroupEvent

Detect and throw MediaConfigException and RuntimeException. Used for MediaGroupEvent from async_configure().

Calls throwIfRuntimeException internally.

Specified by:

throwIfConfigException in interface Async.MediaGroupEvent

Following copied from interface: javax.telephony.media.async.Async.MediaGroupEvent

Throws:

MediaConfigException -