Device Description Repository Simple API 1c

// File: ddrsimpleapi.idl

#ifndef _DDRSIMPLEAPI_IDL_
#define _DDRSIMPLEAPI_IDL_

#pragma prefix "w3c.org"

module ddrsimpleapi
{
	//Forward declarations
	interface AspectName;
	interface PropertyName;
	interface SimplePropertyValue;

	//Array typedefs
	//N.B. the same could be done with anonymous types, but that behaviour is deprecated in IDL
	typedef sequence<AspectName> AspectNameArray;
	typedef sequence<PropertyName> PropertyNameArray;
	typedef sequence<SimplePropertyValue> SimplePropertyValueArray;
	typedef sequence<string> StringArray;
	
	//Represents a Map
	//TODO: Decide which one to choose
	//Alternative
	//interface Map {
	//	string getValue(in string key);
	//};
	struct Pair {
		string key;
		string value;
	};
	typedef sequence<Pair> Map;
	
	//
	//Represents a DDR Exception
	//
	//TODO: There is no exception inheritance in IDL, need to decide whether to use only one exception or several different ones
	//TODO: Methods or attributes?
	exception SimpleException {
		//TODO: how to express constructors?
		long getCode();
		string getMessage();
	};

	exception NameException {
		//TODO: how to express constructors?
		long getCode();
		string getMessage();
	};

	exception SystemException {
		//TODO: how to express constructors?
		long getCode();
		string getMessage();
	};

	exception ValueException {
		//TODO: how to express constructors?
		long getCode();
		string getMessage();
	};

	//Used for NameException
	const long PROPERTY_NOT_RECOGNIZED = 100;
	const long VOCABULARY_NOT_RECOGNIZED = 200;
	const long ASPECT_NOT_RECOGNIZED = 800;
	//Used for SystemException
	const long INITIALIZATION = 400;
	const long CANNOTPROCEED = 500;
	//Used for ValueException
	const long INCOMPATIBLE_TYPES = 600;
	const long NOT_KNOWN = 900;
	const long MULTIPLE_VALUES = 10000;

	
	interface AspectName {
		string getName();
	};

	//
	// Represents a property 
	//
	interface PropertyName {
		//
		// The name of the property
		// 
		string getName();

		//
		// The namespace of the property
		//
		string getNamespace();
	};
	
	//
	//Represents the value of a property
	//
	//TODO: Check the exceptions raised
	interface SimplePropertyValue {
		//
		//Returns the value as double in the default units of the property
		//
		//If the value cannot be represented as a double an exception will be
		//thrown
		//
		double getDouble()
			raises (ValueException);

		//
		//Returns the value as a long in the default units of the property
		//
		//An exception will be thrown if the value cannot be represented as a long
		//
		long getLong()
			raises (ValueException);

		//
		//Returns the value of the property as a string
		//
		//An exception will be thrown if the value does not exist
		//
		string getString()
			raises (ValueException);
		
		//
		//Returns the actual value as a boolean
		//
		//If the value cannot be represented as a boolean an exception will be thrown
		//
		boolean getBoolean()
			raises (ValueException);
		
		//
		//Returns the value as an integer in the default units of the property
		//
		//If the value cannot be represented as an integer an exception will be thrown
		long getInteger()
			raises (ValueException);
		
		//
		//Returns the value as an enumeration
		//
		//If the value cannot be represented as an enumeration an exception will be thrown
		//
		stringArray getEnumeration()
			raises (ValueException);
		
		//
		//Returns the value in the specified unit as a float
		//
		//If the value cannot be represented as a float an exception will be thrown
		//
		float getFloat()
			raises (ValueException);
		
		PropertyName getPropertyName();
		
		boolean exists();
	};
	
	interface SimplePropertyValues {
		SimplePropertyValueArray getAll();

		SimplePropertyValue getValue(in PropertyName prop)
			raises (NameException);
	};
	
	interface SimpleService {
		SimplePropertyValue getPropertyValue(in Map evidence, in PropertyName propertyName)
			raises (NameException, SystemException);

		SimplePropertyValues getPropertyValues(in Map evidence)
			raises (SystemException);

		SimplePropertyValues getPropertyValues(in Map evidence, in PropertyNameArray properties)
			raises (NameException, SystemException);

		SimplePropertyValue getPropertyValue(in Map evidence, in AspectName aspect, in PropertyName propertyName)
			raises (NameException, SystemException);
			
		SimplePropertyValues getPropertyValues(in Map evidence, in AspectName aspect) 
			raises (SystemException);
			
		SimplePropertyValues getPropertyValues(in Map evidence, in AspectName aspect, in PropertyNameArray properties) 
			raises (NameException,SystemException);
			
		PropertyName newPropertyName(in string vocabularyIRI, in string localPropertyName) 
			raises (NameException);
			
		//
		//Creates a property name that is within the default vocabulary
		//
		PropertyName newPropertyName(in string localPropertyName) 
			raises (NameException);
			
		AspectName newAspectName(in string aspectIRI) 
			raises (NameException);
			
		AspectNameArray listAspects() 
			raises (SystemException);

		PropertyNameArray listProperties(in string vocabularyIRI)
			raises (NameException, SystemException);

		StringArray listVocabularies()
			raises (SystemException);

		// Vocabulary cannot be 'null'
		void initialize(in string defaultVocabularyIRI, in Map props)
			raises (SystemException);
	};
	
	interface SimpleServiceFactory {
		SimpleService newSimpleService(in string clazz, in string defaultVocabulary, in Map configuration)
			raises (NameException, SystemException);

		SimpleService newSimpleService(in string defaultVocabulary, in Map configuration)
			raises (NameException, SystemException);
	};
};

#endif _DDRSIMPLEAPI_IDL_