eu.dnetlib.domain.functionality

Class NotificationSchedule

java.lang.Object

eu.dnetlib.domain.functionality.NotificationSchedule

All Implemented Interfaces:

Comparable<NotificationSchedule>

public class NotificationSchedule
extends Object
implements Comparable<NotificationSchedule>

This class represents an execution schedule for a notification query.

Author:

thanos

See Also:

eu.dnetlib.api.functionality.NotificationService, eu.dnetlib.functionality.notification.executor.NotificationQueryExecutor, NotificationQuery, NotificationEvent, NotificationResult, NotificationSubscription

Constructor Summary

Constructors

Constructor and Description
NotificationSchedule() Construct a new notification query with query identifier and trigger threshold set to null, percentile threshold and enabled set to false and execution period set to zero.
NotificationSchedule(String queryId, Float triggerThreshold, boolean percentileThreshold, long executionPeriod, boolean enabled) Construct a new notification schedule.

Method Summary

Modifier and Type	Method and Description
int	compareTo(NotificationSchedule schedule)
boolean	equals(Object object)
long	getExecutionPeriod() Get the execution period of this schedule.
String	getQueryId() Get the query of this schedule.
Float	getTriggerThreshold() Get the trigger threshold of this schedule.
int	hashCode()
boolean	isEnabled() Check if this schedule is enabled.
boolean	isPercentileThreshold() Check if the trigger threshold of this schedule is percentile.
void	setEnabled(boolean enabled) Set the enabled status of this schedule.
void	setExecutionPeriod(long executionPeriod) Set the execution period of this schedule.
void	setPercentileThreshold(boolean percentileThreshold) Set the percentile status of the trigger threshold of this schedule.
void	setQueryId(String queryId) Set the query of this schedule.
void	setTriggerThreshold(Float triggerThreshold) Set the trigger threshold of this schedule.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

NotificationSchedule

public NotificationSchedule(String queryId,
                            Float triggerThreshold,
                            boolean percentileThreshold,
                            long executionPeriod,
                            boolean enabled)

Construct a new notification schedule.

Parameters:

queryId - the unique identifier of the query of this schedule

triggerThreshold - the trigger threshold of this schedule or null if no threshold applies

percentileThreshold - true if trigger threshold is percentile threshold, false otherwise

executionPeriod - the execution period of this schedule expressed in minutes

enabled - true if this topic is currently enabled, false if it currently disabled

NotificationSchedule

public NotificationSchedule()

Construct a new notification query with query identifier and trigger threshold set to null, percentile threshold and enabled set to false and execution period set to zero.

Method Detail

getQueryId

public String getQueryId()

Get the query of this schedule.

Returns:

the unique identifier of the query of this schedule

setQueryId

public void setQueryId(String queryId)

Set the query of this schedule.

Parameters:

queryId - the unique identifier of the query of this schedule

getTriggerThreshold

public Float getTriggerThreshold()

Get the trigger threshold of this schedule.

Returns:

the trigger threshold of this schedule

setTriggerThreshold

public void setTriggerThreshold(Float triggerThreshold)

Set the trigger threshold of this schedule.

Parameters:

triggerThreshold - the the trigger threshold of this schedule

isPercentileThreshold

public boolean isPercentileThreshold()

Check if the trigger threshold of this schedule is percentile.

Returns:

true if the trigger threshold of this topic is percentile, false otherwise

setPercentileThreshold

public void setPercentileThreshold(boolean percentileThreshold)

Set the percentile status of the trigger threshold of this schedule.

Parameters:

percentileThreshold - true to set a percentile trigger threshold to this schedule, false otherwise

getExecutionPeriod

public long getExecutionPeriod()

Get the execution period of this schedule.

Returns:

the the execution period of this schedule

setExecutionPeriod

public void setExecutionPeriod(long executionPeriod)

Set the execution period of this schedule.

Parameters:

executionPeriod - the execution period of this schedule

isEnabled

public boolean isEnabled()

Check if this schedule is enabled.

Returns:

true if this schedule is currently enabled, false otherwise

setEnabled

public void setEnabled(boolean enabled)

Set the enabled status of this schedule.

Parameters:

enabled - true to enable this schedule, false to disable it

compareTo

public int compareTo(NotificationSchedule schedule)

Specified by:

compareTo in interface Comparable<NotificationSchedule>

equals

public boolean equals(Object object)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object