Module io.ciera.runtime.api

Package io.ciera.runtime.api.action

Interface ActionHome

All Known Subinterfaces:

Domain, DynamicObjectInstance, EmptyInstance, InstanceActionHome, ObjectInstance, PersistentDomain, StateMachine

public interface ActionHome

An action home represents an element that can contain generated action language statements. The action home provides a standard way to access the domain (for the purpose of accessing domain resources such as relators, terminator messages, utilities, etc). It also gives access to the execution context for time and event generation.

Method Summary

Modifier and Type	Method	Description
default void	delay(Duration delay)	Deprecated.
default <E extends Event> void	generateEvent(Class<E> eventType, EventTarget target, Object... data)
default <E extends Event> void	generateEventToSelf(Class<E> eventType, EventTarget target, Object... data)
default Application	getApplication()
ExecutionContext	getContext()	Get the execution context.
Domain	getDomain()	Get the parent domain.
default Domain	getDomain(String domainName)
default void	halt()
default Timer	scheduleAction(Duration delay, Runnable action)
default Timer	scheduleAction(TimeStamp expiration, Runnable action)
default <E extends Event> Timer	scheduleEvent(Class<E> eventType, EventTarget target, Duration delay, Object... eventData)
default <E extends Event> Timer	scheduleEvent(Class<E> eventType, EventTarget target, TimeStamp expiration, Object... eventData)
default Timer	scheduleRecurringAction(Duration delay, Duration period, Runnable action)
default Timer	scheduleRecurringAction(TimeStamp expiration, Duration period, Runnable action)
default <E extends Event> Timer	scheduleRecurringEvent(Class<E> eventType, EventTarget target, Duration delay, Duration period, Object... eventData)
default <E extends Event> Timer	scheduleRecurringEvent(Class<E> eventType, EventTarget target, TimeStamp expiration, Duration period, Object... eventData)

Method Details

getDomain

Domain getDomain()

Get the parent domain.

Returns:

Domain the parent domain within which the actions are defined.

getDomain

default Domain getDomain(String domainName)

getContext

ExecutionContext getContext()

Get the execution context.

Returns:

ExecutionContext the execution context within which the actions run.

getApplication

default Application getApplication()

generateEvent

default <E extends Event> void generateEvent(Class<E> eventType,
 EventTarget target,
 Object... data)

generateEventToSelf

default <E extends Event> void generateEventToSelf(Class<E> eventType,
 EventTarget target,
 Object... data)

scheduleEvent

default <E extends Event> Timer scheduleEvent(Class<E> eventType,
 EventTarget target,
 Duration delay,
 Object... eventData)

scheduleEvent

default <E extends Event> Timer scheduleEvent(Class<E> eventType,
 EventTarget target,
 TimeStamp expiration,
 Object... eventData)

scheduleAction

default Timer scheduleAction(Duration delay,
 Runnable action)

scheduleAction

default Timer scheduleAction(TimeStamp expiration,
 Runnable action)

scheduleRecurringEvent

default <E extends Event> Timer scheduleRecurringEvent(Class<E> eventType,
 EventTarget target,
 Duration delay,
 Duration period,
 Object... eventData)

scheduleRecurringEvent

default <E extends Event> Timer scheduleRecurringEvent(Class<E> eventType,
 EventTarget target,
 TimeStamp expiration,
 Duration period,
 Object... eventData)

scheduleRecurringAction

default Timer scheduleRecurringAction(Duration delay,
 Duration period,
 Runnable action)

scheduleRecurringAction

default Timer scheduleRecurringAction(TimeStamp expiration,
 Duration period,
 Runnable action)

halt

default void halt()

delay

@Deprecated
default void delay(Duration delay)

Deprecated.