org.wsmo.service
Interface Capability

All Superinterfaces:

Entity, TopEntity

public interface Capability
extends TopEntity

An interface representing a web service capability.

Version:

$Revision: 1946 $ $Date: 2007-04-02 15:13:28 +0300 (Mon, 02 Apr 2007) $

Author:

not attributable

Method Summary

void	addAssumption(Axiom axiom) Adds an assumption to the list of assumptions associated with this capability.
void	addEffect(Axiom axiom) Adds an effect to the list of effects of this capability.
void	addPostCondition(Axiom axiom) Adds a new post-condition to the list of post-conditions associated with this capability.
void	addPreCondition(Axiom axiom) Adds a pre-condition to the list of pre-conditions of this capability.
void	addSharedVariable(Variable var) Adds a new shared variable to the list of variables used by the logical expressions of this capability.
Set<Axiom>	listAssumptions() Lists the assumptions associated with this capability.
Set<Axiom>	listEffects() Lists the effects of this capability.
Set<Axiom>	listPostConditions() Returns the list of post-conditions associated with this capability.
Set<Axiom>	listPreConditions() Lists the pre-conditions of this capability.
Set<Variable>	listSharedVariables() returns the set of shared variables used by the logical expressions of this capability.
void	removeAssumption(Axiom axiom) Removes an assumption from the list of assumptions associated with this capability.
void	removeAssumption(Identifier id) Removes an assumption from the list of assumptions associated with this capability.
void	removeEffect(Axiom axiom) Removes an effect from the list of effects associated with this capability.
void	removeEffect(Identifier id) Removes an effect from the list of effects associated with this capability.
void	removePostCondition(Axiom axiom) Removes a post-condition from the list of post-conditions associated with this capability.
void	removePostCondition(Identifier id) Removes a post-condition from the list of post-conditions associated with this capability.
void	removePreCondition(Axiom axiom) Removes a pre-condition from the list of pre-conditions associated with this capability.
void	removePreCondition(Identifier id) Removes a pre-condition from the list of pre-conditions associated with this capability.
void	removeSharedVariable(String name) Removes a shared variable from the list of variables used by the logical expressions of this capability.
void	removeSharedVariable(Variable var) Removes a shared variable from the list of variables used by the logical expressions of this capability.

Methods inherited from interface org.wsmo.common.TopEntity

addMediator, addNamespace, addOntology, findNamespace, getDefaultNamespace, getWsmlVariant, listMediators, listNamespaces, listOntologies, removeMediator, removeNamespace, removeNamespace, removeOntology, removeOntology, setDefaultNamespace, setDefaultNamespace, setWsmlVariant

Methods inherited from interface org.wsmo.common.Entity

addNFPValue, addNFPValue, getIdentifier, listNFPValues, listNFPValues, removeNFP, removeNFPValue, removeNFPValue

Method Detail

addSharedVariable

void addSharedVariable(Variable var)
                       throws SynchronisationException,
                              InvalidModelException

Adds a new shared variable to the list of variables used by the logical expressions of this capability.

Parameters:

var - The variable to be added

Throws:

SynchronisationException

InvalidModelException

See Also:

removeSharedVariable(Variable var), removeSharedVariable(String name)

removeSharedVariable

void removeSharedVariable(Variable var)
                          throws SynchronisationException,
                                 InvalidModelException

Removes a shared variable from the list of variables used by the logical expressions of this capability.

Parameters:

var - The variable to be removed.

Throws:

SynchronisationException

InvalidModelException

See Also:

removeSharedVariable(String name)

removeSharedVariable

void removeSharedVariable(String name)
                          throws SynchronisationException,
                                 InvalidModelException

Removes a shared variable from the list of variables used by the logical expressions of this capability.

Parameters:

name - The name of the variable to be removed.

Throws:

SynchronisationException

InvalidModelException

See Also:

removeSharedVariable(Variable var)

listSharedVariables

Set<Variable> listSharedVariables()
                                  throws SynchronisationException

returns the set of shared variables used by the logical expressions of this capability.

Returns:

The set of shared variables

Throws:

SynchronisationException

See Also:

Variable

addPostCondition

void addPostCondition(Axiom axiom)
                      throws SynchronisationException,
                             InvalidModelException

Adds a new post-condition to the list of post-conditions associated with this capability.

Parameters:

axiom - The new post-condition to be added to the lsit of post-conditions associated with this capability.

Throws:

SynchronisationException

InvalidModelException

See Also:

removePostCondition(Axiom axiom), removePostCondition(Identifier id)

removePostCondition

void removePostCondition(Axiom axiom)
                         throws SynchronisationException,
                                InvalidModelException

