buzz.getcoco.iot

Class ScheduleCondition

java.lang.Object

buzz.getcoco.iot.ScheduleCondition

All Implemented Interfaces:

Rule.Condition

public class ScheduleCondition
extends java.lang.Object
implements Rule.Condition

Schedule condition is of one of the two constraint types that can be used to trigger a Rule. As the name suggests schedule conditions are time based conditions, which can used solely or in conjunction with ResourceCondition to form constraint in a rule.

Schedule condition encapsulates the information about time and duration of a resource upon which Scene and Rule can be triggered.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ScheduleCondition.Builder Builder design pattern to create a Schedule Condition object.
static class	ScheduleCondition.ScheduleType Type of scheduling options for a schedule condition that a user can set.

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_SCHEDULE_CONDITION_ID Default ID of the ScheduleCondition.

Method Summary

Modifier and Type	Method and Description
ScheduleCondition	duplicate() A function to create new copy of this ScheduleCondition.
java.time.LocalTime	getExpiryTime() A function to get expiry time of the ScheduleCondition as LocalTime.
int	getId() A function to get unique ID of this ScheduleCondition in Network.
ScheduleCondition.ScheduleType	getScheduleType() A function to get ScheduleCondition.ScheduleType of the ScheduleCondition.
java.time.Instant	getStartTime() A function to get the start time of the ScheduleCondition.
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

DEFAULT_SCHEDULE_CONDITION_ID

public static final int DEFAULT_SCHEDULE_CONDITION_ID

Default ID of the ScheduleCondition.

See Also:

Constant Field Values

Method Detail

getId

public int getId()

A function to get unique ID of this ScheduleCondition in Network.

Returns:

ID of the ScheduleCondition.

getStartTime

public java.time.Instant getStartTime()

A function to get the start time of the ScheduleCondition.

Returns:

Start time.

getExpiryTime

public java.time.LocalTime getExpiryTime()

A function to get expiry time of the ScheduleCondition as LocalTime.

Returns:

Expiry time.

getScheduleType

public ScheduleCondition.ScheduleType getScheduleType()

A function to get ScheduleCondition.ScheduleType of the ScheduleCondition.

Returns:

ScheduleCondition.ScheduleType of the condition.

duplicate

public ScheduleCondition duplicate()

A function to create new copy of this ScheduleCondition.

Specified by:

duplicate in interface Rule.Condition

Returns:

ScheduleCondition

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object