javax.telephony.media.provider
Class Base.ResourceEvent

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.ResourceEvent

All Implemented Interfaces:

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

Direct Known Subclasses:

Base_ASREvent, Base_PlayerEvent, Base_RecorderEvent, Base_SignalDetectorEvent, Base_SignalGeneratorEvent

Enclosing class:

Base

public abstract static class Base.ResourceEvent

extends Base.MediaServiceEvent

implements Async.ResourceEvent

base class for all Async_ResourceEvent classes. each class should define its own fields, accessors, constructors, dispatch, and done 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

Fields inherited from interface javax.telephony.media.ResourceConstants

e_Disconnected, FOREVER, q_Disconnected, q_RTC, rtcc_Disconnected, rtcc_TriggerRTC, v_Forever

Constructor Summary

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

Base.ResourceEvent(java.lang.Object source, Symbol eventID, java.lang.Exception exception, Symbol qual, Symbol error, int suberror, java.util.Dictionary payload)
Construct a ResourceEvent that is already done.

Method Summary

Symbol	getRTCTrigger() Get the RTC Trigger that caused this resource action.
void	throwIfMediaResourceException() used by BasicMediaService to generate Synchronous interface.

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

getMediaService

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

dispatch, 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.ResourceEvent

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

Base.ResourceEvent

public Base.ResourceEvent(java.lang.Object source,
                          Symbol eventID,
                          java.lang.Exception exception,
                          Symbol qual,
                          Symbol error,
                          int suberror,
                          java.util.Dictionary payload)

Construct a ResourceEvent that is already done. Invokes:
setFields(qual, error, suberror, payload);
done(exception);

Parameters:

source - the Object that created this EventObject.

eventID - a Symbol that identifies the event

exception - the Exception to throw if completion failed

qual - a Symbol that identifies the cause of completion

error - a Symbol that identifies the cause of failure

suberror - an int with more info about the error

payload - a Dictionary of additional information.

Method Detail

getRTCTrigger

public Symbol getRTCTrigger()

Get the RTC Trigger that caused this resource action. This is non-null only if getQualifier == ResourceEvent.q_RTC

The Symbol returned is one of the rtcc_[Name] Symbols; possibly a ResourceEvent.ev_[Name] event.

Specified by:

getRTCTrigger in interface ResourceEvent

Returns:

a Symbol identifying an RTC Trigger condition.

throwIfMediaResourceException

public void throwIfMediaResourceException()
                                   throws MediaResourceException

used by BasicMediaService to generate Synchronous interface.

Specified by:

throwIfMediaResourceException in interface Async.ResourceEvent

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

Throws:

MediaResourceException - if contained in this event