Package ch.ivyteam.ivy.process.beans

Interface IPoller

public interface IPoller

Use one of the methods to defined how often or when the IProcessStartEventBean.poll() or IProcessIntermediateEventBean.poll() method should be called

Since:

11.2

API:

This is a public API.

Method Summary

Modifier and Type	Method	Description
void	asDefinedByExpression(String expresssion)	The IProcessStartEventBean.poll() or IProcessIntermediateEventBean.poll() method will be called as defined in the given expression.
void	asDefinedByVariable(String variableName)	The IProcessStartEventBean.poll() or IProcessIntermediateEventBean.poll() method will be called as defined in the value of the variable with the given name.
void	atCron(String cronExpression)	The IProcessStartEventBean.poll() or IProcessIntermediateEventBean.poll() method will be called at times defined by the given cron expression.
void	dailyAt(Time time)	The IProcessStartEventBean.poll() or IProcessIntermediateEventBean.poll() method will be called every day at the given time
void	dailyAt(LocalTime time)	The IProcessStartEventBean.poll() or IProcessIntermediateEventBean.poll() method will be called every day at the given time
void	disable()	The IProcessStartEventBean.poll() or IProcessIntermediateEventBean.poll() method will never called.
void	every(Duration duration)	The IProcessStartEventBean.poll() or IProcessIntermediateEventBean.poll() method will be called every given duration
void	every(Duration duration)	The IProcessStartEventBean.poll() or IProcessIntermediateEventBean.poll() method will be called every given duration

Method Details

every

void every(Duration duration)

The IProcessStartEventBean.poll() or IProcessIntermediateEventBean.poll() method will be called every given duration

Parameters:

duration - positive durations only

Throws:

IllegalArgumentException - if given duration is zero or negative

API:

This public API is available in Java.

every

void every(Duration duration)

The IProcessStartEventBean.poll() or IProcessIntermediateEventBean.poll() method will be called every given duration

Parameters:

duration - positive durations only

Throws:

IllegalArgumentException - if given duration is zero or negative

API:

This public API is available in Java.

dailyAt

void dailyAt(LocalTime time)

The IProcessStartEventBean.poll() or IProcessIntermediateEventBean.poll() method will be called every day at the given time

Parameters:

time -

API:

This public API is available in Java.

dailyAt

void dailyAt(Time time)

The IProcessStartEventBean.poll() or IProcessIntermediateEventBean.poll() method will be called every day at the given time

Parameters:

time -

API:

This public API is available in Java.

atCron

void atCron(String cronExpression)

The IProcessStartEventBean.poll() or IProcessIntermediateEventBean.poll() method will be called at times defined by the given cron expression. The given cron expression must be in the Unix format. Example: 15 10 * * MON

Parameters:

cronExpression -

Throws:

IllegalArgumentException - if cron expression cannot be parsed

See Also:

• Cron Expression

API:

This public API is available in Java.

asDefinedByVariable

void asDefinedByVariable(String variableName)

The IProcessStartEventBean.poll() or IProcessIntermediateEventBean.poll() method will be called as defined in the value of the variable with the given name.

See asDefinedByExpression(String) to learn about the supported variable value formats.

The poll job that calls the IProcessStartEventBean.poll() method is automatically reconfigured if the value of the variable is changed.

Parameters:

variableName -

API:

This public API is available in Java.

asDefinedByExpression

void asDefinedByExpression(String expresssion)

The IProcessStartEventBean.poll() or IProcessIntermediateEventBean.poll() method will be called as defined in the given expression.

The following expression formats are supported:

• Blank - The poll method will never called. E.g.
• Number - The poll method is call every seconds given by the number. E.g., 10
• Time - The poll method is called daily at the given time. E.g., 10:15
• Duration - The poll method is called every given duration. E.g., PT10S
• CRON - The poll method is called at times defined by the given cron expression. E.g., 15 10 * * MON
• Variable - The poll method is called at times defined by the value of the variable. ivy.var.poll

Parameters:

expresssion - name of the variable

Throws:

IllegalArgumentException - if none of the supported formats can be parsed

API:

This public API is available in Java.

disable

void disable()

The IProcessStartEventBean.poll() or IProcessIntermediateEventBean.poll() method will never called.

API:

This public API is available in Java.