Tcl OData Service Provider class

The provider class creates an object instance for an OData service provider. The created instance is then configured to define the service and the code that handles

When a queried, the web server should invoke the dispatch method of the instance and return the appropriate result(s) as indicated by the results of the dispatch method.

CONSTRUCTOR

The constructor of the odata::Provider class takes a single argument which is the name of the OData service.

DESTRUCTOR

The odata::Service class' destructor will delete all remaining odata::EntitySet and odata::Entity instances created by this service.

EXPORTED METHODS

provider add itemType itemName ?args...??

Add the item named itemName of the type itemType to the provider, where itemType is:

action: Add an unbound action to the service. This type will take one additional optional argument, parameterDict, which is a parameter dictionary that defines the action.
entitySet: Add an entity set to the service.This takes one additional optional argument, a dictionary describing the type.
function: Add an unbound function to the service. This type will take one additional optional argument, parameterDict, which is a parameter dictionary that defines the function.
type: Add an type to the service. This takes one additional optional argument, a dictionary describing the type.

provider associate itemType itemName handlerCommand

This associates a command, handlerCommand, to handle request/invokcations of the item. , where itemType is:

action: See Unbound Action/Function Command Interface Specificationfor details.
entitySet: See Entity Handler Command Interface Specification for details.
function: See Unbound Action/Function Command Interface Specificationfor details.
type: Add an type to the service. This takes one additional optional argument, a dictionary describing the type.

provider delete itemType itemName

Remove from the service definition the item specified by itemName and of the type specified by itemType, where itemType is one of:

action
entitySet
function
type

provider dispatch url

This subcommand is called by the web server to have a cause the service to process a request.

provider export

This command returns the "parsed" definition of the service. It can be saved (e.g. to a file) and later used by the load subcommand.

provider import metaData

Parse a Common Schema Definition Language (CSDL) that describes the service to define the service. When using this approch, you must associate handlers to the Entity Sets, Unbound Actions and Unbound Functions.

provider info subCommand ?arg ...?

This method is used to query information about the service and its compontents. Valid subCommand are:

actions

Returns a list of unbound actions advertised by the service.

action unboundActionName

Returns a dictionary (see parameter dictionary) describing the parameters and return value of the action with the name unboundActionName. If no such action exists, an error will be raised.

entitySets

Returns a list of entiy sets advertised by the service.

entitySet entitySetName

Returns a dictionary describing entitySetName. The dictionary is structured as follows:

Handler: The name of the registered handler command.
Type: The type of items (aka entities) that compose the entity set.
Singleton: A boolean indicating if this entity set represents a singleton.

functions

Returns a list of unbound functions advertised by the service.

function unboundFunctionName

Returns a dictionary (see parameter dictionary) describing the parameters and return value of the function with the name unbounFunctionName. If no such fuction exists, an error will be raised.

properties

Returns a list of services properties of the service.

property propertyNAme

Returns the value of the service property specified by propertyName.

types

Returns a list of types that the service uses.

type typeName item

This subcommand returns dictionary describing type. Valid keys are:

properties: Returns a list of the pairs that are the property name and its data type for this type.
relationships: Returns a list of other types that this type has a relationship to.
keys: Returns a list of the properties that are keys, if any, for this type.

provider load parsedServiceDefinition