jadex.model
Interface IMEventbase

All Superinterfaces:

IMBase, IMElement

public interface IMEventbase

extends IMBase

The event container.

Field Summary

static String	CAUSE The cause parameter of condition triggered events.
static String	CONDITION The condition parameter of condition triggered events.
static String	LEGACY_CONTENT Deprecated. Use explicitly defined custom types in ADF.
static String	LEGACY_INTERNAL_EVENT The constant for defining the legacy internal event. todo: remove
static String	LEGACY_TYPE Deprecated. Use explicitly defined custom types in ADF.
static String	STANDARD_GOAL_EVENT The constant for defining the standard goal event.
static String	STANDARD_GOAL_EVENT_REFERENCE The constant for defining the standard goal event.
static String	TYPE_CONDITION_TRIGGERED The condition satisfied internal event type.
static String	TYPE_CONDITION_TRIGGERED_REFERENCE The condition satisfied internal event type.
static String	TYPE_EXECUTEPLAN The execute plan event type.
static String	TYPE_TIMEOUT The timeout internal event type.

Method Summary

IMInternalEvent	createInternalEvent(String name, boolean exported) Create an internal event.
IMInternalEventReference	createInternalEventReference(String name, boolean exported, String ref, boolean req) Create an internal event reference.
IMMessageEvent	createMessageEvent(String name, String type, String direction, boolean exported) Create an message event.
IMMessageEventReference	createMessageEventReference(String name, boolean exported, String ref, boolean req) Create an message event reference.
void	deleteInternalEvent(IMInternalEvent event) Delete an internal event.
void	deleteInternalEventReference(IMInternalEventReference event) Delete an internal event reference.
void	deleteMessageEvent(IMMessageEvent event) Delete an message event.
void	deleteMessageEventReference(IMMessageEventReference event) Delete an message event reference.
IMGoalEvent	getGoalEvent(String name) Get an event by name.
IMGoalEventReference	getGoalEventReference(String name) Get a goal event reference by name.
IMGoalEventReference[]	getGoalEventReferences() Get all known goal event references.
IMGoalEvent[]	getGoalEvents() Get all known goal events.
IMInternalEvent	getInternalEvent(String name) Get an internal event by name.
IMInternalEventReference	getInternalEventReference(String name) Get an event by name.
IMInternalEventReference[]	getInternalEventReferences() Get all known internal event references.
IMInternalEvent[]	getInternalEvents() Get all known internal events.
IMMessageEvent	getMessageEvent(String name) Get a message event by name.
IMMessageEventReference	getMessageEventReference(String name) Get a message event reference by name.
IMMessageEventReference[]	getMessageEventReferences() Get all known message event references.
IMMessageEvent[]	getMessageEvents() Get all known message event.

Methods inherited from interface jadex.model.IMBase

deleteReferenceableElement, getCorrespondingBase, getElementReferences, getReferenceableElement, getReferenceableElements

Methods inherited from interface jadex.model.IMElement

check, getChildren, getDescription, getEncodableRepresentation, getExpressionParameters, getName, getOwner, getReport, getScope, setDescription, setName

Field Detail

STANDARD_GOAL_EVENT

public static final String STANDARD_GOAL_EVENT

The constant for defining the standard goal event.

See Also:

Constant Field Values

STANDARD_GOAL_EVENT_REFERENCE

public static final String STANDARD_GOAL_EVENT_REFERENCE

The constant for defining the standard goal event.

See Also:

Constant Field Values

LEGACY_INTERNAL_EVENT

public static final String LEGACY_INTERNAL_EVENT

The constant for defining the legacy internal event. todo: remove

See Also:

Constant Field Values

LEGACY_TYPE

public static final String LEGACY_TYPE

Deprecated. Use explicitly defined custom types in ADF.

The custom event type parameter for legacy internal events.

See Also:

Constant Field Values

LEGACY_CONTENT

public static final String LEGACY_CONTENT

Deprecated. Use explicitly defined custom types in ADF.

The custom event content parameter for legacy internal events.

See Also:

Constant Field Values

TYPE_TIMEOUT

public static final String TYPE_TIMEOUT

The timeout internal event type.

See Also:

Constant Field Values

TYPE_CONDITION_TRIGGERED

public static final String TYPE_CONDITION_TRIGGERED

The condition satisfied internal event type.

See Also:

Constant Field Values

TYPE_CONDITION_TRIGGERED_REFERENCE

