kaos.core.service.directory
Interface EntityHostEnvDescription

All Superinterfaces:

java.io.Serializable

public interface EntityHostEnvDescription
extends java.io.Serializable

Defines the operations to define and access information about a hosting environment of KAoS entitites.

Method Summary

void	addGuardID(java.lang.String id) Set the id of a guard that is guarding the hosting environment.
java.util.List	getGuardIDs() Obtain the ids of the guards that are guarding the entity hosting environment.
java.lang.String	getGUID() Obtain the GUID of the hosting environment described by this description.
int	getNumberOfHostedAgents() Obtain the number of agents hosted by the environment described by this description.
boolean	isGuarded() Obtain the guarded/unguarded status of the entity hosting environment
boolean	removeGuardID(java.lang.String id) Remove an id of a guard from the collection of Guard ids held by the KAoSAgentDescription.
void	setGuarded(boolean guarded) Set the guarded/unguarded status of the entity hosting environment.
void	setGUID(java.lang.String guid) Set the GUID of the hosting environment described by this description.
void	setNumberOfHostedAgents(int numOfAgents) Set the number of agents hosted by the environment described by this description.

Method Detail

setGUID

void setGUID(java.lang.String guid)

Set the GUID of the hosting environment described by this description.

Parameters:

guid - String containing the guid of the hosting environment this description refers to.

getGUID

java.lang.String getGUID()

Obtain the GUID of the hosting environment described by this description.

Returns:

String containing the hosting environment's GUID.

setGuarded

void setGuarded(boolean guarded)

Set the guarded/unguarded status of the entity hosting environment.

Parameters:

guarded - boolean specifying the guarded/unguarded status of this hosting environment.

isGuarded

boolean isGuarded()

Obtain the guarded/unguarded status of the entity hosting environment

Returns:

boolean containing the guardede/unguarded status of the hosting environment described by this description.

addGuardID

void addGuardID(java.lang.String id)

Set the id of a guard that is guarding the hosting environment.

Parameters:

id - The id of one of the hosting environment's guard.

getGuardIDs

java.util.List getGuardIDs()

Obtain the ids of the guards that are guarding the entity hosting environment.

Returns:

List containing the ids of guards guarding the hosting environment.

removeGuardID

boolean removeGuardID(java.lang.String id)

Remove an id of a guard from the collection of Guard ids held by the KAoSAgentDescription.

Parameters:

name - The id of a Guard to be removed from the collection of Guard ids.

Returns:

true if the collection of Guard ids contained the specified id; otherwise return false.

setNumberOfHostedAgents

void setNumberOfHostedAgents(int numOfAgents)

Set the number of agents hosted by the environment described by this description.

Parameters:

numOfAgents - int containing the number of agents hosted by the environment described by this description.

getNumberOfHostedAgents

int getNumberOfHostedAgents()

Obtain the number of agents hosted by the environment described by this description.

Returns:

int containing the number of agents hosted by the environment described by this description.