javax.telephony.media
Interface DelegationEvent

All Superinterfaces:

DelegationConstants, MediaConstants, MediaEvent, MediaServiceConstants, MediaServiceEvent

All Known Subinterfaces:

Async.DelegationEvent

public interface DelegationEvent

extends MediaServiceEvent, DelegationConstants

Event type for Delegation methods.

EventID corresponds to the method that created the event:

• ev_DelegateToService
• ev_Retrieve
• ev_releaseDelegated

Since:

JTAPI-1.4

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

ev_Delegated, q_Released, q_Removed, q_Retrieved, q_Returned, tag_CatchAll, tag_CatchNone, tag_DestroyRequest, tag_NeverReturn, tag_NormalReturn, tag_RemoveSession, tag_SessionDeath, v_Released

Method Summary

Symbol	getRetrieveCause() Return the cause Symbol of the retrieve() that caused delegateToService() to complete.
java.lang.String	getReturnTag() The returnTag of the releaseToTag() that caused delegateToService() to complete.
boolean	reconfigurationFailed() Returns true if delegateToService() could not reconfigure the MediaGroup when it was returned.

Methods inherited from interface javax.telephony.media.MediaServiceEvent

getMediaService

Methods inherited from interface javax.telephony.media.MediaEvent

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

Method Detail

reconfigurationFailed

public boolean reconfigurationFailed()

Returns true if delegateToService() could not reconfigure the MediaGroup when it was returned.

Note: the MediaGroup is returned when the new/current owner calls some form of release() or when this MediaService invokes retrieve().

Returns:

true if reconfiguration failed when ownership was returned

getRetrieveCause

public Symbol getRetrieveCause()

Return the cause Symbol of the retrieve() that caused delegateToService() to complete.

If this MediaService is unbound because the MediaGroup was retrieved by some older owner using retrieve(Symbol cause), then getRetrieveCause() returns the cause Symbol and getQualifier() returns q_Retrieved.

If the MediaService is unbound because the MediaGroup was released to some older owner using releaseToTag, then getRetrieveCause() returns the v_Released getQualifier() returns q_Released, and getReturnTags() returns the tag String used in releaseToTag(). [that is, a tag which was not caught by this MediaService]

Valid when: event.getEventID().equals(ev_DelegateToService) &&
event.getQualifier.equals(q_Retrieved)
or
event.getQualifier.equals(q_Released)

Note: for the non-trans onRetrieved(ev_Retrieved), the retrieve cause is available from MediaServiceEvent.getQualifier().

Returns:

the Symbol used when the MediaGroup was retrieved from this MediaService.

getReturnTag

public java.lang.String getReturnTag()

The returnTag of the releaseToTag() that caused delegateToService() to complete.

Valid when: event.getEventID().equals(ev_DelegateToService) &&
event.getQualifier().equals(q_Released)
or
event.getQualifier().equals(q_Returned)

Returns:

the returnTag String used in releaseToTag().