com.canto.cumulus.db.trigger

Class Trigger

java.lang.Object

com.canto.cumulus.db.trigger.Trigger

public final class Trigger
extends java.lang.Object

This class describes a single trigger.

Constructor Summary

Constructors

Constructor and Description
Trigger(Condition condition, Action action) Creates a new local trigger instance.

Method Summary

Methods

Modifier and Type	Method and Description
void	bind(Binding binding) Binds this trigger to the given binding.
boolean	equals(java.lang.Object o)
Action	getAction() Returns the action for this trigger.
Binding	getBinding() Returns this triggers binding.
Condition	getCondition() Returns the condition of this trigger.
int	getID() Returns the trigger id.
JPack	getInfo() Returns the info pack for this trigger.
java.lang.String	getOwner() Returns the unique UID of the creator of this trigger.
int	hashCode()
boolean	hasValidID() Returns whether this trigger is already stored at the server and has a valid trigger id.
boolean	isActive() Returns whether this trigger is active.
void	save() Saves this trigger.
void	setActive(boolean active) Sets whether this trigger should be active.
boolean	validateOwner(boolean writeUserUID) Returns whether the stored trigger owner is stored as a unique UID.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Trigger

public Trigger(Condition condition,
       Action action)

Creates a new local trigger instance.

Parameters:

condition - condition for this trigger

action - action to execute for this trigger

Method Detail

isActive

public boolean isActive()

Returns whether this trigger is active.

Returns:

true if this trigger is active

Since:

10.2.5

setActive

public void setActive(boolean active)

Sets whether this trigger should be active.

Parameters:

active - set to true if this trigger is active

Since:

10.2.5

bind

public final void bind(Binding binding)

Binds this trigger to the given binding.

Parameters:

binding - to bind to

getCondition

public Condition getCondition()

Returns the condition of this trigger.

Returns:

condition

getAction

public Action getAction()

Returns the action for this trigger.

Returns:

action

getInfo

public JPack getInfo()

Returns the info pack for this trigger.

Returns:

trigger info

getBinding

public Binding getBinding()

Returns this triggers binding.

Returns:

instance of Binding or null of not yet bound

getOwner

public java.lang.String getOwner()

Returns the unique UID of the creator of this trigger.

Returns:

user UID

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

hasValidID

public boolean hasValidID()

Returns whether this trigger is already stored at the server and has a valid trigger id.

Returns:

true if the stored trigger id is valid

getID

public int getID()

Returns the trigger id.

Returns:

trigger id

save

public void save()
          throws CumulusException,
                 InvalidTypeException,
                 InvalidStateException

Saves this trigger.

Throws:

CumulusException - in case of an error

InvalidTypeException - in case of an invalid type of binding for this trigger

InvalidStateException - in case of an error

validateOwner

public boolean validateOwner(boolean writeUserUID)
                      throws InvalidStateException,
                             InvalidTypeException

Returns whether the stored trigger owner is stored as a unique UID. Additionally this function can convert old trigger to the new standard.

Parameters:

writeUserUID - set to true if you want to convert an old trigger with a login name for the owner to a new trigger using a unique UID

Returns:

true if this trigger complies to the new standard, false otherwise

Throws:

InvalidStateException - in case of an error

InvalidTypeException - in case of an error