org.da.protoframework.model.core

Interface CyclicServiceInstance

All Known Implementing Classes:

PublishCyclicServiceInstance, SendEventCyclicServiceInstance

public interface CyclicServiceInstance

Represent a cyclic Service instance on a Module.

Since:

0.6.27.1

Method Summary

Modifier and Type	Method and Description
java.time.Duration	getDuration() Return the duration (ie the invocation frequency).
java.lang.String	getName() Return the Service instance name.
java.lang.reflect.Method	getSendMethod() Return the Module send method.
boolean	invoke() Invoke the Service.
boolean	isActivated() Return true if the Service is activated.
boolean	isAutoInvoked() Return true if the Service will be automatically invoked for each cycle.
void	setActivated(boolean activated) Set if the Service is activated.

Method Detail

getName

java.lang.String getName()

Return the Service instance name.

Returns:

the Service instance name

setActivated

void setActivated(boolean activated)

Set if the Service is activated. It means that the associated method will be invoked cyclically.

Parameters:

activated - true if the Service is activated

isActivated

boolean isActivated()

Return true if the Service is activated. It means that the associated method will be invoked cyclically.

Returns:

true if the Service is activated

getDuration

java.time.Duration getDuration()

Return the duration (ie the invocation frequency).

Returns:

the duration

isAutoInvoked

boolean isAutoInvoked()

Return true if the Service will be automatically invoked for each cycle.

Returns:

true if the Service will be automatically invoked for each cycle

getSendMethod

java.lang.reflect.Method getSendMethod()

Return the Module send method.

Returns:

the method

invoke

boolean invoke()

Invoke the Service. This will do nothing if isActivated() is false.

Returns:

true if the Service has been invoked