jade.core
Interface Command

All Known Subinterfaces:
HorizontalCommand, VerticalCommand
All Known Implementing Classes:
GenericCommand

public interface Command

The Command interface has to be implemented by all JADE kernel-level commands, used by the various platform services.

Author:
Giovanni Rimassa - FRAMeTech s.r.l.

Method Summary
 jade.security.Credentials getCredentials()
          Get the credentials that the actor of this command wants to use while processing this command.
 java.lang.String getName()
          Query the name of this command object.
 java.lang.Object getParam(int index)
          Obtain the parameter list, as an array of Java objects.
 java.lang.Object[] getParams()
          Obtain the parameter list, as an array of Java objects.
 jade.security.JADEPrincipal getPrincipal()
          Get the JADEPrincipal of the actor, respnsible for this Command object.
 java.lang.Object getReturnValue()
          Obtain the return value for this command.
 java.lang.String getService()
          Query the service this command object belongs to.
 void setCredentials(jade.security.Credentials creds)
           
 void setPrincipal(jade.security.JADEPrincipal p)
           
 void setReturnValue(java.lang.Object rv)
          Assign a return value to this command, so that the original command issuer can retrieve it.
 

Method Detail

getName

java.lang.String getName()
Query the name of this command object.

Returns:
A string containing the name of the given command.

getService

java.lang.String getService()
Query the service this command object belongs to.

Returns:
The name of the service this command object belongs to.

getParam

java.lang.Object getParam(int index)
Obtain the parameter list, as an array of Java objects.

Returns:
The parameters associated with this command object.

getParams

java.lang.Object[] getParams()
Obtain the parameter list, as an array of Java objects.

Returns:
The parameters associated with this command object.

setReturnValue

void setReturnValue(java.lang.Object rv)
Assign a return value to this command, so that the original command issuer can retrieve it.

Parameters:
rv - The desired return value for this command object.

getReturnValue

java.lang.Object getReturnValue()
Obtain the return value for this command.

Returns:
The value that is to be returned back to the issuer of this Command object.

getPrincipal

jade.security.JADEPrincipal getPrincipal()
Get the JADEPrincipal of the actor, respnsible for this Command object.

Returns:

setPrincipal

void setPrincipal(jade.security.JADEPrincipal p)

getCredentials

jade.security.Credentials getCredentials()
Get the credentials that the actor of this command wants to use while processing this command.

Returns:

setCredentials

void setCredentials(jade.security.Credentials creds)


These are the official JADE API. For these API backward compatibility is guaranteed accross JADE versions