RemoteTerminationCommand (API Documentation for jadex-platform-bridge.)

java.lang.Object
- jadex.bridge.component.impl.remotecommands.RemoteTerminationCommand<T>

All Implemented Interfaces:: IRemoteConversationCommand<T>

public class RemoteTerminationCommand<T>
extends java.lang.Object
implements IRemoteConversationCommand<T>

Command for future termmination.

Field Summary

Fields
Modifier and Type Field Description

protected java.lang.Exception reason
The termination reason (if any).

Constructor Summary

Constructors
Constructor Description

RemoteTerminationCommand()
Create the command.

RemoteTerminationCommand(java.lang.Exception reason)
Create the command.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`execute(IInternalAccess access, jadex.commons.future.IFuture<T> future, ISecurityInfo secinf)`	Execute a command.
`java.lang.Exception`	`getReason()`	Get the reason.
`void`	`setReason(java.lang.Exception reason)`	Set the reason.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - reason
```
protected java.lang.Exception reason
```
    The termination reason (if any).
- Constructor Detail
  - RemoteTerminationCommand
```
public RemoteTerminationCommand()
```
    Create the command.
  - RemoteTerminationCommand
```
public RemoteTerminationCommand(java.lang.Exception reason)
```
    Create the command.
- Method Detail
  - execute
```
public void execute(IInternalAccess access,
                    jadex.commons.future.IFuture<T> future,
                    ISecurityInfo secinf)
```
    Execute a command.
    
    Specified by:
    
    execute in interface IRemoteConversationCommand<T>
    
    Parameters:
    
    access - The agent to run the command on.
    
    future - Future of the active conversation.
    
    secinf - The established security level to decide if the command is allowed.
  - getReason
```
public java.lang.Exception getReason()
```
    Get the reason.
    
    Returns:
    
    The reason.
  - setReason
```
public void setReason(java.lang.Exception reason)
```
    Set the reason.
    
    Parameters:
    
    reason - The reason to set.