com.google.enterprise.connector.spi

Interface TraversalSchedule

public interface TraversalSchedule

A traversal schedule for a connector.

Since:

3.0

Method Summary

Modifier and Type	Method and Description
int	getRetryDelay() Returns the number of seconds to delay after finding no new content.
int	getTraversalRate() Returns the target traversal rate in documents per minute.
boolean	inScheduledInterval() Returns true if the current time is within a scheduled traversal interval.
boolean	isDisabled() Returns true if the traversal schedule is disabled.
int	nextScheduledInterval() Returns the number of seconds until the next scheduled traversal interval.
boolean	shouldRun() Returns true if traversals could run at this time, equivalent to

Method Detail

getTraversalRate

int getTraversalRate()

Returns the target traversal rate in documents per minute.

getRetryDelay

int getRetryDelay()

Returns the number of seconds to delay after finding no new content.

isDisabled

boolean isDisabled()

Returns true if the traversal schedule is disabled.

inScheduledInterval

boolean inScheduledInterval()

Returns true if the current time is within a scheduled traversal interval.

nextScheduledInterval

int nextScheduledInterval()

Returns the number of seconds until the next scheduled traversal interval. A return value of 0 (zero) indicates the current time is within a scheduled traversal interval. A returned value of -1 indicates there is no next traversal interval.

shouldRun

boolean shouldRun()

Returns true if traversals could run at this time, equivalent to

!isDisabled() && inScheduledInterval()

.