public static final String TYPE_CONDITION_TRIGGERED_REFERENCE

The condition satisfied internal event type.

See Also:

Constant Field Values

CONDITION

public static final String CONDITION

The condition parameter of condition triggered events.

See Also:

Constant Field Values

CAUSE

public static final String CAUSE

The cause parameter of condition triggered events.

See Also:

Constant Field Values

TYPE_EXECUTEPLAN

public static final String TYPE_EXECUTEPLAN

The execute plan event type.

See Also:

Constant Field Values

Method Detail

getInternalEvents

public IMInternalEvent[] getInternalEvents()

Get all known internal events.

Returns:

The internal events.

getInternalEvent

public IMInternalEvent getInternalEvent(String name)

Get an internal event by name.

Parameters:

name - The internal event name.

Returns:

The internal event with that name (if any).

createInternalEvent

public IMInternalEvent createInternalEvent(String name,
                                           boolean exported)

Create an internal event.

Parameters:

name - The name of the event.

exported - Flag indicating if this event may be referenced from outside capabilities.

Returns:

The internal event.

deleteInternalEvent

public void deleteInternalEvent(IMInternalEvent event)

Delete an internal event.

Parameters:

event - The internal event.

getInternalEventReferences

public IMInternalEventReference[] getInternalEventReferences()

Get all known internal event references.

Returns:

The internal event references.

getInternalEventReference

public IMInternalEventReference getInternalEventReference(String name)

Get an event by name.

Parameters:

name - The internal event reference name.

Returns:

The internal event reference with that name (if any).

createInternalEventReference

public IMInternalEventReference createInternalEventReference(String name,
                                                             boolean exported,
                                                             String ref,
                                                             boolean req)

Create an internal event reference.

Parameters:

name - The name of the event reference.

exported - Flag indicating if this event reference may be referenced from outside capabilities.

ref - The referenced event (or null for abstract).

req - Is a reference required (only for abstract).

Returns:

The internal event reference.

deleteInternalEventReference

public void deleteInternalEventReference(IMInternalEventReference event)

Delete an internal event reference.

Parameters:

event - The internal event reference.

getMessageEvents

public IMMessageEvent[] getMessageEvents()

Get all known message event.

Returns:

The message events.

getMessageEvent

public IMMessageEvent getMessageEvent(String name)

Get a message event by name.

Parameters:

name - The message event name.

Returns:

The message event with that name (if any).

createMessageEvent

public IMMessageEvent createMessageEvent(String name,
                                         String type,
                                         String direction,
                                         boolean exported)

Create an message event.

Parameters:

name - The name of the message event.

type - The type of the message event (e.g. "fipa").

direction - The direction of the message event (send/receive).

exported - Flag indicating if this event may be referenced from outside capabilities.

Returns:

The message event.

deleteMessageEvent

public void deleteMessageEvent(IMMessageEvent event)

Delete an message event.

Parameters:

event - The message event.

getMessageEventReferences

public IMMessageEventReference[] getMessageEventReferences()

Get all known message event references.

Returns:

The message event references.

getMessageEventReference

public IMMessageEventReference getMessageEventReference(String name)

Get a message event reference by name.

Parameters:

name - The message event reference name.

Returns:

The message event reference with that name (if any).

createMessageEventReference

public IMMessageEventReference createMessageEventReference(String name,
                                                           boolean exported,
                                                           String ref,
                                                           boolean req)

Create an message event reference.

Parameters:

name - The name of the event reference.

exported - Flag indicating if this event reference may be referenced from outside capabilities.

ref - The referenced event (or null for abstract).

req - Is a reference required (only for abstract).

Returns:

The message event reference.

deleteMessageEventReference

public void deleteMessageEventReference(IMMessageEventReference event)

Delete an message event reference.

Parameters:

event - The message event reference.

getGoalEvents

public IMGoalEvent[] getGoalEvents()

Get all known goal events.

Returns:

The goal events.

getGoalEvent

public IMGoalEvent getGoalEvent(String name)

Get an event by name.

Parameters:

name - The goal event name.

Returns:

The goal event with that name (if any).

getGoalEventReferences

public IMGoalEventReference[] getGoalEventReferences()

Get all known goal event references.

Returns:

The goal event references.

getGoalEventReference

public IMGoalEventReference getGoalEventReference(String name)

Get a goal event reference by name.

Parameters:

name - The goal event reference name.

Returns:

The goal event reference with that name (if any).