Removes a post-condition from the list of post-conditions associated with this capability.

Parameters:

axiom - The post-condition to be removed.

Throws:

SynchronisationException

InvalidModelException

See Also:

removePostCondition(Identifier id)

removePostCondition

void removePostCondition(Identifier id)
                         throws SynchronisationException,
                                InvalidModelException

Removes a post-condition from the list of post-conditions associated with this capability.

Parameters:

id - The ID of post-condition to be removed.

Throws:

SynchronisationException

InvalidModelException

See Also:

removePostCondition(Axiom axiom)

listPostConditions

Set<Axiom> listPostConditions()
                              throws SynchronisationException

Returns the list of post-conditions associated with this capability.

Returns:

The set of post-conditions associated with this capability.

Throws:

SynchronisationException

See Also:

Axiom

addPreCondition

void addPreCondition(Axiom axiom)
                     throws SynchronisationException,
                            InvalidModelException

Adds a pre-condition to the list of pre-conditions of this capability.

Parameters:

axiom - The pre-condition to be added to the list of pre-conditions of this capability.

Throws:

SynchronisationException

InvalidModelException

See Also:

removePreCondition(Axiom axiom), removePreCondition(Identifier id)

removePreCondition

void removePreCondition(Axiom axiom)
                        throws SynchronisationException,
                               InvalidModelException

Removes a pre-condition from the list of pre-conditions associated with this capability.

Parameters:

axiom - The pre-condition to be removed from the list.

Throws:

SynchronisationException

InvalidModelException

See Also:

removePreCondition(Identifier id)

removePreCondition

void removePreCondition(Identifier id)
                        throws SynchronisationException,
                               InvalidModelException

Removes a pre-condition from the list of pre-conditions associated with this capability.

Parameters:

id - The ID of the pre-condition to be removed from the list.

Throws:

SynchronisationException

InvalidModelException

See Also:

removePreCondition(Axiom axiom)

listPreConditions

Set<Axiom> listPreConditions()
                             throws SynchronisationException

Lists the pre-conditions of this capability.

Returns:

The list of pre-conditions of this capability.

Throws:

SynchronisationException

See Also:

Axiom

addEffect

void addEffect(Axiom axiom)
               throws SynchronisationException,
                      InvalidModelException

Adds an effect to the list of effects of this capability.

Parameters:

axiom - The effect to be added to the list of effects of this capability.

Throws:

SynchronisationException

InvalidModelException

See Also:

removeEffect(Axiom axiom), removeEffect(Identifier id)

removeEffect

void removeEffect(Axiom axiom)
                  throws SynchronisationException,
                         InvalidModelException

Removes an effect from the list of effects associated with this capability.

Parameters:

axiom - The effect to be removed from the list.

Throws:

SynchronisationException

InvalidModelException

See Also:

removeEffect(Identifier id)

removeEffect

void removeEffect(Identifier id)
                  throws SynchronisationException,
                         InvalidModelException

Removes an effect from the list of effects associated with this capability.

Parameters:

id - The ID of the effect to be removed from the list.

Throws:

SynchronisationException

InvalidModelException

See Also:

removeEffect(Axiom axiom)

listEffects

Set<Axiom> listEffects()
                       throws SynchronisationException

Lists the effects of this capability.

Returns:

The list of effects that this capability produces.

Throws:

SynchronisationException

See Also:

Axiom

addAssumption

void addAssumption(Axiom axiom)
                   throws SynchronisationException,
                          InvalidModelException

Adds an assumption to the list of assumptions associated with this capability.

Parameters:

axiom - The new assumption to be added to the list.

Throws:

SynchronisationException

InvalidModelException

See Also:

removeAssumption(Axiom axiom), removeAssumption(Identifier id)

removeAssumption

void removeAssumption(Axiom axiom)
                      throws SynchronisationException,
                             InvalidModelException

Removes an assumption from the list of assumptions associated with this capability.

Parameters:

axiom - The assumption to be removed from the list of assumtions.

Throws:

SynchronisationException

InvalidModelException

See Also:

removeAssumption(Identifier id)

removeAssumption

void removeAssumption(Identifier id)
                      throws SynchronisationException,
                             InvalidModelException

Removes an assumption from the list of assumptions associated with this capability.

Parameters:

id - The ID of the assumption to be removed from the list of assumtions.

Throws:

SynchronisationException

InvalidModelException

See Also:

removeAssumption(Axiom axiom)

listAssumptions

Set<Axiom> listAssumptions()
                           throws SynchronisationException

Lists the assumptions associated with this capability.

Returns:

The list of assumptions associated with this capability.

Throws:

SynchronisationException

See Also:

Axiom