JSR-043: JTAPI-1.4

javax.telephony.media.container
Interface ContainerEvent

All Superinterfaces:
CoderConstants, ContainerConstants, MediaConstants, MediaEvent, MediaServiceConstants
All Known Subinterfaces:
Async_ContainerEvent, Async_DataObjectEvent, DataObjectEvent

public interface ContainerEvent
extends MediaEvent, ContainerConstants

Defines methods for ContainerService events.

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.container.ContainerConstants
b_Append, b_Create, b_Exclusive, b_Truncate, e_OK, k_InputParameters, k_MediaType, k_MediaTypes, v_AccessCopy, v_AccessRead, v_AccessWrite, v_Begin, v_Bytes, v_Create, v_Current, v_End, v_Fail, v_MDO, v_MilliSeconds
 
Fields inherited from interface javax.telephony.media.CoderConstants
v_24kADPCM, v_32kADPCM, v_44kADPCM, v_48k8BitLinear, v_48kALawPCM, v_48kMuLawPCM, v_64k8BitLinear, v_64kALawPCM, v_64kMuLawPCM, v_88k8BitLinear, v_88kALawPCM, v_88kMuLawPCM, v_ADPCM_24k, v_ADPCM_32k, v_ADPCM_44k, v_ADSI, v_ALawPCM_48k, v_ALawPCM_64k, v_ALawPCM_88k, v_ASCII, v_Linear8Bit_48k, v_Linear8Bit_64k, v_Linear8Bit_88k, v_MuLawPCM_48k, v_MuLawPCM_64k, v_MuLawPCM_88k, v_TDD
 
Method Summary
 ContainerService getContainerService()
          Wrap getSource() and cast to ContainerService.
 DataObject getDataObject()
          from openDataObject.
 Symbol getError()
          Identify the reason or cause of an error or failure.
 Symbol getEventID()
          Get the Symbol that identifies this event.
 java.util.Dictionary getInfoDict()
          for getContainerInfo.
 java.lang.String[] getObjectList()
          for listObjects.
 java.util.Dictionary getParamDict()
          for getParameters.
 
Methods inherited from interface javax.telephony.media.MediaEvent
getException, getPayload, getQualifier, getSubError, getWarning
 

Method Detail

getContainerService

public ContainerService getContainerService()
Wrap getSource() and cast to ContainerService.
Returns:
the ContainerService that originated this event.

getEventID

public Symbol getEventID()
Get the Symbol that identifies this event.

For completion events, this identifies the operation that has completed. For synchronous code this is mostly redundant, but it may be useful for asynchronous Listeners. Details about how/why the operation completed is available using getError().

The Symbols returned from by this method will have names of the form: ev_Operation.

Specified by:
getEventID in interface MediaEvent
Returns:
the Symbol that identifies this event

getError

public Symbol getError()
Identify the reason or cause of an error or failure.

If this ContainerEvent is associated with an Exception, then getError() returns a Symbol that identifies the problem.
If this ContainerEvent is not associated with an Exception, then getError() returns the Symbol e_OK.

A list of error Symbols is defined in interface ErrSym.

Specified by:
getError in interface MediaEvent
Returns:
one of the error Symbols.

getInfoDict

public java.util.Dictionary getInfoDict()
for getContainerInfo.
Returns:
a Dictionary of container info

getParamDict

public java.util.Dictionary getParamDict()
for getParameters.
Returns:
a Dictionary of container parameters

getObjectList

public java.lang.String[] getObjectList()
for listObjects.
Returns:
a String[] of MDOs in the container

getDataObject

public DataObject getDataObject()
from openDataObject.
Returns:
the DataObject that was opened.

JSR-043: JTAPI-1.4

Send comments to: JSR-43@ectf.org