jade.domain.JADEAgentManagement
Class DebugOff

java.lang.Object
  extended by jade.domain.JADEAgentManagement.DebugOff
All Implemented Interfaces:
AgentAction, Concept, ContentElement, Term, java.io.Serializable

public class DebugOff
extends java.lang.Object
implements AgentAction

This class represents the debug-off action, requesting a debugger to stop observing a set of agents in the platform.

Version:
$Date: 2003-11-24 14:47:00 +0100 (lun, 24 nov 2003) $ $Revision: 4597 $
Author:
Giovanni Rimassa - Universita' di Parma
See Also:
Serialized Form

Constructor Summary
DebugOff()
          Default constructor.
 
Method Summary
 void addDebuggedAgents(AID id)
          Add an agent identifier to the debugged-agents slot collection of this object.
 void clearAllDebuggedAgents()
          Remove all agent identifiers from the debugged-agents slot collection of this object.
 Iterator getAllDebuggedAgents()
          Access all agent identifiers from the debugged-agents slot collection of this object.
 ArrayList getCloneOfDebuggedAgents()
          This method is called by the AMS in order to prepare an RMI call.
 AID getDebugger()
          Retrieve the value of the debugger slot of this action, containing the agent identifier of the debugger agent.
 java.lang.String getPassword()
          Retrieve the value of the password slot of this action, containing the password used to authenticate the principal requesting this action.
 boolean removeDebuggedAgents(AID id)
          Remove an agent identifier from the debugged-agents slot collection of this object.
 void setDebugger(AID id)
          Set the debugger slot of this action.
 void setPassword(java.lang.String p)
          Set the password slot of this action.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

DebugOff

public DebugOff()
Default constructor. A default constructor is necessary for ontological classes.

Method Detail

setDebugger

public void setDebugger(AID id)
Set the debugger slot of this action.

Parameters:
id - The agent identifier of the debugger agent.

getDebugger

public AID getDebugger()
Retrieve the value of the debugger slot of this action, containing the agent identifier of the debugger agent.

Returns:
The value of the debugger slot, or null if no value was set.

clearAllDebuggedAgents

public void clearAllDebuggedAgents()
Remove all agent identifiers from the debugged-agents slot collection of this object.


addDebuggedAgents

public void addDebuggedAgents(AID id)
Add an agent identifier to the debugged-agents slot collection of this object.

Parameters:
id - The agent identifier to add to the collection.

removeDebuggedAgents

public boolean removeDebuggedAgents(AID id)
Remove an agent identifier from the debugged-agents slot collection of this object.

Parameters:
id - The agent identifier to remove from the collection.
Returns:
A boolean, telling whether the element was present in the collection or not.

getAllDebuggedAgents

public Iterator getAllDebuggedAgents()
Access all agent identifiers from the debugged-agents slot collection of this object.

Returns:
An iterator over the properties collection.

getCloneOfDebuggedAgents

public ArrayList getCloneOfDebuggedAgents()
This method is called by the AMS in order to prepare an RMI call. The getAllDebuggedAgents() cannot be used as it returns an Iterator that is not serializable.


setPassword

public void setPassword(java.lang.String p)
Set the password slot of this action.

Parameters:
p - The password used to authenticate the principal requesting this action.

getPassword

public java.lang.String getPassword()
Retrieve the value of the password slot of this action, containing the password used to authenticate the principal requesting this action.

Returns:
The value of the password slot, or null if no value was set.