kaos.core.service.directory.query
Class AgentRelations

java.lang.Object
  kaos.core.service.directory.query.AgentRelations

public class AgentRelations
extends java.lang.Object

This class enables to perform queries about different kinds of relations between agents. $Revision: 1.7 $

Constructor Summary

AgentRelations(KAoSAgentDirectoryServiceProxy _myKAoSDirectoryServiceProxy)
Constructor of the class.

Method Summary

java.util.Vector	collectSubordinatesFrom(java.lang.String domainName) Get a list of agents in the child domains of the single domain the given agent is a member of with a positive authorisation (interpreted these as subordinates)
java.util.Vector	collectSuperiorsFrom(java.lang.String domainName) Get a list of agents in the parent domains of a single domain the given agent is a member of with a positive authorisation (interpreted these as superiors)
java.util.Vector	getPeers(java.lang.String agentGUID) Get a list of agents in the domain(s) the given agent is in with a positive authorisation (interpreted as peers)
java.util.Vector	getSubordinates(java.lang.String agentGUID) Get a list of agents in the child domains of the domains the given agent is a member of with a positive authorisation (interpreted these as subordinates)
java.util.Vector	getSuperiors(java.lang.String agentGUID) Get a list of agents in the parent domains of the domains the given agent is a member of with a positive authorisation (interpreted these as superiors)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AgentRelations

public AgentRelations(KAoSAgentDirectoryServiceProxy _myKAoSDirectoryServiceProxy)

Constructor of the class.

Parameters:

_myKAoSDirectoryServiceProxy - reference to the object representing a Directory Service proxy withing agent execution context

Method Detail

getPeers

public java.util.Vector getPeers(java.lang.String agentGUID)
                          throws NotRegisteredException

Get a list of agents in the domain(s) the given agent is in with a positive authorisation (interpreted as peers)

Parameters:

agentGUID - GUID of the agent, whose peers are requested

Returns:

Vector of peers' AgentDescriptions

Throws:

NotRegisteredException - if the agentGUID is not registered

getSubordinates

public java.util.Vector getSubordinates(java.lang.String agentGUID)
                                 throws NotRegisteredException

Get a list of agents in the child domains of the domains the given agent is a member of with a positive authorisation (interpreted these as subordinates)

Parameters:

agentGUID - GUID of the agent, whose subordinates are requested

Returns:

Vector of subordinates' AgentDescriptions

Throws:

NotRegisteredException - if the agentGUID is not registered

getSuperiors

public java.util.Vector getSuperiors(java.lang.String agentGUID)
                              throws NotRegisteredException

Get a list of agents in the parent domains of the domains the given agent is a member of with a positive authorisation (interpreted these as superiors)

Parameters:

agentGUID - GUID of the agent, whose susuperiors are requested

Returns:

Vector of superiors' AgentDescriptions

Throws:

NotRegisteredException - if the agentGUID is not registered

collectSuperiorsFrom

public java.util.Vector collectSuperiorsFrom(java.lang.String domainName)

Get a list of agents in the parent domains of a single domain the given agent is a member of with a positive authorisation (interpreted these as superiors)

Parameters:

domainName - string representing the domain name

Returns:

Vector of superiors' AgentDescriptions from this domain and above it

collectSubordinatesFrom

public java.util.Vector collectSubordinatesFrom(java.lang.String domainName)
                                         throws NotRegisteredException

Get a list of agents in the child domains of the single domain the given agent is a member of with a positive authorisation (interpreted these as subordinates)

Parameters:

domainName - string representing the domain name

Returns:

Vector of subordinates' AgentDescriptions from this domain and above it

Throws:

NotRegisteredException