kaos.ontology.management
Interface KAoSOntologyQueryService

All Known Subinterfaces:
DirectoryService
All Known Implementing Classes:
CorbaAgentDirectoryServiceProxy, CougaarAgentDirectoryServiceProxy, GridAgentDirectoryServiceProxy, GridDirectoryServicePolicyCert, KAoSAgentDirectoryServiceProxy, KAoSDirectoryService, TCPAgentDirectoryServiceProxy, TunnelClient

public interface KAoSOntologyQueryService

Defines the operations querying a ontology repository about Actors Actions and Entities.


Method Summary
 java.util.Set getActions(java.lang.String forActor)
          Get descriptions of the Action classes the specified Actor class or instance can perfom based on its class.
 java.util.Set getClassesOfActors(java.lang.String baseActorClass)
          Get names of the Actors classes known to the ontology repository being a subclass of the specified base class.
 java.util.Set getClassesOfActorsCapableOfPerformingActions(java.lang.String actionClass)
          Get names of Actor classes capable to perform a given action, without taking into consideration policy restrictions
 java.util.Set getClassesOfGroups(java.lang.String baseGroupClass)
          Get names of the Group classes known to the ontology repository being a subclass of the specified base class.
 java.util.Set getClassesOfPlaces(java.lang.String basePlaceClass)
          Get names of the Places classes known to the ontology repository being a subclass of the specified base class.
 java.util.Set getClassesOfTargets(java.lang.String baseTargetClass)
          Get names of the targets (Actors or Entities) classes known to the ontology repository being a subclass of the specified base class.
 java.util.Set getIndividualActors(java.lang.String baseActorClass)
          Get names of the individual Actors known to the ontology repository being an instance of the specified base class.
 java.util.Set getIndividualGroups(java.lang.String baseGroupClass)
          Get names of the individual Groups known to the ontology repository being an instance of the specified base class.
 java.util.Set getIndividualPlaces(java.lang.String basePlaceClass)
          Get names of the individual Places known to the ontology repository being an instance of the specified base class.
 java.util.Set getIndividualTargets(java.lang.String baseTargetClass)
          Get names of the individual targets (Actors or Entities) known to the ontology repository being an instance of the specified base class.
 

Method Detail

getIndividualActors

java.util.Set getIndividualActors(java.lang.String baseActorClass)
                                  throws UnknownConceptException,
                                         DirectoryFailure
Get names of the individual Actors known to the ontology repository being an instance of the specified base class.

Parameters:
baseActorClass - The name of the Actor class which the return elements have to be an instance of If the name is empty uses Actor as a base class
Returns:
Set of names of individual Actors
Throws:
UnknownConceptException - if baseActorClass is unknow for the ontology repository
DirectoryFailure

getClassesOfActors

java.util.Set getClassesOfActors(java.lang.String baseActorClass)
                                 throws UnknownConceptException,
                                        DirectoryFailure
Get names of the Actors classes known to the ontology repository being a subclass of the specified base class.

Parameters:
baseActorClass - The name of the Actor class which the return classes have to be a subclass of If the name is empty uses Actor as a base class
Returns:
Set of names of Actor subclasses
Throws:
UnknownConceptException - if baseActorClass is unknow for the ontology repository
DirectoryFailure

getIndividualPlaces

java.util.Set getIndividualPlaces(java.lang.String basePlaceClass)
                                  throws UnknownConceptException,
                                         DirectoryFailure
Get names of the individual Places known to the ontology repository being an instance of the specified base class.

Parameters:
basePlaceClass - The name of the Place class which the return elements have to be an instance of If the name is empty uses Place as a base class
Returns:
Set of names of individual Places
Throws:
UnknownConceptException - if basePlaceClass is unknow for the ontology repository
DirectoryFailure

getClassesOfPlaces

java.util.Set getClassesOfPlaces(java.lang.String basePlaceClass)
                                 throws UnknownConceptException,
                                        DirectoryFailure
Get names of the Places classes known to the ontology repository being a subclass of the specified base class.

Parameters:
basePlaceClass - The name of the Place class which the return classes have to be a subclass of If the name is empty uses Place as a base class
Returns:
Set of names of Place subclasses
Throws:
UnknownConceptException - if basePlaceClass is unknow for the ontology repository
DirectoryFailure

getIndividualGroups

java.util.Set getIndividualGroups(java.lang.String baseGroupClass)
                                  throws UnknownConceptException,
                                         DirectoryFailure
Get names of the individual Groups known to the ontology repository being an instance of the specified base class.

Parameters:
baseGroupClass - The name of the Group class which the return elements have to be an instance of If the name is empty uses Group as a base class
Returns:
Set of names of individual Groups
Throws:
UnknownConceptException - if baseGroupClass is unknow for the ontology repository
DirectoryFailure

getClassesOfGroups

java.util.Set getClassesOfGroups(java.lang.String baseGroupClass)
                                 throws UnknownConceptException,
                                        DirectoryFailure
Get names of the Group classes known to the ontology repository being a subclass of the specified base class.

Parameters:
baseGroupClass - The name of the Group class which the return elements have to be an instance of If the name is empty uses Group as a base class
Returns:
Set of names of individual Groups
Throws:
UnknownConceptException - if baseGroupClass is unknow for the ontology repository
DirectoryFailure

getIndividualTargets

java.util.Set getIndividualTargets(java.lang.String baseTargetClass)
                                   throws UnknownConceptException,
                                          DirectoryFailure
Get names of the individual targets (Actors or Entities) known to the ontology repository being an instance of the specified base class.

Parameters:
baseTargetClass - The name of the targets (Actor or Entity) class which the return classes have to be a subclass of
Returns:
Set of names of individual targets (Actors or Entities)
Throws:
UnknownConceptException - if baseTargetClass is unknow for the ontology repository
DirectoryFailure

getClassesOfTargets

java.util.Set getClassesOfTargets(java.lang.String baseTargetClass)
                                  throws UnknownConceptException,
                                         DirectoryFailure
Get names of the targets (Actors or Entities) classes known to the ontology repository being a subclass of the specified base class.

Parameters:
baseTargetClass - The name of the targets (Actor or Entity) class which the return classes have to be a subclass of
Returns:
Set of names of targets (Actors or Entities) subclasses
Throws:
UnknownConceptException - if baseTargetClass is unknow for the ontology repository
DirectoryFailure

getActions

java.util.Set getActions(java.lang.String forActor)
                         throws UnknownConceptException,
                                DirectoryFailure
Get descriptions of the Action classes the specified Actor class or instance can perfom based on its class.

Parameters:
forActor - The name of the Actor class or instance
Returns:
Set of ActionClassDescription
Throws:
UnknownConceptException - if forActor is unknow for the ontology repository
DirectoryFailure

getClassesOfActorsCapableOfPerformingActions

java.util.Set getClassesOfActorsCapableOfPerformingActions(java.lang.String actionClass)
                                                           throws UnknownConceptException,
                                                                  DirectoryFailure
Get names of Actor classes capable to perform a given action, without taking into consideration policy restrictions

Parameters:
actionClass - The name of the Action class
Returns:
Set of Strings containg names of Actor classes
Throws:
UnknownConceptException - if actionClass is unknow for the ontology repository
DirectoryFailure