org.apache.uima.ducc.transport.event.sm

Interface IServiceReply

public interface IServiceReply

This interface defines the reply structure returned by the various invocations of the DuccServiceApi methods.

Method Summary

Modifier and Type	Method and Description
String	getEndpoint() This returns the service endpoint that was operated upon.
long	getId() Return the uniqud numeric ID assigned by the service manager for this service.
String	getMessage() If there was an informational or error message associated with the action, this method is used to return it.
boolean	getReturnCode() This method indicates whether the associated services verb was successful.
List<IServiceDescription>	getServiceDescriptions() This returns null for non-query events.

Method Detail

getReturnCode

boolean getReturnCode()

This method indicates whether the associated services verb was successful.

Returns:

true if the action was successful; false otherwise.

getMessage

String getMessage()

If there was an informational or error message associated with the action, this method is used to return it.

Returns:

Return the message as a String. If the action was successful as indicated by getReturnCode() this message may be null.

getEndpoint

String getEndpoint()

This returns the service endpoint that was operated upon. API uses may use this to verify the correct endpoint for their action. For some actions, if getReturnCode() is null this method may return null.

Returns:

A string, containing the service endpoint, or NULL.

getId

long getId()

Return the uniqud numeric ID assigned by the service manager for this service. If the action is "register" and the service manager is unable to register the service, the return code will be returned false, a reason will be returned in getMessage(), and the id will be returned as -1.

Returns:

A number, unique to this service.

getServiceDescriptions

List<IServiceDescription> getServiceDescriptions()

This returns null for non-query events. For query events, this returns a list of the services known to the service manager, as filtered by the query parameters.

Returns:

A list of services known to the service manager for query events, null otherwise.