org.optimizationservices.oscommon.communicationinterface
Interface OSdL

All Known Implementing Classes:

OSRegistryAgent

public interface OSdL

The OSdL interface declares all the methods as specified in the Optimization Services (OS) Framework, specifically the Optimization Services discover Language (OSdL). These methods are called by an OS agent to register, find and validate in an OS registry any OS services, such as OS solvers or analyzers. Any registry that wants to become an OS-type callable on the distributed system must implement this interface.

Since:

OS 1.0

Version:

1.0, 03/14/2004

Author:

Robert Fourer, Jun Ma, Kipp Martin

Method Summary

java.lang.String	find(java.lang.String osql, java.lang.String osol) Discover an Optimization Service whose instance is given by a string following the Optimization Services query Language (OSqL) schema and returns the location information in a string that follows the Optimization Services URI, or Universal Resource Indentifier Language, (OSuL) schema.
java.lang.String	knock(java.lang.String osplInput, java.lang.String osol) This method is called by one optimization service on another optimization service to provide runtime dynamic process information (push mechanism).
java.lang.String	register(java.lang.String osel, java.lang.String osol) register an Optimization Service whose instance is given by a string following the Optimization Services entity Language (OSeL) schema and returns a string that contains an XSLT style sheet transformation so that it can be used for standard web pubblication of the Optimization Service that just joined.
java.lang.String	validate(java.lang.String osxl, java.lang.String osol) Validate an osxl string according to the corresponding OSxL schema.

Method Detail

find

java.lang.String find(java.lang.String osql,
                      java.lang.String osol)

Discover an Optimization Service whose instance is given by a string following the Optimization Services query Language (OSqL) schema and returns the location information in a string that follows the Optimization Services URI, or Universal Resource Indentifier Language, (OSuL) schema.

Parameters:

OSqL - holds the Optimization Service query in a string which format follows the Optimization Services query Language (OSqL) schema.

osol - holds the optimization option in a string which format follows the Optimization Services option Language (OSoL) schema.

Returns:

the location information in a string that follows the Optimization Services URI, or Universal Resource Indentifier Language, (OSuL) schema.

register

java.lang.String register(java.lang.String osel,
                          java.lang.String osol)

register an Optimization Service whose instance is given by a string following the Optimization Services entity Language (OSeL) schema and returns a string that contains an XSLT style sheet transformation so that it can be used for standard web pubblication of the Optimization Service that just joined. The XSLT is espcially used to publish the OSeL.

Parameters:

osel - holds the Optimization Service entity description in a string which format follows the Optimization Services entity Language (OSeL) schema.

osol - holds the optimization option in a string which format follows the Optimization Services option Language (OSoL) schema.

Returns:

the register process output information in a string which format follows the OSpL schema.

validate

java.lang.String validate(java.lang.String osxl,
                          java.lang.String osol)

Validate an osxl string according to the corresponding OSxL schema.

Parameters:

osxl - holds the xml string to be validated.

osol - holds the optimization option in a string which format follows the Optimization Services option Language (OSoL) schema.

Returns:

the validate process output information in a string which format follows the OSpL schema.

knock

java.lang.String knock(java.lang.String osplInput,
                       java.lang.String osol)

This method is called by one optimization service on another optimization service to provide runtime dynamic process information (push mechanism).

Parameters:

osplInput - holds the input process information a string which format follows the Optimization Services process Language (OSpL) schema.

osol - holds the optimization option in a string which format follows the Optimization Services option Language (OSoL) schema.

Returns:

osplOutput, the ouput process information in a string which format follows the OSpL schema.