ExternalContextAccess (SARL Agent Oriented Programming Language 0.12.0 API)

All Superinterfaces:

Capacity

All Known Implementing Classes:

ExternalContextAccessSkill
```
public interface ExternalContextAccess
extends Capacity
```
Provides functions for accessing and managing the external contexts of an agent.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`emit(space : EventSpace, event : Event, [scope : Scope<Address>])` Emits a given event with the provided scope in the given space.
`ConcurrentCollection<AgentContext>`	`getAllContexts()` Replies all contexts this agent is a member of, including the default context.
`AgentContext`	`getContext(contextID : UUID)` Replies the AgentContext for the given ID.
`AgentContext`	`getUniverseContext()` Replies the AgentContext that is the root of all the contexts.
`boolean`	`isInSpace(event : Event, space : Space)` Replies if the given event was emitted in the given space.
`boolean`	`isInSpace(event : Event, spaceID : SpaceID)` Replies if the given event was emitted in the space with the given identifier..
`boolean`	`isInSpace(event : Event, spaceID : UUID)` Replies if the given event was emitted in the space with the given identifier..
`AgentContext`	`join(contextID : UUID, expectedDefaultSpaceID : UUID)` Joins a new parent context (a new super holon).
`boolean`	`leave(contextID : UUID)` Leaves the parent's context.

- Method Detail
  - getAllContexts
```
@Pure
def getAllContexts() : ConcurrentCollection<AgentContext> 
```
    Description copied from interface: ExternalContextAccess
    
    Replies all contexts this agent is a member of, including the default context.
    
    Returns:
    
    the list of the known agent contexts.
  - getContext
```
@Pure
def getContext(contextID : UUID) : AgentContext 
```
    Description copied from interface: ExternalContextAccess
    
    Replies the AgentContext for the given ID. The agent must have joined the context before calling this action or use its parentContextID
    
    Parameters:
    
    contextID - the ID of the context to get.
    
    Returns:
    
    the agent context instance.
    
    Throws:
    
    UnknownContextException - if the context specified context is not known by the agent.
    
    See Also:
    
    Agent.getParentID(), ExternalContextAccess.join(java.util.UUID, java.util.UUID)
  - getUniverseContext
```
@Pure
def getUniverseContext() : AgentContext 
```
    Description copied from interface: ExternalContextAccess
    
    Replies the AgentContext that is the root of all the contexts. Usually, the Universe context is managed by the SARL run-time environment. The agent may be a member of this context, or not.
    
    Returns:
    
    the context that is at the root of all the contexts.
    
    Since:
    
    0.7
  - join
```
def join(contextID : UUID,
         expectedDefaultSpaceID : UUID) : AgentContext 
```
    Description copied from interface: ExternalContextAccess
    Joins a new parent context (a new super holon).
    The agent will be involved in the context with the ID given by contextID. The parameter expectedDefaultSpaceID is only used to check if the caller of this function knows the ID of the default space in the context to be involved in. Note that the context must already exists, and the default space inside this context must have the same ID as expectedDefaultSpaceID. If the given expectedDefaultSpaceID does not match the ID of the default space in the context contextID, then the access to the context is forbidden.
    This actions registers the agent in the default Space of the context with the ID contextID.
    This function replies false if one of the following conditions evaluates to true:
    - the agent is not alive;
    - the given context identifier does not corresponds to a known context;
    - the given space identifier is not the one of the context's default space;
    - the given context identifier corresponds to a context in which the agent is already member.
    Parameters:
    
    contextID - the identifier of the context to join.
    
    expectedDefaultSpaceID - the known identifier of the default space in the agent context with the given identifier.
    
    Returns:
    
    the joined context. null if the context cannot be joined.
    
    Since:
    
    0.12 for the returned context.
    
    Fired Events:
    
    ContextJoined in its inner Context default space (Behaviors#wake)., MemberJoined in its parent Context default Space
  - leave
```
def leave(contextID : UUID) : boolean 
```
    Description copied from interface: ExternalContextAccess
    Leaves the parent's context.
    Because an agent must be always into a context, this function fails (and replies false) when the context to be leaved is the current default context of the agent, and there is no other context or more than 1 other context that could be elected as the new default context.
    This function replies false if one of the following conditions evaluates to true:
    - the agent is not alive;
    - the given context identifier does not corresponds to a known context;
    - the given context identifier corresponds to a context in which the agent is not member.
    - the given context identifier corresponds to a known external context, but there is no other context to be elected as the new default context for the agent.
    Parameters:
    
    contextID - the identifier of the context to leave.
    
    Returns:
    
    true if the agent has leaved the context. false if one of the conditions described in the function's comment evaluates to true.
    
    Fired Events:
    
    ContextLeft in its inner Context default space (Behaviors#wake)., MemberLeft in its parent Context default Space
  - isInSpace
```
@Pure
def isInSpace(event : Event,
                    space : Space) : boolean 
```
    Description copied from interface: ExternalContextAccess
    
    Replies if the given event was emitted in the given space.
    
    Parameters:
    
    event - the event to test.
    
    space - the space in which the event may be.
    
    Returns:
    
    true if the given event was emitted in the given space. Otherwise false.
    
    Since:
    
    0.2
  - isInSpace
```
@Pure
def isInSpace(event : Event,
                    spaceID : SpaceID) : boolean 
```
    Description copied from interface: ExternalContextAccess
    
    Replies if the given event was emitted in the space with the given identifier..
    
    Parameters:
    
    event - the event to test.
    
    spaceID - the identifier of the space in which the event may be.
    
    Returns:
    
    true if the given event was emitted in the space with the given identifier. Otherwise false.
    
    Since:
    
    0.2
  - isInSpace
```
@Pure
def isInSpace(event : Event,
                    spaceID : UUID) : boolean 
```
    Description copied from interface: ExternalContextAccess
    
    Replies if the given event was emitted in the space with the given identifier..
    
    Parameters:
    
    event - the event to test.
    
    spaceID - the identifier of the space in which the event may be.
    
    Returns:
    
    true if the given event was emitted in the space with the given identifier. Otherwise false.
    
    Since:
    
    0.2
  - emit
```
def emit(space : EventSpace,
         event : Event,
         [scope : Scope<Address>]) : void 
```
    Description copied from interface: ExternalContextAccess
    
    Emits a given event with the provided scope in the given space. Equivalent to space.emit(getID,event,scope)
    
    Parameters:
    
    space - the space in which the event should be fired.
    
    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.6

Capacity ExternalContextAccess

Method Summary

Method Detail

getAllContexts

getContext

getUniverseContext

join

leave

isInSpace

isInSpace

isInSpace

emit