org.universAAL.middleware.service

Class CallStatus

java.lang.Object

org.universAAL.middleware.rdf.Resource

org.universAAL.middleware.rdf.FinalizedResource

org.universAAL.middleware.service.CallStatus

public final class CallStatus
extends FinalizedResource

The CallStatus simply describes the possible status of the services. The possible status for services can take the values below: 0.SUCCEEDED 1.NO_MATCHING_SERVICE_FOUND 2.RESPONSE_TIMED_OUT 3.SERVICE_SPECIFIC_FAILURE

Author:

mtazari - Saied Tazari

Field Summary

Fields

Modifier and Type	Field and Description
static CallStatus	denied
static int	DENIED
static String	MY_URI
static int	NO_MATCHING_SERVICE_FOUND
static CallStatus	noMatchingServiceFound
static int	RESPONSE_TIMED_OUT
static CallStatus	responseTimedOut
static int	SERVICE_SPECIFIC_FAILURE
static CallStatus	serviceSpecificFailure
static CallStatus	succeeded
static int	SUCCEEDED

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

Method Summary

Modifier and Type	Method and Description
int	getPropSerializationType(String propURI) Answers if the given property has to be considered when serializing this individual in a minimized way, and if not ignore-able, whether its value should be presented in its full form or can be reduced.
String	name() Returns the name of the CallStatus as specified by the order
int	ord() Returns the number of the order (integer).
boolean	setProperty(String propURI, Object o) Adds a statement with this resource as the subject, the given propURI as the predicate and the given value as the object.
static CallStatus	valueOf(String name) Returns the value of the call status.

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, getResource, getResourceComment, getResourceLabel, getResourceLabel, getStaticFieldValue, hashCode, hasProperty, isAnon, isBlockingAddingTypes, isClosedCollection, isQualifiedName, isWellFormed, 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

See Also:

Constant Field Values

SUCCEEDED

public static final int SUCCEEDED

See Also:

Constant Field Values

NO_MATCHING_SERVICE_FOUND

public static final int NO_MATCHING_SERVICE_FOUND

See Also:

Constant Field Values

RESPONSE_TIMED_OUT

public static final int RESPONSE_TIMED_OUT

See Also:

Constant Field Values

SERVICE_SPECIFIC_FAILURE

public static final int SERVICE_SPECIFIC_FAILURE

See Also:

Constant Field Values

DENIED

public static final int DENIED

See Also:

Constant Field Values

succeeded

public static final CallStatus succeeded

noMatchingServiceFound

public static final CallStatus noMatchingServiceFound

responseTimedOut

public static final CallStatus responseTimedOut

serviceSpecificFailure

public static final CallStatus serviceSpecificFailure

denied

public static final CallStatus denied

Method Detail

valueOf

public static CallStatus valueOf(String name)

Returns the value of the call status. It returns the predefined names for the call status of services according to VOCABULARY_NAMESPACE.

Parameters:

name - gets the status value

getPropSerializationType

public int getPropSerializationType(String propURI)

Description copied from class: Resource

Answers if the given property has to be considered when serializing this individual in a minimized way, and if not ignore-able, whether its value should be presented in its full form or can be reduced. The return value must be one of Resource.PROP_SERIALIZATION_OPTIONAL, Resource.PROP_SERIALIZATION_REDUCED, or Resource.PROP_SERIALIZATION_FULL. It can be assumed that the given property is one of those returned by Resource.getPropertyURIs().
Decision criterion should be if the value of this property is absolutely necessary when this resource is being sent to a remote node. If the subclass rates it as unlikely that the receiver side would need this info, the answer should be PROP_SERIALIZATION_OPTIONAL in favor of lower communication traffic and higher performance even at risk of a possible additional query on the receiver side for fetching this info. With the same rationale, if a property should be included in the process of serialization, it is preferable to include it in a reduced form; in this case the return value should be PROP_SERIALIZATION_REDUCED, otherwise PROP_SERIALIZATION_FULL can be returned. Subclasses should normally overwrite this method as this default implementation returns always PROP_SERIALIZATION_FULL.

Overrides:

getPropSerializationType in class Resource

Parameters:

propURI - the URI of the property

See Also:

Resource.getPropSerializationType(String propURI)

name

public String name()

Returns the name of the CallStatus as specified by the order

ord

public int ord()

Returns the number of the order (integer).

setProperty

public boolean setProperty(String propURI,
                           Object o)

Description copied from class: Resource

Adds a statement with this resource as the subject, the given propURI as the predicate and the given value as the object. Subclasses must override this in order to decide if the statement to be added fits the general class constraints. If not, the call of this method should be ignored. For each property only one single call may be made to this method, unless subsequent calls to this method for setting the value of the same property are treated as an update for an update-able property. Multi-valued properties must be set using an instance of List. The differentiation, if a such list should be treated as an rdf:List, can be made with the help of Resource.isClosedCollection(String). The default implementation here accepts all property-value pairs blindly except for rdf:type which is handled if the value is a type URI, a Resource or a java.util.List of them.

Note: The setting of the property rdf:type is being handled by this class via the final methods Resource.addType(String, boolean), Resource.getType(), and Resource.getTypes(). Although these methods give the view of handling type URIs as strings, but in reality the types are stored as direct instances of this class. So, the subclasses should ignore calls for setting rdf:type; if not, then the subclass must pay attention that the value should be a List of direct instances of this class so that (1) the Resource.toString() method returns just the URI and (2) the serializers get no problems with the value. Also, settings via subclasses may be overwritten by this class if a subsequent call to Resource.addType(String, boolean) is made.

Overrides:

setProperty in class Resource

Returns:

true if the property changed as a result of the call

See Also:

Resource.setProperty(String propURI, Object value)