|
JSR-043: JTAPI-1.4 | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Base interface for all Events in the media pacakge. Indicates the completion of some media package operation. Characterized by an EventID representing the event identity.
This interface defines a set of accessors common to all media events. The accessors may return null if the value is not relevant for the particular event being queried.
Note: Classes that implement this interface shall follow the standard Java Listener design pattern by extending java.util.EventObject.
Fields inherited from interface javax.telephony.media.MediaConstants |
e_OK, q_Duration, q_Standard, q_Stop |
Method Summary | |
Symbol |
getError()
Return a Symbol describing the error. |
Symbol |
getEventID()
Get the Symbol that identifies this event. |
java.lang.Exception |
getException()
Return the Exception associated with this event. |
java.util.Dictionary |
getPayload()
Implementation-specific additional event information. |
Symbol |
getQualifier()
Return the qualifier value for this event. |
int |
getSubError()
Return the int suberror field for this event. |
Symbol |
getWarning()
Return a Symbol describing the warning. |
Method Detail |
public Symbol getEventID()
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. Further detail about how/why the operation
completed is available using getQualifier()
.
The Symbols returned from by this method have names of the form:
ev_Operation
.
ResourceEvent
public Symbol getQualifier()
Standard return values are one of:
q_Standard, q_Duration, q_RTC, q_Stop
which indicate the reason or mode of completion.
Other qualifiers may be documented in the resource event classes.
If the associated method or transaction did not succeed,
this methods returns null;
use getError()
to determine the cause of failure.
public Symbol getWarning()
public Symbol getError()
public int getSubError()
public java.util.Dictionary getPayload()
public java.lang.Exception getException()
If the operation terminated with any kind of exception, return that Exception. If the operation completed with statusOK, then return null.
The Exception returned will be one of the Exceptions declared in the synchronous interface for the request method, or any undeclared RuntimeException.
Note: the stacktrace in the Exception may not be useful. The stacktrace may be of the original creator of the Exception (which could be in some other implementation Thread) or may be from the last call to throwIfSomeException().
|
JSR-043: JTAPI-1.4 | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |