DefaultContextInteractions (SARL Agent Oriented Programming Language 0.12.0 API)

All Superinterfaces:

Capacity

All Known Implementing Classes:

DefaultContextInteractionsSkill
```
public interface DefaultContextInteractions
extends Capacity
```
Gives access to the DefaultContext of the agent and common actions on its default space. Defines a set of commonly accessed action performed on the Default Space of the Default Context of the agent.

Method Summary

All Methods Instance Methods Abstract Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`emit(event : Event, [scope : Scope<Address>])` Emits a given event with the provided scope in the DefaultSpace of the DefaultContext.
`void`	`emitToParent(event : Event)` Emits or forward the given event to the parent agent into the default context of the calling agent.
`Address`	`getDefaultAddress()` Return the Address of the agent in the Default Space of the Default Context.
`AgentContext`	`getDefaultContext()` Returns the Default context fo the agent.
`UUID`	`getDefaultParentID()` Replies the identifier of the default parent.
`Scope<Address>`	`getDefaultParentScope()` Replies the event scope that corresponds to the default parent.
`EventSpace`	`getDefaultSpace()` Returns the Default Space of the Default Context.
`boolean`	`isDefaultContext(context : AgentContext)` Replies if the given context is the default context.
`boolean`	`isDefaultContext(contextID : UUID)` Replies if the given identifier is the identifier of the default context.
`boolean`	`isDefaultSpace(space : Space)` Replies if the given space is the default space of the default context.
`boolean`	`isDefaultSpace(space : SpaceID)` Replies if the given identifier is the identifier of the default space of the default context.
`boolean`	`isDefaultSpace(space : UUID)` Replies if the given identifier is the identifier of the default space of the default context.
`boolean`	`isInDefaultSpace(event : Event)` Replies if the given event was emitted in the default space of the default context.
`UUID`	`spawn(agentType : Class<? extends Agent>, params : Object*)` Deprecated. See the `Lifecycle` capacity.
`void`	`willReceive(receiver : UUID, event : Event)` Deprecated. since 0.11, see `DefaultContextInteractions.emit(Event,Scope)`

- Method Detail
  - getDefaultContext
```
@Pure
def getDefaultContext() : AgentContext 
```
    Description copied from interface: DefaultContextInteractions
    
    Returns the Default context fo the agent.
    
    Returns:
    
    the default context.
  - getDefaultSpace
```
@Pure
def getDefaultSpace() : EventSpace 
```
    Description copied from interface: DefaultContextInteractions
    
    Returns the Default Space of the Default Context. Equivalent to defaultContext.defaultSpace.
    
    Returns:
    
    the default event space.
  - getDefaultAddress
```
@Pure
def getDefaultAddress() : Address 
```
    Description copied from interface: DefaultContextInteractions
    
    Return the Address of the agent in the Default Space of the Default Context. Equivalent to defaultContext.defaultSpace.getAddress(this.ID)
    
    Returns:
    
    the address of the agent in the default space.
  - emit
```
def emit(event : Event,
         [scope : Scope<Address>]) : void 
```
    Description copied from interface: DefaultContextInteractions
    
    Emits a given event with the provided scope in the DefaultSpace of the DefaultContext. Equivalent to defaultContext.defaultSpace.emit(e,scope)
    
    Parameters:
    
    event - the event to emit.
    
    scope - the definition of the scope that will be used for selected the receivers of the events. If null, all the agents in the space will receive the event.
  - getDefaultParentID
```
@Pure
def getDefaultParentID() : UUID 
```
    Description copied from interface: DefaultContextInteractions
    
    Replies the identifier of the default parent.
    The default parent agent has the same identifier as the default context.
    
    Returns:
    
    the identifier of the default parent of the current agent.
    
    Since:
    
    0.12
  - getDefaultParentScope
```
@Pure
def getDefaultParentScope() : Scope<Address> 
```
    Description copied from interface: DefaultContextInteractions
    
    Replies the event scope that corresponds to the default parent.
    
    Returns:
    
    the identifier of the default parent of the current agent.
    
    Since:
    
    0.12
  - emitToParent
```
def emitToParent(event : Event) : void 
```
    Description copied from interface: DefaultContextInteractions
    
    Emits or forward the given event to the parent agent into the default context of the calling agent.
    
    Parameters:
    
    event - the event to emit.
    
    scope - the definition of the scope that will be used for selected the receivers of the events. If null, all the agents in the space will receive the event.
    
    Since:
    
    0.12
  - willReceive
```
@Deprecated
def willReceive(receiver : UUID,
                            event : Event) : void 
```
    Deprecated. since 0.11, see DefaultContextInteractions.emit(Event,Scope)
    
    Description copied from interface: DefaultContextInteractions
    
    Inverse signature of send. Useful to send events using the agent's UUID.
    
    Parameters:
    
    receiver - the identifier of the expected receiver.
    
    event - the event to emit.
    
    Since:
    
    0.4
  - isDefaultSpace
```
@Pure
def isDefaultSpace(space : Space) : boolean 
```
    Description copied from interface: DefaultContextInteractions
    
    Replies if the given space is the default space of the default context.
    
    Parameters:
    
    space - the space to test.
    
    Returns:
    
    true if the given space is the default space of the default context. Otherwise false.
    
    Since:
    
    0.2
  - isDefaultSpace
```
@Pure
def isDefaultSpace(space : SpaceID) : boolean 
```
    Description copied from interface: DefaultContextInteractions
    
    Replies if the given identifier is the identifier of the default space of the default context.
    
    Parameters:
    
    space - the space to test.
    
    Returns:
    
    true if the given identifier is the identifier of the default space of the default context. Otherwise false.
    
    Since:
    
    0.2
  - isDefaultSpace
```
@Pure
def isDefaultSpace(space : UUID) : boolean 
```
    Description copied from interface: DefaultContextInteractions
    
    Replies if the given identifier is the identifier of the default space of the default context.
    
    Parameters:
    
    space - the space to test.
    
    Returns:
    
    true if the given identifier is the identifier of the default space of the default context. Otherwise false.
    
    Since:
    
    0.2
  - isInDefaultSpace
```
@Pure
def isInDefaultSpace(event : Event) : boolean 
```
    Description copied from interface: DefaultContextInteractions
    
    Replies if the given event was emitted in the default space of the default context.
    
    Parameters:
    
    event - the event to test.
    
    Returns:
    
    true if the given event is emitted in the default space of the default context. Otherwise false.
    
    Since:
    
    0.2
  - isDefaultContext
```
@Pure
def isDefaultContext(context : AgentContext) : boolean 
```
    Description copied from interface: DefaultContextInteractions
    
    Replies if the given context is the default context.
    
    Parameters:
    
    context - the agent context to test.
    
    Returns:
    
    true if the given context is the default context. Otherwise false.
    
    Since:
    
    0.2
  - isDefaultContext
```
@Pure
def isDefaultContext(contextID : UUID) : boolean 
```
    Description copied from interface: DefaultContextInteractions
    
    Replies if the given identifier is the identifier of the default context.
    
    Parameters:
    
    contextID - the identifier of the context.
    
    Returns:
    
    true if the given identifier is the identifier of the default context. Otherwise false.
    
    Since:
    
    0.2
  - spawn
```
@Deprecated
def spawn(agentType : Class<? extends Agent>,
                      params : Object*) : UUID 
```
    Deprecated. See the Lifecycle capacity.
    
    Description copied from interface: DefaultContextInteractions
    
    Spawns a new Agent inside the default context of this agent. This action must automatically register the newly created agent within the default space of the context.
    
    Parameters:
    
    agentType - the type of the agent to spawn.
    
    params - the arguments to pass in the initialization event to the spawned agent.
    
    Returns:
    
    the identifier of the spawned agent.
    
    Fired Events:
    
    AgentSpawned in DefaultSpace, AgentSpawnFailure if the cannot be spawn.

Capacity DefaultContextInteractions

Method Summary

Method Detail

getDefaultContext

getDefaultSpace

getDefaultAddress

emit

getDefaultParentID

getDefaultParentScope

emitToParent

willReceive

isDefaultSpace

isDefaultSpace

isDefaultSpace

isInDefaultSpace

isDefaultContext

isDefaultContext

spawn