|
JSR-043: JTAPI-1.4 | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
A ServiceEvent representing a Request from a NamedService.
ServiceRequestEvent events are delivered to a NamedServiceListener.
Fields inherited from interface javax.telephony.media.MediaConstants |
e_OK, q_Duration, q_Standard, q_Stop |
Fields inherited from interface javax.telephony.media.messaging.MessageConstants |
e_NotFound, e_NotSupported, ev_Close, ev_OpenNamedService, ev_RegisterService, ev_ServiceClosed, ev_ServiceOpened, ev_UnregisterService, k_Error, k_EventData, k_Payload, k_Qualifier, k_ServiceName, k_Status, k_SubError, v_Null |
Method Summary | |
void |
reply(java.util.Dictionary message)
Reply to sender. |
void |
reply(Symbol qualifier,
Symbol error,
int suberror,
boolean isException,
java.util.Dictionary payload)
Reply to sender. |
Methods inherited from interface javax.telephony.media.messaging.ServiceEvent |
getMessagingService, getNamedService, getServiceName, sendEvent |
Methods inherited from interface javax.telephony.media.MediaEvent |
getError, getEventID, getException, getPayload, getQualifier, getSubError, getWarning |
Method Detail |
public void reply(Symbol qualifier, Symbol error, int suberror, boolean isException, java.util.Dictionary payload) throws ServiceException
Supply Message_ components directly.
qualifier
- a qualifier Symbol (default q_Standard)error
- an Error Symbol (if no error, use Error_OK)suberror
- an int (use Symbol.hashCode() if necessary)isException
- boolean true only if error
indicates an Exceptionpayload
- the EventData to be sent.ServiceClosedException
- if the service is closed.public void reply(java.util.Dictionary message) throws ServiceException
The reply message is constructed using fields extracted from the message Dictionary:
Expected Type | ESymbol Key | Default Value |
Symbol | Message_Qualifier | Any_Standard |
Symbol/Integer | Message_Error | Any_Null/0 |
Symbol/Integer | Message_SubError | Any_Null/0 |
Boolean | Message_Status | Boolean.FALSE |
Dictionary | Message_EventData | message |
Note: if Message_Error is not set, or is Error_OK, or Integer(0) or Any_Null (the equivalent Symbol value for zero), then the error field is set to 0 (reported in S.410 as Error_OK) and status is set to statusOK (Message_Status is not consulted).
Note: Message_Status indicates whether the Error denotes an Exception. The status value sent in the message is computed as
((Error is e_OK|null) ? Succeed : (Status ? Fail : Warn))
Note: if Message_EventData is not specified, then the given message Dictionary (including the Message_ keys) is used as EventData, and reported in S.410 using getPayload().
message
- a Dictionary of event message components.ServiceClosedException
- if the service is closed.
|
JSR-043: JTAPI-1.4 | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |