org.universAAL.middleware.service

Class MultiServiceResponse

java.lang.Object

org.universAAL.middleware.rdf.Resource

org.universAAL.middleware.rdf.FinalizedResource

org.universAAL.middleware.rdf.ScopedResource

org.universAAL.middleware.service.ServiceResponse

org.universAAL.middleware.service.MultiServiceResponse

All Implemented Interfaces:

Response, UtilityReply

public final class MultiServiceResponse
extends ServiceResponse

The MultiServiceResponse represents a set of ServiceResponse s.

Author:

Carsten Stockloew

Field Summary

Fields

Modifier and Type	Field and Description
static String	MY_URI A resource URI that specifies the resource as a multi service response.

Fields inherited from class org.universAAL.middleware.service.ServiceResponse

PROP_SERVICE_CALL_STATUS, PROP_SERVICE_HAS_OUTPUT, PROP_SERVICE_SPECIFIC_ERROR, PROP_UNBOUND_OUTPUT_ALLOWED

Fields inherited from class org.universAAL.middleware.rdf.ScopedResource

ONLY_LOCAL_SCOPE, PROP_ORIG_SCOPE, PROP_SCOPES

Fields inherited from class org.universAAL.middleware.rdf.Resource

ANON_URI_PREFIX, blockAddingTypes, isXMLLiteral, NAMESPACE_PREFIX, ns_delim_index, PROP_INVOLVED_HUMAN_USER, PROP_RDF_FIRST, PROP_RDF_REST, PROP_RDF_TYPE, PROP_RDFS_COMMENT, PROP_RDFS_LABEL, PROP_SERIALIZATION_FULL, PROP_SERIALIZATION_OPTIONAL, PROP_SERIALIZATION_REDUCED, PROP_SERIALIZATION_UNDEFINED, props, RDF_EMPTY_LIST, RDF_NAMESPACE, RDFS_NAMESPACE, SERVICE_NAMESPACE, TYPE_RDF_LIST, TYPE_RDFS_CLASS, uri, VOCABULARY_NAMESPACE

Constructor Summary

Constructors

Constructor and Description
MultiServiceResponse()
MultiServiceResponse(String instanceURI)

Method Summary

Modifier and Type	Method and Description
void	addOutput(ProcessOutput output) Adds output payload to this object.
void	addResponse(ServiceResponse response) Add a new response to the list of responses.
CallStatus	getCallStatus() Retrieves the call status.
List<Object>	getOutput(String paramURI) Returns all value objects returned for a required output with the given paramURI.
List<ProcessOutput>	getOutputs() Retrieves all of the service outputs as a raw List without any rearranging.
Map<String,List<Object>>	getOutputsMap() Get all outputs.
List<ServiceResponse>	getResponses() Get a list of all responses.
boolean	hasCallStatus(CallStatus status) Determines if one of the responses has the given call status.
boolean	hasNoSuccessCallStatus() Determines if one of the responses has a status that is not succeeded.
boolean	setProperty(String propURI, Object value) This method inherits the superclass behavior, but performs some additional checks for correctness of the property values, specific for the ServiceResponse.

Methods inherited from class org.universAAL.middleware.service.ServiceResponse

addOutput, allowUnboundOutput, disallowUnboundOutput, getOutput, getProvider, isUnboundOutputAllowed, isWellFormed

Methods inherited from class org.universAAL.middleware.rdf.ScopedResource

addScope, clearScopes, getOriginScope, getScopes, isScoped, isSerializableTo, setOriginScope, setScope

Methods inherited from class org.universAAL.middleware.rdf.FinalizedResource

addType, getLocalName, getNamespace, getProperty, getPropertyURIs, getType, getTypes, getURI, hasQualifiedName, isAnon, numberOfProperties

Methods inherited from class org.universAAL.middleware.rdf.Resource

