org.universAAL.middleware.service.owl
Class InitialServiceDialog

java.lang.Object
  org.universAAL.middleware.rdf.Resource
      org.universAAL.middleware.rdf.FinalizedResource
          org.universAAL.middleware.owl.ManagedIndividual
              org.universAAL.middleware.service.owl.Service
                  org.universAAL.middleware.service.owl.UserInterfaceService
                      org.universAAL.middleware.service.owl.InitialServiceDialog

public final class InitialServiceDialog
extends UserInterfaceService

Author:

mtazari - Saied Tazari

Field Summary

static String

MY_URI

Fields inherited from class org.universAAL.middleware.service.owl.UserInterfaceService

OUTPUT_INSTANCE_INFO, PROP_CORRELATED_SERVICE_CLASS, PROP_DESCRIPTION, PROP_HAS_INFO_RETRIEVAL_PROCESS, PROP_HAS_VENDOR, SERVICE_REQUEST_URI_PREFIX_INFO, SERVICE_REQUEST_URI_PREFIX_START

Fields inherited from class org.universAAL.middleware.service.owl.Service

instanceLevelRestrictions, myProfile, numberOfValueRestrictions, OWLS_NAMESPACE_PREFIX, OWLS_SERVICE_NAMESPACE, PROP_INSTANCE_LEVEL_RESTRICTIONS, PROP_NUMBER_OF_VALUE_RESTRICTIONS, PROP_OWLS_PRESENTED_BY, PROP_OWLS_PRESENTS

Fields inherited from class org.universAAL.middleware.owl.ManagedIndividual

OWL_NAMESPACE, TYPE_OWL_INDIVIDUAL, TYPE_OWL_THING

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

ANON_URI_PREFIX, blockAddingTypes, isXMLLiteral, ns_delim_index, 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, PROP_uAAL_INVOLVED_HUMAN_USER, props, RDF_EMPTY_LIST, RDF_NAMESPACE, RDFS_NAMESPACE, TYPE_RDF_LIST, TYPE_RDFS_CLASS, uAAL_NAMESPACE_PREFIX, uAAL_SERVICE_NAMESPACE, uAAL_VOCABULARY_NAMESPACE, uri

Constructor Summary

InitialServiceDialog()
For exclusive use by serializers.

InitialServiceDialog(String uri)
Create a new initial dialog service.

Method Summary

static ServiceProfile	createInitialDialogProfile(String serviceClassURI, String vendor, String description, String startServiceURI) Creates and returns an appropriate ServiceProfile for an initial dialog.
protected Hashtable	getClassLevelRestrictions()
String	getClassURI() Get the class URI for this ManagedIndividual.
static String	getInitialDialogDescription(String serviceClassURI, String vendor, ServiceCaller theCaller)
static UserInterfaceService[]	getInitialDialogInfo(String serviceClassURI, ServiceCaller theCaller)
static ServiceRequest	getInitialDialogRequest(String serviceClassURI, String vendor, Resource requestingUser)
static boolean	startInitialDialog(String serviceClassURI, String vendor, Resource requestingUser, ServiceCaller theCaller) Start an initial dialog.

Methods inherited from class org.universAAL.middleware.service.owl.UserInterfaceService

createServiceProfile, createServiceProfile, getPropSerializationType, getUIServiceDescription, getUIServiceDescription, getUIServiceInfo, getUIServiceInfo, getUIServiceRequest, getUIServiceRequest

Methods inherited from class org.universAAL.middleware.service.owl.Service

addFilteringInput, addFilteringType, addInputWithAddEffect, addInputWithChangeEffect, addInputWithRemoveEffect, addInstanceLevelRestriction, addOutput, addRestriction, createInput, getInstanceLevelFixedValueOnProp, getInstanceLevelRestrictionOnProp, getNumberOfValueRestrictions, getProfile, getRestrictedPropsOnInstanceLevel, getRestrictionOnPropPath, setProperty

Methods inherited from class org.universAAL.middleware.owl.ManagedIndividual

checkCompatibility, checkMembership, copy, deepCopy, getClassRestrictionsOnProperty, getInstance, getNonAbstractSuperClasses, getNonabstractSuperClasses, getOntClassInfo, getTypeURI, isRegisteredClassURI, isWellFormed, setPropertyPathFromOffset, toManagedIndividual

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, equals, generateAnonURI, getDefaultLang, getFilename, getMultiLangProp, getOrConstructLabel, getResource, getResourceComment, getResourceLabel, getStaticFieldValue, hashCode, hasProperty, isAnon, isBlockingAddingTypes, isClosedCollection, isQualifiedName, literal, representsQualifiedURI, serializesAsXMLLiteral, setPropertyPath, setPropertyPath, 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

Constructor Detail

InitialServiceDialog

public InitialServiceDialog()

For exclusive use by serializers.

InitialServiceDialog

public InitialServiceDialog(String uri)

Create a new initial dialog service.

Parameters:

uri - URI of this initial dialog service.

Method Detail

getClassURI

public String getClassURI()

Description copied from class: ManagedIndividual

Get the class URI for this ManagedIndividual. All non-abstract subclasses MUST overwrite this method!

Overrides:

getClassURI in class ManagedIndividual

Returns:

The class URI.

See Also:

ManagedIndividual.getClassURI()

createInitialDialogProfile

public static ServiceProfile createInitialDialogProfile(String serviceClassURI,
                                                        String vendor,
                                                        String description,
                                                        String startServiceURI)

Creates and returns an appropriate ServiceProfile for an initial dialog.

See Also:

UserInterfaceService.createServiceProfile(UserInterfaceService, String, String, String, String)

getInitialDialogDescription

public static String getInitialDialogDescription(String serviceClassURI,
                                                 String vendor,
                                                 ServiceCaller theCaller)

See Also:

UserInterfaceService.getUIServiceDescription(UserInterfaceService, String, String, ServiceCaller)

getInitialDialogInfo

public static UserInterfaceService[] getInitialDialogInfo(String serviceClassURI,
                                                          ServiceCaller theCaller)

See Also:

UserInterfaceService.getUIServiceInfo(UserInterfaceService, String, ServiceCaller)

getInitialDialogRequest

public static ServiceRequest getInitialDialogRequest(String serviceClassURI,
                                                     String vendor,
                                                     Resource requestingUser)

See Also:

UserInterfaceService.getUIServiceRequest(UserInterfaceService, String, String, Resource)

startInitialDialog

public static boolean startInitialDialog(String serviceClassURI,
                                         String vendor,
                                         Resource requestingUser,
                                         ServiceCaller theCaller)

Start an initial dialog. This method will issue a service request on the service bus to start a registered initial dialog service.

Parameters:

serviceClassURI - the URI of the service class from an underlying ontology, e.g. the value of Lighting.MY_URI from the lighting example.

vendor - the URL of the partner home page that provides the UI e.g. "http://www.igd.fraunhofer.de"

requestingUser - the user that requested the UI service.

theCaller -

Returns:

true, if the call is successful, i.e. the initial dialog that was called returned CallStatus.succeeded

getClassLevelRestrictions

protected Hashtable getClassLevelRestrictions()

See Also:

org.universAAL.middleware.service.owl.Service#getClassLevelRestrictions()