|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
@RpcInterface(value="ucp.v30.requests.service") @UciService(value="ucp.v30.requests.service") public interface UcpServiceRequests
| Field Summary | |
|---|---|
static String |
SERVICE_NAME
The UCI service name used for this interface |
| Method Summary | |
|---|---|
List<String> |
getProvidedEvents()
This request can be used to query the server for the service names of all supported events. |
List<String> |
getProvidedRequests()
This request can be used to query the server for the service names of all supported requests. |
boolean |
providesEvents(String serviceName)
This request can be used by the client to detect if events it wants to use are actually provided by the server. |
boolean |
providesRequests(String serviceName)
This request can be used by the client to detect if another requests it wants to use are actually provided by the server. |
boolean |
subscribeEvents(String serviceName)
The client logged in at the server may subscribe to events provided by the server. |
void |
unsubscribeEvents(String serviceName)
The client logged in may also unsubscribe any events it has previously subscribed to. |
| Field Detail |
|---|
static final String SERVICE_NAME
| Method Detail |
|---|
boolean subscribeEvents(String serviceName)
throws UciException
serviceName - a String denoting the service name of the events the client wants to receive
true if the registration was successful or false if the
requested events are not provided by the server
UciException - if the request is placed while the UCI client is not connected (
UcpNotConnectedException).
void unsubscribeEvents(String serviceName)
throws UciException
serviceName - a String denoting the service name of the events to unsubscribe from
UciException - if the request is placed while the UCI client is not connected (
UcpNotConnectedException).
boolean providesEvents(String serviceName)
throws UciException
serviceName - a String denoting the service name of the events to query for
true if the given events are supported by the server or
false if not supported.
UciException - if the request is placed while the UCI client is not connected (
UcpNotConnectedException).
List<String> getProvidedEvents()
throws UciException
UciException - if the request is placed while the UCI client is not connected (
UcpNotConnectedException).
boolean providesRequests(String serviceName)
throws UciException
serviceName - a String denoting the service name of the requests to query for
true if the given requests are supported by the server or
false if not supported.
UciException - if the request is placed while the UCI client is not connected (
UcpNotConnectedException).
List<String> getProvidedRequests()
throws UciException
UciException - if the request is placed while the UCI client is not connected (
UcpNotConnectedException).
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||