biz.sc.mm.dm.base

Interface Trigger

All Superinterfaces:

PersistentObject, Verifiable

public interface Trigger
extends PersistentObject

Class strictly involved with functionality of operating server.

Method Summary

Methods

Modifier and Type	Method and Description
java.util.Date	getEndTime() Get the time at which the Trigger should quit repeating - even if an assigned 'repeatCount' isn't yet satisfied.
java.util.Date	getNextFireTime()
int	getRepeatCount() Get the number of times the Trigger should repeat, after which it will be automatically deleted.
java.lang.Integer	getRepeatCountLeft()
long	getRepeatInterval() Get the the time interval (in milliseconds) at which the Trigger should repeat.
java.util.ArrayList	getScriptList() Get Scripts List executed by trigger.
java.util.Date	getStartTime() Get the time at which the Trigger should occur.
TriggerFrequencyType	getTriggerFrequencyType()
java.util.TimeZone	getUserTimeZone()
boolean	isActive() Get the value of current state of trigger (active or inactive).
boolean	isUseUserTimeZone()
void	setActive(boolean b) Set the state of trigger (active or inactive).
void	setEndTime(java.util.Date date) Set the time at which the Trigger should quit repeating (and be automatically deleted).
void	setNextFireTime(java.util.Date nextFireTime)
void	setRepeatCount(int rc) Set the the number of time the Trigger should repeat, after which it will be automatically deleted.
void	setRepeatCountLeft(int repeatCountLeft)
void	setRepeatInterval(long ri) Set the time interval (in milliseconds) at which the Trigger should repeat.
void	setScriptList(java.util.ArrayList scriptList) Set the scripts list to be executed by trigger.
void	setStartTime(java.util.Date date) Set the the number of time the Trigger should repeat, after which it will be automatically deleted.
void	setTriggerFrequencyType(TriggerFrequencyType frequencyType)
void	setUseUserTimeZone(boolean useUserTimeZone)
java.lang.String	toString() Get the string representation.

Methods inherited from interface biz.sc.mm.dm.PersistentObject

getDescription, getName, getObjectIdentifier, getProperties, isEditable, setDescription, setEditable, setName, setObjectIdentifier

Methods inherited from interface biz.sc.mm.dm.base.Verifiable

verify

Method Detail

getScriptList

java.util.ArrayList getScriptList()

Get Scripts List executed by trigger.

Returns:

Scripts List executed by trigger.

getRepeatCount

int getRepeatCount()

Get the number of times the Trigger should repeat, after which it will be automatically deleted.

Returns:

the the number of times the Trigger should repeat, after which it will be automatically deleted.

getEndTime

java.util.Date getEndTime()

Get the time at which the Trigger should quit repeating - even if an assigned 'repeatCount' isn't yet satisfied.

Returns:

the time at which the Trigger should quit repeating

getStartTime

java.util.Date getStartTime()

Get the time at which the Trigger should occur.

Returns:

the time at which the Trigger should occur.

getRepeatInterval

long getRepeatInterval()

Get the the time interval (in milliseconds) at which the Trigger should repeat.

Returns:

the the time interval (in milliseconds) at which the Trigger should repeat.

setRepeatCount

void setRepeatCount(int rc)

Set the the number of time the Trigger should repeat, after which it will be automatically deleted. By default repeat count equals -1 what means that triggers repeat indefinitely.

Parameters:

the - number of time the Trigger should repeat.

setStartTime

void setStartTime(java.util.Date date)

Set the the number of time the Trigger should repeat, after which it will be automatically deleted. By default repeat count equals -1 what means that triggers repeat indefinitely.

Parameters:

the - number of time the Trigger should repeat.

setEndTime

void setEndTime(java.util.Date date)

Set the time at which the Trigger should quit repeating (and be automatically deleted). Default start time is 1970-01-01.

Parameters:

the - time at which the Trigger should quit repeating

setRepeatInterval

void setRepeatInterval(long ri)

Set the time interval (in milliseconds) at which the Trigger should repeat.

Parameters:

the - time interval (in milliseconds) at which the Trigger should repeat

setScriptList

void setScriptList(java.util.ArrayList scriptList)

Set the scripts list to be executed by trigger.

Parameters:

scripts - list

isActive

boolean isActive()

Get the value of current state of trigger (active or inactive).

Returns:

the boolean value of current state

setActive

void setActive(boolean b)

Set the state of trigger (active or inactive).

Parameters:

boolean - value (active or inactive)

toString

java.lang.String toString()

Get the string representation.

Overrides:

toString in class java.lang.Object

Returns:

the String representation.

getTriggerFrequencyType

TriggerFrequencyType getTriggerFrequencyType()

setTriggerFrequencyType

void setTriggerFrequencyType(TriggerFrequencyType frequencyType)

getUserTimeZone

java.util.TimeZone getUserTimeZone()

isUseUserTimeZone

boolean isUseUserTimeZone()

setUseUserTimeZone

void setUseUserTimeZone(boolean useUserTimeZone)

getNextFireTime

java.util.Date getNextFireTime()

setNextFireTime

void setNextFireTime(java.util.Date nextFireTime)

getRepeatCountLeft

java.lang.Integer getRepeatCountLeft()

setRepeatCountLeft

void setRepeatCountLeft(int repeatCountLeft)