addMultiLangProp, asList, asList, asRDFList, changeProperty, copy, deepCopy, equals, generateAnonURI, getDefaultLang, getFilename, getMultiLangProp, getOrConstructLabel, getOrConstructLabel, getPropSerializationType, getResource, getResourceComment, getResourceLabel, getResourceLabel, getStaticFieldValue, hashCode, hasProperty, isAnon, isBlockingAddingTypes, isClosedCollection, isQualifiedName, literal, representsQualifiedURI, serializesAsXMLLiteral, setPropertyPath, setPropertyPath, setPropertyPathFromOffset, setResourceComment, setResourceLabel, toString, toStringRecursive, toStringRecursive, unliteral

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

MY_URI

public static final String MY_URI

A resource URI that specifies the resource as a multi service response.

See Also:

Constant Field Values

Constructor Detail

MultiServiceResponse

public MultiServiceResponse()

MultiServiceResponse

public MultiServiceResponse(String instanceURI)

Method Detail

addOutput

public void addOutput(ProcessOutput output)

Description copied from class: ServiceResponse

Adds output payload to this object. Keeps any output payload that was previously added.

Overrides:

addOutput in class ServiceResponse

Parameters:

output - the ouput that needs to be added.

getCallStatus

public CallStatus getCallStatus()

Retrieves the call status. The status is CallStatus.succeeded if at least one of the responses has status CallStatus.succeeded.

Overrides:

getCallStatus in class ServiceResponse

Returns:

the current call status. If the aggregated call status is not set and the individual status are all not succeeded then a random status from one of the responses is returned.

hasCallStatus

public boolean hasCallStatus(CallStatus status)

Determines if one of the responses has the given call status.

Parameters:

status - the status to search for.

Returns:

true, if one of the responses has the given call status.

hasNoSuccessCallStatus

public boolean hasNoSuccessCallStatus()

Determines if one of the responses has a status that is not succeeded.

Returns:

true, of one of the responses has a status that is not succeeded.

getOutput

public List<Object> getOutput(String paramURI)

Description copied from class: ServiceResponse

Returns all value objects returned for a required output with the given paramURI. Since the original request might have been responded by several different service components, the responses are merged and returned into one list. A return value of null indicates that there are no outputs in the response. If an empty list is returned by this method, it indicates that there are no output related to the given paramURI. Otherwise, the return value is always a list even if there is only one value object in that list.

Overrides:

getOutput in class ServiceResponse

Parameters:

paramURI - the URI of the required output.

Returns:

the output with the specified URI.

getOutputsMap

public Map<String,List<Object>> getOutputsMap()

Description copied from class: ServiceResponse

Get all outputs. This method is similar to ServiceResponse.getOutput(String) but instead of providing the output of one parameter, it provides the outputs of all parameters. The URI of the parameter is the key of the returned map.

Overrides:

getOutputsMap in class ServiceResponse

Returns:

the non-null map of all outputs of the service.

getOutputs

public List<ProcessOutput> getOutputs()

Description copied from class: ServiceResponse

Retrieves all of the service outputs as a raw List without any rearranging.

Overrides:

getOutputs in class ServiceResponse

Returns:

the outputs that the invoked services produced. May be null. If this object is a MultiServiceResponse then the list can contain more than one ProcessOutput with the same URI; those outputs then come from different responses.

setProperty

public boolean setProperty(String propURI,
                           Object value)

Description copied from class: ServiceResponse

This method inherits the superclass behavior, but performs some additional checks for correctness of the property values, specific for the ServiceResponse.

Overrides:

setProperty in class ServiceResponse

Returns:

true if the property changed as a result of the call

See Also:

Resource.setProperty(java.lang.String, java.lang.Object)

addResponse

public void addResponse(ServiceResponse response)

Add a new response to the list of responses.

Parameters:

response - The response to add.

getResponses

public List<ServiceResponse> getResponses()

Get a list of all responses.

Returns:

the non-null list of all responses.