Package com.esprow.oapi.repository

Interface OapiTimerSchedule

public interface OapiTimerSchedule

Invokes an operation to either start or cancel a timer.

The following attributes and references are supported:

• Activity
• Actor
• Interval
• Name
• Operation

Method Summary

Modifier and Type	Method	Description
OapiAction	getActivity()	Returns an action to take when the timer expires.
String	getActor()	Returns the actor that owns the timer.
Duration	getInterval()	Returns the time to the timer's expiration.
String	getName()	Returns the name of the timer.
TimerOperation	getOperation()	Returns an indication whether to start or cancel.
void	setActivity(OapiAction value)	Set an action to take when the timer expires.
void	setActor(String value)	Set the actor that owns the timer.
void	setInterval(Duration value)	Set the time to the timer's expiration.
void	setName(String value)	Set the name of the timer.
void	setOperation(TimerOperation value)	Set an indication whether to start or cancel.

Method Details

getActivity

OapiAction getActivity()

Returns an action to take when the timer expires.

Returns:

an action to take when the timer expires

See Also:

• setActivity(OapiAction)

setActivity

void setActivity(OapiAction value)

Set an action to take when the timer expires.

Parameters:

value - the new value of the 'Activity' containment reference.

See Also:

• getActivity()

getActor

String getActor()

Returns the actor that owns the timer.

Returns:

the actor that owns the timer

See Also:

• setActor(String)

setActor

void setActor(String value)

Set the actor that owns the timer.

Parameters:

value - the new value of the 'Actor' attribute.

See Also:

• getActor()

getInterval

Duration getInterval()

Returns the time to the timer's expiration.

Returns:

the time to the timer's expiration

See Also:

• setInterval(Duration)

setInterval

void setInterval(Duration value)

Set the time to the timer's expiration.

Parameters:

value - the new value of the 'Interval' attribute.

See Also:

• getInterval()

getName

String getName()

Returns the name of the timer.

Returns:

the name of the timer

See Also:

• setName(String)

setName

void setName(String value)

Set the name of the timer.

Parameters:

value - the new value of the 'Name' attribute.

See Also:

• getName()

getOperation

TimerOperation getOperation()

Returns an indication whether to start or cancel. The literals are from the enumeration TimerOperation.

Returns:

an indication whether to start or cancel

See Also:

• TimerOperation
• setOperation(TimerOperation)

setOperation

void setOperation(TimerOperation value)

Set an indication whether to start or cancel.

Parameters:

value - the new value of the 'Operation' attribute.

See Also:

• TimerOperation
• getOperation()